e_commerce_token

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 e commerce token API

func (*Client) CreateECommerceToken 

func (a *Client) CreateECommerceToken(params *CreateECommerceTokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateECommerceTokenOK, error)
CreateECommerceToken creates a new e commerce token

Creates a new eCommerce token.

This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.

### 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) RefreshECommerceToken 

func (a *Client) RefreshECommerceToken(params *RefreshECommerceTokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RefreshECommerceTokenOK, error)
RefreshECommerceToken refreshes an e commerce token

Refresh an eCommerce token.

CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.

### 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 {
	CreateECommerceToken(params *CreateECommerceTokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateECommerceTokenOK, error)

	RefreshECommerceToken(params *RefreshECommerceTokenParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*RefreshECommerceTokenOK, 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 e commerce token API client.

type CreateECommerceTokenBadRequest 

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

Bad Request

func NewCreateECommerceTokenBadRequest 

func NewCreateECommerceTokenBadRequest() *CreateECommerceTokenBadRequest

NewCreateECommerceTokenBadRequest creates a CreateECommerceTokenBadRequest with default headers values

func (*CreateECommerceTokenBadRequest) Error 

func (o *CreateECommerceTokenBadRequest) Error() string

type CreateECommerceTokenInternalServerError 

type CreateECommerceTokenInternalServerError struct {
}
CreateECommerceTokenInternalServerError describes a response with status code 500, with default header values.

Server Error

func NewCreateECommerceTokenInternalServerError 

func NewCreateECommerceTokenInternalServerError() *CreateECommerceTokenInternalServerError

NewCreateECommerceTokenInternalServerError creates a CreateECommerceTokenInternalServerError with default headers values

func (*CreateECommerceTokenInternalServerError) Error 

func (o *CreateECommerceTokenInternalServerError) Error() string

type CreateECommerceTokenOK 

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

Success

func NewCreateECommerceTokenOK 

func NewCreateECommerceTokenOK() *CreateECommerceTokenOK

NewCreateECommerceTokenOK creates a CreateECommerceTokenOK with default headers values

func (*CreateECommerceTokenOK) Error 

func (o *CreateECommerceTokenOK) Error() string

func (*CreateECommerceTokenOK) GetPayload 

func (o *CreateECommerceTokenOK) GetPayload() *models.ECommerceTokenOutputModel

type CreateECommerceTokenParams 

type CreateECommerceTokenParams 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.
	Body *models.CreateECommerceTokenInputModel

	/* CompanyID.

	   The company ID that will be issued this certificate.

	   Format: int32
	*/
	CompanyID int32

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

CreateECommerceTokenParams contains all the parameters to send to the API endpoint 

for the create e commerce token operation.

Typically these are written to a http.Request.

func NewCreateECommerceTokenParams 

func NewCreateECommerceTokenParams() *CreateECommerceTokenParams

NewCreateECommerceTokenParams creates a new CreateECommerceTokenParams 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 NewCreateECommerceTokenParamsWithContext 

func NewCreateECommerceTokenParamsWithContext(ctx context.Context) *CreateECommerceTokenParams

NewCreateECommerceTokenParamsWithContext creates a new CreateECommerceTokenParams object with the ability to set a context for a request.

func NewCreateECommerceTokenParamsWithHTTPClient 

func NewCreateECommerceTokenParamsWithHTTPClient(client *http.Client) *CreateECommerceTokenParams

NewCreateECommerceTokenParamsWithHTTPClient creates a new CreateECommerceTokenParams object with the ability to set a custom HTTPClient for a request.

func NewCreateECommerceTokenParamsWithTimeout 

func NewCreateECommerceTokenParamsWithTimeout(timeout time.Duration) *CreateECommerceTokenParams

NewCreateECommerceTokenParamsWithTimeout creates a new CreateECommerceTokenParams object with the ability to set a timeout on a request.

func (*CreateECommerceTokenParams) SetBody 

func (o *CreateECommerceTokenParams) SetBody(body *models.CreateECommerceTokenInputModel)

SetBody adds the body to the create e commerce token params

func (*CreateECommerceTokenParams) SetCompanyID 

func (o *CreateECommerceTokenParams) SetCompanyID(companyID int32)

SetCompanyID adds the companyId to the create e commerce token params

func (*CreateECommerceTokenParams) SetContext 

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

SetContext adds the context to the create e commerce token params

func (*CreateECommerceTokenParams) SetDefaults 

func (o *CreateECommerceTokenParams) SetDefaults()

SetDefaults hydrates default values in the create e commerce token params (not the query body).

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

func (*CreateECommerceTokenParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the create e commerce token params

func (*CreateECommerceTokenParams) SetTimeout 

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

SetTimeout adds the timeout to the create e commerce token params

func (*CreateECommerceTokenParams) SetXAvalaraClient 

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

SetXAvalaraClient adds the xAvalaraClient to the create e commerce token params

func (*CreateECommerceTokenParams) WithBody 

func (o *CreateECommerceTokenParams) WithBody(body *models.CreateECommerceTokenInputModel) *CreateECommerceTokenParams

WithBody adds the body to the create e commerce token params

func (*CreateECommerceTokenParams) WithCompanyID 

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

WithCompanyID adds the companyID to the create e commerce token params

func (*CreateECommerceTokenParams) WithContext 

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

WithContext adds the context to the create e commerce token params

func (*CreateECommerceTokenParams) WithDefaults 

func (o *CreateECommerceTokenParams) WithDefaults() *CreateECommerceTokenParams

WithDefaults hydrates default values in the create e commerce token params (not the query body).

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

func (*CreateECommerceTokenParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the create e commerce token params

func (*CreateECommerceTokenParams) WithTimeout 

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

WithTimeout adds the timeout to the create e commerce token params

func (*CreateECommerceTokenParams) WithXAvalaraClient 

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

WithXAvalaraClient adds the xAvalaraClient to the create e commerce token params

func (*CreateECommerceTokenParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type CreateECommerceTokenReader 

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

CreateECommerceTokenReader is a Reader for the CreateECommerceToken structure.

func (*CreateECommerceTokenReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type CreateECommerceTokenUnauthorized 

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

Unauthorized

func NewCreateECommerceTokenUnauthorized 

func NewCreateECommerceTokenUnauthorized() *CreateECommerceTokenUnauthorized

NewCreateECommerceTokenUnauthorized creates a CreateECommerceTokenUnauthorized with default headers values

func (*CreateECommerceTokenUnauthorized) Error 

func (o *CreateECommerceTokenUnauthorized) Error() string

type RefreshECommerceTokenBadRequest 

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

Bad Request

func NewRefreshECommerceTokenBadRequest 

func NewRefreshECommerceTokenBadRequest() *RefreshECommerceTokenBadRequest

NewRefreshECommerceTokenBadRequest creates a RefreshECommerceTokenBadRequest with default headers values

func (*RefreshECommerceTokenBadRequest) Error 

func (o *RefreshECommerceTokenBadRequest) Error() string

type RefreshECommerceTokenInternalServerError 

type RefreshECommerceTokenInternalServerError struct {
}
RefreshECommerceTokenInternalServerError describes a response with status code 500, with default header values.

Server Error

func NewRefreshECommerceTokenInternalServerError 

func NewRefreshECommerceTokenInternalServerError() *RefreshECommerceTokenInternalServerError

NewRefreshECommerceTokenInternalServerError creates a RefreshECommerceTokenInternalServerError with default headers values

func (*RefreshECommerceTokenInternalServerError) Error 

func (o *RefreshECommerceTokenInternalServerError) Error() string

type RefreshECommerceTokenOK 

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

Success

func NewRefreshECommerceTokenOK 

func NewRefreshECommerceTokenOK() *RefreshECommerceTokenOK

NewRefreshECommerceTokenOK creates a RefreshECommerceTokenOK with default headers values

func (*RefreshECommerceTokenOK) Error 

func (o *RefreshECommerceTokenOK) Error() string

func (*RefreshECommerceTokenOK) GetPayload 

func (o *RefreshECommerceTokenOK) GetPayload() *models.ECommerceTokenOutputModelFetchResult

type RefreshECommerceTokenParams 

type RefreshECommerceTokenParams 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.
	Body *models.RefreshECommerceTokenInputModel

	/* CompanyID.

	   The company ID that the refreshed certificate belongs to.

	   Format: int32
	*/
	CompanyID int32

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

RefreshECommerceTokenParams contains all the parameters to send to the API endpoint 

for the refresh e commerce token operation.

Typically these are written to a http.Request.

func NewRefreshECommerceTokenParams 

func NewRefreshECommerceTokenParams() *RefreshECommerceTokenParams

NewRefreshECommerceTokenParams creates a new RefreshECommerceTokenParams 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 NewRefreshECommerceTokenParamsWithContext 

func NewRefreshECommerceTokenParamsWithContext(ctx context.Context) *RefreshECommerceTokenParams

NewRefreshECommerceTokenParamsWithContext creates a new RefreshECommerceTokenParams object with the ability to set a context for a request.

func NewRefreshECommerceTokenParamsWithHTTPClient 

func NewRefreshECommerceTokenParamsWithHTTPClient(client *http.Client) *RefreshECommerceTokenParams

NewRefreshECommerceTokenParamsWithHTTPClient creates a new RefreshECommerceTokenParams object with the ability to set a custom HTTPClient for a request.

func NewRefreshECommerceTokenParamsWithTimeout 

func NewRefreshECommerceTokenParamsWithTimeout(timeout time.Duration) *RefreshECommerceTokenParams

NewRefreshECommerceTokenParamsWithTimeout creates a new RefreshECommerceTokenParams object with the ability to set a timeout on a request.

func (*RefreshECommerceTokenParams) SetBody 

func (o *RefreshECommerceTokenParams) SetBody(body *models.RefreshECommerceTokenInputModel)

SetBody adds the body to the refresh e commerce token params

func (*RefreshECommerceTokenParams) SetCompanyID 

func (o *RefreshECommerceTokenParams) SetCompanyID(companyID int32)

SetCompanyID adds the companyId to the refresh e commerce token params

func (*RefreshECommerceTokenParams) SetContext 

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

SetContext adds the context to the refresh e commerce token params

func (*RefreshECommerceTokenParams) SetDefaults 

func (o *RefreshECommerceTokenParams) SetDefaults()

SetDefaults hydrates default values in the refresh e commerce token params (not the query body).

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

func (*RefreshECommerceTokenParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the refresh e commerce token params

func (*RefreshECommerceTokenParams) SetTimeout 

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

SetTimeout adds the timeout to the refresh e commerce token params

func (*RefreshECommerceTokenParams) SetXAvalaraClient 

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

SetXAvalaraClient adds the xAvalaraClient to the refresh e commerce token params

func (*RefreshECommerceTokenParams) WithBody 

func (o *RefreshECommerceTokenParams) WithBody(body *models.RefreshECommerceTokenInputModel) *RefreshECommerceTokenParams

WithBody adds the body to the refresh e commerce token params

func (*RefreshECommerceTokenParams) WithCompanyID 

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

WithCompanyID adds the companyID to the refresh e commerce token params

func (*RefreshECommerceTokenParams) WithContext 

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

WithContext adds the context to the refresh e commerce token params

func (*RefreshECommerceTokenParams) WithDefaults 

func (o *RefreshECommerceTokenParams) WithDefaults() *RefreshECommerceTokenParams

WithDefaults hydrates default values in the refresh e commerce token params (not the query body).

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

func (*RefreshECommerceTokenParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the refresh e commerce token params

func (*RefreshECommerceTokenParams) WithTimeout 

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

WithTimeout adds the timeout to the refresh e commerce token params

func (*RefreshECommerceTokenParams) WithXAvalaraClient 

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

WithXAvalaraClient adds the xAvalaraClient to the refresh e commerce token params

func (*RefreshECommerceTokenParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type RefreshECommerceTokenReader 

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

RefreshECommerceTokenReader is a Reader for the RefreshECommerceToken structure.

func (*RefreshECommerceTokenReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type RefreshECommerceTokenUnauthorized 

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

Unauthorized

func NewRefreshECommerceTokenUnauthorized 

func NewRefreshECommerceTokenUnauthorized() *RefreshECommerceTokenUnauthorized

NewRefreshECommerceTokenUnauthorized creates a RefreshECommerceTokenUnauthorized with default headers values

func (*RefreshECommerceTokenUnauthorized) Error 

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