utilities

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: 10 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 utilities API

func (*Client) GetMySubscription 

func (a *Client) GetMySubscription(params *GetMySubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetMySubscriptionOK, error)
GetMySubscription checks if the current user is subscribed to a specific service

Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.

This API will return an error if it is called with invalid authentication credentials.

This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use specific features of AvaTax.

func (*Client) ListMySubscriptions 

func (a *Client) ListMySubscriptions(params *ListMySubscriptionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListMySubscriptionsOK, error)
ListMySubscriptions lists all services to which the current user is subscribed

Returns the list of all subscriptions enabled for the currently logged in user.

This API will return an error if it is called with invalid authentication credentials.

This API is intended to help you determine whether you have the necessary subscription to use certain API calls within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product or subscription to provide useful information to the current user as to whether they are entitled to use specific features of AvaTax.

func (*Client) Ping 

func (a *Client) Ping(params *PingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PingOK, error)
Ping tests connectivity and version of the service

Check connectivity to AvaTax and return information about the AvaTax API server.

This API is intended to help you verify that your connection is working. This API will always succeed and will never return a error. It provides basic information about the server you connect to:

* `version` - The version number of the AvaTax API server that responded to your request. The AvaTax API version number is updated once per month during Avalara's update process. * `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request. * `authenticationType` - If you provided valid credentials to the API, this field will tell you whether you used Bearer, Username, or LicenseKey authentication. * `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user. * `authenticatedUserId` - If you provided valid credentials to the API, this field will tell you the user ID of the currently logged in user. * `authenticatedAccountId` - If you provided valid credentials to the API, this field will contain the account ID of the currently logged in user.

This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even if you do not have verified connection credentials. If this API fails, either your computer is not connected to the internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available. For more information on the uptime of AvaTax, please see [Avalara's AvaTax Status Page](https://status.avalara.com/).

### Security Policies

* This API may be called without providing authentication credentials.

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 {
	GetMySubscription(params *GetMySubscriptionParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetMySubscriptionOK, error)

	ListMySubscriptions(params *ListMySubscriptionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListMySubscriptionsOK, error)

	Ping(params *PingParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PingOK, 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 utilities API client.

type GetMySubscriptionBadRequest 

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

Bad Request

func NewGetMySubscriptionBadRequest 

func NewGetMySubscriptionBadRequest() *GetMySubscriptionBadRequest

NewGetMySubscriptionBadRequest creates a GetMySubscriptionBadRequest with default headers values

func (*GetMySubscriptionBadRequest) Error 

func (o *GetMySubscriptionBadRequest) Error() string

type GetMySubscriptionNotFound 

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

Not Found

func NewGetMySubscriptionNotFound 

func NewGetMySubscriptionNotFound() *GetMySubscriptionNotFound

NewGetMySubscriptionNotFound creates a GetMySubscriptionNotFound with default headers values

func (*GetMySubscriptionNotFound) Error 

func (o *GetMySubscriptionNotFound) Error() string

type GetMySubscriptionOK 

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

Success

func NewGetMySubscriptionOK 

func NewGetMySubscriptionOK() *GetMySubscriptionOK

NewGetMySubscriptionOK creates a GetMySubscriptionOK with default headers values

func (*GetMySubscriptionOK) Error 

func (o *GetMySubscriptionOK) Error() string

func (*GetMySubscriptionOK) GetPayload 

func (o *GetMySubscriptionOK) GetPayload() *models.SubscriptionModel

type GetMySubscriptionParams 

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

	/* ServiceTypeID.

	   The service to check
	*/
	ServiceTypeID string

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

GetMySubscriptionParams contains all the parameters to send to the API endpoint 

for the get my subscription operation.

Typically these are written to a http.Request.

func NewGetMySubscriptionParams 

func NewGetMySubscriptionParams() *GetMySubscriptionParams

NewGetMySubscriptionParams creates a new GetMySubscriptionParams 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 NewGetMySubscriptionParamsWithContext 

func NewGetMySubscriptionParamsWithContext(ctx context.Context) *GetMySubscriptionParams

NewGetMySubscriptionParamsWithContext creates a new GetMySubscriptionParams object with the ability to set a context for a request.

func NewGetMySubscriptionParamsWithHTTPClient 

func NewGetMySubscriptionParamsWithHTTPClient(client *http.Client) *GetMySubscriptionParams

NewGetMySubscriptionParamsWithHTTPClient creates a new GetMySubscriptionParams object with the ability to set a custom HTTPClient for a request.

func NewGetMySubscriptionParamsWithTimeout 

func NewGetMySubscriptionParamsWithTimeout(timeout time.Duration) *GetMySubscriptionParams

NewGetMySubscriptionParamsWithTimeout creates a new GetMySubscriptionParams object with the ability to set a timeout on a request.

func (*GetMySubscriptionParams) SetContext 

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

SetContext adds the context to the get my subscription params

func (*GetMySubscriptionParams) SetDefaults 

func (o *GetMySubscriptionParams) SetDefaults()

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

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

func (*GetMySubscriptionParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get my subscription params

func (*GetMySubscriptionParams) SetServiceTypeID 

func (o *GetMySubscriptionParams) SetServiceTypeID(serviceTypeID string)

SetServiceTypeID adds the serviceTypeId to the get my subscription params

func (*GetMySubscriptionParams) SetTimeout 

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

SetTimeout adds the timeout to the get my subscription params

func (*GetMySubscriptionParams) SetXAvalaraClient 

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

SetXAvalaraClient adds the xAvalaraClient to the get my subscription params

func (*GetMySubscriptionParams) WithContext 

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

WithContext adds the context to the get my subscription params

func (*GetMySubscriptionParams) WithDefaults 

func (o *GetMySubscriptionParams) WithDefaults() *GetMySubscriptionParams

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

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

func (*GetMySubscriptionParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get my subscription params

func (*GetMySubscriptionParams) WithServiceTypeID 

func (o *GetMySubscriptionParams) WithServiceTypeID(serviceTypeID string) *GetMySubscriptionParams

WithServiceTypeID adds the serviceTypeID to the get my subscription params

func (*GetMySubscriptionParams) WithTimeout 

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

WithTimeout adds the timeout to the get my subscription params

func (*GetMySubscriptionParams) WithXAvalaraClient 

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

WithXAvalaraClient adds the xAvalaraClient to the get my subscription params

func (*GetMySubscriptionParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetMySubscriptionReader 

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

GetMySubscriptionReader is a Reader for the GetMySubscription structure.

func (*GetMySubscriptionReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetMySubscriptionUnauthorized 

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

Unauthorized

func NewGetMySubscriptionUnauthorized 

func NewGetMySubscriptionUnauthorized() *GetMySubscriptionUnauthorized

NewGetMySubscriptionUnauthorized creates a GetMySubscriptionUnauthorized with default headers values

func (*GetMySubscriptionUnauthorized) Error 

func (o *GetMySubscriptionUnauthorized) Error() string

type ListMySubscriptionsBadRequest 

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

Bad Request

func NewListMySubscriptionsBadRequest 

func NewListMySubscriptionsBadRequest() *ListMySubscriptionsBadRequest

NewListMySubscriptionsBadRequest creates a ListMySubscriptionsBadRequest with default headers values

func (*ListMySubscriptionsBadRequest) Error 

func (o *ListMySubscriptionsBadRequest) Error() string

type ListMySubscriptionsOK 

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

Success

func NewListMySubscriptionsOK 

func NewListMySubscriptionsOK() *ListMySubscriptionsOK

NewListMySubscriptionsOK creates a ListMySubscriptionsOK with default headers values

func (*ListMySubscriptionsOK) Error 

func (o *ListMySubscriptionsOK) Error() string

func (*ListMySubscriptionsOK) GetPayload 

func (o *ListMySubscriptionsOK) GetPayload() *models.SubscriptionModelFetchResult

type ListMySubscriptionsParams 

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

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

ListMySubscriptionsParams contains all the parameters to send to the API endpoint 

for the list my subscriptions operation.

Typically these are written to a http.Request.

func NewListMySubscriptionsParams 

func NewListMySubscriptionsParams() *ListMySubscriptionsParams

NewListMySubscriptionsParams creates a new ListMySubscriptionsParams 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 NewListMySubscriptionsParamsWithContext 

func NewListMySubscriptionsParamsWithContext(ctx context.Context) *ListMySubscriptionsParams

NewListMySubscriptionsParamsWithContext creates a new ListMySubscriptionsParams object with the ability to set a context for a request.

func NewListMySubscriptionsParamsWithHTTPClient 

func NewListMySubscriptionsParamsWithHTTPClient(client *http.Client) *ListMySubscriptionsParams

NewListMySubscriptionsParamsWithHTTPClient creates a new ListMySubscriptionsParams object with the ability to set a custom HTTPClient for a request.

func NewListMySubscriptionsParamsWithTimeout 

func NewListMySubscriptionsParamsWithTimeout(timeout time.Duration) *ListMySubscriptionsParams

NewListMySubscriptionsParamsWithTimeout creates a new ListMySubscriptionsParams object with the ability to set a timeout on a request.

func (*ListMySubscriptionsParams) SetContext 

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

SetContext adds the context to the list my subscriptions params

func (*ListMySubscriptionsParams) SetDefaults 

func (o *ListMySubscriptionsParams) SetDefaults()

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

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

func (*ListMySubscriptionsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list my subscriptions params

func (*ListMySubscriptionsParams) SetTimeout 

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

SetTimeout adds the timeout to the list my subscriptions params

func (*ListMySubscriptionsParams) SetXAvalaraClient 

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

SetXAvalaraClient adds the xAvalaraClient to the list my subscriptions params

func (*ListMySubscriptionsParams) WithContext 

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

WithContext adds the context to the list my subscriptions params

func (*ListMySubscriptionsParams) WithDefaults 

func (o *ListMySubscriptionsParams) WithDefaults() *ListMySubscriptionsParams

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

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

func (*ListMySubscriptionsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list my subscriptions params

func (*ListMySubscriptionsParams) WithTimeout 

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

WithTimeout adds the timeout to the list my subscriptions params

func (*ListMySubscriptionsParams) WithXAvalaraClient 

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

WithXAvalaraClient adds the xAvalaraClient to the list my subscriptions params

func (*ListMySubscriptionsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListMySubscriptionsReader 

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

ListMySubscriptionsReader is a Reader for the ListMySubscriptions structure.

func (*ListMySubscriptionsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListMySubscriptionsUnauthorized 

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

Unauthorized

func NewListMySubscriptionsUnauthorized 

func NewListMySubscriptionsUnauthorized() *ListMySubscriptionsUnauthorized

NewListMySubscriptionsUnauthorized creates a ListMySubscriptionsUnauthorized with default headers values

func (*ListMySubscriptionsUnauthorized) Error 

func (o *ListMySubscriptionsUnauthorized) Error() string

type PingBadRequest 

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

Bad Request

func NewPingBadRequest 

func NewPingBadRequest() *PingBadRequest

NewPingBadRequest creates a PingBadRequest with default headers values

func (*PingBadRequest) Error 

func (o *PingBadRequest) Error() string

type PingOK 

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

Success

func NewPingOK 

func NewPingOK() *PingOK

NewPingOK creates a PingOK with default headers values

func (*PingOK) Error 

func (o *PingOK) Error() string

func (*PingOK) GetPayload 

func (o *PingOK) GetPayload() *models.PingResultModel

type PingParams 

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

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

PingParams contains all the parameters to send to the API endpoint 

for the ping operation.

Typically these are written to a http.Request.

func NewPingParams 

func NewPingParams() *PingParams

NewPingParams creates a new PingParams 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 NewPingParamsWithContext 

func NewPingParamsWithContext(ctx context.Context) *PingParams

NewPingParamsWithContext creates a new PingParams object with the ability to set a context for a request.

func NewPingParamsWithHTTPClient 

func NewPingParamsWithHTTPClient(client *http.Client) *PingParams

NewPingParamsWithHTTPClient creates a new PingParams object with the ability to set a custom HTTPClient for a request.

func NewPingParamsWithTimeout 

func NewPingParamsWithTimeout(timeout time.Duration) *PingParams

NewPingParamsWithTimeout creates a new PingParams object with the ability to set a timeout on a request.

func (*PingParams) SetContext 

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

SetContext adds the context to the ping params

func (*PingParams) SetDefaults 

func (o *PingParams) SetDefaults()

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

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

func (*PingParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the ping params

func (*PingParams) SetTimeout 

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

SetTimeout adds the timeout to the ping params

func (*PingParams) SetXAvalaraClient 

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

SetXAvalaraClient adds the xAvalaraClient to the ping params

func (*PingParams) WithContext 

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

WithContext adds the context to the ping params

func (*PingParams) WithDefaults 

func (o *PingParams) WithDefaults() *PingParams

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

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

func (*PingParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the ping params

func (*PingParams) WithTimeout 

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

WithTimeout adds the timeout to the ping params

func (*PingParams) WithXAvalaraClient 

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

WithXAvalaraClient adds the xAvalaraClient to the ping params

func (*PingParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type PingReader 

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

PingReader is a Reader for the Ping structure.

func (*PingReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type PingUnauthorized 

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

Unauthorized

func NewPingUnauthorized 

func NewPingUnauthorized() *PingUnauthorized

NewPingUnauthorized creates a PingUnauthorized with default headers values

func (*PingUnauthorized) Error 

func (o *PingUnauthorized) 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.