Documentation
¶
Index ¶
- type CancelBatchBadRequest
- type CancelBatchNotFound
- type CancelBatchOK
- type CancelBatchParams
- func (o *CancelBatchParams) SetCompanyID(companyID int32)
- func (o *CancelBatchParams) SetContext(ctx context.Context)
- func (o *CancelBatchParams) SetDefaults()
- func (o *CancelBatchParams) SetHTTPClient(client *http.Client)
- func (o *CancelBatchParams) SetID(id int32)
- func (o *CancelBatchParams) SetTimeout(timeout time.Duration)
- func (o *CancelBatchParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *CancelBatchParams) WithCompanyID(companyID int32) *CancelBatchParams
- func (o *CancelBatchParams) WithContext(ctx context.Context) *CancelBatchParams
- func (o *CancelBatchParams) WithDefaults() *CancelBatchParams
- func (o *CancelBatchParams) WithHTTPClient(client *http.Client) *CancelBatchParams
- func (o *CancelBatchParams) WithID(id int32) *CancelBatchParams
- func (o *CancelBatchParams) WithTimeout(timeout time.Duration) *CancelBatchParams
- func (o *CancelBatchParams) WithXAvalaraClient(xAvalaraClient *string) *CancelBatchParams
- func (o *CancelBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CancelBatchReader
- type CancelBatchUnauthorized
- type Client
- func (a *Client) CancelBatch(params *CancelBatchParams, authInfo runtime.ClientAuthInfoWriter, ...) (*CancelBatchOK, error)
- func (a *Client) CreateBatches(params *CreateBatchesParams, authInfo runtime.ClientAuthInfoWriter, ...) (*CreateBatchesOK, error)
- func (a *Client) CreateTransactionBatch(params *CreateTransactionBatchParams, authInfo runtime.ClientAuthInfoWriter, ...) (*CreateTransactionBatchOK, error)
- func (a *Client) DeleteBatch(params *DeleteBatchParams, authInfo runtime.ClientAuthInfoWriter, ...) (*DeleteBatchOK, error)
- func (a *Client) DownloadBatch(params *DownloadBatchParams, authInfo runtime.ClientAuthInfoWriter, ...) (*DownloadBatchOK, error)
- func (a *Client) GetBatch(params *GetBatchParams, authInfo runtime.ClientAuthInfoWriter, ...) (*GetBatchOK, error)
- func (a *Client) ListBatchesByCompany(params *ListBatchesByCompanyParams, authInfo runtime.ClientAuthInfoWriter, ...) (*ListBatchesByCompanyOK, error)
- func (a *Client) QueryBatches(params *QueryBatchesParams, authInfo runtime.ClientAuthInfoWriter, ...) (*QueryBatchesOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientOption
- type ClientService
- type CreateBatchesBadRequest
- type CreateBatchesNotFound
- type CreateBatchesOK
- type CreateBatchesParams
- func (o *CreateBatchesParams) SetBody(body []*models.BatchModel)
- func (o *CreateBatchesParams) SetCompanyID(companyID int32)
- func (o *CreateBatchesParams) SetContext(ctx context.Context)
- func (o *CreateBatchesParams) SetDefaults()
- func (o *CreateBatchesParams) SetHTTPClient(client *http.Client)
- func (o *CreateBatchesParams) SetTimeout(timeout time.Duration)
- func (o *CreateBatchesParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *CreateBatchesParams) WithBody(body []*models.BatchModel) *CreateBatchesParams
- func (o *CreateBatchesParams) WithCompanyID(companyID int32) *CreateBatchesParams
- func (o *CreateBatchesParams) WithContext(ctx context.Context) *CreateBatchesParams
- func (o *CreateBatchesParams) WithDefaults() *CreateBatchesParams
- func (o *CreateBatchesParams) WithHTTPClient(client *http.Client) *CreateBatchesParams
- func (o *CreateBatchesParams) WithTimeout(timeout time.Duration) *CreateBatchesParams
- func (o *CreateBatchesParams) WithXAvalaraClient(xAvalaraClient *string) *CreateBatchesParams
- func (o *CreateBatchesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CreateBatchesReader
- type CreateBatchesUnauthorized
- type CreateTransactionBatchBadRequest
- type CreateTransactionBatchNotFound
- type CreateTransactionBatchOK
- type CreateTransactionBatchParams
- func NewCreateTransactionBatchParams() *CreateTransactionBatchParams
- func NewCreateTransactionBatchParamsWithContext(ctx context.Context) *CreateTransactionBatchParams
- func NewCreateTransactionBatchParamsWithHTTPClient(client *http.Client) *CreateTransactionBatchParams
- func NewCreateTransactionBatchParamsWithTimeout(timeout time.Duration) *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) SetBody(body *models.CreateTransactionBatchRequestModel)
- func (o *CreateTransactionBatchParams) SetCompanyID(companyID int32)
- func (o *CreateTransactionBatchParams) SetContext(ctx context.Context)
- func (o *CreateTransactionBatchParams) SetDefaults()
- func (o *CreateTransactionBatchParams) SetHTTPClient(client *http.Client)
- func (o *CreateTransactionBatchParams) SetTimeout(timeout time.Duration)
- func (o *CreateTransactionBatchParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *CreateTransactionBatchParams) WithBody(body *models.CreateTransactionBatchRequestModel) *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) WithCompanyID(companyID int32) *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) WithContext(ctx context.Context) *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) WithDefaults() *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) WithHTTPClient(client *http.Client) *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) WithTimeout(timeout time.Duration) *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) WithXAvalaraClient(xAvalaraClient *string) *CreateTransactionBatchParams
- func (o *CreateTransactionBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CreateTransactionBatchReader
- type CreateTransactionBatchUnauthorized
- type DeleteBatchBadRequest
- type DeleteBatchNotFound
- type DeleteBatchOK
- type DeleteBatchParams
- func (o *DeleteBatchParams) SetCompanyID(companyID int32)
- func (o *DeleteBatchParams) SetContext(ctx context.Context)
- func (o *DeleteBatchParams) SetDefaults()
- func (o *DeleteBatchParams) SetHTTPClient(client *http.Client)
- func (o *DeleteBatchParams) SetID(id int32)
- func (o *DeleteBatchParams) SetTimeout(timeout time.Duration)
- func (o *DeleteBatchParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *DeleteBatchParams) WithCompanyID(companyID int32) *DeleteBatchParams
- func (o *DeleteBatchParams) WithContext(ctx context.Context) *DeleteBatchParams
- func (o *DeleteBatchParams) WithDefaults() *DeleteBatchParams
- func (o *DeleteBatchParams) WithHTTPClient(client *http.Client) *DeleteBatchParams
- func (o *DeleteBatchParams) WithID(id int32) *DeleteBatchParams
- func (o *DeleteBatchParams) WithTimeout(timeout time.Duration) *DeleteBatchParams
- func (o *DeleteBatchParams) WithXAvalaraClient(xAvalaraClient *string) *DeleteBatchParams
- func (o *DeleteBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type DeleteBatchReader
- type DeleteBatchUnauthorized
- type DownloadBatchBadRequest
- type DownloadBatchNotFound
- type DownloadBatchOK
- type DownloadBatchParams
- func (o *DownloadBatchParams) SetBatchID(batchID int32)
- func (o *DownloadBatchParams) SetCompanyID(companyID int32)
- func (o *DownloadBatchParams) SetContext(ctx context.Context)
- func (o *DownloadBatchParams) SetDefaults()
- func (o *DownloadBatchParams) SetHTTPClient(client *http.Client)
- func (o *DownloadBatchParams) SetID(id int32)
- func (o *DownloadBatchParams) SetTimeout(timeout time.Duration)
- func (o *DownloadBatchParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *DownloadBatchParams) WithBatchID(batchID int32) *DownloadBatchParams
- func (o *DownloadBatchParams) WithCompanyID(companyID int32) *DownloadBatchParams
- func (o *DownloadBatchParams) WithContext(ctx context.Context) *DownloadBatchParams
- func (o *DownloadBatchParams) WithDefaults() *DownloadBatchParams
- func (o *DownloadBatchParams) WithHTTPClient(client *http.Client) *DownloadBatchParams
- func (o *DownloadBatchParams) WithID(id int32) *DownloadBatchParams
- func (o *DownloadBatchParams) WithTimeout(timeout time.Duration) *DownloadBatchParams
- func (o *DownloadBatchParams) WithXAvalaraClient(xAvalaraClient *string) *DownloadBatchParams
- func (o *DownloadBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type DownloadBatchReader
- type DownloadBatchUnauthorized
- type GetBatchBadRequest
- type GetBatchNotFound
- type GetBatchOK
- type GetBatchParams
- func (o *GetBatchParams) SetCompanyID(companyID int32)
- func (o *GetBatchParams) SetContext(ctx context.Context)
- func (o *GetBatchParams) SetDefaults()
- func (o *GetBatchParams) SetHTTPClient(client *http.Client)
- func (o *GetBatchParams) SetID(id int32)
- func (o *GetBatchParams) SetTimeout(timeout time.Duration)
- func (o *GetBatchParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *GetBatchParams) WithCompanyID(companyID int32) *GetBatchParams
- func (o *GetBatchParams) WithContext(ctx context.Context) *GetBatchParams
- func (o *GetBatchParams) WithDefaults() *GetBatchParams
- func (o *GetBatchParams) WithHTTPClient(client *http.Client) *GetBatchParams
- func (o *GetBatchParams) WithID(id int32) *GetBatchParams
- func (o *GetBatchParams) WithTimeout(timeout time.Duration) *GetBatchParams
- func (o *GetBatchParams) WithXAvalaraClient(xAvalaraClient *string) *GetBatchParams
- func (o *GetBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetBatchReader
- type GetBatchUnauthorized
- type ListBatchesByCompanyBadRequest
- type ListBatchesByCompanyNotFound
- type ListBatchesByCompanyOK
- type ListBatchesByCompanyParams
- func NewListBatchesByCompanyParams() *ListBatchesByCompanyParams
- func NewListBatchesByCompanyParamsWithContext(ctx context.Context) *ListBatchesByCompanyParams
- func NewListBatchesByCompanyParamsWithHTTPClient(client *http.Client) *ListBatchesByCompanyParams
- func NewListBatchesByCompanyParamsWithTimeout(timeout time.Duration) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) SetCompanyID(companyID int32)
- func (o *ListBatchesByCompanyParams) SetContext(ctx context.Context)
- func (o *ListBatchesByCompanyParams) SetDefaults()
- func (o *ListBatchesByCompanyParams) SetDollarFilter(dollarFilter *string)
- func (o *ListBatchesByCompanyParams) SetDollarInclude(dollarInclude *string)
- func (o *ListBatchesByCompanyParams) SetDollarOrderBy(dollarOrderBy *string)
- func (o *ListBatchesByCompanyParams) SetDollarSkip(dollarSkip *int32)
- func (o *ListBatchesByCompanyParams) SetDollarTop(dollarTop *int32)
- func (o *ListBatchesByCompanyParams) SetHTTPClient(client *http.Client)
- func (o *ListBatchesByCompanyParams) SetTimeout(timeout time.Duration)
- func (o *ListBatchesByCompanyParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *ListBatchesByCompanyParams) WithCompanyID(companyID int32) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithContext(ctx context.Context) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithDefaults() *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithDollarFilter(dollarFilter *string) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithDollarInclude(dollarInclude *string) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithDollarOrderBy(dollarOrderBy *string) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithDollarSkip(dollarSkip *int32) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithDollarTop(dollarTop *int32) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithHTTPClient(client *http.Client) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithTimeout(timeout time.Duration) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WithXAvalaraClient(xAvalaraClient *string) *ListBatchesByCompanyParams
- func (o *ListBatchesByCompanyParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type ListBatchesByCompanyReader
- type ListBatchesByCompanyUnauthorized
- type QueryBatchesBadRequest
- type QueryBatchesOK
- type QueryBatchesParams
- func (o *QueryBatchesParams) SetContext(ctx context.Context)
- func (o *QueryBatchesParams) SetDefaults()
- func (o *QueryBatchesParams) SetDollarFilter(dollarFilter *string)
- func (o *QueryBatchesParams) SetDollarInclude(dollarInclude *string)
- func (o *QueryBatchesParams) SetDollarOrderBy(dollarOrderBy *string)
- func (o *QueryBatchesParams) SetDollarSkip(dollarSkip *int32)
- func (o *QueryBatchesParams) SetDollarTop(dollarTop *int32)
- func (o *QueryBatchesParams) SetHTTPClient(client *http.Client)
- func (o *QueryBatchesParams) SetTimeout(timeout time.Duration)
- func (o *QueryBatchesParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *QueryBatchesParams) WithContext(ctx context.Context) *QueryBatchesParams
- func (o *QueryBatchesParams) WithDefaults() *QueryBatchesParams
- func (o *QueryBatchesParams) WithDollarFilter(dollarFilter *string) *QueryBatchesParams
- func (o *QueryBatchesParams) WithDollarInclude(dollarInclude *string) *QueryBatchesParams
- func (o *QueryBatchesParams) WithDollarOrderBy(dollarOrderBy *string) *QueryBatchesParams
- func (o *QueryBatchesParams) WithDollarSkip(dollarSkip *int32) *QueryBatchesParams
- func (o *QueryBatchesParams) WithDollarTop(dollarTop *int32) *QueryBatchesParams
- func (o *QueryBatchesParams) WithHTTPClient(client *http.Client) *QueryBatchesParams
- func (o *QueryBatchesParams) WithTimeout(timeout time.Duration) *QueryBatchesParams
- func (o *QueryBatchesParams) WithXAvalaraClient(xAvalaraClient *string) *QueryBatchesParams
- func (o *QueryBatchesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type QueryBatchesReader
- type QueryBatchesUnauthorized
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CancelBatchBadRequest ¶
type CancelBatchBadRequest struct { }
CancelBatchBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewCancelBatchBadRequest ¶
func NewCancelBatchBadRequest() *CancelBatchBadRequest
NewCancelBatchBadRequest creates a CancelBatchBadRequest with default headers values
func (*CancelBatchBadRequest) Error ¶
func (o *CancelBatchBadRequest) Error() string
type CancelBatchNotFound ¶
type CancelBatchNotFound struct { }
CancelBatchNotFound describes a response with status code 404, with default header values.
Not Found
func NewCancelBatchNotFound ¶
func NewCancelBatchNotFound() *CancelBatchNotFound
NewCancelBatchNotFound creates a CancelBatchNotFound with default headers values
func (*CancelBatchNotFound) Error ¶
func (o *CancelBatchNotFound) Error() string
type CancelBatchOK ¶
type CancelBatchOK struct {
Payload *models.BatchModel
}
CancelBatchOK describes a response with status code 200, with default header values.
Success
func NewCancelBatchOK ¶
func NewCancelBatchOK() *CancelBatchOK
NewCancelBatchOK creates a CancelBatchOK with default headers values
func (*CancelBatchOK) Error ¶
func (o *CancelBatchOK) Error() string
func (*CancelBatchOK) GetPayload ¶
func (o *CancelBatchOK) GetPayload() *models.BatchModel
type CancelBatchParams ¶
type CancelBatchParams struct { /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* CompanyID. The ID of the company that owns this batch. Format: int32 */ CompanyID int32 /* ID. The ID of the batch to cancel. Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
CancelBatchParams contains all the parameters to send to the API endpoint
for the cancel batch operation. Typically these are written to a http.Request.
func NewCancelBatchParams ¶
func NewCancelBatchParams() *CancelBatchParams
NewCancelBatchParams creates a new CancelBatchParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewCancelBatchParamsWithContext ¶
func NewCancelBatchParamsWithContext(ctx context.Context) *CancelBatchParams
NewCancelBatchParamsWithContext creates a new CancelBatchParams object with the ability to set a context for a request.
func NewCancelBatchParamsWithHTTPClient ¶
func NewCancelBatchParamsWithHTTPClient(client *http.Client) *CancelBatchParams
NewCancelBatchParamsWithHTTPClient creates a new CancelBatchParams object with the ability to set a custom HTTPClient for a request.
func NewCancelBatchParamsWithTimeout ¶
func NewCancelBatchParamsWithTimeout(timeout time.Duration) *CancelBatchParams
NewCancelBatchParamsWithTimeout creates a new CancelBatchParams object with the ability to set a timeout on a request.
func (*CancelBatchParams) SetCompanyID ¶
func (o *CancelBatchParams) SetCompanyID(companyID int32)
SetCompanyID adds the companyId to the cancel batch params
func (*CancelBatchParams) SetContext ¶
func (o *CancelBatchParams) SetContext(ctx context.Context)
SetContext adds the context to the cancel batch params
func (*CancelBatchParams) SetDefaults ¶
func (o *CancelBatchParams) SetDefaults()
SetDefaults hydrates default values in the cancel batch params (not the query body).
All values with no default are reset to their zero value.
func (*CancelBatchParams) SetHTTPClient ¶
func (o *CancelBatchParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the cancel batch params
func (*CancelBatchParams) SetID ¶
func (o *CancelBatchParams) SetID(id int32)
SetID adds the id to the cancel batch params
func (*CancelBatchParams) SetTimeout ¶
func (o *CancelBatchParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the cancel batch params
func (*CancelBatchParams) SetXAvalaraClient ¶
func (o *CancelBatchParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the cancel batch params
func (*CancelBatchParams) WithCompanyID ¶
func (o *CancelBatchParams) WithCompanyID(companyID int32) *CancelBatchParams
WithCompanyID adds the companyID to the cancel batch params
func (*CancelBatchParams) WithContext ¶
func (o *CancelBatchParams) WithContext(ctx context.Context) *CancelBatchParams
WithContext adds the context to the cancel batch params
func (*CancelBatchParams) WithDefaults ¶
func (o *CancelBatchParams) WithDefaults() *CancelBatchParams
WithDefaults hydrates default values in the cancel batch params (not the query body).
All values with no default are reset to their zero value.
func (*CancelBatchParams) WithHTTPClient ¶
func (o *CancelBatchParams) WithHTTPClient(client *http.Client) *CancelBatchParams
WithHTTPClient adds the HTTPClient to the cancel batch params
func (*CancelBatchParams) WithID ¶
func (o *CancelBatchParams) WithID(id int32) *CancelBatchParams
WithID adds the id to the cancel batch params
func (*CancelBatchParams) WithTimeout ¶
func (o *CancelBatchParams) WithTimeout(timeout time.Duration) *CancelBatchParams
WithTimeout adds the timeout to the cancel batch params
func (*CancelBatchParams) WithXAvalaraClient ¶
func (o *CancelBatchParams) WithXAvalaraClient(xAvalaraClient *string) *CancelBatchParams
WithXAvalaraClient adds the xAvalaraClient to the cancel batch params
func (*CancelBatchParams) WriteToRequest ¶
func (o *CancelBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CancelBatchReader ¶
type CancelBatchReader struct {
// contains filtered or unexported fields
}
CancelBatchReader is a Reader for the CancelBatch structure.
func (*CancelBatchReader) ReadResponse ¶
func (o *CancelBatchReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type CancelBatchUnauthorized ¶
type CancelBatchUnauthorized struct { }
CancelBatchUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewCancelBatchUnauthorized ¶
func NewCancelBatchUnauthorized() *CancelBatchUnauthorized
NewCancelBatchUnauthorized creates a CancelBatchUnauthorized with default headers values
func (*CancelBatchUnauthorized) Error ¶
func (o *CancelBatchUnauthorized) Error() string
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for batches API
func (*Client) CancelBatch ¶
func (a *Client) CancelBatch(params *CancelBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CancelBatchOK, error)
CancelBatch cancels an in progress batch Marks the in progress batch identified by this URL as cancelled.
Only JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message.
Only in progress batches can be cancelled. If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive an error message. Cancelling an in progress batch does not delete any transactions that were created before the cancellation.
Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
func (*Client) CreateBatches ¶
func (a *Client) CreateBatches(params *CreateBatchesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateBatchesOK, error)
CreateBatches creates a new batch Create one or more new batch objects attached to this company.
Each batch object may have one or more file objects (currently only one file is supported).
When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation.
Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
The maximum content length of the request body is limited to 28.6 MB. If this limit is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if the API is called from a browser). In this situation, please split the request into smaller batches.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
func (*Client) CreateTransactionBatch ¶
func (a *Client) CreateTransactionBatch(params *CreateTransactionBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateTransactionBatchOK, error)
CreateTransactionBatch creates a new transaction batch Create a new transaction batch objects attached to this company.
When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation.
Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
The maximum content length of the request body is limited to 28.6 MB. If this limit is exceeded, a 404 Not Found status will be returned (possibly with a CORS error if the API is called from a browser). In this situation, please split the request into smaller batches.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
func (*Client) DeleteBatch ¶
func (a *Client) DeleteBatch(params *DeleteBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteBatchOK, error)
DeleteBatch deletes a single batch Marks the batch identified by this URL as deleted.
If you attempt to delete a batch that is being processed, you will receive an error message. Deleting a batch does not delete any transactions that were created by importing the batch.
Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
### Security Policies
* This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
func (*Client) DownloadBatch ¶
func (a *Client) DownloadBatch(params *DownloadBatchParams, authInfo runtime.ClientAuthInfoWriter, writer io.Writer, opts ...ClientOption) (*DownloadBatchOK, error)
DownloadBatch downloads a single batch file Download a single batch file identified by this URL.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
func (*Client) GetBatch ¶
func (a *Client) GetBatch(params *GetBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBatchOK, error)
GetBatch retrieves a single batch Get the batch object identified by this URL. A batch object is a large
collection of API calls stored in a compact file.
Use this endpoint to retrieve the results or check the status of a batch.
When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation.
Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
func (*Client) ListBatchesByCompany ¶
func (a *Client) ListBatchesByCompany(params *ListBatchesByCompanyParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListBatchesByCompanyOK, error)
ListBatchesByCompany retrieves all batches for this company List all batch objects attached to the specified company.
A batch object is a large collection of API calls stored in a compact file.
Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
Use [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/) to retrieve the results, or check the status, of an individual batch.
When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation.
Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
func (*Client) QueryBatches ¶
func (a *Client) QueryBatches(params *QueryBatchesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*QueryBatchesOK, error)
QueryBatches retrieves all batches Get multiple batch objects across all companies.
A batch object is a large collection of API calls stored in a compact file.
Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . Paginate results using the `$top`, `$skip`, and `$orderby` parameters.
When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. To check the status of a batch, fetch the batch and retrieve the results of the batch operation.
Because the batch system processes with a degree of concurrency, and because of batch sizes in the queue vary, AvaTax API is unable to accurately predict when a batch will complete. If high performance processing is required, please use the [CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientOption ¶
type ClientOption func(*runtime.ClientOperation)
ClientOption is the option for Client methods
type ClientService ¶
type ClientService interface { CancelBatch(params *CancelBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CancelBatchOK, error) CreateBatches(params *CreateBatchesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateBatchesOK, error) CreateTransactionBatch(params *CreateTransactionBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateTransactionBatchOK, error) DeleteBatch(params *DeleteBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteBatchOK, error) DownloadBatch(params *DownloadBatchParams, authInfo runtime.ClientAuthInfoWriter, writer io.Writer, opts ...ClientOption) (*DownloadBatchOK, error) GetBatch(params *GetBatchParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetBatchOK, error) ListBatchesByCompany(params *ListBatchesByCompanyParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListBatchesByCompanyOK, error) QueryBatches(params *QueryBatchesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*QueryBatchesOK, error) SetTransport(transport runtime.ClientTransport) }
ClientService is the interface for Client methods
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
New creates a new batches API client.
type CreateBatchesBadRequest ¶
type CreateBatchesBadRequest struct { }
CreateBatchesBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewCreateBatchesBadRequest ¶
func NewCreateBatchesBadRequest() *CreateBatchesBadRequest
NewCreateBatchesBadRequest creates a CreateBatchesBadRequest with default headers values
func (*CreateBatchesBadRequest) Error ¶
func (o *CreateBatchesBadRequest) Error() string
type CreateBatchesNotFound ¶
type CreateBatchesNotFound struct { }
CreateBatchesNotFound describes a response with status code 404, with default header values.
Not Found
func NewCreateBatchesNotFound ¶
func NewCreateBatchesNotFound() *CreateBatchesNotFound
NewCreateBatchesNotFound creates a CreateBatchesNotFound with default headers values
func (*CreateBatchesNotFound) Error ¶
func (o *CreateBatchesNotFound) Error() string
type CreateBatchesOK ¶
type CreateBatchesOK struct {
Payload []*models.BatchModel
}
CreateBatchesOK describes a response with status code 200, with default header values.
Success
func NewCreateBatchesOK ¶
func NewCreateBatchesOK() *CreateBatchesOK
NewCreateBatchesOK creates a CreateBatchesOK with default headers values
func (*CreateBatchesOK) Error ¶
func (o *CreateBatchesOK) Error() string
func (*CreateBatchesOK) GetPayload ¶
func (o *CreateBatchesOK) GetPayload() []*models.BatchModel
type CreateBatchesParams ¶
type CreateBatchesParams struct { /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* Body. The batch you wish to create. */ Body []*models.BatchModel /* CompanyID. The ID of the company that owns this batch. Format: int32 */ CompanyID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
CreateBatchesParams contains all the parameters to send to the API endpoint
for the create batches operation. Typically these are written to a http.Request.
func NewCreateBatchesParams ¶
func NewCreateBatchesParams() *CreateBatchesParams
NewCreateBatchesParams creates a new CreateBatchesParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewCreateBatchesParamsWithContext ¶
func NewCreateBatchesParamsWithContext(ctx context.Context) *CreateBatchesParams
NewCreateBatchesParamsWithContext creates a new CreateBatchesParams object with the ability to set a context for a request.
func NewCreateBatchesParamsWithHTTPClient ¶
func NewCreateBatchesParamsWithHTTPClient(client *http.Client) *CreateBatchesParams
NewCreateBatchesParamsWithHTTPClient creates a new CreateBatchesParams object with the ability to set a custom HTTPClient for a request.
func NewCreateBatchesParamsWithTimeout ¶
func NewCreateBatchesParamsWithTimeout(timeout time.Duration) *CreateBatchesParams
NewCreateBatchesParamsWithTimeout creates a new CreateBatchesParams object with the ability to set a timeout on a request.
func (*CreateBatchesParams) SetBody ¶
func (o *CreateBatchesParams) SetBody(body []*models.BatchModel)
SetBody adds the body to the create batches params
func (*CreateBatchesParams) SetCompanyID ¶
func (o *CreateBatchesParams) SetCompanyID(companyID int32)
SetCompanyID adds the companyId to the create batches params
func (*CreateBatchesParams) SetContext ¶
func (o *CreateBatchesParams) SetContext(ctx context.Context)
SetContext adds the context to the create batches params
func (*CreateBatchesParams) SetDefaults ¶
func (o *CreateBatchesParams) SetDefaults()
SetDefaults hydrates default values in the create batches params (not the query body).
All values with no default are reset to their zero value.
func (*CreateBatchesParams) SetHTTPClient ¶
func (o *CreateBatchesParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the create batches params
func (*CreateBatchesParams) SetTimeout ¶
func (o *CreateBatchesParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the create batches params
func (*CreateBatchesParams) SetXAvalaraClient ¶
func (o *CreateBatchesParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the create batches params
func (*CreateBatchesParams) WithBody ¶
func (o *CreateBatchesParams) WithBody(body []*models.BatchModel) *CreateBatchesParams
WithBody adds the body to the create batches params
func (*CreateBatchesParams) WithCompanyID ¶
func (o *CreateBatchesParams) WithCompanyID(companyID int32) *CreateBatchesParams
WithCompanyID adds the companyID to the create batches params
func (*CreateBatchesParams) WithContext ¶
func (o *CreateBatchesParams) WithContext(ctx context.Context) *CreateBatchesParams
WithContext adds the context to the create batches params
func (*CreateBatchesParams) WithDefaults ¶
func (o *CreateBatchesParams) WithDefaults() *CreateBatchesParams
WithDefaults hydrates default values in the create batches params (not the query body).
All values with no default are reset to their zero value.
func (*CreateBatchesParams) WithHTTPClient ¶
func (o *CreateBatchesParams) WithHTTPClient(client *http.Client) *CreateBatchesParams
WithHTTPClient adds the HTTPClient to the create batches params
func (*CreateBatchesParams) WithTimeout ¶
func (o *CreateBatchesParams) WithTimeout(timeout time.Duration) *CreateBatchesParams
WithTimeout adds the timeout to the create batches params
func (*CreateBatchesParams) WithXAvalaraClient ¶
func (o *CreateBatchesParams) WithXAvalaraClient(xAvalaraClient *string) *CreateBatchesParams
WithXAvalaraClient adds the xAvalaraClient to the create batches params
func (*CreateBatchesParams) WriteToRequest ¶
func (o *CreateBatchesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CreateBatchesReader ¶
type CreateBatchesReader struct {
// contains filtered or unexported fields
}
CreateBatchesReader is a Reader for the CreateBatches structure.
func (*CreateBatchesReader) ReadResponse ¶
func (o *CreateBatchesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type CreateBatchesUnauthorized ¶
type CreateBatchesUnauthorized struct { }
CreateBatchesUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewCreateBatchesUnauthorized ¶
func NewCreateBatchesUnauthorized() *CreateBatchesUnauthorized
NewCreateBatchesUnauthorized creates a CreateBatchesUnauthorized with default headers values
func (*CreateBatchesUnauthorized) Error ¶
func (o *CreateBatchesUnauthorized) Error() string
type CreateTransactionBatchBadRequest ¶
type CreateTransactionBatchBadRequest struct { }
CreateTransactionBatchBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewCreateTransactionBatchBadRequest ¶
func NewCreateTransactionBatchBadRequest() *CreateTransactionBatchBadRequest
NewCreateTransactionBatchBadRequest creates a CreateTransactionBatchBadRequest with default headers values
func (*CreateTransactionBatchBadRequest) Error ¶
func (o *CreateTransactionBatchBadRequest) Error() string
type CreateTransactionBatchNotFound ¶
type CreateTransactionBatchNotFound struct { }
CreateTransactionBatchNotFound describes a response with status code 404, with default header values.
Not Found
func NewCreateTransactionBatchNotFound ¶
func NewCreateTransactionBatchNotFound() *CreateTransactionBatchNotFound
NewCreateTransactionBatchNotFound creates a CreateTransactionBatchNotFound with default headers values
func (*CreateTransactionBatchNotFound) Error ¶
func (o *CreateTransactionBatchNotFound) Error() string
type CreateTransactionBatchOK ¶
type CreateTransactionBatchOK struct {
Payload *models.CreateTransactionBatchResponseModel
}
CreateTransactionBatchOK describes a response with status code 200, with default header values.
Success
func NewCreateTransactionBatchOK ¶
func NewCreateTransactionBatchOK() *CreateTransactionBatchOK
NewCreateTransactionBatchOK creates a CreateTransactionBatchOK with default headers values
func (*CreateTransactionBatchOK) Error ¶
func (o *CreateTransactionBatchOK) Error() string
func (*CreateTransactionBatchOK) GetPayload ¶
func (o *CreateTransactionBatchOK) GetPayload() *models.CreateTransactionBatchResponseModel
type CreateTransactionBatchParams ¶
type CreateTransactionBatchParams struct { /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* Body. The transaction batch you wish to create. */ Body *models.CreateTransactionBatchRequestModel /* CompanyID. The ID of the company that owns this batch. Format: int32 */ CompanyID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
CreateTransactionBatchParams contains all the parameters to send to the API endpoint
for the create transaction batch operation. Typically these are written to a http.Request.
func NewCreateTransactionBatchParams ¶
func NewCreateTransactionBatchParams() *CreateTransactionBatchParams
NewCreateTransactionBatchParams creates a new CreateTransactionBatchParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewCreateTransactionBatchParamsWithContext ¶
func NewCreateTransactionBatchParamsWithContext(ctx context.Context) *CreateTransactionBatchParams
NewCreateTransactionBatchParamsWithContext creates a new CreateTransactionBatchParams object with the ability to set a context for a request.
func NewCreateTransactionBatchParamsWithHTTPClient ¶
func NewCreateTransactionBatchParamsWithHTTPClient(client *http.Client) *CreateTransactionBatchParams
NewCreateTransactionBatchParamsWithHTTPClient creates a new CreateTransactionBatchParams object with the ability to set a custom HTTPClient for a request.
func NewCreateTransactionBatchParamsWithTimeout ¶
func NewCreateTransactionBatchParamsWithTimeout(timeout time.Duration) *CreateTransactionBatchParams
NewCreateTransactionBatchParamsWithTimeout creates a new CreateTransactionBatchParams object with the ability to set a timeout on a request.
func (*CreateTransactionBatchParams) SetBody ¶
func (o *CreateTransactionBatchParams) SetBody(body *models.CreateTransactionBatchRequestModel)
SetBody adds the body to the create transaction batch params
func (*CreateTransactionBatchParams) SetCompanyID ¶
func (o *CreateTransactionBatchParams) SetCompanyID(companyID int32)
SetCompanyID adds the companyId to the create transaction batch params
func (*CreateTransactionBatchParams) SetContext ¶
func (o *CreateTransactionBatchParams) SetContext(ctx context.Context)
SetContext adds the context to the create transaction batch params
func (*CreateTransactionBatchParams) SetDefaults ¶
func (o *CreateTransactionBatchParams) SetDefaults()
SetDefaults hydrates default values in the create transaction batch params (not the query body).
All values with no default are reset to their zero value.
func (*CreateTransactionBatchParams) SetHTTPClient ¶
func (o *CreateTransactionBatchParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the create transaction batch params
func (*CreateTransactionBatchParams) SetTimeout ¶
func (o *CreateTransactionBatchParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the create transaction batch params
func (*CreateTransactionBatchParams) SetXAvalaraClient ¶
func (o *CreateTransactionBatchParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the create transaction batch params
func (*CreateTransactionBatchParams) WithBody ¶
func (o *CreateTransactionBatchParams) WithBody(body *models.CreateTransactionBatchRequestModel) *CreateTransactionBatchParams
WithBody adds the body to the create transaction batch params
func (*CreateTransactionBatchParams) WithCompanyID ¶
func (o *CreateTransactionBatchParams) WithCompanyID(companyID int32) *CreateTransactionBatchParams
WithCompanyID adds the companyID to the create transaction batch params
func (*CreateTransactionBatchParams) WithContext ¶
func (o *CreateTransactionBatchParams) WithContext(ctx context.Context) *CreateTransactionBatchParams
WithContext adds the context to the create transaction batch params
func (*CreateTransactionBatchParams) WithDefaults ¶
func (o *CreateTransactionBatchParams) WithDefaults() *CreateTransactionBatchParams
WithDefaults hydrates default values in the create transaction batch params (not the query body).
All values with no default are reset to their zero value.
func (*CreateTransactionBatchParams) WithHTTPClient ¶
func (o *CreateTransactionBatchParams) WithHTTPClient(client *http.Client) *CreateTransactionBatchParams
WithHTTPClient adds the HTTPClient to the create transaction batch params
func (*CreateTransactionBatchParams) WithTimeout ¶
func (o *CreateTransactionBatchParams) WithTimeout(timeout time.Duration) *CreateTransactionBatchParams
WithTimeout adds the timeout to the create transaction batch params
func (*CreateTransactionBatchParams) WithXAvalaraClient ¶
func (o *CreateTransactionBatchParams) WithXAvalaraClient(xAvalaraClient *string) *CreateTransactionBatchParams
WithXAvalaraClient adds the xAvalaraClient to the create transaction batch params
func (*CreateTransactionBatchParams) WriteToRequest ¶
func (o *CreateTransactionBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CreateTransactionBatchReader ¶
type CreateTransactionBatchReader struct {
// contains filtered or unexported fields
}
CreateTransactionBatchReader is a Reader for the CreateTransactionBatch structure.
func (*CreateTransactionBatchReader) ReadResponse ¶
func (o *CreateTransactionBatchReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type CreateTransactionBatchUnauthorized ¶
type CreateTransactionBatchUnauthorized struct { }
CreateTransactionBatchUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewCreateTransactionBatchUnauthorized ¶
func NewCreateTransactionBatchUnauthorized() *CreateTransactionBatchUnauthorized
NewCreateTransactionBatchUnauthorized creates a CreateTransactionBatchUnauthorized with default headers values
func (*CreateTransactionBatchUnauthorized) Error ¶
func (o *CreateTransactionBatchUnauthorized) Error() string
type DeleteBatchBadRequest ¶
type DeleteBatchBadRequest struct { }
DeleteBatchBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewDeleteBatchBadRequest ¶
func NewDeleteBatchBadRequest() *DeleteBatchBadRequest
NewDeleteBatchBadRequest creates a DeleteBatchBadRequest with default headers values
func (*DeleteBatchBadRequest) Error ¶
func (o *DeleteBatchBadRequest) Error() string
type DeleteBatchNotFound ¶
type DeleteBatchNotFound struct { }
DeleteBatchNotFound describes a response with status code 404, with default header values.
Not Found
func NewDeleteBatchNotFound ¶
func NewDeleteBatchNotFound() *DeleteBatchNotFound
NewDeleteBatchNotFound creates a DeleteBatchNotFound with default headers values
func (*DeleteBatchNotFound) Error ¶
func (o *DeleteBatchNotFound) Error() string
type DeleteBatchOK ¶
type DeleteBatchOK struct {
Payload []*models.ErrorDetail
}
DeleteBatchOK describes a response with status code 200, with default header values.
Success
func NewDeleteBatchOK ¶
func NewDeleteBatchOK() *DeleteBatchOK
NewDeleteBatchOK creates a DeleteBatchOK with default headers values
func (*DeleteBatchOK) Error ¶
func (o *DeleteBatchOK) Error() string
func (*DeleteBatchOK) GetPayload ¶
func (o *DeleteBatchOK) GetPayload() []*models.ErrorDetail
type DeleteBatchParams ¶
type DeleteBatchParams struct { /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* CompanyID. The ID of the company that owns this batch. Format: int32 */ CompanyID int32 /* ID. The ID of the batch to delete. Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
DeleteBatchParams contains all the parameters to send to the API endpoint
for the delete batch operation. Typically these are written to a http.Request.
func NewDeleteBatchParams ¶
func NewDeleteBatchParams() *DeleteBatchParams
NewDeleteBatchParams creates a new DeleteBatchParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewDeleteBatchParamsWithContext ¶
func NewDeleteBatchParamsWithContext(ctx context.Context) *DeleteBatchParams
NewDeleteBatchParamsWithContext creates a new DeleteBatchParams object with the ability to set a context for a request.
func NewDeleteBatchParamsWithHTTPClient ¶
func NewDeleteBatchParamsWithHTTPClient(client *http.Client) *DeleteBatchParams
NewDeleteBatchParamsWithHTTPClient creates a new DeleteBatchParams object with the ability to set a custom HTTPClient for a request.
func NewDeleteBatchParamsWithTimeout ¶
func NewDeleteBatchParamsWithTimeout(timeout time.Duration) *DeleteBatchParams
NewDeleteBatchParamsWithTimeout creates a new DeleteBatchParams object with the ability to set a timeout on a request.
func (*DeleteBatchParams) SetCompanyID ¶
func (o *DeleteBatchParams) SetCompanyID(companyID int32)
SetCompanyID adds the companyId to the delete batch params
func (*DeleteBatchParams) SetContext ¶
func (o *DeleteBatchParams) SetContext(ctx context.Context)
SetContext adds the context to the delete batch params
func (*DeleteBatchParams) SetDefaults ¶
func (o *DeleteBatchParams) SetDefaults()
SetDefaults hydrates default values in the delete batch params (not the query body).
All values with no default are reset to their zero value.
func (*DeleteBatchParams) SetHTTPClient ¶
func (o *DeleteBatchParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the delete batch params
func (*DeleteBatchParams) SetID ¶
func (o *DeleteBatchParams) SetID(id int32)
SetID adds the id to the delete batch params
func (*DeleteBatchParams) SetTimeout ¶
func (o *DeleteBatchParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the delete batch params
func (*DeleteBatchParams) SetXAvalaraClient ¶
func (o *DeleteBatchParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the delete batch params
func (*DeleteBatchParams) WithCompanyID ¶
func (o *DeleteBatchParams) WithCompanyID(companyID int32) *DeleteBatchParams
WithCompanyID adds the companyID to the delete batch params
func (*DeleteBatchParams) WithContext ¶
func (o *DeleteBatchParams) WithContext(ctx context.Context) *DeleteBatchParams
WithContext adds the context to the delete batch params
func (*DeleteBatchParams) WithDefaults ¶
func (o *DeleteBatchParams) WithDefaults() *DeleteBatchParams
WithDefaults hydrates default values in the delete batch params (not the query body).
All values with no default are reset to their zero value.
func (*DeleteBatchParams) WithHTTPClient ¶
func (o *DeleteBatchParams) WithHTTPClient(client *http.Client) *DeleteBatchParams
WithHTTPClient adds the HTTPClient to the delete batch params
func (*DeleteBatchParams) WithID ¶
func (o *DeleteBatchParams) WithID(id int32) *DeleteBatchParams
WithID adds the id to the delete batch params
func (*DeleteBatchParams) WithTimeout ¶
func (o *DeleteBatchParams) WithTimeout(timeout time.Duration) *DeleteBatchParams
WithTimeout adds the timeout to the delete batch params
func (*DeleteBatchParams) WithXAvalaraClient ¶
func (o *DeleteBatchParams) WithXAvalaraClient(xAvalaraClient *string) *DeleteBatchParams
WithXAvalaraClient adds the xAvalaraClient to the delete batch params
func (*DeleteBatchParams) WriteToRequest ¶
func (o *DeleteBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type DeleteBatchReader ¶
type DeleteBatchReader struct {
// contains filtered or unexported fields
}
DeleteBatchReader is a Reader for the DeleteBatch structure.
func (*DeleteBatchReader) ReadResponse ¶
func (o *DeleteBatchReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type DeleteBatchUnauthorized ¶
type DeleteBatchUnauthorized struct { }
DeleteBatchUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewDeleteBatchUnauthorized ¶
func NewDeleteBatchUnauthorized() *DeleteBatchUnauthorized
NewDeleteBatchUnauthorized creates a DeleteBatchUnauthorized with default headers values
func (*DeleteBatchUnauthorized) Error ¶
func (o *DeleteBatchUnauthorized) Error() string
type DownloadBatchBadRequest ¶
type DownloadBatchBadRequest struct { }
DownloadBatchBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewDownloadBatchBadRequest ¶
func NewDownloadBatchBadRequest() *DownloadBatchBadRequest
NewDownloadBatchBadRequest creates a DownloadBatchBadRequest with default headers values
func (*DownloadBatchBadRequest) Error ¶
func (o *DownloadBatchBadRequest) Error() string
type DownloadBatchNotFound ¶
type DownloadBatchNotFound struct { }
DownloadBatchNotFound describes a response with status code 404, with default header values.
Not Found
func NewDownloadBatchNotFound ¶
func NewDownloadBatchNotFound() *DownloadBatchNotFound
NewDownloadBatchNotFound creates a DownloadBatchNotFound with default headers values
func (*DownloadBatchNotFound) Error ¶
func (o *DownloadBatchNotFound) Error() string
type DownloadBatchOK ¶
DownloadBatchOK describes a response with status code 200, with default header values.
OK
func NewDownloadBatchOK ¶
func NewDownloadBatchOK(writer io.Writer) *DownloadBatchOK
NewDownloadBatchOK creates a DownloadBatchOK with default headers values
func (*DownloadBatchOK) Error ¶
func (o *DownloadBatchOK) Error() string
func (*DownloadBatchOK) GetPayload ¶
func (o *DownloadBatchOK) GetPayload() io.Writer
type DownloadBatchParams ¶
type DownloadBatchParams struct { /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* BatchID. The ID of the batch object Format: int32 */ BatchID int32 /* CompanyID. The ID of the company that owns this batch Format: int32 */ CompanyID int32 /* ID. The primary key of this batch file object Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
DownloadBatchParams contains all the parameters to send to the API endpoint
for the download batch operation. Typically these are written to a http.Request.
func NewDownloadBatchParams ¶
func NewDownloadBatchParams() *DownloadBatchParams
NewDownloadBatchParams creates a new DownloadBatchParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewDownloadBatchParamsWithContext ¶
func NewDownloadBatchParamsWithContext(ctx context.Context) *DownloadBatchParams
NewDownloadBatchParamsWithContext creates a new DownloadBatchParams object with the ability to set a context for a request.
func NewDownloadBatchParamsWithHTTPClient ¶
func NewDownloadBatchParamsWithHTTPClient(client *http.Client) *DownloadBatchParams
NewDownloadBatchParamsWithHTTPClient creates a new DownloadBatchParams object with the ability to set a custom HTTPClient for a request.
func NewDownloadBatchParamsWithTimeout ¶
func NewDownloadBatchParamsWithTimeout(timeout time.Duration) *DownloadBatchParams
NewDownloadBatchParamsWithTimeout creates a new DownloadBatchParams object with the ability to set a timeout on a request.
func (*DownloadBatchParams) SetBatchID ¶
func (o *DownloadBatchParams) SetBatchID(batchID int32)
SetBatchID adds the batchId to the download batch params
func (*DownloadBatchParams) SetCompanyID ¶
func (o *DownloadBatchParams) SetCompanyID(companyID int32)
SetCompanyID adds the companyId to the download batch params
func (*DownloadBatchParams) SetContext ¶
func (o *DownloadBatchParams) SetContext(ctx context.Context)
SetContext adds the context to the download batch params
func (*DownloadBatchParams) SetDefaults ¶
func (o *DownloadBatchParams) SetDefaults()
SetDefaults hydrates default values in the download batch params (not the query body).
All values with no default are reset to their zero value.
func (*DownloadBatchParams) SetHTTPClient ¶
func (o *DownloadBatchParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the download batch params
func (*DownloadBatchParams) SetID ¶
func (o *DownloadBatchParams) SetID(id int32)
SetID adds the id to the download batch params
func (*DownloadBatchParams) SetTimeout ¶
func (o *DownloadBatchParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the download batch params
func (*DownloadBatchParams) SetXAvalaraClient ¶
func (o *DownloadBatchParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the download batch params
func (*DownloadBatchParams) WithBatchID ¶
func (o *DownloadBatchParams) WithBatchID(batchID int32) *DownloadBatchParams
WithBatchID adds the batchID to the download batch params
func (*DownloadBatchParams) WithCompanyID ¶
func (o *DownloadBatchParams) WithCompanyID(companyID int32) *DownloadBatchParams
WithCompanyID adds the companyID to the download batch params
func (*DownloadBatchParams) WithContext ¶
func (o *DownloadBatchParams) WithContext(ctx context.Context) *DownloadBatchParams
WithContext adds the context to the download batch params
func (*DownloadBatchParams) WithDefaults ¶
func (o *DownloadBatchParams) WithDefaults() *DownloadBatchParams
WithDefaults hydrates default values in the download batch params (not the query body).
All values with no default are reset to their zero value.
func (*DownloadBatchParams) WithHTTPClient ¶
func (o *DownloadBatchParams) WithHTTPClient(client *http.Client) *DownloadBatchParams
WithHTTPClient adds the HTTPClient to the download batch params
func (*DownloadBatchParams) WithID ¶
func (o *DownloadBatchParams) WithID(id int32) *DownloadBatchParams
WithID adds the id to the download batch params
func (*DownloadBatchParams) WithTimeout ¶
func (o *DownloadBatchParams) WithTimeout(timeout time.Duration) *DownloadBatchParams
WithTimeout adds the timeout to the download batch params
func (*DownloadBatchParams) WithXAvalaraClient ¶
func (o *DownloadBatchParams) WithXAvalaraClient(xAvalaraClient *string) *DownloadBatchParams
WithXAvalaraClient adds the xAvalaraClient to the download batch params
func (*DownloadBatchParams) WriteToRequest ¶
func (o *DownloadBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type DownloadBatchReader ¶
type DownloadBatchReader struct {
// contains filtered or unexported fields
}
DownloadBatchReader is a Reader for the DownloadBatch structure.
func (*DownloadBatchReader) ReadResponse ¶
func (o *DownloadBatchReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type DownloadBatchUnauthorized ¶
type DownloadBatchUnauthorized struct { }
DownloadBatchUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewDownloadBatchUnauthorized ¶
func NewDownloadBatchUnauthorized() *DownloadBatchUnauthorized
NewDownloadBatchUnauthorized creates a DownloadBatchUnauthorized with default headers values
func (*DownloadBatchUnauthorized) Error ¶
func (o *DownloadBatchUnauthorized) Error() string
type GetBatchBadRequest ¶
type GetBatchBadRequest struct { }
GetBatchBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewGetBatchBadRequest ¶
func NewGetBatchBadRequest() *GetBatchBadRequest
NewGetBatchBadRequest creates a GetBatchBadRequest with default headers values
func (*GetBatchBadRequest) Error ¶
func (o *GetBatchBadRequest) Error() string
type GetBatchNotFound ¶
type GetBatchNotFound struct { }
GetBatchNotFound describes a response with status code 404, with default header values.
Not Found
func NewGetBatchNotFound ¶
func NewGetBatchNotFound() *GetBatchNotFound
NewGetBatchNotFound creates a GetBatchNotFound with default headers values
func (*GetBatchNotFound) Error ¶
func (o *GetBatchNotFound) Error() string
type GetBatchOK ¶
type GetBatchOK struct {
Payload *models.BatchModel
}
GetBatchOK describes a response with status code 200, with default header values.
Success
func NewGetBatchOK ¶
func NewGetBatchOK() *GetBatchOK
NewGetBatchOK creates a GetBatchOK with default headers values
func (*GetBatchOK) Error ¶
func (o *GetBatchOK) Error() string
func (*GetBatchOK) GetPayload ¶
func (o *GetBatchOK) GetPayload() *models.BatchModel
type GetBatchParams ¶
type GetBatchParams struct { /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* CompanyID. The ID of the company that owns this batch Format: int32 */ CompanyID int32 /* ID. The primary key of this batch Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetBatchParams contains all the parameters to send to the API endpoint
for the get batch operation. Typically these are written to a http.Request.
func NewGetBatchParams ¶
func NewGetBatchParams() *GetBatchParams
NewGetBatchParams creates a new GetBatchParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewGetBatchParamsWithContext ¶
func NewGetBatchParamsWithContext(ctx context.Context) *GetBatchParams
NewGetBatchParamsWithContext creates a new GetBatchParams object with the ability to set a context for a request.
func NewGetBatchParamsWithHTTPClient ¶
func NewGetBatchParamsWithHTTPClient(client *http.Client) *GetBatchParams
NewGetBatchParamsWithHTTPClient creates a new GetBatchParams object with the ability to set a custom HTTPClient for a request.
func NewGetBatchParamsWithTimeout ¶
func NewGetBatchParamsWithTimeout(timeout time.Duration) *GetBatchParams
NewGetBatchParamsWithTimeout creates a new GetBatchParams object with the ability to set a timeout on a request.
func (*GetBatchParams) SetCompanyID ¶
func (o *GetBatchParams) SetCompanyID(companyID int32)
SetCompanyID adds the companyId to the get batch params
func (*GetBatchParams) SetContext ¶
func (o *GetBatchParams) SetContext(ctx context.Context)
SetContext adds the context to the get batch params
func (*GetBatchParams) SetDefaults ¶
func (o *GetBatchParams) SetDefaults()
SetDefaults hydrates default values in the get batch params (not the query body).
All values with no default are reset to their zero value.
func (*GetBatchParams) SetHTTPClient ¶
func (o *GetBatchParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get batch params
func (*GetBatchParams) SetID ¶
func (o *GetBatchParams) SetID(id int32)
SetID adds the id to the get batch params
func (*GetBatchParams) SetTimeout ¶
func (o *GetBatchParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get batch params
func (*GetBatchParams) SetXAvalaraClient ¶
func (o *GetBatchParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the get batch params
func (*GetBatchParams) WithCompanyID ¶
func (o *GetBatchParams) WithCompanyID(companyID int32) *GetBatchParams
WithCompanyID adds the companyID to the get batch params
func (*GetBatchParams) WithContext ¶
func (o *GetBatchParams) WithContext(ctx context.Context) *GetBatchParams
WithContext adds the context to the get batch params
func (*GetBatchParams) WithDefaults ¶
func (o *GetBatchParams) WithDefaults() *GetBatchParams
WithDefaults hydrates default values in the get batch params (not the query body).
All values with no default are reset to their zero value.
func (*GetBatchParams) WithHTTPClient ¶
func (o *GetBatchParams) WithHTTPClient(client *http.Client) *GetBatchParams
WithHTTPClient adds the HTTPClient to the get batch params
func (*GetBatchParams) WithID ¶
func (o *GetBatchParams) WithID(id int32) *GetBatchParams
WithID adds the id to the get batch params
func (*GetBatchParams) WithTimeout ¶
func (o *GetBatchParams) WithTimeout(timeout time.Duration) *GetBatchParams
WithTimeout adds the timeout to the get batch params
func (*GetBatchParams) WithXAvalaraClient ¶
func (o *GetBatchParams) WithXAvalaraClient(xAvalaraClient *string) *GetBatchParams
WithXAvalaraClient adds the xAvalaraClient to the get batch params
func (*GetBatchParams) WriteToRequest ¶
func (o *GetBatchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetBatchReader ¶
type GetBatchReader struct {
// contains filtered or unexported fields
}
GetBatchReader is a Reader for the GetBatch structure.
func (*GetBatchReader) ReadResponse ¶
func (o *GetBatchReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetBatchUnauthorized ¶
type GetBatchUnauthorized struct { }
GetBatchUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewGetBatchUnauthorized ¶
func NewGetBatchUnauthorized() *GetBatchUnauthorized
NewGetBatchUnauthorized creates a GetBatchUnauthorized with default headers values
func (*GetBatchUnauthorized) Error ¶
func (o *GetBatchUnauthorized) Error() string
type ListBatchesByCompanyBadRequest ¶
type ListBatchesByCompanyBadRequest struct { }
ListBatchesByCompanyBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewListBatchesByCompanyBadRequest ¶
func NewListBatchesByCompanyBadRequest() *ListBatchesByCompanyBadRequest
NewListBatchesByCompanyBadRequest creates a ListBatchesByCompanyBadRequest with default headers values
func (*ListBatchesByCompanyBadRequest) Error ¶
func (o *ListBatchesByCompanyBadRequest) Error() string
type ListBatchesByCompanyNotFound ¶
type ListBatchesByCompanyNotFound struct { }
ListBatchesByCompanyNotFound describes a response with status code 404, with default header values.
Not Found
func NewListBatchesByCompanyNotFound ¶
func NewListBatchesByCompanyNotFound() *ListBatchesByCompanyNotFound
NewListBatchesByCompanyNotFound creates a ListBatchesByCompanyNotFound with default headers values
func (*ListBatchesByCompanyNotFound) Error ¶
func (o *ListBatchesByCompanyNotFound) Error() string
type ListBatchesByCompanyOK ¶
type ListBatchesByCompanyOK struct {
Payload *models.BatchModelFetchResult
}
ListBatchesByCompanyOK describes a response with status code 200, with default header values.
Success
func NewListBatchesByCompanyOK ¶
func NewListBatchesByCompanyOK() *ListBatchesByCompanyOK
NewListBatchesByCompanyOK creates a ListBatchesByCompanyOK with default headers values
func (*ListBatchesByCompanyOK) Error ¶
func (o *ListBatchesByCompanyOK) Error() string
func (*ListBatchesByCompanyOK) GetPayload ¶
func (o *ListBatchesByCompanyOK) GetPayload() *models.BatchModelFetchResult
type ListBatchesByCompanyParams ¶
type ListBatchesByCompanyParams struct { /* DollarFilter. A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* files */ DollarFilter *string /* DollarInclude. A comma separated list of additional data to retrieve. */ DollarInclude *string /* DollarOrderBy. A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. */ DollarOrderBy *string /* DollarSkip. If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. Format: int32 */ DollarSkip *int32 /* DollarTop. If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. Format: int32 */ DollarTop *int32 /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* CompanyID. The ID of the company that owns these batches Format: int32 */ CompanyID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
ListBatchesByCompanyParams contains all the parameters to send to the API endpoint
for the list batches by company operation. Typically these are written to a http.Request.
func NewListBatchesByCompanyParams ¶
func NewListBatchesByCompanyParams() *ListBatchesByCompanyParams
NewListBatchesByCompanyParams creates a new ListBatchesByCompanyParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewListBatchesByCompanyParamsWithContext ¶
func NewListBatchesByCompanyParamsWithContext(ctx context.Context) *ListBatchesByCompanyParams
NewListBatchesByCompanyParamsWithContext creates a new ListBatchesByCompanyParams object with the ability to set a context for a request.
func NewListBatchesByCompanyParamsWithHTTPClient ¶
func NewListBatchesByCompanyParamsWithHTTPClient(client *http.Client) *ListBatchesByCompanyParams
NewListBatchesByCompanyParamsWithHTTPClient creates a new ListBatchesByCompanyParams object with the ability to set a custom HTTPClient for a request.
func NewListBatchesByCompanyParamsWithTimeout ¶
func NewListBatchesByCompanyParamsWithTimeout(timeout time.Duration) *ListBatchesByCompanyParams
NewListBatchesByCompanyParamsWithTimeout creates a new ListBatchesByCompanyParams object with the ability to set a timeout on a request.
func (*ListBatchesByCompanyParams) SetCompanyID ¶
func (o *ListBatchesByCompanyParams) SetCompanyID(companyID int32)
SetCompanyID adds the companyId to the list batches by company params
func (*ListBatchesByCompanyParams) SetContext ¶
func (o *ListBatchesByCompanyParams) SetContext(ctx context.Context)
SetContext adds the context to the list batches by company params
func (*ListBatchesByCompanyParams) SetDefaults ¶
func (o *ListBatchesByCompanyParams) SetDefaults()
SetDefaults hydrates default values in the list batches by company params (not the query body).
All values with no default are reset to their zero value.
func (*ListBatchesByCompanyParams) SetDollarFilter ¶
func (o *ListBatchesByCompanyParams) SetDollarFilter(dollarFilter *string)
SetDollarFilter adds the dollarFilter to the list batches by company params
func (*ListBatchesByCompanyParams) SetDollarInclude ¶
func (o *ListBatchesByCompanyParams) SetDollarInclude(dollarInclude *string)
SetDollarInclude adds the dollarInclude to the list batches by company params
func (*ListBatchesByCompanyParams) SetDollarOrderBy ¶
func (o *ListBatchesByCompanyParams) SetDollarOrderBy(dollarOrderBy *string)
SetDollarOrderBy adds the dollarOrderBy to the list batches by company params
func (*ListBatchesByCompanyParams) SetDollarSkip ¶
func (o *ListBatchesByCompanyParams) SetDollarSkip(dollarSkip *int32)
SetDollarSkip adds the dollarSkip to the list batches by company params
func (*ListBatchesByCompanyParams) SetDollarTop ¶
func (o *ListBatchesByCompanyParams) SetDollarTop(dollarTop *int32)
SetDollarTop adds the dollarTop to the list batches by company params
func (*ListBatchesByCompanyParams) SetHTTPClient ¶
func (o *ListBatchesByCompanyParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the list batches by company params
func (*ListBatchesByCompanyParams) SetTimeout ¶
func (o *ListBatchesByCompanyParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the list batches by company params
func (*ListBatchesByCompanyParams) SetXAvalaraClient ¶
func (o *ListBatchesByCompanyParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the list batches by company params
func (*ListBatchesByCompanyParams) WithCompanyID ¶
func (o *ListBatchesByCompanyParams) WithCompanyID(companyID int32) *ListBatchesByCompanyParams
WithCompanyID adds the companyID to the list batches by company params
func (*ListBatchesByCompanyParams) WithContext ¶
func (o *ListBatchesByCompanyParams) WithContext(ctx context.Context) *ListBatchesByCompanyParams
WithContext adds the context to the list batches by company params
func (*ListBatchesByCompanyParams) WithDefaults ¶
func (o *ListBatchesByCompanyParams) WithDefaults() *ListBatchesByCompanyParams
WithDefaults hydrates default values in the list batches by company params (not the query body).
All values with no default are reset to their zero value.
func (*ListBatchesByCompanyParams) WithDollarFilter ¶
func (o *ListBatchesByCompanyParams) WithDollarFilter(dollarFilter *string) *ListBatchesByCompanyParams
WithDollarFilter adds the dollarFilter to the list batches by company params
func (*ListBatchesByCompanyParams) WithDollarInclude ¶
func (o *ListBatchesByCompanyParams) WithDollarInclude(dollarInclude *string) *ListBatchesByCompanyParams
WithDollarInclude adds the dollarInclude to the list batches by company params
func (*ListBatchesByCompanyParams) WithDollarOrderBy ¶
func (o *ListBatchesByCompanyParams) WithDollarOrderBy(dollarOrderBy *string) *ListBatchesByCompanyParams
WithDollarOrderBy adds the dollarOrderBy to the list batches by company params
func (*ListBatchesByCompanyParams) WithDollarSkip ¶
func (o *ListBatchesByCompanyParams) WithDollarSkip(dollarSkip *int32) *ListBatchesByCompanyParams
WithDollarSkip adds the dollarSkip to the list batches by company params
func (*ListBatchesByCompanyParams) WithDollarTop ¶
func (o *ListBatchesByCompanyParams) WithDollarTop(dollarTop *int32) *ListBatchesByCompanyParams
WithDollarTop adds the dollarTop to the list batches by company params
func (*ListBatchesByCompanyParams) WithHTTPClient ¶
func (o *ListBatchesByCompanyParams) WithHTTPClient(client *http.Client) *ListBatchesByCompanyParams
WithHTTPClient adds the HTTPClient to the list batches by company params
func (*ListBatchesByCompanyParams) WithTimeout ¶
func (o *ListBatchesByCompanyParams) WithTimeout(timeout time.Duration) *ListBatchesByCompanyParams
WithTimeout adds the timeout to the list batches by company params
func (*ListBatchesByCompanyParams) WithXAvalaraClient ¶
func (o *ListBatchesByCompanyParams) WithXAvalaraClient(xAvalaraClient *string) *ListBatchesByCompanyParams
WithXAvalaraClient adds the xAvalaraClient to the list batches by company params
func (*ListBatchesByCompanyParams) WriteToRequest ¶
func (o *ListBatchesByCompanyParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type ListBatchesByCompanyReader ¶
type ListBatchesByCompanyReader struct {
// contains filtered or unexported fields
}
ListBatchesByCompanyReader is a Reader for the ListBatchesByCompany structure.
func (*ListBatchesByCompanyReader) ReadResponse ¶
func (o *ListBatchesByCompanyReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type ListBatchesByCompanyUnauthorized ¶
type ListBatchesByCompanyUnauthorized struct { }
ListBatchesByCompanyUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewListBatchesByCompanyUnauthorized ¶
func NewListBatchesByCompanyUnauthorized() *ListBatchesByCompanyUnauthorized
NewListBatchesByCompanyUnauthorized creates a ListBatchesByCompanyUnauthorized with default headers values
func (*ListBatchesByCompanyUnauthorized) Error ¶
func (o *ListBatchesByCompanyUnauthorized) Error() string
type QueryBatchesBadRequest ¶
type QueryBatchesBadRequest struct { }
QueryBatchesBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewQueryBatchesBadRequest ¶
func NewQueryBatchesBadRequest() *QueryBatchesBadRequest
NewQueryBatchesBadRequest creates a QueryBatchesBadRequest with default headers values
func (*QueryBatchesBadRequest) Error ¶
func (o *QueryBatchesBadRequest) Error() string
type QueryBatchesOK ¶
type QueryBatchesOK struct {
Payload *models.BatchModelFetchResult
}
QueryBatchesOK describes a response with status code 200, with default header values.
Success
func NewQueryBatchesOK ¶
func NewQueryBatchesOK() *QueryBatchesOK
NewQueryBatchesOK creates a QueryBatchesOK with default headers values
func (*QueryBatchesOK) Error ¶
func (o *QueryBatchesOK) Error() string
func (*QueryBatchesOK) GetPayload ¶
func (o *QueryBatchesOK) GetPayload() *models.BatchModelFetchResult
type QueryBatchesParams ¶
type QueryBatchesParams struct { /* DollarFilter. A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* files */ DollarFilter *string /* DollarInclude. A comma separated list of additional data to retrieve. */ DollarInclude *string /* DollarOrderBy. A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. */ DollarOrderBy *string /* DollarSkip. If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. Format: int32 */ DollarSkip *int32 /* DollarTop. If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. Format: int32 */ DollarTop *int32 /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
QueryBatchesParams contains all the parameters to send to the API endpoint
for the query batches operation. Typically these are written to a http.Request.
func NewQueryBatchesParams ¶
func NewQueryBatchesParams() *QueryBatchesParams
NewQueryBatchesParams creates a new QueryBatchesParams object, with the default timeout for this client.
Default values are not hydrated, since defaults are normally applied by the API server side.
To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewQueryBatchesParamsWithContext ¶
func NewQueryBatchesParamsWithContext(ctx context.Context) *QueryBatchesParams
NewQueryBatchesParamsWithContext creates a new QueryBatchesParams object with the ability to set a context for a request.
func NewQueryBatchesParamsWithHTTPClient ¶
func NewQueryBatchesParamsWithHTTPClient(client *http.Client) *QueryBatchesParams
NewQueryBatchesParamsWithHTTPClient creates a new QueryBatchesParams object with the ability to set a custom HTTPClient for a request.
func NewQueryBatchesParamsWithTimeout ¶
func NewQueryBatchesParamsWithTimeout(timeout time.Duration) *QueryBatchesParams
NewQueryBatchesParamsWithTimeout creates a new QueryBatchesParams object with the ability to set a timeout on a request.
func (*QueryBatchesParams) SetContext ¶
func (o *QueryBatchesParams) SetContext(ctx context.Context)
SetContext adds the context to the query batches params
func (*QueryBatchesParams) SetDefaults ¶
func (o *QueryBatchesParams) SetDefaults()
SetDefaults hydrates default values in the query batches params (not the query body).
All values with no default are reset to their zero value.
func (*QueryBatchesParams) SetDollarFilter ¶
func (o *QueryBatchesParams) SetDollarFilter(dollarFilter *string)
SetDollarFilter adds the dollarFilter to the query batches params
func (*QueryBatchesParams) SetDollarInclude ¶
func (o *QueryBatchesParams) SetDollarInclude(dollarInclude *string)
SetDollarInclude adds the dollarInclude to the query batches params
func (*QueryBatchesParams) SetDollarOrderBy ¶
func (o *QueryBatchesParams) SetDollarOrderBy(dollarOrderBy *string)
SetDollarOrderBy adds the dollarOrderBy to the query batches params
func (*QueryBatchesParams) SetDollarSkip ¶
func (o *QueryBatchesParams) SetDollarSkip(dollarSkip *int32)
SetDollarSkip adds the dollarSkip to the query batches params
func (*QueryBatchesParams) SetDollarTop ¶
func (o *QueryBatchesParams) SetDollarTop(dollarTop *int32)
SetDollarTop adds the dollarTop to the query batches params
func (*QueryBatchesParams) SetHTTPClient ¶
func (o *QueryBatchesParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the query batches params
func (*QueryBatchesParams) SetTimeout ¶
func (o *QueryBatchesParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the query batches params
func (*QueryBatchesParams) SetXAvalaraClient ¶
func (o *QueryBatchesParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the query batches params
func (*QueryBatchesParams) WithContext ¶
func (o *QueryBatchesParams) WithContext(ctx context.Context) *QueryBatchesParams
WithContext adds the context to the query batches params
func (*QueryBatchesParams) WithDefaults ¶
func (o *QueryBatchesParams) WithDefaults() *QueryBatchesParams
WithDefaults hydrates default values in the query batches params (not the query body).
All values with no default are reset to their zero value.
func (*QueryBatchesParams) WithDollarFilter ¶
func (o *QueryBatchesParams) WithDollarFilter(dollarFilter *string) *QueryBatchesParams
WithDollarFilter adds the dollarFilter to the query batches params
func (*QueryBatchesParams) WithDollarInclude ¶
func (o *QueryBatchesParams) WithDollarInclude(dollarInclude *string) *QueryBatchesParams
WithDollarInclude adds the dollarInclude to the query batches params
func (*QueryBatchesParams) WithDollarOrderBy ¶
func (o *QueryBatchesParams) WithDollarOrderBy(dollarOrderBy *string) *QueryBatchesParams
WithDollarOrderBy adds the dollarOrderBy to the query batches params
func (*QueryBatchesParams) WithDollarSkip ¶
func (o *QueryBatchesParams) WithDollarSkip(dollarSkip *int32) *QueryBatchesParams
WithDollarSkip adds the dollarSkip to the query batches params
func (*QueryBatchesParams) WithDollarTop ¶
func (o *QueryBatchesParams) WithDollarTop(dollarTop *int32) *QueryBatchesParams
WithDollarTop adds the dollarTop to the query batches params
func (*QueryBatchesParams) WithHTTPClient ¶
func (o *QueryBatchesParams) WithHTTPClient(client *http.Client) *QueryBatchesParams
WithHTTPClient adds the HTTPClient to the query batches params
func (*QueryBatchesParams) WithTimeout ¶
func (o *QueryBatchesParams) WithTimeout(timeout time.Duration) *QueryBatchesParams
WithTimeout adds the timeout to the query batches params
func (*QueryBatchesParams) WithXAvalaraClient ¶
func (o *QueryBatchesParams) WithXAvalaraClient(xAvalaraClient *string) *QueryBatchesParams
WithXAvalaraClient adds the xAvalaraClient to the query batches params
func (*QueryBatchesParams) WriteToRequest ¶
func (o *QueryBatchesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type QueryBatchesReader ¶
type QueryBatchesReader struct {
// contains filtered or unexported fields
}
QueryBatchesReader is a Reader for the QueryBatches structure.
func (*QueryBatchesReader) ReadResponse ¶
func (o *QueryBatchesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type QueryBatchesUnauthorized ¶
type QueryBatchesUnauthorized struct { }
QueryBatchesUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewQueryBatchesUnauthorized ¶
func NewQueryBatchesUnauthorized() *QueryBatchesUnauthorized
NewQueryBatchesUnauthorized creates a QueryBatchesUnauthorized with default headers values
func (*QueryBatchesUnauthorized) Error ¶
func (o *QueryBatchesUnauthorized) Error() string
Source Files
¶
- batches_client.go
- cancel_batch_parameters.go
- cancel_batch_responses.go
- create_batches_parameters.go
- create_batches_responses.go
- create_transaction_batch_parameters.go
- create_transaction_batch_responses.go
- delete_batch_parameters.go
- delete_batch_responses.go
- download_batch_parameters.go
- download_batch_responses.go
- get_batch_parameters.go
- get_batch_responses.go
- list_batches_by_company_parameters.go
- list_batches_by_company_responses.go
- query_batches_parameters.go
- query_batches_responses.go