reports

package
v0.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 25, 2022 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for reports API

func (*Client) DownloadReport 

func (a *Client) DownloadReport(params *DownloadReportParams, authInfo runtime.ClientAuthInfoWriter, writer io.Writer, opts ...ClientOption) (*DownloadReportOK, error)
DownloadReport downloads a report

This API downloads the file associated with a report.

If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete, use the `GetReport` API.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

* Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.

* We throttle this API. You can only call this API up to 5 times in a minute.

### Security Policies

* This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.

func (*Client) GetReport 

func (a *Client) GetReport(params *GetReportParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetReportOK, error)
GetReport retrieves a single report

Retrieve a single report by its unique ID number.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

* Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.

This API call returns information about any report type.

func (*Client) InitiateExportDocumentLineReport 

func (a *Client) InitiateExportDocumentLineReport(params *InitiateExportDocumentLineReportParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*InitiateExportDocumentLineReportOK, error)
InitiateExportDocumentLineReport initiates an export document line report task

Begins running an `ExportDocumentLine` report task and returns the identity of the report.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

* Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.

The `ExportDocumentLine` report produces information about invoice lines recorded within your account.

To split large reports into multiple smaller partitions, use the numberOfPartitions and partition properties on ExportDocumentLineModel.

Example - split a report into three partitions

* Follow the steps above with numberOfPartitions = 3 and partition = 0 * Follow the steps above with numberOfPartitions = 3 and partition = 1 * Follow the steps above with numberOfPartitions = 3 and partition = 2 * Once all three reports are downloaded merge the files on the client side.

### Security Policies

* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.

func (*Client) ListReports 

func (a *Client) ListReports(params *ListReportsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListReportsOK, error)
ListReports lists all report tasks for account

List all report tasks for your account.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

* Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type. * In the result of the Initiate API, you receive back a report's `id` value. * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.

This API call returns information about all report types across your entire account.

### Security Policies

* This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, 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 {
	DownloadReport(params *DownloadReportParams, authInfo runtime.ClientAuthInfoWriter, writer io.Writer, opts ...ClientOption) (*DownloadReportOK, error)

	GetReport(params *GetReportParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetReportOK, error)

	InitiateExportDocumentLineReport(params *InitiateExportDocumentLineReportParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*InitiateExportDocumentLineReportOK, error)

	ListReports(params *ListReportsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListReportsOK, 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 reports API client.

type DownloadReportBadRequest 

type DownloadReportBadRequest struct {
}
DownloadReportBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewDownloadReportBadRequest 

func NewDownloadReportBadRequest() *DownloadReportBadRequest

NewDownloadReportBadRequest creates a DownloadReportBadRequest with default headers values

func (*DownloadReportBadRequest) Error 

func (o *DownloadReportBadRequest) Error() string

type DownloadReportNotFound 

type DownloadReportNotFound struct {
}
DownloadReportNotFound describes a response with status code 404, with default header values.

Not Found

func NewDownloadReportNotFound 

func NewDownloadReportNotFound() *DownloadReportNotFound

NewDownloadReportNotFound creates a DownloadReportNotFound with default headers values

func (*DownloadReportNotFound) Error 

func (o *DownloadReportNotFound) Error() string

type DownloadReportOK 

type DownloadReportOK struct {
	Payload io.Writer
}
DownloadReportOK describes a response with status code 200, with default header values.

OK

func NewDownloadReportOK 

func NewDownloadReportOK(writer io.Writer) *DownloadReportOK

NewDownloadReportOK creates a DownloadReportOK with default headers values

func (*DownloadReportOK) Error 

func (o *DownloadReportOK) Error() string

func (*DownloadReportOK) GetPayload 

func (o *DownloadReportOK) GetPayload() io.Writer

type DownloadReportParams 

type DownloadReportParams 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

	/* ID.

	   The unique ID number of this report

	   Format: int64
	*/
	ID int64

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DownloadReportParams contains all the parameters to send to the API endpoint 

for the download report operation.

Typically these are written to a http.Request.

func NewDownloadReportParams 

func NewDownloadReportParams() *DownloadReportParams

NewDownloadReportParams creates a new DownloadReportParams 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 NewDownloadReportParamsWithContext 

func NewDownloadReportParamsWithContext(ctx context.Context) *DownloadReportParams

NewDownloadReportParamsWithContext creates a new DownloadReportParams object with the ability to set a context for a request.

func NewDownloadReportParamsWithHTTPClient 

func NewDownloadReportParamsWithHTTPClient(client *http.Client) *DownloadReportParams

NewDownloadReportParamsWithHTTPClient creates a new DownloadReportParams object with the ability to set a custom HTTPClient for a request.

func NewDownloadReportParamsWithTimeout 

func NewDownloadReportParamsWithTimeout(timeout time.Duration) *DownloadReportParams

NewDownloadReportParamsWithTimeout creates a new DownloadReportParams object with the ability to set a timeout on a request.

func (*DownloadReportParams) SetContext 

func (o *DownloadReportParams) SetContext(ctx context.Context)

SetContext adds the context to the download report params

func (*DownloadReportParams) SetDefaults 

func (o *DownloadReportParams) SetDefaults()

SetDefaults hydrates default values in the download report params (not the query body).

All values with no default are reset to their zero value.

func (*DownloadReportParams) SetHTTPClient 

func (o *DownloadReportParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the download report params

func (*DownloadReportParams) SetID 

func (o *DownloadReportParams) SetID(id int64)

SetID adds the id to the download report params

func (*DownloadReportParams) SetTimeout 

func (o *DownloadReportParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the download report params

func (*DownloadReportParams) SetXAvalaraClient 

func (o *DownloadReportParams) SetXAvalaraClient(xAvalaraClient *string)

SetXAvalaraClient adds the xAvalaraClient to the download report params

func (*DownloadReportParams) WithContext 

func (o *DownloadReportParams) WithContext(ctx context.Context) *DownloadReportParams

WithContext adds the context to the download report params

func (*DownloadReportParams) WithDefaults 

func (o *DownloadReportParams) WithDefaults() *DownloadReportParams

WithDefaults hydrates default values in the download report params (not the query body).

All values with no default are reset to their zero value.

func (*DownloadReportParams) WithHTTPClient 

func (o *DownloadReportParams) WithHTTPClient(client *http.Client) *DownloadReportParams

WithHTTPClient adds the HTTPClient to the download report params

func (*DownloadReportParams) WithID 

func (o *DownloadReportParams) WithID(id int64) *DownloadReportParams

WithID adds the id to the download report params

func (*DownloadReportParams) WithTimeout 

func (o *DownloadReportParams) WithTimeout(timeout time.Duration) *DownloadReportParams

WithTimeout adds the timeout to the download report params

func (*DownloadReportParams) WithXAvalaraClient 

func (o *DownloadReportParams) WithXAvalaraClient(xAvalaraClient *string) *DownloadReportParams

WithXAvalaraClient adds the xAvalaraClient to the download report params

func (*DownloadReportParams) WriteToRequest 

func (o *DownloadReportParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DownloadReportReader 

type DownloadReportReader struct {
	// contains filtered or unexported fields
}

DownloadReportReader is a Reader for the DownloadReport structure.

func (*DownloadReportReader) ReadResponse 

func (o *DownloadReportReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DownloadReportUnauthorized 

type DownloadReportUnauthorized struct {
}
DownloadReportUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewDownloadReportUnauthorized 

func NewDownloadReportUnauthorized() *DownloadReportUnauthorized

NewDownloadReportUnauthorized creates a DownloadReportUnauthorized with default headers values

func (*DownloadReportUnauthorized) Error 

func (o *DownloadReportUnauthorized) Error() string

type GetReportBadRequest 

type GetReportBadRequest struct {
}
GetReportBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewGetReportBadRequest 

func NewGetReportBadRequest() *GetReportBadRequest

NewGetReportBadRequest creates a GetReportBadRequest with default headers values

func (*GetReportBadRequest) Error 

func (o *GetReportBadRequest) Error() string

type GetReportNotFound 

type GetReportNotFound struct {
}
GetReportNotFound describes a response with status code 404, with default header values.

Not Found

func NewGetReportNotFound 

func NewGetReportNotFound() *GetReportNotFound

NewGetReportNotFound creates a GetReportNotFound with default headers values

func (*GetReportNotFound) Error 

func (o *GetReportNotFound) Error() string

type GetReportOK 

type GetReportOK struct {
	Payload *models.ReportModel
}
GetReportOK describes a response with status code 200, with default header values.

Success

func NewGetReportOK 

func NewGetReportOK() *GetReportOK

NewGetReportOK creates a GetReportOK with default headers values

func (*GetReportOK) Error 

func (o *GetReportOK) Error() string

func (*GetReportOK) GetPayload 

func (o *GetReportOK) GetPayload() *models.ReportModel

type GetReportParams 

type GetReportParams 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

	/* ID.

	   The unique ID number of the report to retrieve

	   Format: int64
	*/
	ID int64

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetReportParams contains all the parameters to send to the API endpoint 

for the get report operation.

Typically these are written to a http.Request.

func NewGetReportParams 

func NewGetReportParams() *GetReportParams

NewGetReportParams creates a new GetReportParams 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 NewGetReportParamsWithContext 

func NewGetReportParamsWithContext(ctx context.Context) *GetReportParams

NewGetReportParamsWithContext creates a new GetReportParams object with the ability to set a context for a request.

func NewGetReportParamsWithHTTPClient 

func NewGetReportParamsWithHTTPClient(client *http.Client) *GetReportParams

NewGetReportParamsWithHTTPClient creates a new GetReportParams object with the ability to set a custom HTTPClient for a request.

func NewGetReportParamsWithTimeout 

func NewGetReportParamsWithTimeout(timeout time.Duration) *GetReportParams

NewGetReportParamsWithTimeout creates a new GetReportParams object with the ability to set a timeout on a request.

func (*GetReportParams) SetContext 

func (o *GetReportParams) SetContext(ctx context.Context)

SetContext adds the context to the get report params

func (*GetReportParams) SetDefaults 

func (o *GetReportParams) SetDefaults()

SetDefaults hydrates default values in the get report params (not the query body).

All values with no default are reset to their zero value.

func (*GetReportParams) SetHTTPClient 

func (o *GetReportParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get report params

func (*GetReportParams) SetID 

func (o *GetReportParams) SetID(id int64)

SetID adds the id to the get report params

func (*GetReportParams) SetTimeout 

func (o *GetReportParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get report params

func (*GetReportParams) SetXAvalaraClient 

func (o *GetReportParams) SetXAvalaraClient(xAvalaraClient *string)

SetXAvalaraClient adds the xAvalaraClient to the get report params

func (*GetReportParams) WithContext 

func (o *GetReportParams) WithContext(ctx context.Context) *GetReportParams

WithContext adds the context to the get report params

func (*GetReportParams) WithDefaults 

func (o *GetReportParams) WithDefaults() *GetReportParams

WithDefaults hydrates default values in the get report params (not the query body).

All values with no default are reset to their zero value.

func (*GetReportParams) WithHTTPClient 

func (o *GetReportParams) WithHTTPClient(client *http.Client) *GetReportParams

WithHTTPClient adds the HTTPClient to the get report params

func (*GetReportParams) WithID 

func (o *GetReportParams) WithID(id int64) *GetReportParams

WithID adds the id to the get report params

func (*GetReportParams) WithTimeout 

func (o *GetReportParams) WithTimeout(timeout time.Duration) *GetReportParams

WithTimeout adds the timeout to the get report params

func (*GetReportParams) WithXAvalaraClient 

func (o *GetReportParams) WithXAvalaraClient(xAvalaraClient *string) *GetReportParams

WithXAvalaraClient adds the xAvalaraClient to the get report params

func (*GetReportParams) WriteToRequest 

func (o *GetReportParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetReportReader 

type GetReportReader struct {
	// contains filtered or unexported fields
}

GetReportReader is a Reader for the GetReport structure.

func (*GetReportReader) ReadResponse 

func (o *GetReportReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetReportUnauthorized 

type GetReportUnauthorized struct {
}
GetReportUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewGetReportUnauthorized 

func NewGetReportUnauthorized() *GetReportUnauthorized

NewGetReportUnauthorized creates a GetReportUnauthorized with default headers values

func (*GetReportUnauthorized) Error 

func (o *GetReportUnauthorized) Error() string

type InitiateExportDocumentLineReportBadRequest 

type InitiateExportDocumentLineReportBadRequest struct {
}
InitiateExportDocumentLineReportBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewInitiateExportDocumentLineReportBadRequest 

func NewInitiateExportDocumentLineReportBadRequest() *InitiateExportDocumentLineReportBadRequest

NewInitiateExportDocumentLineReportBadRequest creates a InitiateExportDocumentLineReportBadRequest with default headers values

func (*InitiateExportDocumentLineReportBadRequest) Error 

func (o *InitiateExportDocumentLineReportBadRequest) Error() string

type InitiateExportDocumentLineReportNotFound 

type InitiateExportDocumentLineReportNotFound struct {
}
InitiateExportDocumentLineReportNotFound describes a response with status code 404, with default header values.

Not Found

func NewInitiateExportDocumentLineReportNotFound 

func NewInitiateExportDocumentLineReportNotFound() *InitiateExportDocumentLineReportNotFound

NewInitiateExportDocumentLineReportNotFound creates a InitiateExportDocumentLineReportNotFound with default headers values

func (*InitiateExportDocumentLineReportNotFound) Error 

func (o *InitiateExportDocumentLineReportNotFound) Error() string

type InitiateExportDocumentLineReportOK 

type InitiateExportDocumentLineReportOK struct {
	Payload []*models.ReportModel
}
InitiateExportDocumentLineReportOK describes a response with status code 200, with default header values.

Success

func NewInitiateExportDocumentLineReportOK 

func NewInitiateExportDocumentLineReportOK() *InitiateExportDocumentLineReportOK

NewInitiateExportDocumentLineReportOK creates a InitiateExportDocumentLineReportOK with default headers values

func (*InitiateExportDocumentLineReportOK) Error 

func (o *InitiateExportDocumentLineReportOK) Error() string

func (*InitiateExportDocumentLineReportOK) GetPayload 

func (o *InitiateExportDocumentLineReportOK) GetPayload() []*models.ReportModel

type InitiateExportDocumentLineReportParams 

type InitiateExportDocumentLineReportParams 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.

	   Options that may be configured to customize the report.
	*/
	Body *models.ExportDocumentLineModel

	/* CompanyID.

	   The unique ID number of the company to report on.

	   Format: int32
	*/
	CompanyID int32

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InitiateExportDocumentLineReportParams contains all the parameters to send to the API endpoint 

for the initiate export document line report operation.

Typically these are written to a http.Request.

func NewInitiateExportDocumentLineReportParams 

func NewInitiateExportDocumentLineReportParams() *InitiateExportDocumentLineReportParams

NewInitiateExportDocumentLineReportParams creates a new InitiateExportDocumentLineReportParams 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 NewInitiateExportDocumentLineReportParamsWithContext 

func NewInitiateExportDocumentLineReportParamsWithContext(ctx context.Context) *InitiateExportDocumentLineReportParams

NewInitiateExportDocumentLineReportParamsWithContext creates a new InitiateExportDocumentLineReportParams object with the ability to set a context for a request.

func NewInitiateExportDocumentLineReportParamsWithHTTPClient 

func NewInitiateExportDocumentLineReportParamsWithHTTPClient(client *http.Client) *InitiateExportDocumentLineReportParams

NewInitiateExportDocumentLineReportParamsWithHTTPClient creates a new InitiateExportDocumentLineReportParams object with the ability to set a custom HTTPClient for a request.

func NewInitiateExportDocumentLineReportParamsWithTimeout 

func NewInitiateExportDocumentLineReportParamsWithTimeout(timeout time.Duration) *InitiateExportDocumentLineReportParams

NewInitiateExportDocumentLineReportParamsWithTimeout creates a new InitiateExportDocumentLineReportParams object with the ability to set a timeout on a request.

func (*InitiateExportDocumentLineReportParams) SetBody 

func (o *InitiateExportDocumentLineReportParams) SetBody(body *models.ExportDocumentLineModel)

SetBody adds the body to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) SetCompanyID 

func (o *InitiateExportDocumentLineReportParams) SetCompanyID(companyID int32)

SetCompanyID adds the companyId to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) SetContext 

func (o *InitiateExportDocumentLineReportParams) SetContext(ctx context.Context)

SetContext adds the context to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) SetDefaults 

func (o *InitiateExportDocumentLineReportParams) SetDefaults()

SetDefaults hydrates default values in the initiate export document line report params (not the query body).

All values with no default are reset to their zero value.

func (*InitiateExportDocumentLineReportParams) SetHTTPClient 

func (o *InitiateExportDocumentLineReportParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) SetTimeout 

func (o *InitiateExportDocumentLineReportParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) SetXAvalaraClient 

func (o *InitiateExportDocumentLineReportParams) SetXAvalaraClient(xAvalaraClient *string)

SetXAvalaraClient adds the xAvalaraClient to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) WithBody 

func (o *InitiateExportDocumentLineReportParams) WithBody(body *models.ExportDocumentLineModel) *InitiateExportDocumentLineReportParams

WithBody adds the body to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) WithCompanyID 

func (o *InitiateExportDocumentLineReportParams) WithCompanyID(companyID int32) *InitiateExportDocumentLineReportParams

WithCompanyID adds the companyID to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) WithContext 

func (o *InitiateExportDocumentLineReportParams) WithContext(ctx context.Context) *InitiateExportDocumentLineReportParams

WithContext adds the context to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) WithDefaults 

func (o *InitiateExportDocumentLineReportParams) WithDefaults() *InitiateExportDocumentLineReportParams

WithDefaults hydrates default values in the initiate export document line report params (not the query body).

All values with no default are reset to their zero value.

func (*InitiateExportDocumentLineReportParams) WithHTTPClient 

func (o *InitiateExportDocumentLineReportParams) WithHTTPClient(client *http.Client) *InitiateExportDocumentLineReportParams

WithHTTPClient adds the HTTPClient to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) WithTimeout 

func (o *InitiateExportDocumentLineReportParams) WithTimeout(timeout time.Duration) *InitiateExportDocumentLineReportParams

WithTimeout adds the timeout to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) WithXAvalaraClient 

func (o *InitiateExportDocumentLineReportParams) WithXAvalaraClient(xAvalaraClient *string) *InitiateExportDocumentLineReportParams

WithXAvalaraClient adds the xAvalaraClient to the initiate export document line report params

func (*InitiateExportDocumentLineReportParams) WriteToRequest 

func (o *InitiateExportDocumentLineReportParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type InitiateExportDocumentLineReportReader 

type InitiateExportDocumentLineReportReader struct {
	// contains filtered or unexported fields
}

InitiateExportDocumentLineReportReader is a Reader for the InitiateExportDocumentLineReport structure.

func (*InitiateExportDocumentLineReportReader) ReadResponse 

func (o *InitiateExportDocumentLineReportReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type InitiateExportDocumentLineReportUnauthorized 

type InitiateExportDocumentLineReportUnauthorized struct {
}
InitiateExportDocumentLineReportUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewInitiateExportDocumentLineReportUnauthorized 

func NewInitiateExportDocumentLineReportUnauthorized() *InitiateExportDocumentLineReportUnauthorized

NewInitiateExportDocumentLineReportUnauthorized creates a InitiateExportDocumentLineReportUnauthorized with default headers values

func (*InitiateExportDocumentLineReportUnauthorized) Error 

func (o *InitiateExportDocumentLineReportUnauthorized) Error() string

type ListReportsBadRequest 

type ListReportsBadRequest struct {
}
ListReportsBadRequest describes a response with status code 400, with default header values.

Bad Request

func NewListReportsBadRequest 

func NewListReportsBadRequest() *ListReportsBadRequest

NewListReportsBadRequest creates a ListReportsBadRequest with default headers values

func (*ListReportsBadRequest) Error 

func (o *ListReportsBadRequest) Error() string

type ListReportsNotFound 

type ListReportsNotFound struct {
}
ListReportsNotFound describes a response with status code 404, with default header values.

Not Found

func NewListReportsNotFound 

func NewListReportsNotFound() *ListReportsNotFound

NewListReportsNotFound creates a ListReportsNotFound with default headers values

func (*ListReportsNotFound) Error 

func (o *ListReportsNotFound) Error() string

type ListReportsOK 

type ListReportsOK struct {
	Payload *models.ReportModelFetchResult
}
ListReportsOK describes a response with status code 200, with default header values.

Success

func NewListReportsOK 

func NewListReportsOK() *ListReportsOK

NewListReportsOK creates a ListReportsOK with default headers values

func (*ListReportsOK) Error 

func (o *ListReportsOK) Error() string

func (*ListReportsOK) GetPayload 

func (o *ListReportsOK) GetPayload() *models.ReportModelFetchResult

type ListReportsParams 

type ListReportsParams struct {

	/* 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
	   Default: 25
	*/
	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 for which to get reports.

	   Format: int32
	*/
	CompanyID *int32

	/* PageKey.

	   Provide a page key to retrieve the next page of results.
	*/
	PageKey *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListReportsParams contains all the parameters to send to the API endpoint 

for the list reports operation.

Typically these are written to a http.Request.

func NewListReportsParams 

func NewListReportsParams() *ListReportsParams

NewListReportsParams creates a new ListReportsParams 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 NewListReportsParamsWithContext 

func NewListReportsParamsWithContext(ctx context.Context) *ListReportsParams

NewListReportsParamsWithContext creates a new ListReportsParams object with the ability to set a context for a request.

func NewListReportsParamsWithHTTPClient 

func NewListReportsParamsWithHTTPClient(client *http.Client) *ListReportsParams

NewListReportsParamsWithHTTPClient creates a new ListReportsParams object with the ability to set a custom HTTPClient for a request.

func NewListReportsParamsWithTimeout 

func NewListReportsParamsWithTimeout(timeout time.Duration) *ListReportsParams

NewListReportsParamsWithTimeout creates a new ListReportsParams object with the ability to set a timeout on a request.

func (*ListReportsParams) SetCompanyID 

func (o *ListReportsParams) SetCompanyID(companyID *int32)

SetCompanyID adds the companyId to the list reports params

func (*ListReportsParams) SetContext 

func (o *ListReportsParams) SetContext(ctx context.Context)

SetContext adds the context to the list reports params

func (*ListReportsParams) SetDefaults 

func (o *ListReportsParams) SetDefaults()

SetDefaults hydrates default values in the list reports params (not the query body).

All values with no default are reset to their zero value.

func (*ListReportsParams) SetDollarSkip 

func (o *ListReportsParams) SetDollarSkip(dollarSkip *int32)

SetDollarSkip adds the dollarSkip to the list reports params

func (*ListReportsParams) SetDollarTop 

func (o *ListReportsParams) SetDollarTop(dollarTop *int32)

SetDollarTop adds the dollarTop to the list reports params

func (*ListReportsParams) SetHTTPClient 

func (o *ListReportsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list reports params

func (*ListReportsParams) SetPageKey 

func (o *ListReportsParams) SetPageKey(pageKey *string)

SetPageKey adds the pageKey to the list reports params

func (*ListReportsParams) SetTimeout 

func (o *ListReportsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list reports params

func (*ListReportsParams) SetXAvalaraClient 

func (o *ListReportsParams) SetXAvalaraClient(xAvalaraClient *string)

SetXAvalaraClient adds the xAvalaraClient to the list reports params

func (*ListReportsParams) WithCompanyID 

func (o *ListReportsParams) WithCompanyID(companyID *int32) *ListReportsParams

WithCompanyID adds the companyID to the list reports params

func (*ListReportsParams) WithContext 

func (o *ListReportsParams) WithContext(ctx context.Context) *ListReportsParams

WithContext adds the context to the list reports params

func (*ListReportsParams) WithDefaults 

func (o *ListReportsParams) WithDefaults() *ListReportsParams

WithDefaults hydrates default values in the list reports params (not the query body).

All values with no default are reset to their zero value.

func (*ListReportsParams) WithDollarSkip 

func (o *ListReportsParams) WithDollarSkip(dollarSkip *int32) *ListReportsParams

WithDollarSkip adds the dollarSkip to the list reports params

func (*ListReportsParams) WithDollarTop 

func (o *ListReportsParams) WithDollarTop(dollarTop *int32) *ListReportsParams

WithDollarTop adds the dollarTop to the list reports params

func (*ListReportsParams) WithHTTPClient 

func (o *ListReportsParams) WithHTTPClient(client *http.Client) *ListReportsParams

WithHTTPClient adds the HTTPClient to the list reports params

func (*ListReportsParams) WithPageKey 

func (o *ListReportsParams) WithPageKey(pageKey *string) *ListReportsParams

WithPageKey adds the pageKey to the list reports params

func (*ListReportsParams) WithTimeout 

func (o *ListReportsParams) WithTimeout(timeout time.Duration) *ListReportsParams

WithTimeout adds the timeout to the list reports params

func (*ListReportsParams) WithXAvalaraClient 

func (o *ListReportsParams) WithXAvalaraClient(xAvalaraClient *string) *ListReportsParams

WithXAvalaraClient adds the xAvalaraClient to the list reports params

func (*ListReportsParams) WriteToRequest 

func (o *ListReportsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListReportsReader 

type ListReportsReader struct {
	// contains filtered or unexported fields
}

ListReportsReader is a Reader for the ListReports structure.

func (*ListReportsReader) ReadResponse 

func (o *ListReportsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListReportsUnauthorized 

type ListReportsUnauthorized struct {
}
ListReportsUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewListReportsUnauthorized 

func NewListReportsUnauthorized() *ListReportsUnauthorized

NewListReportsUnauthorized creates a ListReportsUnauthorized with default headers values

func (*ListReportsUnauthorized) Error 

func (o *ListReportsUnauthorized) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.