Documentation
¶
Index ¶
- type Client
- func (a *Client) DismissNotification(params *DismissNotificationParams, authInfo runtime.ClientAuthInfoWriter, ...) (*DismissNotificationOK, error)
- func (a *Client) GetNotification(params *GetNotificationParams, authInfo runtime.ClientAuthInfoWriter, ...) (*GetNotificationOK, error)
- func (a *Client) ListNotifications(params *ListNotificationsParams, authInfo runtime.ClientAuthInfoWriter, ...) (*ListNotificationsOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- type ClientOption
- type ClientService
- type DismissNotificationBadRequest
- type DismissNotificationNotFound
- type DismissNotificationOK
- type DismissNotificationParams
- func NewDismissNotificationParams() *DismissNotificationParams
- func NewDismissNotificationParamsWithContext(ctx context.Context) *DismissNotificationParams
- func NewDismissNotificationParamsWithHTTPClient(client *http.Client) *DismissNotificationParams
- func NewDismissNotificationParamsWithTimeout(timeout time.Duration) *DismissNotificationParams
- func (o *DismissNotificationParams) SetContext(ctx context.Context)
- func (o *DismissNotificationParams) SetDefaults()
- func (o *DismissNotificationParams) SetHTTPClient(client *http.Client)
- func (o *DismissNotificationParams) SetID(id int64)
- func (o *DismissNotificationParams) SetTimeout(timeout time.Duration)
- func (o *DismissNotificationParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *DismissNotificationParams) WithContext(ctx context.Context) *DismissNotificationParams
- func (o *DismissNotificationParams) WithDefaults() *DismissNotificationParams
- func (o *DismissNotificationParams) WithHTTPClient(client *http.Client) *DismissNotificationParams
- func (o *DismissNotificationParams) WithID(id int64) *DismissNotificationParams
- func (o *DismissNotificationParams) WithTimeout(timeout time.Duration) *DismissNotificationParams
- func (o *DismissNotificationParams) WithXAvalaraClient(xAvalaraClient *string) *DismissNotificationParams
- func (o *DismissNotificationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type DismissNotificationReader
- type DismissNotificationUnauthorized
- type GetNotificationBadRequest
- type GetNotificationNotFound
- type GetNotificationOK
- type GetNotificationParams
- func NewGetNotificationParams() *GetNotificationParams
- func NewGetNotificationParamsWithContext(ctx context.Context) *GetNotificationParams
- func NewGetNotificationParamsWithHTTPClient(client *http.Client) *GetNotificationParams
- func NewGetNotificationParamsWithTimeout(timeout time.Duration) *GetNotificationParams
- func (o *GetNotificationParams) SetContext(ctx context.Context)
- func (o *GetNotificationParams) SetDefaults()
- func (o *GetNotificationParams) SetHTTPClient(client *http.Client)
- func (o *GetNotificationParams) SetID(id int64)
- func (o *GetNotificationParams) SetTimeout(timeout time.Duration)
- func (o *GetNotificationParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *GetNotificationParams) WithContext(ctx context.Context) *GetNotificationParams
- func (o *GetNotificationParams) WithDefaults() *GetNotificationParams
- func (o *GetNotificationParams) WithHTTPClient(client *http.Client) *GetNotificationParams
- func (o *GetNotificationParams) WithID(id int64) *GetNotificationParams
- func (o *GetNotificationParams) WithTimeout(timeout time.Duration) *GetNotificationParams
- func (o *GetNotificationParams) WithXAvalaraClient(xAvalaraClient *string) *GetNotificationParams
- func (o *GetNotificationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetNotificationReader
- type GetNotificationUnauthorized
- type ListNotificationsBadRequest
- type ListNotificationsOK
- type ListNotificationsParams
- func NewListNotificationsParams() *ListNotificationsParams
- func NewListNotificationsParamsWithContext(ctx context.Context) *ListNotificationsParams
- func NewListNotificationsParamsWithHTTPClient(client *http.Client) *ListNotificationsParams
- func NewListNotificationsParamsWithTimeout(timeout time.Duration) *ListNotificationsParams
- func (o *ListNotificationsParams) SetContext(ctx context.Context)
- func (o *ListNotificationsParams) SetDefaults()
- func (o *ListNotificationsParams) SetDollarFilter(dollarFilter *string)
- func (o *ListNotificationsParams) SetDollarOrderBy(dollarOrderBy *string)
- func (o *ListNotificationsParams) SetDollarSkip(dollarSkip *int32)
- func (o *ListNotificationsParams) SetDollarTop(dollarTop *int32)
- func (o *ListNotificationsParams) SetHTTPClient(client *http.Client)
- func (o *ListNotificationsParams) SetTimeout(timeout time.Duration)
- func (o *ListNotificationsParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *ListNotificationsParams) WithContext(ctx context.Context) *ListNotificationsParams
- func (o *ListNotificationsParams) WithDefaults() *ListNotificationsParams
- func (o *ListNotificationsParams) WithDollarFilter(dollarFilter *string) *ListNotificationsParams
- func (o *ListNotificationsParams) WithDollarOrderBy(dollarOrderBy *string) *ListNotificationsParams
- func (o *ListNotificationsParams) WithDollarSkip(dollarSkip *int32) *ListNotificationsParams
- func (o *ListNotificationsParams) WithDollarTop(dollarTop *int32) *ListNotificationsParams
- func (o *ListNotificationsParams) WithHTTPClient(client *http.Client) *ListNotificationsParams
- func (o *ListNotificationsParams) WithTimeout(timeout time.Duration) *ListNotificationsParams
- func (o *ListNotificationsParams) WithXAvalaraClient(xAvalaraClient *string) *ListNotificationsParams
- func (o *ListNotificationsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type ListNotificationsReader
- type ListNotificationsUnauthorized
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 notifications API
func (*Client) DismissNotification ¶
func (a *Client) DismissNotification(params *DismissNotificationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DismissNotificationOK, error)
DismissNotification marks a single notification as dismissed Marks the notification identified by this URL as dismissed.
A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed any relevant concerns raised by this notification.
An example of a notification would be a message about new software, or a change to AvaTax that may affect you, or a potential issue with your company's tax profile.
When you dismiss a notification, the notification will track the user and time when it was dismissed. You can then later review which employees of your company dismissed notifications to determine if they were resolved appropriately.
A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) GetNotification ¶
func (a *Client) GetNotification(params *GetNotificationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetNotificationOK, error)
GetNotification retrieves a single notification Retrieve a single notification by its unique ID number.
A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed any relevant concerns raised by this notification.
An example of a notification would be a message about new software, or a change to AvaTax that may affect you, or a potential issue with your company's tax profile.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) ListNotifications ¶
func (a *Client) ListNotifications(params *ListNotificationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListNotificationsOK, error)
ListNotifications lists all notifications List all notifications.
A notification is a message from Avalara that may have relevance to your business. You may want to regularly review notifications and then dismiss them when you are certain that you have addressed any relevant concerns raised by this notification.
An example of a notification would be a message about new software, or a change to AvaTax that may affect you, or a potential issue with your company's tax profile.
You may 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 your results using the `$top`, `$skip`, and `$orderby` parameters.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
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 { DismissNotification(params *DismissNotificationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DismissNotificationOK, error) GetNotification(params *GetNotificationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetNotificationOK, error) ListNotifications(params *ListNotificationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListNotificationsOK, 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 notifications API client.
type DismissNotificationBadRequest ¶
type DismissNotificationBadRequest struct { }
DismissNotificationBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewDismissNotificationBadRequest ¶
func NewDismissNotificationBadRequest() *DismissNotificationBadRequest
NewDismissNotificationBadRequest creates a DismissNotificationBadRequest with default headers values
func (*DismissNotificationBadRequest) Error ¶
func (o *DismissNotificationBadRequest) Error() string
type DismissNotificationNotFound ¶
type DismissNotificationNotFound struct { }
DismissNotificationNotFound describes a response with status code 404, with default header values.
Not Found
func NewDismissNotificationNotFound ¶
func NewDismissNotificationNotFound() *DismissNotificationNotFound
NewDismissNotificationNotFound creates a DismissNotificationNotFound with default headers values
func (*DismissNotificationNotFound) Error ¶
func (o *DismissNotificationNotFound) Error() string
type DismissNotificationOK ¶
type DismissNotificationOK struct {
Payload *models.NotificationModel
}
DismissNotificationOK describes a response with status code 200, with default header values.
Success
func NewDismissNotificationOK ¶
func NewDismissNotificationOK() *DismissNotificationOK
NewDismissNotificationOK creates a DismissNotificationOK with default headers values
func (*DismissNotificationOK) Error ¶
func (o *DismissNotificationOK) Error() string
func (*DismissNotificationOK) GetPayload ¶
func (o *DismissNotificationOK) GetPayload() *models.NotificationModel
type DismissNotificationParams ¶
type DismissNotificationParams 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 id of the notification you wish to mark as dismissed. Format: int64 */ ID int64 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
DismissNotificationParams contains all the parameters to send to the API endpoint
for the dismiss notification operation. Typically these are written to a http.Request.
func NewDismissNotificationParams ¶
func NewDismissNotificationParams() *DismissNotificationParams
NewDismissNotificationParams creates a new DismissNotificationParams 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 NewDismissNotificationParamsWithContext ¶
func NewDismissNotificationParamsWithContext(ctx context.Context) *DismissNotificationParams
NewDismissNotificationParamsWithContext creates a new DismissNotificationParams object with the ability to set a context for a request.
func NewDismissNotificationParamsWithHTTPClient ¶
func NewDismissNotificationParamsWithHTTPClient(client *http.Client) *DismissNotificationParams
NewDismissNotificationParamsWithHTTPClient creates a new DismissNotificationParams object with the ability to set a custom HTTPClient for a request.
func NewDismissNotificationParamsWithTimeout ¶
func NewDismissNotificationParamsWithTimeout(timeout time.Duration) *DismissNotificationParams
NewDismissNotificationParamsWithTimeout creates a new DismissNotificationParams object with the ability to set a timeout on a request.
func (*DismissNotificationParams) SetContext ¶
func (o *DismissNotificationParams) SetContext(ctx context.Context)
SetContext adds the context to the dismiss notification params
func (*DismissNotificationParams) SetDefaults ¶
func (o *DismissNotificationParams) SetDefaults()
SetDefaults hydrates default values in the dismiss notification params (not the query body).
All values with no default are reset to their zero value.
func (*DismissNotificationParams) SetHTTPClient ¶
func (o *DismissNotificationParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the dismiss notification params
func (*DismissNotificationParams) SetID ¶
func (o *DismissNotificationParams) SetID(id int64)
SetID adds the id to the dismiss notification params
func (*DismissNotificationParams) SetTimeout ¶
func (o *DismissNotificationParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the dismiss notification params
func (*DismissNotificationParams) SetXAvalaraClient ¶
func (o *DismissNotificationParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the dismiss notification params
func (*DismissNotificationParams) WithContext ¶
func (o *DismissNotificationParams) WithContext(ctx context.Context) *DismissNotificationParams
WithContext adds the context to the dismiss notification params
func (*DismissNotificationParams) WithDefaults ¶
func (o *DismissNotificationParams) WithDefaults() *DismissNotificationParams
WithDefaults hydrates default values in the dismiss notification params (not the query body).
All values with no default are reset to their zero value.
func (*DismissNotificationParams) WithHTTPClient ¶
func (o *DismissNotificationParams) WithHTTPClient(client *http.Client) *DismissNotificationParams
WithHTTPClient adds the HTTPClient to the dismiss notification params
func (*DismissNotificationParams) WithID ¶
func (o *DismissNotificationParams) WithID(id int64) *DismissNotificationParams
WithID adds the id to the dismiss notification params
func (*DismissNotificationParams) WithTimeout ¶
func (o *DismissNotificationParams) WithTimeout(timeout time.Duration) *DismissNotificationParams
WithTimeout adds the timeout to the dismiss notification params
func (*DismissNotificationParams) WithXAvalaraClient ¶
func (o *DismissNotificationParams) WithXAvalaraClient(xAvalaraClient *string) *DismissNotificationParams
WithXAvalaraClient adds the xAvalaraClient to the dismiss notification params
func (*DismissNotificationParams) WriteToRequest ¶
func (o *DismissNotificationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type DismissNotificationReader ¶
type DismissNotificationReader struct {
// contains filtered or unexported fields
}
DismissNotificationReader is a Reader for the DismissNotification structure.
func (*DismissNotificationReader) ReadResponse ¶
func (o *DismissNotificationReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type DismissNotificationUnauthorized ¶
type DismissNotificationUnauthorized struct { }
DismissNotificationUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewDismissNotificationUnauthorized ¶
func NewDismissNotificationUnauthorized() *DismissNotificationUnauthorized
NewDismissNotificationUnauthorized creates a DismissNotificationUnauthorized with default headers values
func (*DismissNotificationUnauthorized) Error ¶
func (o *DismissNotificationUnauthorized) Error() string
type GetNotificationBadRequest ¶
type GetNotificationBadRequest struct { }
GetNotificationBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewGetNotificationBadRequest ¶
func NewGetNotificationBadRequest() *GetNotificationBadRequest
NewGetNotificationBadRequest creates a GetNotificationBadRequest with default headers values
func (*GetNotificationBadRequest) Error ¶
func (o *GetNotificationBadRequest) Error() string
type GetNotificationNotFound ¶
type GetNotificationNotFound struct { }
GetNotificationNotFound describes a response with status code 404, with default header values.
Not Found
func NewGetNotificationNotFound ¶
func NewGetNotificationNotFound() *GetNotificationNotFound
NewGetNotificationNotFound creates a GetNotificationNotFound with default headers values
func (*GetNotificationNotFound) Error ¶
func (o *GetNotificationNotFound) Error() string
type GetNotificationOK ¶
type GetNotificationOK struct {
Payload *models.NotificationModel
}
GetNotificationOK describes a response with status code 200, with default header values.
Success
func NewGetNotificationOK ¶
func NewGetNotificationOK() *GetNotificationOK
NewGetNotificationOK creates a GetNotificationOK with default headers values
func (*GetNotificationOK) Error ¶
func (o *GetNotificationOK) Error() string
func (*GetNotificationOK) GetPayload ¶
func (o *GetNotificationOK) GetPayload() *models.NotificationModel
type GetNotificationParams ¶
type GetNotificationParams 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 id of the notification to retrieve. Format: int64 */ ID int64 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetNotificationParams contains all the parameters to send to the API endpoint
for the get notification operation. Typically these are written to a http.Request.
func NewGetNotificationParams ¶
func NewGetNotificationParams() *GetNotificationParams
NewGetNotificationParams creates a new GetNotificationParams 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 NewGetNotificationParamsWithContext ¶
func NewGetNotificationParamsWithContext(ctx context.Context) *GetNotificationParams
NewGetNotificationParamsWithContext creates a new GetNotificationParams object with the ability to set a context for a request.
func NewGetNotificationParamsWithHTTPClient ¶
func NewGetNotificationParamsWithHTTPClient(client *http.Client) *GetNotificationParams
NewGetNotificationParamsWithHTTPClient creates a new GetNotificationParams object with the ability to set a custom HTTPClient for a request.
func NewGetNotificationParamsWithTimeout ¶
func NewGetNotificationParamsWithTimeout(timeout time.Duration) *GetNotificationParams
NewGetNotificationParamsWithTimeout creates a new GetNotificationParams object with the ability to set a timeout on a request.
func (*GetNotificationParams) SetContext ¶
func (o *GetNotificationParams) SetContext(ctx context.Context)
SetContext adds the context to the get notification params
func (*GetNotificationParams) SetDefaults ¶
func (o *GetNotificationParams) SetDefaults()
SetDefaults hydrates default values in the get notification params (not the query body).
All values with no default are reset to their zero value.
func (*GetNotificationParams) SetHTTPClient ¶
func (o *GetNotificationParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get notification params
func (*GetNotificationParams) SetID ¶
func (o *GetNotificationParams) SetID(id int64)
SetID adds the id to the get notification params
func (*GetNotificationParams) SetTimeout ¶
func (o *GetNotificationParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get notification params
func (*GetNotificationParams) SetXAvalaraClient ¶
func (o *GetNotificationParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the get notification params
func (*GetNotificationParams) WithContext ¶
func (o *GetNotificationParams) WithContext(ctx context.Context) *GetNotificationParams
WithContext adds the context to the get notification params
func (*GetNotificationParams) WithDefaults ¶
func (o *GetNotificationParams) WithDefaults() *GetNotificationParams
WithDefaults hydrates default values in the get notification params (not the query body).
All values with no default are reset to their zero value.
func (*GetNotificationParams) WithHTTPClient ¶
func (o *GetNotificationParams) WithHTTPClient(client *http.Client) *GetNotificationParams
WithHTTPClient adds the HTTPClient to the get notification params
func (*GetNotificationParams) WithID ¶
func (o *GetNotificationParams) WithID(id int64) *GetNotificationParams
WithID adds the id to the get notification params
func (*GetNotificationParams) WithTimeout ¶
func (o *GetNotificationParams) WithTimeout(timeout time.Duration) *GetNotificationParams
WithTimeout adds the timeout to the get notification params
func (*GetNotificationParams) WithXAvalaraClient ¶
func (o *GetNotificationParams) WithXAvalaraClient(xAvalaraClient *string) *GetNotificationParams
WithXAvalaraClient adds the xAvalaraClient to the get notification params
func (*GetNotificationParams) WriteToRequest ¶
func (o *GetNotificationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetNotificationReader ¶
type GetNotificationReader struct {
// contains filtered or unexported fields
}
GetNotificationReader is a Reader for the GetNotification structure.
func (*GetNotificationReader) ReadResponse ¶
func (o *GetNotificationReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetNotificationUnauthorized ¶
type GetNotificationUnauthorized struct { }
GetNotificationUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewGetNotificationUnauthorized ¶
func NewGetNotificationUnauthorized() *GetNotificationUnauthorized
NewGetNotificationUnauthorized creates a GetNotificationUnauthorized with default headers values
func (*GetNotificationUnauthorized) Error ¶
func (o *GetNotificationUnauthorized) Error() string
type ListNotificationsBadRequest ¶
type ListNotificationsBadRequest struct { }
ListNotificationsBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewListNotificationsBadRequest ¶
func NewListNotificationsBadRequest() *ListNotificationsBadRequest
NewListNotificationsBadRequest creates a ListNotificationsBadRequest with default headers values
func (*ListNotificationsBadRequest) Error ¶
func (o *ListNotificationsBadRequest) Error() string
type ListNotificationsOK ¶
type ListNotificationsOK struct {
Payload *models.NotificationModelFetchResult
}
ListNotificationsOK describes a response with status code 200, with default header values.
Success
func NewListNotificationsOK ¶
func NewListNotificationsOK() *ListNotificationsOK
NewListNotificationsOK creates a ListNotificationsOK with default headers values
func (*ListNotificationsOK) Error ¶
func (o *ListNotificationsOK) Error() string
func (*ListNotificationsOK) GetPayload ¶
func (o *ListNotificationsOK) GetPayload() *models.NotificationModelFetchResult
type ListNotificationsParams ¶
type ListNotificationsParams 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/). */ DollarFilter *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 }
ListNotificationsParams contains all the parameters to send to the API endpoint
for the list notifications operation. Typically these are written to a http.Request.
func NewListNotificationsParams ¶
func NewListNotificationsParams() *ListNotificationsParams
NewListNotificationsParams creates a new ListNotificationsParams 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 NewListNotificationsParamsWithContext ¶
func NewListNotificationsParamsWithContext(ctx context.Context) *ListNotificationsParams
NewListNotificationsParamsWithContext creates a new ListNotificationsParams object with the ability to set a context for a request.
func NewListNotificationsParamsWithHTTPClient ¶
func NewListNotificationsParamsWithHTTPClient(client *http.Client) *ListNotificationsParams
NewListNotificationsParamsWithHTTPClient creates a new ListNotificationsParams object with the ability to set a custom HTTPClient for a request.
func NewListNotificationsParamsWithTimeout ¶
func NewListNotificationsParamsWithTimeout(timeout time.Duration) *ListNotificationsParams
NewListNotificationsParamsWithTimeout creates a new ListNotificationsParams object with the ability to set a timeout on a request.
func (*ListNotificationsParams) SetContext ¶
func (o *ListNotificationsParams) SetContext(ctx context.Context)
SetContext adds the context to the list notifications params
func (*ListNotificationsParams) SetDefaults ¶
func (o *ListNotificationsParams) SetDefaults()
SetDefaults hydrates default values in the list notifications params (not the query body).
All values with no default are reset to their zero value.
func (*ListNotificationsParams) SetDollarFilter ¶
func (o *ListNotificationsParams) SetDollarFilter(dollarFilter *string)
SetDollarFilter adds the dollarFilter to the list notifications params
func (*ListNotificationsParams) SetDollarOrderBy ¶
func (o *ListNotificationsParams) SetDollarOrderBy(dollarOrderBy *string)
SetDollarOrderBy adds the dollarOrderBy to the list notifications params
func (*ListNotificationsParams) SetDollarSkip ¶
func (o *ListNotificationsParams) SetDollarSkip(dollarSkip *int32)
SetDollarSkip adds the dollarSkip to the list notifications params
func (*ListNotificationsParams) SetDollarTop ¶
func (o *ListNotificationsParams) SetDollarTop(dollarTop *int32)
SetDollarTop adds the dollarTop to the list notifications params
func (*ListNotificationsParams) SetHTTPClient ¶
func (o *ListNotificationsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the list notifications params
func (*ListNotificationsParams) SetTimeout ¶
func (o *ListNotificationsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the list notifications params
func (*ListNotificationsParams) SetXAvalaraClient ¶
func (o *ListNotificationsParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the list notifications params
func (*ListNotificationsParams) WithContext ¶
func (o *ListNotificationsParams) WithContext(ctx context.Context) *ListNotificationsParams
WithContext adds the context to the list notifications params
func (*ListNotificationsParams) WithDefaults ¶
func (o *ListNotificationsParams) WithDefaults() *ListNotificationsParams
WithDefaults hydrates default values in the list notifications params (not the query body).
All values with no default are reset to their zero value.
func (*ListNotificationsParams) WithDollarFilter ¶
func (o *ListNotificationsParams) WithDollarFilter(dollarFilter *string) *ListNotificationsParams
WithDollarFilter adds the dollarFilter to the list notifications params
func (*ListNotificationsParams) WithDollarOrderBy ¶
func (o *ListNotificationsParams) WithDollarOrderBy(dollarOrderBy *string) *ListNotificationsParams
WithDollarOrderBy adds the dollarOrderBy to the list notifications params
func (*ListNotificationsParams) WithDollarSkip ¶
func (o *ListNotificationsParams) WithDollarSkip(dollarSkip *int32) *ListNotificationsParams
WithDollarSkip adds the dollarSkip to the list notifications params
func (*ListNotificationsParams) WithDollarTop ¶
func (o *ListNotificationsParams) WithDollarTop(dollarTop *int32) *ListNotificationsParams
WithDollarTop adds the dollarTop to the list notifications params
func (*ListNotificationsParams) WithHTTPClient ¶
func (o *ListNotificationsParams) WithHTTPClient(client *http.Client) *ListNotificationsParams
WithHTTPClient adds the HTTPClient to the list notifications params
func (*ListNotificationsParams) WithTimeout ¶
func (o *ListNotificationsParams) WithTimeout(timeout time.Duration) *ListNotificationsParams
WithTimeout adds the timeout to the list notifications params
func (*ListNotificationsParams) WithXAvalaraClient ¶
func (o *ListNotificationsParams) WithXAvalaraClient(xAvalaraClient *string) *ListNotificationsParams
WithXAvalaraClient adds the xAvalaraClient to the list notifications params
func (*ListNotificationsParams) WriteToRequest ¶
func (o *ListNotificationsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type ListNotificationsReader ¶
type ListNotificationsReader struct {
// contains filtered or unexported fields
}
ListNotificationsReader is a Reader for the ListNotifications structure.
func (*ListNotificationsReader) ReadResponse ¶
func (o *ListNotificationsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type ListNotificationsUnauthorized ¶
type ListNotificationsUnauthorized struct { }
ListNotificationsUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewListNotificationsUnauthorized ¶
func NewListNotificationsUnauthorized() *ListNotificationsUnauthorized
NewListNotificationsUnauthorized creates a ListNotificationsUnauthorized with default headers values
func (*ListNotificationsUnauthorized) Error ¶
func (o *ListNotificationsUnauthorized) Error() string