tax_rate_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"
	"strconv"

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

// TaxRateModel Contains information about the general tangible personal property sales tax rates for this jurisdiction.
//
// This rate is calculated by making assumptions about the tax calculation process.  It does not account for:
//
// * Sourcing rules, such as origin-and-destination based transactions.
// * Product taxability rules, such as different tax rates for different product types.
// * Nexus declarations, where some customers are not obligated to collect tax in specific jurisdictions.
// * Tax thresholds and rate differences by amounts.
// * And many more custom use cases.
//
// To upgrade to a fully-featured and accurate tax process that handles these scenarios correctly, please
// contact Avalara to upgrade to AvaTax!
// Example: {"rates":[{"name":"CALIFORNIA","rate":0.0625,"type":"State"}],"totalRate":0.0625}
//
// swagger:model TaxRateModel
type TaxRateModel struct {

	// The list of individual rate elements for general tangible personal property sold at a retail
	// point of presence in this jurisdiction on this date.
	// Example: [{"name":"CALIFORNIA","rate":0.0625,"type":"State"}]
	Rates []*RateModel `json:"rates"`

	// The total sales tax rate for general tangible personal property sold at a retail point of presence
	// in this jurisdiction on this date.
	// Example: 0.0625
	TotalRate float64 `json:"totalRate,omitempty"`
}

// Validate validates this tax rate model
func (m *TaxRateModel) Validate(formats strfmt.Registry) error {
	var res []error

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

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

func (m *TaxRateModel) validateRates(formats strfmt.Registry) error {
	if swag.IsZero(m.Rates) { // not required
		return nil
	}

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

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

	}

	return nil
}

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

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

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

func (m *TaxRateModel) contextValidateRates(ctx context.Context, formats strfmt.Registry) error {

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

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

	}

	return nil
}

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

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