taxes

type Archived = bool

type AssociationResponse struct {
	// Id The ID of the associated object.
	Id int64 `json:"id,omitempty"`

	// Type The type of association.
	Type string `json:"type,omitempty"`
}

type Associations = []string

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

type ClientInterface interface {
	// GetTaxes request
	GetTaxes(ctx context.Context, params *GetTaxesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTaxWithBody request with any body
	CreateTaxWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTax(ctx context.Context, body CreateTaxJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchTaxesWithBody request with any body
	SearchTaxesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SearchTaxes(ctx context.Context, body SearchTaxesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteTaxById request
	DeleteTaxById(ctx context.Context, taxId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTaxById request
	GetTaxById(ctx context.Context, taxId int64, params *GetTaxByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateTaxWithBody request with any body
	UpdateTaxWithBody(ctx context.Context, taxId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateTax(ctx context.Context, taxId string, body UpdateTaxJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// GetTaxesWithResponse request
	GetTaxesWithResponse(ctx context.Context, params *GetTaxesParams, reqEditors ...RequestEditorFn) (*GetTaxesResponse, error)

	// CreateTaxWithBodyWithResponse request with any body
	CreateTaxWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTaxResponse, error)

	CreateTaxWithResponse(ctx context.Context, body CreateTaxJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTaxResponse, error)

	// SearchTaxesWithBodyWithResponse request with any body
	SearchTaxesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchTaxesResponse, error)

	SearchTaxesWithResponse(ctx context.Context, body SearchTaxesJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchTaxesResponse, error)

	// DeleteTaxByIdWithResponse request
	DeleteTaxByIdWithResponse(ctx context.Context, taxId string, reqEditors ...RequestEditorFn) (*DeleteTaxByIdResponse, error)

	// GetTaxByIdWithResponse request
	GetTaxByIdWithResponse(ctx context.Context, taxId int64, params *GetTaxByIdParams, reqEditors ...RequestEditorFn) (*GetTaxByIdResponse, error)

	// UpdateTaxWithBodyWithResponse request with any body
	UpdateTaxWithBodyWithResponse(ctx context.Context, taxId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateTaxResponse, error)

	UpdateTaxWithResponse(ctx context.Context, taxId string, body UpdateTaxJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateTaxResponse, error)
}

type CreateTaxJSONBody struct {
	// Associations List of associations for the tax.
	Associations *[]struct {
		// To Target object details for the association.
		To *struct {
			// Id Target object ID.
			Id *string `json:"id,omitempty"`
		} `json:"to,omitempty"`
		Types *[]struct {
			// AssociationCategory Category of the association.
			AssociationCategory *CreateTaxJSONBodyAssociationsTypesAssociationCategory `json:"associationCategory,omitempty"`

			// AssociationTypeId ID of the association type.
			AssociationTypeId *int32 `json:"associationTypeId,omitempty"`
		} `json:"types,omitempty"`
	} `json:"associations,omitempty"`

	// ObjectWriteTraceId Trace ID for object write operations.
	ObjectWriteTraceId *string `json:"objectWriteTraceId,omitempty"`

	// Properties Key-value pairs of tax properties.
	Properties map[string]string `json:"properties"`
}

type CreateTaxJSONBodyAssociationsTypesAssociationCategory string

type CreateTaxJSONRequestBody CreateTaxJSONBody

type CreateTaxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *struct {
		// Archived Whether the customer is archived or not.
		Archived bool `json:"archived,omitempty"`

		// ArchivedAt Timestamp when the tax was archived.
		ArchivedAt time.Time `json:"archivedAt,omitempty"`

		// CreatedAt Timestamp when the tax was created.
		CreatedAt time.Time `json:"createdAt,omitempty"`

		// Id Unique ID of the created tax.
		Id string `json:"id,omitempty"`

		// Properties Properties of the created tax.
		Properties map[string]interface{} `json:"properties,omitempty"`

		// PropertiesWithHistory A map of the tax's properties including historical values.
		PropertiesWithHistory map[string][]PropertyHistory `json:"propertiesWithHistory,omitempty"`

		// UpdatedAt Timestamp when the tax was last updated.
		UpdatedAt time.Time `json:"updatedAt,omitempty"`
	}
}

type DeleteTaxByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

type Filter struct {
	// HighValue A high-value filter criterion.
	HighValue string `json:"highValue,omitempty"`

	// Operator defines model for Filter.Operator
	Operator FilterOperator `json:"operator,omitempty"`

	// PropertyName The property name to filter by.
	PropertyName string `json:"propertyName,omitempty"`

	// Value A single value to match for the property.
	Value string `json:"value,omitempty"`

	// Values List of values to match for the property.
	Values []string `json:"values,omitempty"`
}

type FilterGroups struct {
	Filters []Filter `json:"filters,omitempty"`
}

type FilterOperator string

type GetTaxByIdParams struct {
	// IdProperty The property to use as the ID.
	IdProperty *string `form:"idProperty,omitempty" json:"idProperty,omitempty"`

	// Properties Comma-separated list of properties to include in the response.
	// If a specified property is not present, it will be ignored.
	Properties *Properties `form:"properties,omitempty" json:"properties,omitempty"`

	// PropertiesWithHistory Comma-separated list of properties to include with their historical values.
	// Historical data reduces the maximum number of objects returned per request.
	PropertiesWithHistory *PropertiesWithHistory `form:"propertiesWithHistory,omitempty" json:"propertiesWithHistory,omitempty"`

	// Associations Comma-separated list of object types to retrieve associated IDs for.
	// Nonexistent associations will be ignored.
	Associations *Associations `form:"associations,omitempty" json:"associations,omitempty"`

	// Archived Include only archived results.
	Archived *Archived `form:"archived,omitempty" json:"archived,omitempty"`
}

type GetTaxByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TaxResponse
}

type GetTaxesParams struct {
	// Limit Maximum number of results per page.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// After Cursor token for the next page of results.
	After *string `form:"after,omitempty" json:"after,omitempty"`

	// Properties Comma-separated list of properties to include in the response.
	// If a specified property is not present, it will be ignored.
	Properties *Properties `form:"properties,omitempty" json:"properties,omitempty"`

	// PropertiesWithHistory Comma-separated list of properties to include with their historical values.
	// Historical data reduces the maximum number of objects returned per request.
	PropertiesWithHistory *PropertiesWithHistory `form:"propertiesWithHistory,omitempty" json:"propertiesWithHistory,omitempty"`

	// Associations Comma-separated list of object types to retrieve associated IDs for.
	// Nonexistent associations will be ignored.
	Associations *Associations `form:"associations,omitempty" json:"associations,omitempty"`

	// Archived Include only archived results.
	Archived *Archived `form:"archived,omitempty" json:"archived,omitempty"`
}

type GetTaxesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TaxesResponse
}

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type ObjectAssociationsResponse struct {
	Results []AssociationResponse `json:"results,omitempty"`
}

type Paging struct {
	Next PagingNext `json:"next,omitempty"`
}

type PagingNext struct {
	// After The cursor token for the next page of results.
	After string `json:"after,omitempty"`

	// Link The link for the next page of results.
	Link string `json:"link,omitempty"`
}

type Properties = []string

type PropertiesWithHistory = []string

type PropertyHistory struct {
	// SourceId The source ID of the historical property value.
	SourceId string `json:"sourceId,omitempty"`

	// SourceLabel The source label for the historical property.
	SourceLabel string `json:"sourceLabel,omitempty"`

	// SourceType The source type of the historical property value.
	SourceType string `json:"sourceType,omitempty"`

	// Timestamp When the property value was set.
	Timestamp time.Time `json:"timestamp,omitempty"`

	// UpdatedByUserId The user ID who updated the property.
	UpdatedByUserId int `json:"updatedByUserId,omitempty"`

	// Value The historical value of the property.
	Value string `json:"value,omitempty"`
}

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type SearchParams struct {
	After      *int         `json:"after,omitempty"`
	Limit      *int         `json:"limit,omitempty"`
	Properties *[]string    `json:"properties,omitempty"`
	Query      *string      `json:"query,omitempty"`
	Schema     FilterGroups `json:"schema,omitempty"`

	// Sorts Use a sorting rule in the request body to see results in a specific order (ascending or descending). Only one sorting rule can be applied to any search.
	Sorts *[]Sort `json:"sorts,omitempty"`
}

type SearchTaxesJSONBody struct {
	After        *string        `json:"after,omitempty"`
	FilterGroups []FilterGroups `json:"filterGroups,omitempty"`
	Limit        *int           `json:"limit,omitempty"`
	Properties   *[]string      `json:"properties,omitempty"`
	Query        *string        `json:"query,omitempty"`
	Sorts        *[]string      `json:"sorts,omitempty"`
}

type SearchTaxesJSONRequestBody SearchTaxesJSONBody

type SearchTaxesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TaxesResponse
}

type ServerInterface interface {
	// Retrieve a list of taxes
	// (GET /crm/v3/objects/taxes)
	GetTaxes(ctx echo.Context, params GetTaxesParams) error
	// Create a new tax
	// (POST /crm/v3/objects/taxes)
	CreateTax(ctx echo.Context) error
	// Search for taxes by email
	// (POST /crm/v3/objects/taxes/search)
	SearchTaxes(ctx echo.Context) error
	// Delete a tax
	// (DELETE /crm/v3/objects/taxes/{taxId})
	DeleteTaxById(ctx echo.Context, taxId string) error
	// Get Tax Details
	// (GET /crm/v3/objects/taxes/{taxId})
	GetTaxById(ctx echo.Context, taxId int64, params GetTaxByIdParams) error
	// Update a tax
	// (PATCH /crm/v3/objects/taxes/{taxId})
	UpdateTax(ctx echo.Context, taxId string) error
}

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

type Sort struct {
	Direction    *SortDirection `json:"direction,omitempty"`
	PropertyName *string        `json:"propertyName,omitempty"`
}

type SortDirection string

type TaxAssociations struct {
	Contacts ObjectAssociationsResponse `json:"contacts,omitempty"`
	Deals    ObjectAssociationsResponse `json:"deals,omitempty"`
	Tickets  ObjectAssociationsResponse `json:"tickets,omitempty"`
}

type TaxResponse struct {
	// Archived Indicates if the tax is archived.
	Archived     bool            `json:"archived,omitempty"`
	Associations TaxAssociations `json:"associations,omitempty"`

	// CreatedAt When the tax was created.
	CreatedAt time.Time `json:"createdAt,omitempty"`

	// Id Unique identifier for the tax.
	Id string `json:"id,omitempty"`

	// Properties A key-value map of the contact's properties.
	Properties map[string]string `json:"properties,omitempty"`

	// PropertiesWithHistory A map of the contact's properties including historical values.
	PropertiesWithHistory map[string][]PropertyHistory `json:"propertiesWithHistory,omitempty"`

	// UpdatedAt When the tax was last updated.
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
}

type TaxesResponse struct {
	Paging  *Paging       `json:"paging,omitempty"`
	Results []TaxResponse `json:"results,omitempty"`
}

type UpdateTaxJSONBody struct {
	// ObjectWriteTraceId Unique trace ID for the operation.
	ObjectWriteTraceId *string `json:"objectWriteTraceId,omitempty"`

	// Properties Key-value pairs representing the deal properties to update.
	Properties map[string]string `json:"properties"`
}

type UpdateTaxJSONRequestBody UpdateTaxJSONBody

type UpdateTaxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Archived Whether the customer is archived or not.
		Archived bool `json:"archived,omitempty"`

		// ArchivedAt Timestamp when the tax was archived.
		ArchivedAt time.Time `json:"archivedAt,omitempty"`

		// CreatedAt Timestamp when the tax was created.
		CreatedAt time.Time `json:"createdAt,omitempty"`

		// Id Unique ID of the updated tax.
		Id string `json:"id,omitempty"`

		// Properties Properties of the updated tax.
		Properties map[string]interface{} `json:"properties,omitempty"`

		// PropertiesWithHistory A map of the tax's properties including historical values.
		PropertiesWithHistory map[string][]PropertyHistory `json:"propertiesWithHistory,omitempty"`

		// UpdatedAt Timestamp when the tax was last updated.
		UpdatedAt time.Time `json:"updatedAt,omitempty"`
	}
}