model_create_submission_batch_request.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 CreateSubmissionBatchRequest type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &CreateSubmissionBatchRequest{}

// CreateSubmissionBatchRequest The submissions to create, and the settings they share.
type CreateSubmissionBatchRequest struct {
	// Your own data about the batch, such as an ID from your app.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// The template for each submission that doesn't name its own `template_id`.
	TemplateId *string `json:"template_id,omitempty"`
	// The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`.
	TemplateVersion *string `json:"template_version,omitempty"`
	// The default `test` for each submission that doesn't set its own.
	Test *bool `json:"test,omitempty"`
	// The default `output_formats` for each submission that doesn't set its own.
	OutputFormats []OutputFormat `json:"output_formats,omitempty"`
	// Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests` and the options for DocSpring's emails to signers (`send_email`, `signing_order`, `email_subject`, `email_message`, `cc`, `reply_to`, `notification_emails`, `notify_when_signed` and `reminders`), plus `template_id` and `template_version` when it uses a different template from the batch.
	Submissions []SubmissionInput `json:"submissions"`
	AdditionalProperties map[string]interface{}
}

type _CreateSubmissionBatchRequest CreateSubmissionBatchRequest

// NewCreateSubmissionBatchRequest instantiates a new CreateSubmissionBatchRequest 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 NewCreateSubmissionBatchRequest(submissions []SubmissionInput) *CreateSubmissionBatchRequest {
	this := CreateSubmissionBatchRequest{}
	this.Submissions = submissions
	return &this
}

// NewCreateSubmissionBatchRequestWithDefaults instantiates a new CreateSubmissionBatchRequest 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 NewCreateSubmissionBatchRequestWithDefaults() *CreateSubmissionBatchRequest {
	this := CreateSubmissionBatchRequest{}
	return &this
}

// GetMetadata returns the Metadata field value if set, zero value otherwise.
func (o *CreateSubmissionBatchRequest) GetMetadata() map[string]interface{} {
	if o == nil || IsNil(o.Metadata) {
		var ret map[string]interface{}
		return ret
	}
	return o.Metadata
}

// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *CreateSubmissionBatchRequest) GetMetadataOk() (map[string]interface{}, bool) {
	if o == nil || IsNil(o.Metadata) {
		return map[string]interface{}{}, false
	}
	return o.Metadata, true
}

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

	return false
}

// SetMetadata gets a reference to the given map[string]interface{} and assigns it to the Metadata field.
func (o *CreateSubmissionBatchRequest) SetMetadata(v map[string]interface{}) {
	o.Metadata = v
}

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

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

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

	return false
}

// SetTemplateId gets a reference to the given string and assigns it to the TemplateId field.
func (o *CreateSubmissionBatchRequest) SetTemplateId(v string) {
	o.TemplateId = &v
}

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

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

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

	return false
}

// SetTemplateVersion gets a reference to the given string and assigns it to the TemplateVersion field.
func (o *CreateSubmissionBatchRequest) SetTemplateVersion(v string) {
	o.TemplateVersion = &v
}

// GetTest returns the Test field value if set, zero value otherwise.
func (o *CreateSubmissionBatchRequest) GetTest() bool {
	if o == nil || IsNil(o.Test) {
		var ret bool
		return ret
	}
	return *o.Test
}

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

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

	return false
}

// SetTest gets a reference to the given bool and assigns it to the Test field.
func (o *CreateSubmissionBatchRequest) SetTest(v bool) {
	o.Test = &v
}

// GetOutputFormats returns the OutputFormats field value if set, zero value otherwise.
func (o *CreateSubmissionBatchRequest) GetOutputFormats() []OutputFormat {
	if o == nil || IsNil(o.OutputFormats) {
		var ret []OutputFormat
		return ret
	}
	return o.OutputFormats
}

// GetOutputFormatsOk returns a tuple with the OutputFormats field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *CreateSubmissionBatchRequest) GetOutputFormatsOk() ([]OutputFormat, bool) {
	if o == nil || IsNil(o.OutputFormats) {
		return nil, false
	}
	return o.OutputFormats, true
}

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

	return false
}

// SetOutputFormats gets a reference to the given []OutputFormat and assigns it to the OutputFormats field.
func (o *CreateSubmissionBatchRequest) SetOutputFormats(v []OutputFormat) {
	o.OutputFormats = v
}

// GetSubmissions returns the Submissions field value
func (o *CreateSubmissionBatchRequest) GetSubmissions() []SubmissionInput {
	if o == nil {
		var ret []SubmissionInput
		return ret
	}

	return o.Submissions
}

// GetSubmissionsOk returns a tuple with the Submissions field value
// and a boolean to check if the value has been set.
func (o *CreateSubmissionBatchRequest) GetSubmissionsOk() ([]SubmissionInput, bool) {
	if o == nil {
		return nil, false
	}
	return o.Submissions, true
}

// SetSubmissions sets field value
func (o *CreateSubmissionBatchRequest) SetSubmissions(v []SubmissionInput) {
	o.Submissions = v
}

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

func (o CreateSubmissionBatchRequest) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	if !IsNil(o.Metadata) {
		toSerialize["metadata"] = o.Metadata
	}
	if !IsNil(o.TemplateId) {
		toSerialize["template_id"] = o.TemplateId
	}
	if !IsNil(o.TemplateVersion) {
		toSerialize["template_version"] = o.TemplateVersion
	}
	if !IsNil(o.Test) {
		toSerialize["test"] = o.Test
	}
	if !IsNil(o.OutputFormats) {
		toSerialize["output_formats"] = o.OutputFormats
	}
	toSerialize["submissions"] = o.Submissions

	for key, value := range o.AdditionalProperties {
		toSerialize[key] = value
	}

	return toSerialize, nil
}

func (o *CreateSubmissionBatchRequest) 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{
		"submissions",
	}

	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)
		}
	}

	varCreateSubmissionBatchRequest := _CreateSubmissionBatchRequest{}

	err = json.Unmarshal(data, &varCreateSubmissionBatchRequest)

	if err != nil {
		return err
	}

	*o = CreateSubmissionBatchRequest(varCreateSubmissionBatchRequest)

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

	if err = json.Unmarshal(data, &additionalProperties); err == nil {
		delete(additionalProperties, "metadata")
		delete(additionalProperties, "template_id")
		delete(additionalProperties, "template_version")
		delete(additionalProperties, "test")
		delete(additionalProperties, "output_formats")
		delete(additionalProperties, "submissions")
		o.AdditionalProperties = additionalProperties
	}

	return err
}

type NullableCreateSubmissionBatchRequest struct {
	value *CreateSubmissionBatchRequest
	isSet bool
}

func (v NullableCreateSubmissionBatchRequest) Get() *CreateSubmissionBatchRequest {
	return v.value
}

func (v *NullableCreateSubmissionBatchRequest) Set(val *CreateSubmissionBatchRequest) {
	v.value = val
	v.isSet = true
}

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

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

func NewNullableCreateSubmissionBatchRequest(val *CreateSubmissionBatchRequest) *NullableCreateSubmissionBatchRequest {
	return &NullableCreateSubmissionBatchRequest{value: val, isSet: true}
}

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

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