model_html_engine_options.go

/*
DocSpring API

Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.

API version: v2
*/

// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.

package docspring

import (
	"encoding/json"
	"fmt"
)

// checks if the HtmlEngineOptions type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &HtmlEngineOptions{}

// HtmlEngineOptions How an HTML template's PDFs are printed.
type HtmlEngineOptions struct {
	// The paper size. `Custom` uses `width` and `height`.
	Format PageFormat `json:"format"`
	// The page width for the `Custom` format, with a unit (`8.5in`, `210mm`).
	Width *string `json:"width,omitempty"`
	// The page height for the `Custom` format, with a unit.
	Height *string `json:"height,omitempty"`
	// How much to scale the page, such as `0.8`. `1` prints it at its normal size.
	Scale float32 `json:"scale"`
	// Print pages in landscape orientation.
	Landscape bool `json:"landscape"`
	// Print background colors and images.
	PrintBackground bool `json:"print_background"`
	// The top margin, with a unit, such as `1in` or `20mm`.
	MarginTop string `json:"margin_top"`
	// The bottom margin, with a unit.
	MarginBottom string `json:"margin_bottom"`
	// The left margin, with a unit.
	MarginLeft string `json:"margin_left"`
	// The right margin, with a unit.
	MarginRight string `json:"margin_right"`
}

type _HtmlEngineOptions HtmlEngineOptions

// NewHtmlEngineOptions instantiates a new HtmlEngineOptions object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewHtmlEngineOptions(format PageFormat, scale float32, landscape bool, printBackground bool, marginTop string, marginBottom string, marginLeft string, marginRight string) *HtmlEngineOptions {
	this := HtmlEngineOptions{}
	this.Format = format
	this.Scale = scale
	this.Landscape = landscape
	this.PrintBackground = printBackground
	this.MarginTop = marginTop
	this.MarginBottom = marginBottom
	this.MarginLeft = marginLeft
	this.MarginRight = marginRight
	return &this
}

// NewHtmlEngineOptionsWithDefaults instantiates a new HtmlEngineOptions object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewHtmlEngineOptionsWithDefaults() *HtmlEngineOptions {
	this := HtmlEngineOptions{}
	return &this
}

// GetFormat returns the Format field value
func (o *HtmlEngineOptions) GetFormat() PageFormat {
	if o == nil {
		var ret PageFormat
		return ret
	}

	return o.Format
}

// GetFormatOk returns a tuple with the Format field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetFormatOk() (*PageFormat, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Format, true
}

// SetFormat sets field value
func (o *HtmlEngineOptions) SetFormat(v PageFormat) {
	o.Format = v
}

// GetWidth returns the Width field value if set, zero value otherwise.
func (o *HtmlEngineOptions) GetWidth() string {
	if o == nil || IsNil(o.Width) {
		var ret string
		return ret
	}
	return *o.Width
}

// GetWidthOk returns a tuple with the Width field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetWidthOk() (*string, bool) {
	if o == nil || IsNil(o.Width) {
		return nil, false
	}
	return o.Width, true
}

// HasWidth returns a boolean if a field has been set.
func (o *HtmlEngineOptions) HasWidth() bool {
	if o != nil && !IsNil(o.Width) {
		return true
	}

	return false
}

// SetWidth gets a reference to the given string and assigns it to the Width field.
func (o *HtmlEngineOptions) SetWidth(v string) {
	o.Width = &v
}

// GetHeight returns the Height field value if set, zero value otherwise.
func (o *HtmlEngineOptions) GetHeight() string {
	if o == nil || IsNil(o.Height) {
		var ret string
		return ret
	}
	return *o.Height
}

// GetHeightOk returns a tuple with the Height field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetHeightOk() (*string, bool) {
	if o == nil || IsNil(o.Height) {
		return nil, false
	}
	return o.Height, true
}

// HasHeight returns a boolean if a field has been set.
func (o *HtmlEngineOptions) HasHeight() bool {
	if o != nil && !IsNil(o.Height) {
		return true
	}

	return false
}

// SetHeight gets a reference to the given string and assigns it to the Height field.
func (o *HtmlEngineOptions) SetHeight(v string) {
	o.Height = &v
}

// GetScale returns the Scale field value
func (o *HtmlEngineOptions) GetScale() float32 {
	if o == nil {
		var ret float32
		return ret
	}

	return o.Scale
}

// GetScaleOk returns a tuple with the Scale field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetScaleOk() (*float32, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Scale, true
}

// SetScale sets field value
func (o *HtmlEngineOptions) SetScale(v float32) {
	o.Scale = v
}

// GetLandscape returns the Landscape field value
func (o *HtmlEngineOptions) GetLandscape() bool {
	if o == nil {
		var ret bool
		return ret
	}

	return o.Landscape
}

// GetLandscapeOk returns a tuple with the Landscape field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetLandscapeOk() (*bool, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Landscape, true
}

// SetLandscape sets field value
func (o *HtmlEngineOptions) SetLandscape(v bool) {
	o.Landscape = v
}

// GetPrintBackground returns the PrintBackground field value
func (o *HtmlEngineOptions) GetPrintBackground() bool {
	if o == nil {
		var ret bool
		return ret
	}

	return o.PrintBackground
}

// GetPrintBackgroundOk returns a tuple with the PrintBackground field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetPrintBackgroundOk() (*bool, bool) {
	if o == nil {
		return nil, false
	}
	return &o.PrintBackground, true
}

// SetPrintBackground sets field value
func (o *HtmlEngineOptions) SetPrintBackground(v bool) {
	o.PrintBackground = v
}

// GetMarginTop returns the MarginTop field value
func (o *HtmlEngineOptions) GetMarginTop() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.MarginTop
}

// GetMarginTopOk returns a tuple with the MarginTop field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetMarginTopOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.MarginTop, true
}

// SetMarginTop sets field value
func (o *HtmlEngineOptions) SetMarginTop(v string) {
	o.MarginTop = v
}

// GetMarginBottom returns the MarginBottom field value
func (o *HtmlEngineOptions) GetMarginBottom() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.MarginBottom
}

// GetMarginBottomOk returns a tuple with the MarginBottom field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetMarginBottomOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.MarginBottom, true
}

// SetMarginBottom sets field value
func (o *HtmlEngineOptions) SetMarginBottom(v string) {
	o.MarginBottom = v
}

// GetMarginLeft returns the MarginLeft field value
func (o *HtmlEngineOptions) GetMarginLeft() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.MarginLeft
}

// GetMarginLeftOk returns a tuple with the MarginLeft field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetMarginLeftOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.MarginLeft, true
}

// SetMarginLeft sets field value
func (o *HtmlEngineOptions) SetMarginLeft(v string) {
	o.MarginLeft = v
}

// GetMarginRight returns the MarginRight field value
func (o *HtmlEngineOptions) GetMarginRight() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.MarginRight
}

// GetMarginRightOk returns a tuple with the MarginRight field value
// and a boolean to check if the value has been set.
func (o *HtmlEngineOptions) GetMarginRightOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.MarginRight, true
}

// SetMarginRight sets field value
func (o *HtmlEngineOptions) SetMarginRight(v string) {
	o.MarginRight = v
}

func (o HtmlEngineOptions) MarshalJSON() ([]byte, error) {
	toSerialize,err := o.ToMap()
	if err != nil {
		return []byte{}, err
	}
	return json.Marshal(toSerialize)
}

func (o HtmlEngineOptions) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	toSerialize["format"] = o.Format
	if !IsNil(o.Width) {
		toSerialize["width"] = o.Width
	}
	if !IsNil(o.Height) {
		toSerialize["height"] = o.Height
	}
	toSerialize["scale"] = o.Scale
	toSerialize["landscape"] = o.Landscape
	toSerialize["print_background"] = o.PrintBackground
	toSerialize["margin_top"] = o.MarginTop
	toSerialize["margin_bottom"] = o.MarginBottom
	toSerialize["margin_left"] = o.MarginLeft
	toSerialize["margin_right"] = o.MarginRight
	return toSerialize, nil
}

func (o *HtmlEngineOptions) UnmarshalJSON(data []byte) (err error) {
	// This validates that all required properties are included in the JSON object
	// by unmarshalling the object into a generic map with string keys and checking
	// that every required field exists as a key in the generic map.
	requiredProperties := []string{
		"format",
		"scale",
		"landscape",
		"print_background",
		"margin_top",
		"margin_bottom",
		"margin_left",
		"margin_right",
	}

	allProperties := make(map[string]interface{})

	err = json.Unmarshal(data, &allProperties)

	if err != nil {
		return err;
	}

	for _, requiredProperty := range(requiredProperties) {
		if _, exists := allProperties[requiredProperty]; !exists {
			return fmt.Errorf("no value given for required property %v", requiredProperty)
		}
	}

	varHtmlEngineOptions := _HtmlEngineOptions{}

	// Ignore unknown fields, so a field added to the API later doesn't break this client.
	err = json.Unmarshal(data, &varHtmlEngineOptions)

	if err != nil {
		return err
	}

	*o = HtmlEngineOptions(varHtmlEngineOptions)

	return err
}

type NullableHtmlEngineOptions struct {
	value *HtmlEngineOptions
	isSet bool
}

func (v NullableHtmlEngineOptions) Get() *HtmlEngineOptions {
	return v.value
}

func (v *NullableHtmlEngineOptions) Set(val *HtmlEngineOptions) {
	v.value = val
	v.isSet = true
}

func (v NullableHtmlEngineOptions) IsSet() bool {
	return v.isSet
}

func (v *NullableHtmlEngineOptions) Unset() {
	v.value = nil
	v.isSet = false
}

func NewNullableHtmlEngineOptions(val *HtmlEngineOptions) *NullableHtmlEngineOptions {
	return &NullableHtmlEngineOptions{value: val, isSet: true}
}

func (v NullableHtmlEngineOptions) MarshalJSON() ([]byte, error) {
	return json.Marshal(v.value)
}

func (v *NullableHtmlEngineOptions) UnmarshalJSON(src []byte) error {
	v.isSet = true
	return json.Unmarshal(src, &v.value)
}