filing_request_data_model.go

// Code generated by go-swagger; DO NOT EDIT.

package models

// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command

import (
	"context"
	"encoding/json"
	"strconv"

	"github.com/go-openapi/errors"
	"github.com/go-openapi/strfmt"
	"github.com/go-openapi/swag"
	"github.com/go-openapi/validate"
)

// FilingRequestDataModel Represents a commitment to file a tax return on a recurring basis.
// Only used if you subscribe to Avalara Returns.
// Example: {"answers":[{"answer":"Answer to question 1","filingQuestionId":1},{"answer":"Answer to question 2","filingQuestionId":2}],"companyReturnId":1,"country":"US","effDate":"2017-01-01","endDate":"2020-01-01","filingFrequencyId":"Monthly","isClone":false,"locationCode":"LOC-1","months":2,"region":"WI","registrationId":"1234","returnName":"WIST12CT","taxAuthorityId":121,"taxAuthorityName":"WISCONSIN","taxFormCode":"US00194","taxTypeId":"SalesTax"}
//
// swagger:model FilingRequestDataModel
type FilingRequestDataModel struct {

	// Filing question answers
	// Example: [{"answer":"Answer to question 1","filingQuestionId":1},{"answer":"Answer to question 2","filingQuestionId":2}]
	Answers []*FilingAnswerModel `json:"answers"`

	// The company return ID if requesting an update.
	// Example: 1
	CompanyReturnID int64 `json:"companyReturnId,omitempty"`

	// The two character ISO 3166 country code of the country that issued the tax form for this filing calendar.
	// Example: US
	// Read Only: true
	Country string `json:"country,omitempty"`

	// Filing cycle effective date of the request
	// Example: 2017-01-01T00:00:00
	// Required: true
	// Format: date
	EffDate *strfmt.Date `json:"effDate"`

	// Filing cycle end date of the request
	// Example: 2020-01-01T00:00:00
	// Format: date
	EndDate strfmt.Date `json:"endDate,omitempty"`

	// The filing frequency of the request
	// Example: Monthly
	// Required: true
	// Enum: [Monthly Quarterly SemiAnnually Annually Bimonthly Occasional InverseQuarterly Weekly]
	FilingFrequencyID *string `json:"filingFrequencyId"`

	// The start period of a fiscal year for this form/company
	FiscalYearStartMonth int32 `json:"fiscalYearStartMonth,omitempty"`

	// Flag if the request is a clone of a current filing calendar
	// Example: false
	IsClone bool `json:"isClone,omitempty"`

	// Location code of the request
	// Example: LOC-1
	LocationCode string `json:"locationCode,omitempty"`

	// The months of the request
	// Example: 2
	// Required: true
	Months *int16 `json:"months"`

	// The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar.
	// Example: WI
	// Read Only: true
	Region string `json:"region,omitempty"`

	// State registration ID of the company requesting the filing calendar.
	// Example: 1234
	RegistrationID string `json:"registrationId,omitempty"`

	// DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead.
	// The legacy return name of the requested calendar.
	// Example: WIST12CT
	ReturnName string `json:"returnName,omitempty"`

	// The tax authority id of the return
	// Example: 121
	// Read Only: true
	TaxAuthorityID int32 `json:"taxAuthorityId,omitempty"`

	// The tax authority name on the return
	// Example: WISCONSIN
	// Read Only: true
	TaxAuthorityName string `json:"taxAuthorityName,omitempty"`

	// The Avalara standard tax form code of the tax form for this filing calendar.  The first two characters of the tax form code
	// are the ISO 3166 country code of the country that issued this form.
	// Example: US00194
	TaxFormCode string `json:"taxFormCode,omitempty"`

	// The type of tax to report on this return.
	// Example: E
	// Enum: [E Lodging Bottle RentToOwn BikeTax LandedCost CheckoutBag Alcohol Amusement Hospitality RentalLeasing GrossReceipts Mattress Lumber Paint Tires EI All BothSalesAndUseTax ConsumerUseTax ConsumersUseAndSellersUseTax ConsumerUseAndSalesTax Fee VATInputTax LightBulbs Meals VATNonrecoverableInputTax VATOutputTax PIF Rental SalesTax UseTax EWaste Batteries]
	TaxTypeID string `json:"taxTypeId,omitempty"`
}

// Validate validates this filing request data model
func (m *FilingRequestDataModel) Validate(formats strfmt.Registry) error {
	var res []error

	if err := m.validateAnswers(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateEffDate(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateEndDate(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateFilingFrequencyID(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateMonths(formats); err != nil {
		res = append(res, err)
	}

	if err := m.validateTaxTypeID(formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *FilingRequestDataModel) validateAnswers(formats strfmt.Registry) error {
	if swag.IsZero(m.Answers) { // not required
		return nil
	}

	for i := 0; i < len(m.Answers); i++ {
		if swag.IsZero(m.Answers[i]) { // not required
			continue
		}

		if m.Answers[i] != nil {
			if err := m.Answers[i].Validate(formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("answers" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("answers" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

func (m *FilingRequestDataModel) validateEffDate(formats strfmt.Registry) error {

	if err := validate.Required("effDate", "body", m.EffDate); err != nil {
		return err
	}

	if err := validate.FormatOf("effDate", "body", "date", m.EffDate.String(), formats); err != nil {
		return err
	}

	return nil
}

func (m *FilingRequestDataModel) validateEndDate(formats strfmt.Registry) error {
	if swag.IsZero(m.EndDate) { // not required
		return nil
	}

	if err := validate.FormatOf("endDate", "body", "date", m.EndDate.String(), formats); err != nil {
		return err
	}

	return nil
}

var filingRequestDataModelTypeFilingFrequencyIDPropEnum []interface{}

func init() {
	var res []string
	if err := json.Unmarshal([]byte(`["Monthly","Quarterly","SemiAnnually","Annually","Bimonthly","Occasional","InverseQuarterly","Weekly"]`), &res); err != nil {
		panic(err)
	}
	for _, v := range res {
		filingRequestDataModelTypeFilingFrequencyIDPropEnum = append(filingRequestDataModelTypeFilingFrequencyIDPropEnum, v)
	}
}

const (

	// FilingRequestDataModelFilingFrequencyIDMonthly captures enum value "Monthly"
	FilingRequestDataModelFilingFrequencyIDMonthly string = "Monthly"

	// FilingRequestDataModelFilingFrequencyIDQuarterly captures enum value "Quarterly"
	FilingRequestDataModelFilingFrequencyIDQuarterly string = "Quarterly"

	// FilingRequestDataModelFilingFrequencyIDSemiAnnually captures enum value "SemiAnnually"
	FilingRequestDataModelFilingFrequencyIDSemiAnnually string = "SemiAnnually"

	// FilingRequestDataModelFilingFrequencyIDAnnually captures enum value "Annually"
	FilingRequestDataModelFilingFrequencyIDAnnually string = "Annually"

	// FilingRequestDataModelFilingFrequencyIDBimonthly captures enum value "Bimonthly"
	FilingRequestDataModelFilingFrequencyIDBimonthly string = "Bimonthly"

	// FilingRequestDataModelFilingFrequencyIDOccasional captures enum value "Occasional"
	FilingRequestDataModelFilingFrequencyIDOccasional string = "Occasional"

	// FilingRequestDataModelFilingFrequencyIDInverseQuarterly captures enum value "InverseQuarterly"
	FilingRequestDataModelFilingFrequencyIDInverseQuarterly string = "InverseQuarterly"

	// FilingRequestDataModelFilingFrequencyIDWeekly captures enum value "Weekly"
	FilingRequestDataModelFilingFrequencyIDWeekly string = "Weekly"
)

// prop value enum
func (m *FilingRequestDataModel) validateFilingFrequencyIDEnum(path, location string, value string) error {
	if err := validate.EnumCase(path, location, value, filingRequestDataModelTypeFilingFrequencyIDPropEnum, true); err != nil {
		return err
	}
	return nil
}

func (m *FilingRequestDataModel) validateFilingFrequencyID(formats strfmt.Registry) error {

	if err := validate.Required("filingFrequencyId", "body", m.FilingFrequencyID); err != nil {
		return err
	}

	// value enum
	if err := m.validateFilingFrequencyIDEnum("filingFrequencyId", "body", *m.FilingFrequencyID); err != nil {
		return err
	}

	return nil
}

func (m *FilingRequestDataModel) validateMonths(formats strfmt.Registry) error {

	if err := validate.Required("months", "body", m.Months); err != nil {
		return err
	}

	return nil
}

var filingRequestDataModelTypeTaxTypeIDPropEnum []interface{}

func init() {
	var res []string
	if err := json.Unmarshal([]byte(`["E","Lodging","Bottle","RentToOwn","BikeTax","LandedCost","CheckoutBag","Alcohol","Amusement","Hospitality","RentalLeasing","GrossReceipts","Mattress","Lumber","Paint","Tires","EI","All","BothSalesAndUseTax","ConsumerUseTax","ConsumersUseAndSellersUseTax","ConsumerUseAndSalesTax","Fee","VATInputTax","LightBulbs","Meals","VATNonrecoverableInputTax","VATOutputTax","PIF","Rental","SalesTax","UseTax","EWaste","Batteries"]`), &res); err != nil {
		panic(err)
	}
	for _, v := range res {
		filingRequestDataModelTypeTaxTypeIDPropEnum = append(filingRequestDataModelTypeTaxTypeIDPropEnum, v)
	}
}

const (

	// FilingRequestDataModelTaxTypeIDE captures enum value "E"
	FilingRequestDataModelTaxTypeIDE string = "E"

	// FilingRequestDataModelTaxTypeIDLodging captures enum value "Lodging"
	FilingRequestDataModelTaxTypeIDLodging string = "Lodging"

	// FilingRequestDataModelTaxTypeIDBottle captures enum value "Bottle"
	FilingRequestDataModelTaxTypeIDBottle string = "Bottle"

	// FilingRequestDataModelTaxTypeIDRentToOwn captures enum value "RentToOwn"
	FilingRequestDataModelTaxTypeIDRentToOwn string = "RentToOwn"

	// FilingRequestDataModelTaxTypeIDBikeTax captures enum value "BikeTax"
	FilingRequestDataModelTaxTypeIDBikeTax string = "BikeTax"

	// FilingRequestDataModelTaxTypeIDLandedCost captures enum value "LandedCost"
	FilingRequestDataModelTaxTypeIDLandedCost string = "LandedCost"

	// FilingRequestDataModelTaxTypeIDCheckoutBag captures enum value "CheckoutBag"
	FilingRequestDataModelTaxTypeIDCheckoutBag string = "CheckoutBag"

	// FilingRequestDataModelTaxTypeIDAlcohol captures enum value "Alcohol"
	FilingRequestDataModelTaxTypeIDAlcohol string = "Alcohol"

	// FilingRequestDataModelTaxTypeIDAmusement captures enum value "Amusement"
	FilingRequestDataModelTaxTypeIDAmusement string = "Amusement"

	// FilingRequestDataModelTaxTypeIDHospitality captures enum value "Hospitality"
	FilingRequestDataModelTaxTypeIDHospitality string = "Hospitality"

	// FilingRequestDataModelTaxTypeIDRentalLeasing captures enum value "RentalLeasing"
	FilingRequestDataModelTaxTypeIDRentalLeasing string = "RentalLeasing"

	// FilingRequestDataModelTaxTypeIDGrossReceipts captures enum value "GrossReceipts"
	FilingRequestDataModelTaxTypeIDGrossReceipts string = "GrossReceipts"

	// FilingRequestDataModelTaxTypeIDMattress captures enum value "Mattress"
	FilingRequestDataModelTaxTypeIDMattress string = "Mattress"

	// FilingRequestDataModelTaxTypeIDLumber captures enum value "Lumber"
	FilingRequestDataModelTaxTypeIDLumber string = "Lumber"

	// FilingRequestDataModelTaxTypeIDPaint captures enum value "Paint"
	FilingRequestDataModelTaxTypeIDPaint string = "Paint"

	// FilingRequestDataModelTaxTypeIDTires captures enum value "Tires"
	FilingRequestDataModelTaxTypeIDTires string = "Tires"

	// FilingRequestDataModelTaxTypeIDEI captures enum value "EI"
	FilingRequestDataModelTaxTypeIDEI string = "EI"

	// FilingRequestDataModelTaxTypeIDAll captures enum value "All"
	FilingRequestDataModelTaxTypeIDAll string = "All"

	// FilingRequestDataModelTaxTypeIDBothSalesAndUseTax captures enum value "BothSalesAndUseTax"
	FilingRequestDataModelTaxTypeIDBothSalesAndUseTax string = "BothSalesAndUseTax"

	// FilingRequestDataModelTaxTypeIDConsumerUseTax captures enum value "ConsumerUseTax"
	FilingRequestDataModelTaxTypeIDConsumerUseTax string = "ConsumerUseTax"

	// FilingRequestDataModelTaxTypeIDConsumersUseAndSellersUseTax captures enum value "ConsumersUseAndSellersUseTax"
	FilingRequestDataModelTaxTypeIDConsumersUseAndSellersUseTax string = "ConsumersUseAndSellersUseTax"

	// FilingRequestDataModelTaxTypeIDConsumerUseAndSalesTax captures enum value "ConsumerUseAndSalesTax"
	FilingRequestDataModelTaxTypeIDConsumerUseAndSalesTax string = "ConsumerUseAndSalesTax"

	// FilingRequestDataModelTaxTypeIDFee captures enum value "Fee"
	FilingRequestDataModelTaxTypeIDFee string = "Fee"

	// FilingRequestDataModelTaxTypeIDVATInputTax captures enum value "VATInputTax"
	FilingRequestDataModelTaxTypeIDVATInputTax string = "VATInputTax"

	// FilingRequestDataModelTaxTypeIDLightBulbs captures enum value "LightBulbs"
	FilingRequestDataModelTaxTypeIDLightBulbs string = "LightBulbs"

	// FilingRequestDataModelTaxTypeIDMeals captures enum value "Meals"
	FilingRequestDataModelTaxTypeIDMeals string = "Meals"

	// FilingRequestDataModelTaxTypeIDVATNonrecoverableInputTax captures enum value "VATNonrecoverableInputTax"
	FilingRequestDataModelTaxTypeIDVATNonrecoverableInputTax string = "VATNonrecoverableInputTax"

	// FilingRequestDataModelTaxTypeIDVATOutputTax captures enum value "VATOutputTax"
	FilingRequestDataModelTaxTypeIDVATOutputTax string = "VATOutputTax"

	// FilingRequestDataModelTaxTypeIDPIF captures enum value "PIF"
	FilingRequestDataModelTaxTypeIDPIF string = "PIF"

	// FilingRequestDataModelTaxTypeIDRental captures enum value "Rental"
	FilingRequestDataModelTaxTypeIDRental string = "Rental"

	// FilingRequestDataModelTaxTypeIDSalesTax captures enum value "SalesTax"
	FilingRequestDataModelTaxTypeIDSalesTax string = "SalesTax"

	// FilingRequestDataModelTaxTypeIDUseTax captures enum value "UseTax"
	FilingRequestDataModelTaxTypeIDUseTax string = "UseTax"

	// FilingRequestDataModelTaxTypeIDEWaste captures enum value "EWaste"
	FilingRequestDataModelTaxTypeIDEWaste string = "EWaste"

	// FilingRequestDataModelTaxTypeIDBatteries captures enum value "Batteries"
	FilingRequestDataModelTaxTypeIDBatteries string = "Batteries"
)

// prop value enum
func (m *FilingRequestDataModel) validateTaxTypeIDEnum(path, location string, value string) error {
	if err := validate.EnumCase(path, location, value, filingRequestDataModelTypeTaxTypeIDPropEnum, true); err != nil {
		return err
	}
	return nil
}

func (m *FilingRequestDataModel) validateTaxTypeID(formats strfmt.Registry) error {
	if swag.IsZero(m.TaxTypeID) { // not required
		return nil
	}

	// value enum
	if err := m.validateTaxTypeIDEnum("taxTypeId", "body", m.TaxTypeID); err != nil {
		return err
	}

	return nil
}

// ContextValidate validate this filing request data model based on the context it is used
func (m *FilingRequestDataModel) ContextValidate(ctx context.Context, formats strfmt.Registry) error {
	var res []error

	if err := m.contextValidateAnswers(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateCountry(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateRegion(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateTaxAuthorityID(ctx, formats); err != nil {
		res = append(res, err)
	}

	if err := m.contextValidateTaxAuthorityName(ctx, formats); err != nil {
		res = append(res, err)
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}

func (m *FilingRequestDataModel) contextValidateAnswers(ctx context.Context, formats strfmt.Registry) error {

	for i := 0; i < len(m.Answers); i++ {

		if m.Answers[i] != nil {
			if err := m.Answers[i].ContextValidate(ctx, formats); err != nil {
				if ve, ok := err.(*errors.Validation); ok {
					return ve.ValidateName("answers" + "." + strconv.Itoa(i))
				} else if ce, ok := err.(*errors.CompositeError); ok {
					return ce.ValidateName("answers" + "." + strconv.Itoa(i))
				}
				return err
			}
		}

	}

	return nil
}

func (m *FilingRequestDataModel) contextValidateCountry(ctx context.Context, formats strfmt.Registry) error {

	if err := validate.ReadOnly(ctx, "country", "body", string(m.Country)); err != nil {
		return err
	}

	return nil
}

func (m *FilingRequestDataModel) contextValidateRegion(ctx context.Context, formats strfmt.Registry) error {

	if err := validate.ReadOnly(ctx, "region", "body", string(m.Region)); err != nil {
		return err
	}

	return nil
}

func (m *FilingRequestDataModel) contextValidateTaxAuthorityID(ctx context.Context, formats strfmt.Registry) error {

	if err := validate.ReadOnly(ctx, "taxAuthorityId", "body", int32(m.TaxAuthorityID)); err != nil {
		return err
	}

	return nil
}

func (m *FilingRequestDataModel) contextValidateTaxAuthorityName(ctx context.Context, formats strfmt.Registry) error {

	if err := validate.ReadOnly(ctx, "taxAuthorityName", "body", string(m.TaxAuthorityName)); err != nil {
		return err
	}

	return nil
}

// MarshalBinary interface implementation
func (m *FilingRequestDataModel) MarshalBinary() ([]byte, error) {
	if m == nil {
		return nil, nil
	}
	return swag.WriteJSON(m)
}

// UnmarshalBinary interface implementation
func (m *FilingRequestDataModel) UnmarshalBinary(b []byte) error {
	var res FilingRequestDataModel
	if err := swag.ReadJSON(b, &res); err != nil {
		return err
	}
	*m = res
	return nil
}