Documentation
¶
Index ¶
- type ChangePasswordBadRequest
- type ChangePasswordOK
- type ChangePasswordParams
- func NewChangePasswordParams() *ChangePasswordParams
- func NewChangePasswordParamsWithContext(ctx context.Context) *ChangePasswordParams
- func NewChangePasswordParamsWithHTTPClient(client *http.Client) *ChangePasswordParams
- func NewChangePasswordParamsWithTimeout(timeout time.Duration) *ChangePasswordParams
- func (o *ChangePasswordParams) SetBody(body *models.PasswordChangeModel)
- func (o *ChangePasswordParams) SetContext(ctx context.Context)
- func (o *ChangePasswordParams) SetDefaults()
- func (o *ChangePasswordParams) SetHTTPClient(client *http.Client)
- func (o *ChangePasswordParams) SetTimeout(timeout time.Duration)
- func (o *ChangePasswordParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *ChangePasswordParams) WithBody(body *models.PasswordChangeModel) *ChangePasswordParams
- func (o *ChangePasswordParams) WithContext(ctx context.Context) *ChangePasswordParams
- func (o *ChangePasswordParams) WithDefaults() *ChangePasswordParams
- func (o *ChangePasswordParams) WithHTTPClient(client *http.Client) *ChangePasswordParams
- func (o *ChangePasswordParams) WithTimeout(timeout time.Duration) *ChangePasswordParams
- func (o *ChangePasswordParams) WithXAvalaraClient(xAvalaraClient *string) *ChangePasswordParams
- func (o *ChangePasswordParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type ChangePasswordReader
- type ChangePasswordUnauthorized
- type Client
- func (a *Client) ChangePassword(params *ChangePasswordParams, authInfo runtime.ClientAuthInfoWriter, ...) (*ChangePasswordOK, error)
- func (a *Client) CreateUsers(params *CreateUsersParams, authInfo runtime.ClientAuthInfoWriter, ...) (*CreateUsersOK, error)
- func (a *Client) DeleteUser(params *DeleteUserParams, authInfo runtime.ClientAuthInfoWriter, ...) (*DeleteUserOK, error)
- func (a *Client) GetUser(params *GetUserParams, authInfo runtime.ClientAuthInfoWriter, ...) (*GetUserOK, error)
- func (a *Client) GetUserEntitlements(params *GetUserEntitlementsParams, authInfo runtime.ClientAuthInfoWriter, ...) (*GetUserEntitlementsOK, error)
- func (a *Client) ListUsersByAccount(params *ListUsersByAccountParams, authInfo runtime.ClientAuthInfoWriter, ...) (*ListUsersByAccountOK, error)
- func (a *Client) QueryUsers(params *QueryUsersParams, authInfo runtime.ClientAuthInfoWriter, ...) (*QueryUsersOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- func (a *Client) UpdateUser(params *UpdateUserParams, authInfo runtime.ClientAuthInfoWriter, ...) (*UpdateUserOK, error)
- type ClientOption
- type ClientService
- type CreateUsersBadRequest
- type CreateUsersNotFound
- type CreateUsersOK
- type CreateUsersParams
- func (o *CreateUsersParams) SetAccountID(accountID int32)
- func (o *CreateUsersParams) SetBody(body []*models.UserModel)
- func (o *CreateUsersParams) SetContext(ctx context.Context)
- func (o *CreateUsersParams) SetDefaults()
- func (o *CreateUsersParams) SetHTTPClient(client *http.Client)
- func (o *CreateUsersParams) SetTimeout(timeout time.Duration)
- func (o *CreateUsersParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *CreateUsersParams) WithAccountID(accountID int32) *CreateUsersParams
- func (o *CreateUsersParams) WithBody(body []*models.UserModel) *CreateUsersParams
- func (o *CreateUsersParams) WithContext(ctx context.Context) *CreateUsersParams
- func (o *CreateUsersParams) WithDefaults() *CreateUsersParams
- func (o *CreateUsersParams) WithHTTPClient(client *http.Client) *CreateUsersParams
- func (o *CreateUsersParams) WithTimeout(timeout time.Duration) *CreateUsersParams
- func (o *CreateUsersParams) WithXAvalaraClient(xAvalaraClient *string) *CreateUsersParams
- func (o *CreateUsersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CreateUsersReader
- type CreateUsersUnauthorized
- type DeleteUserBadRequest
- type DeleteUserNotFound
- type DeleteUserOK
- type DeleteUserParams
- func (o *DeleteUserParams) SetAccountID(accountID int32)
- func (o *DeleteUserParams) SetContext(ctx context.Context)
- func (o *DeleteUserParams) SetDefaults()
- func (o *DeleteUserParams) SetHTTPClient(client *http.Client)
- func (o *DeleteUserParams) SetID(id int32)
- func (o *DeleteUserParams) SetTimeout(timeout time.Duration)
- func (o *DeleteUserParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *DeleteUserParams) WithAccountID(accountID int32) *DeleteUserParams
- func (o *DeleteUserParams) WithContext(ctx context.Context) *DeleteUserParams
- func (o *DeleteUserParams) WithDefaults() *DeleteUserParams
- func (o *DeleteUserParams) WithHTTPClient(client *http.Client) *DeleteUserParams
- func (o *DeleteUserParams) WithID(id int32) *DeleteUserParams
- func (o *DeleteUserParams) WithTimeout(timeout time.Duration) *DeleteUserParams
- func (o *DeleteUserParams) WithXAvalaraClient(xAvalaraClient *string) *DeleteUserParams
- func (o *DeleteUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type DeleteUserReader
- type DeleteUserUnauthorized
- type GetUserBadRequest
- type GetUserEntitlementsBadRequest
- type GetUserEntitlementsNotFound
- type GetUserEntitlementsOK
- type GetUserEntitlementsParams
- func NewGetUserEntitlementsParams() *GetUserEntitlementsParams
- func NewGetUserEntitlementsParamsWithContext(ctx context.Context) *GetUserEntitlementsParams
- func NewGetUserEntitlementsParamsWithHTTPClient(client *http.Client) *GetUserEntitlementsParams
- func NewGetUserEntitlementsParamsWithTimeout(timeout time.Duration) *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) SetAccountID(accountID int32)
- func (o *GetUserEntitlementsParams) SetContext(ctx context.Context)
- func (o *GetUserEntitlementsParams) SetDefaults()
- func (o *GetUserEntitlementsParams) SetHTTPClient(client *http.Client)
- func (o *GetUserEntitlementsParams) SetID(id int32)
- func (o *GetUserEntitlementsParams) SetTimeout(timeout time.Duration)
- func (o *GetUserEntitlementsParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *GetUserEntitlementsParams) WithAccountID(accountID int32) *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) WithContext(ctx context.Context) *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) WithDefaults() *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) WithHTTPClient(client *http.Client) *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) WithID(id int32) *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) WithTimeout(timeout time.Duration) *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) WithXAvalaraClient(xAvalaraClient *string) *GetUserEntitlementsParams
- func (o *GetUserEntitlementsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetUserEntitlementsReader
- type GetUserEntitlementsUnauthorized
- type GetUserNotFound
- type GetUserOK
- type GetUserParams
- func (o *GetUserParams) SetAccountID(accountID int32)
- func (o *GetUserParams) SetContext(ctx context.Context)
- func (o *GetUserParams) SetDefaults()
- func (o *GetUserParams) SetDollarInclude(dollarInclude *string)
- func (o *GetUserParams) SetHTTPClient(client *http.Client)
- func (o *GetUserParams) SetID(id int32)
- func (o *GetUserParams) SetTimeout(timeout time.Duration)
- func (o *GetUserParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *GetUserParams) WithAccountID(accountID int32) *GetUserParams
- func (o *GetUserParams) WithContext(ctx context.Context) *GetUserParams
- func (o *GetUserParams) WithDefaults() *GetUserParams
- func (o *GetUserParams) WithDollarInclude(dollarInclude *string) *GetUserParams
- func (o *GetUserParams) WithHTTPClient(client *http.Client) *GetUserParams
- func (o *GetUserParams) WithID(id int32) *GetUserParams
- func (o *GetUserParams) WithTimeout(timeout time.Duration) *GetUserParams
- func (o *GetUserParams) WithXAvalaraClient(xAvalaraClient *string) *GetUserParams
- func (o *GetUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetUserReader
- type GetUserUnauthorized
- type ListUsersByAccountBadRequest
- type ListUsersByAccountNotFound
- type ListUsersByAccountOK
- type ListUsersByAccountParams
- func NewListUsersByAccountParams() *ListUsersByAccountParams
- func NewListUsersByAccountParamsWithContext(ctx context.Context) *ListUsersByAccountParams
- func NewListUsersByAccountParamsWithHTTPClient(client *http.Client) *ListUsersByAccountParams
- func NewListUsersByAccountParamsWithTimeout(timeout time.Duration) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) SetAccountID(accountID int32)
- func (o *ListUsersByAccountParams) SetContext(ctx context.Context)
- func (o *ListUsersByAccountParams) SetDefaults()
- func (o *ListUsersByAccountParams) SetDollarFilter(dollarFilter *string)
- func (o *ListUsersByAccountParams) SetDollarInclude(dollarInclude *string)
- func (o *ListUsersByAccountParams) SetDollarOrderBy(dollarOrderBy *string)
- func (o *ListUsersByAccountParams) SetDollarSkip(dollarSkip *int32)
- func (o *ListUsersByAccountParams) SetDollarTop(dollarTop *int32)
- func (o *ListUsersByAccountParams) SetHTTPClient(client *http.Client)
- func (o *ListUsersByAccountParams) SetTimeout(timeout time.Duration)
- func (o *ListUsersByAccountParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *ListUsersByAccountParams) WithAccountID(accountID int32) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithContext(ctx context.Context) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithDefaults() *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithDollarFilter(dollarFilter *string) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithDollarInclude(dollarInclude *string) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithDollarOrderBy(dollarOrderBy *string) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithDollarSkip(dollarSkip *int32) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithDollarTop(dollarTop *int32) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithHTTPClient(client *http.Client) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithTimeout(timeout time.Duration) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WithXAvalaraClient(xAvalaraClient *string) *ListUsersByAccountParams
- func (o *ListUsersByAccountParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type ListUsersByAccountReader
- type ListUsersByAccountUnauthorized
- type QueryUsersBadRequest
- type QueryUsersOK
- type QueryUsersParams
- func (o *QueryUsersParams) SetContext(ctx context.Context)
- func (o *QueryUsersParams) SetDefaults()
- func (o *QueryUsersParams) SetDollarFilter(dollarFilter *string)
- func (o *QueryUsersParams) SetDollarInclude(dollarInclude *string)
- func (o *QueryUsersParams) SetDollarOrderBy(dollarOrderBy *string)
- func (o *QueryUsersParams) SetDollarSkip(dollarSkip *int32)
- func (o *QueryUsersParams) SetDollarTop(dollarTop *int32)
- func (o *QueryUsersParams) SetHTTPClient(client *http.Client)
- func (o *QueryUsersParams) SetTimeout(timeout time.Duration)
- func (o *QueryUsersParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *QueryUsersParams) WithContext(ctx context.Context) *QueryUsersParams
- func (o *QueryUsersParams) WithDefaults() *QueryUsersParams
- func (o *QueryUsersParams) WithDollarFilter(dollarFilter *string) *QueryUsersParams
- func (o *QueryUsersParams) WithDollarInclude(dollarInclude *string) *QueryUsersParams
- func (o *QueryUsersParams) WithDollarOrderBy(dollarOrderBy *string) *QueryUsersParams
- func (o *QueryUsersParams) WithDollarSkip(dollarSkip *int32) *QueryUsersParams
- func (o *QueryUsersParams) WithDollarTop(dollarTop *int32) *QueryUsersParams
- func (o *QueryUsersParams) WithHTTPClient(client *http.Client) *QueryUsersParams
- func (o *QueryUsersParams) WithTimeout(timeout time.Duration) *QueryUsersParams
- func (o *QueryUsersParams) WithXAvalaraClient(xAvalaraClient *string) *QueryUsersParams
- func (o *QueryUsersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type QueryUsersReader
- type QueryUsersUnauthorized
- type UpdateUserBadRequest
- type UpdateUserNotFound
- type UpdateUserOK
- type UpdateUserParams
- func (o *UpdateUserParams) SetAccountID(accountID int32)
- func (o *UpdateUserParams) SetBody(body *models.UserModel)
- func (o *UpdateUserParams) SetContext(ctx context.Context)
- func (o *UpdateUserParams) SetDefaults()
- func (o *UpdateUserParams) SetHTTPClient(client *http.Client)
- func (o *UpdateUserParams) SetID(id int32)
- func (o *UpdateUserParams) SetTimeout(timeout time.Duration)
- func (o *UpdateUserParams) SetXAvalaraClient(xAvalaraClient *string)
- func (o *UpdateUserParams) WithAccountID(accountID int32) *UpdateUserParams
- func (o *UpdateUserParams) WithBody(body *models.UserModel) *UpdateUserParams
- func (o *UpdateUserParams) WithContext(ctx context.Context) *UpdateUserParams
- func (o *UpdateUserParams) WithDefaults() *UpdateUserParams
- func (o *UpdateUserParams) WithHTTPClient(client *http.Client) *UpdateUserParams
- func (o *UpdateUserParams) WithID(id int32) *UpdateUserParams
- func (o *UpdateUserParams) WithTimeout(timeout time.Duration) *UpdateUserParams
- func (o *UpdateUserParams) WithXAvalaraClient(xAvalaraClient *string) *UpdateUserParams
- func (o *UpdateUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type UpdateUserReader
- type UpdateUserUnauthorized
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChangePasswordBadRequest ¶
type ChangePasswordBadRequest struct { }
ChangePasswordBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewChangePasswordBadRequest ¶
func NewChangePasswordBadRequest() *ChangePasswordBadRequest
NewChangePasswordBadRequest creates a ChangePasswordBadRequest with default headers values
func (*ChangePasswordBadRequest) Error ¶
func (o *ChangePasswordBadRequest) Error() string
type ChangePasswordOK ¶
type ChangePasswordOK struct {
Payload string
}
ChangePasswordOK describes a response with status code 200, with default header values.
Success
func NewChangePasswordOK ¶
func NewChangePasswordOK() *ChangePasswordOK
NewChangePasswordOK creates a ChangePasswordOK with default headers values
func (*ChangePasswordOK) Error ¶
func (o *ChangePasswordOK) Error() string
func (*ChangePasswordOK) GetPayload ¶
func (o *ChangePasswordOK) GetPayload() string
type ChangePasswordParams ¶
type ChangePasswordParams 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. An object containing your current password and the new password. */ Body *models.PasswordChangeModel Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
ChangePasswordParams contains all the parameters to send to the API endpoint
for the change password operation. Typically these are written to a http.Request.
func NewChangePasswordParams ¶
func NewChangePasswordParams() *ChangePasswordParams
NewChangePasswordParams creates a new ChangePasswordParams 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 NewChangePasswordParamsWithContext ¶
func NewChangePasswordParamsWithContext(ctx context.Context) *ChangePasswordParams
NewChangePasswordParamsWithContext creates a new ChangePasswordParams object with the ability to set a context for a request.
func NewChangePasswordParamsWithHTTPClient ¶
func NewChangePasswordParamsWithHTTPClient(client *http.Client) *ChangePasswordParams
NewChangePasswordParamsWithHTTPClient creates a new ChangePasswordParams object with the ability to set a custom HTTPClient for a request.
func NewChangePasswordParamsWithTimeout ¶
func NewChangePasswordParamsWithTimeout(timeout time.Duration) *ChangePasswordParams
NewChangePasswordParamsWithTimeout creates a new ChangePasswordParams object with the ability to set a timeout on a request.
func (*ChangePasswordParams) SetBody ¶
func (o *ChangePasswordParams) SetBody(body *models.PasswordChangeModel)
SetBody adds the body to the change password params
func (*ChangePasswordParams) SetContext ¶
func (o *ChangePasswordParams) SetContext(ctx context.Context)
SetContext adds the context to the change password params
func (*ChangePasswordParams) SetDefaults ¶
func (o *ChangePasswordParams) SetDefaults()
SetDefaults hydrates default values in the change password params (not the query body).
All values with no default are reset to their zero value.
func (*ChangePasswordParams) SetHTTPClient ¶
func (o *ChangePasswordParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the change password params
func (*ChangePasswordParams) SetTimeout ¶
func (o *ChangePasswordParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the change password params
func (*ChangePasswordParams) SetXAvalaraClient ¶
func (o *ChangePasswordParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the change password params
func (*ChangePasswordParams) WithBody ¶
func (o *ChangePasswordParams) WithBody(body *models.PasswordChangeModel) *ChangePasswordParams
WithBody adds the body to the change password params
func (*ChangePasswordParams) WithContext ¶
func (o *ChangePasswordParams) WithContext(ctx context.Context) *ChangePasswordParams
WithContext adds the context to the change password params
func (*ChangePasswordParams) WithDefaults ¶
func (o *ChangePasswordParams) WithDefaults() *ChangePasswordParams
WithDefaults hydrates default values in the change password params (not the query body).
All values with no default are reset to their zero value.
func (*ChangePasswordParams) WithHTTPClient ¶
func (o *ChangePasswordParams) WithHTTPClient(client *http.Client) *ChangePasswordParams
WithHTTPClient adds the HTTPClient to the change password params
func (*ChangePasswordParams) WithTimeout ¶
func (o *ChangePasswordParams) WithTimeout(timeout time.Duration) *ChangePasswordParams
WithTimeout adds the timeout to the change password params
func (*ChangePasswordParams) WithXAvalaraClient ¶
func (o *ChangePasswordParams) WithXAvalaraClient(xAvalaraClient *string) *ChangePasswordParams
WithXAvalaraClient adds the xAvalaraClient to the change password params
func (*ChangePasswordParams) WriteToRequest ¶
func (o *ChangePasswordParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type ChangePasswordReader ¶
type ChangePasswordReader struct {
// contains filtered or unexported fields
}
ChangePasswordReader is a Reader for the ChangePassword structure.
func (*ChangePasswordReader) ReadResponse ¶
func (o *ChangePasswordReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type ChangePasswordUnauthorized ¶
type ChangePasswordUnauthorized struct { }
ChangePasswordUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewChangePasswordUnauthorized ¶
func NewChangePasswordUnauthorized() *ChangePasswordUnauthorized
NewChangePasswordUnauthorized creates a ChangePasswordUnauthorized with default headers values
func (*ChangePasswordUnauthorized) Error ¶
func (o *ChangePasswordUnauthorized) Error() string
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for users API
func (*Client) ChangePassword ¶
func (a *Client) ChangePassword(params *ChangePasswordParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ChangePasswordOK, error)
ChangePassword changes password Allows a user to change their password via an API call.
This API allows an authenticated user to change their password via an API call. This feature is only available for accounts that do not use SAML integrated password validation.
This API only allows the currently authenticated user to change their password; it cannot be used to apply to a different user than the one authenticating the current API call.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) CreateUsers ¶
func (a *Client) CreateUsers(params *CreateUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateUsersOK, error)
CreateUsers creates new users Create one or more new user objects attached to this account.
A user represents one person with access privileges to make API calls and work with a specific account.
Users who are account administrators or company users are permitted to create user records to invite additional team members to work with AvaTax.
A newly created user will receive an email inviting them to create their password. This means that you must provide a valid email address for all user accounts created.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) DeleteUser ¶
func (a *Client) DeleteUser(params *DeleteUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteUserOK, error)
DeleteUser deletes a single user Mark the user object identified by this URL as deleted.
This API is available for use by account and company administrators only.
Account and company administrators may only delete users within the appropriate organizations they control.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
func (*Client) GetUser ¶
func (a *Client) GetUser(params *GetUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserOK, error)
GetUser retrieves a single user Get the user object identified by this URL.
A user represents one person with access privileges to make API calls and work with a specific account.
You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
* FetchDeleted
### 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) GetUserEntitlements ¶
func (a *Client) GetUserEntitlements(params *GetUserEntitlementsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserEntitlementsOK, error)
GetUserEntitlements retrieves all entitlements for a single user Return a list of all entitlements to which this user has rights to access.
Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is allowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use. This API call is intended to provide a validation endpoint to determine, before making an API call, whether this call is likely to succeed. For example, if user 567 within account 999 is attempting to create a new child company underneath company 12345, you could preview the user's entitlements and predict whether this call would succeed:
- Retrieve entitlements by calling '/api/v2/accounts/999/users/567/entitlements' . If the call fails, you do not have accurate credentials for this user.
- If the 'accessLevel' field within entitlements is 'None', the call will fail.
- If the 'accessLevel' field within entitlements is 'SingleCompany' or 'SingleAccount', the call will fail if the companies table does not contain the ID number 12345.
- If the 'permissions' array within entitlements does not contain 'AccountSvc.CompanySave', the call will fail.
For a full list of defined permissions, please use '/api/v2/definitions/permissions' .
### 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) ListUsersByAccount ¶
func (a *Client) ListUsersByAccount(params *ListUsersByAccountParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListUsersByAccountOK, error)
ListUsersByAccount retrieves users for this account List all user objects attached to this account.
A user represents one person with access privileges to make API calls and work with a specific account.
When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key. By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
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.
You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
* FetchDeleted
### 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) QueryUsers ¶
func (a *Client) QueryUsers(params *QueryUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*QueryUsersOK, error)
QueryUsers retrieves all users Get multiple user objects across all accounts.
A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated via either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key.
When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key. By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
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.
You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
* FetchDeleted
### 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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) UpdateUser ¶
func (a *Client) UpdateUser(params *UpdateUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateUserOK, error)
UpdateUser updates a single user Replace the existing user object at this URL with an updated object.
A user represents one person with access privileges to make API calls and work with a specific account. All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null, you may either set its value to null or omit that field from the object you post.
### Security Policies
* This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
type ClientOption ¶
type ClientOption func(*runtime.ClientOperation)
ClientOption is the option for Client methods
type ClientService ¶
type ClientService interface { ChangePassword(params *ChangePasswordParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ChangePasswordOK, error) CreateUsers(params *CreateUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*CreateUsersOK, error) DeleteUser(params *DeleteUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteUserOK, error) GetUser(params *GetUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserOK, error) GetUserEntitlements(params *GetUserEntitlementsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUserEntitlementsOK, error) ListUsersByAccount(params *ListUsersByAccountParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListUsersByAccountOK, error) QueryUsers(params *QueryUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*QueryUsersOK, error) UpdateUser(params *UpdateUserParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UpdateUserOK, 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 users API client.
type CreateUsersBadRequest ¶
type CreateUsersBadRequest struct { }
CreateUsersBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewCreateUsersBadRequest ¶
func NewCreateUsersBadRequest() *CreateUsersBadRequest
NewCreateUsersBadRequest creates a CreateUsersBadRequest with default headers values
func (*CreateUsersBadRequest) Error ¶
func (o *CreateUsersBadRequest) Error() string
type CreateUsersNotFound ¶
type CreateUsersNotFound struct { }
CreateUsersNotFound describes a response with status code 404, with default header values.
Not Found
func NewCreateUsersNotFound ¶
func NewCreateUsersNotFound() *CreateUsersNotFound
NewCreateUsersNotFound creates a CreateUsersNotFound with default headers values
func (*CreateUsersNotFound) Error ¶
func (o *CreateUsersNotFound) Error() string
type CreateUsersOK ¶
CreateUsersOK describes a response with status code 200, with default header values.
Success
func NewCreateUsersOK ¶
func NewCreateUsersOK() *CreateUsersOK
NewCreateUsersOK creates a CreateUsersOK with default headers values
func (*CreateUsersOK) Error ¶
func (o *CreateUsersOK) Error() string
func (*CreateUsersOK) GetPayload ¶
func (o *CreateUsersOK) GetPayload() []*models.UserModel
type CreateUsersParams ¶
type CreateUsersParams 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 /* AccountID. The unique ID number of the account where these users will be created. Format: int32 */ AccountID int32 /* Body. The user or array of users you wish to create. */ Body []*models.UserModel Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
CreateUsersParams contains all the parameters to send to the API endpoint
for the create users operation. Typically these are written to a http.Request.
func NewCreateUsersParams ¶
func NewCreateUsersParams() *CreateUsersParams
NewCreateUsersParams creates a new CreateUsersParams 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 NewCreateUsersParamsWithContext ¶
func NewCreateUsersParamsWithContext(ctx context.Context) *CreateUsersParams
NewCreateUsersParamsWithContext creates a new CreateUsersParams object with the ability to set a context for a request.
func NewCreateUsersParamsWithHTTPClient ¶
func NewCreateUsersParamsWithHTTPClient(client *http.Client) *CreateUsersParams
NewCreateUsersParamsWithHTTPClient creates a new CreateUsersParams object with the ability to set a custom HTTPClient for a request.
func NewCreateUsersParamsWithTimeout ¶
func NewCreateUsersParamsWithTimeout(timeout time.Duration) *CreateUsersParams
NewCreateUsersParamsWithTimeout creates a new CreateUsersParams object with the ability to set a timeout on a request.
func (*CreateUsersParams) SetAccountID ¶
func (o *CreateUsersParams) SetAccountID(accountID int32)
SetAccountID adds the accountId to the create users params
func (*CreateUsersParams) SetBody ¶
func (o *CreateUsersParams) SetBody(body []*models.UserModel)
SetBody adds the body to the create users params
func (*CreateUsersParams) SetContext ¶
func (o *CreateUsersParams) SetContext(ctx context.Context)
SetContext adds the context to the create users params
func (*CreateUsersParams) SetDefaults ¶
func (o *CreateUsersParams) SetDefaults()
SetDefaults hydrates default values in the create users params (not the query body).
All values with no default are reset to their zero value.
func (*CreateUsersParams) SetHTTPClient ¶
func (o *CreateUsersParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the create users params
func (*CreateUsersParams) SetTimeout ¶
func (o *CreateUsersParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the create users params
func (*CreateUsersParams) SetXAvalaraClient ¶
func (o *CreateUsersParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the create users params
func (*CreateUsersParams) WithAccountID ¶
func (o *CreateUsersParams) WithAccountID(accountID int32) *CreateUsersParams
WithAccountID adds the accountID to the create users params
func (*CreateUsersParams) WithBody ¶
func (o *CreateUsersParams) WithBody(body []*models.UserModel) *CreateUsersParams
WithBody adds the body to the create users params
func (*CreateUsersParams) WithContext ¶
func (o *CreateUsersParams) WithContext(ctx context.Context) *CreateUsersParams
WithContext adds the context to the create users params
func (*CreateUsersParams) WithDefaults ¶
func (o *CreateUsersParams) WithDefaults() *CreateUsersParams
WithDefaults hydrates default values in the create users params (not the query body).
All values with no default are reset to their zero value.
func (*CreateUsersParams) WithHTTPClient ¶
func (o *CreateUsersParams) WithHTTPClient(client *http.Client) *CreateUsersParams
WithHTTPClient adds the HTTPClient to the create users params
func (*CreateUsersParams) WithTimeout ¶
func (o *CreateUsersParams) WithTimeout(timeout time.Duration) *CreateUsersParams
WithTimeout adds the timeout to the create users params
func (*CreateUsersParams) WithXAvalaraClient ¶
func (o *CreateUsersParams) WithXAvalaraClient(xAvalaraClient *string) *CreateUsersParams
WithXAvalaraClient adds the xAvalaraClient to the create users params
func (*CreateUsersParams) WriteToRequest ¶
func (o *CreateUsersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CreateUsersReader ¶
type CreateUsersReader struct {
// contains filtered or unexported fields
}
CreateUsersReader is a Reader for the CreateUsers structure.
func (*CreateUsersReader) ReadResponse ¶
func (o *CreateUsersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type CreateUsersUnauthorized ¶
type CreateUsersUnauthorized struct { }
CreateUsersUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewCreateUsersUnauthorized ¶
func NewCreateUsersUnauthorized() *CreateUsersUnauthorized
NewCreateUsersUnauthorized creates a CreateUsersUnauthorized with default headers values
func (*CreateUsersUnauthorized) Error ¶
func (o *CreateUsersUnauthorized) Error() string
type DeleteUserBadRequest ¶
type DeleteUserBadRequest struct { }
DeleteUserBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewDeleteUserBadRequest ¶
func NewDeleteUserBadRequest() *DeleteUserBadRequest
NewDeleteUserBadRequest creates a DeleteUserBadRequest with default headers values
func (*DeleteUserBadRequest) Error ¶
func (o *DeleteUserBadRequest) Error() string
type DeleteUserNotFound ¶
type DeleteUserNotFound struct { }
DeleteUserNotFound describes a response with status code 404, with default header values.
Not Found
func NewDeleteUserNotFound ¶
func NewDeleteUserNotFound() *DeleteUserNotFound
NewDeleteUserNotFound creates a DeleteUserNotFound with default headers values
func (*DeleteUserNotFound) Error ¶
func (o *DeleteUserNotFound) Error() string
type DeleteUserOK ¶
type DeleteUserOK struct {
Payload []*models.ErrorDetail
}
DeleteUserOK describes a response with status code 200, with default header values.
Success
func NewDeleteUserOK ¶
func NewDeleteUserOK() *DeleteUserOK
NewDeleteUserOK creates a DeleteUserOK with default headers values
func (*DeleteUserOK) Error ¶
func (o *DeleteUserOK) Error() string
func (*DeleteUserOK) GetPayload ¶
func (o *DeleteUserOK) GetPayload() []*models.ErrorDetail
type DeleteUserParams ¶
type DeleteUserParams 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 /* AccountID. The accountID of the user you wish to delete. Format: int32 */ AccountID int32 /* ID. The ID of the user you wish to delete. Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
DeleteUserParams contains all the parameters to send to the API endpoint
for the delete user operation. Typically these are written to a http.Request.
func NewDeleteUserParams ¶
func NewDeleteUserParams() *DeleteUserParams
NewDeleteUserParams creates a new DeleteUserParams 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 NewDeleteUserParamsWithContext ¶
func NewDeleteUserParamsWithContext(ctx context.Context) *DeleteUserParams
NewDeleteUserParamsWithContext creates a new DeleteUserParams object with the ability to set a context for a request.
func NewDeleteUserParamsWithHTTPClient ¶
func NewDeleteUserParamsWithHTTPClient(client *http.Client) *DeleteUserParams
NewDeleteUserParamsWithHTTPClient creates a new DeleteUserParams object with the ability to set a custom HTTPClient for a request.
func NewDeleteUserParamsWithTimeout ¶
func NewDeleteUserParamsWithTimeout(timeout time.Duration) *DeleteUserParams
NewDeleteUserParamsWithTimeout creates a new DeleteUserParams object with the ability to set a timeout on a request.
func (*DeleteUserParams) SetAccountID ¶
func (o *DeleteUserParams) SetAccountID(accountID int32)
SetAccountID adds the accountId to the delete user params
func (*DeleteUserParams) SetContext ¶
func (o *DeleteUserParams) SetContext(ctx context.Context)
SetContext adds the context to the delete user params
func (*DeleteUserParams) SetDefaults ¶
func (o *DeleteUserParams) SetDefaults()
SetDefaults hydrates default values in the delete user params (not the query body).
All values with no default are reset to their zero value.
func (*DeleteUserParams) SetHTTPClient ¶
func (o *DeleteUserParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the delete user params
func (*DeleteUserParams) SetID ¶
func (o *DeleteUserParams) SetID(id int32)
SetID adds the id to the delete user params
func (*DeleteUserParams) SetTimeout ¶
func (o *DeleteUserParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the delete user params
func (*DeleteUserParams) SetXAvalaraClient ¶
func (o *DeleteUserParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the delete user params
func (*DeleteUserParams) WithAccountID ¶
func (o *DeleteUserParams) WithAccountID(accountID int32) *DeleteUserParams
WithAccountID adds the accountID to the delete user params
func (*DeleteUserParams) WithContext ¶
func (o *DeleteUserParams) WithContext(ctx context.Context) *DeleteUserParams
WithContext adds the context to the delete user params
func (*DeleteUserParams) WithDefaults ¶
func (o *DeleteUserParams) WithDefaults() *DeleteUserParams
WithDefaults hydrates default values in the delete user params (not the query body).
All values with no default are reset to their zero value.
func (*DeleteUserParams) WithHTTPClient ¶
func (o *DeleteUserParams) WithHTTPClient(client *http.Client) *DeleteUserParams
WithHTTPClient adds the HTTPClient to the delete user params
func (*DeleteUserParams) WithID ¶
func (o *DeleteUserParams) WithID(id int32) *DeleteUserParams
WithID adds the id to the delete user params
func (*DeleteUserParams) WithTimeout ¶
func (o *DeleteUserParams) WithTimeout(timeout time.Duration) *DeleteUserParams
WithTimeout adds the timeout to the delete user params
func (*DeleteUserParams) WithXAvalaraClient ¶
func (o *DeleteUserParams) WithXAvalaraClient(xAvalaraClient *string) *DeleteUserParams
WithXAvalaraClient adds the xAvalaraClient to the delete user params
func (*DeleteUserParams) WriteToRequest ¶
func (o *DeleteUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type DeleteUserReader ¶
type DeleteUserReader struct {
// contains filtered or unexported fields
}
DeleteUserReader is a Reader for the DeleteUser structure.
func (*DeleteUserReader) ReadResponse ¶
func (o *DeleteUserReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type DeleteUserUnauthorized ¶
type DeleteUserUnauthorized struct { }
DeleteUserUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewDeleteUserUnauthorized ¶
func NewDeleteUserUnauthorized() *DeleteUserUnauthorized
NewDeleteUserUnauthorized creates a DeleteUserUnauthorized with default headers values
func (*DeleteUserUnauthorized) Error ¶
func (o *DeleteUserUnauthorized) Error() string
type GetUserBadRequest ¶
type GetUserBadRequest struct { }
GetUserBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewGetUserBadRequest ¶
func NewGetUserBadRequest() *GetUserBadRequest
NewGetUserBadRequest creates a GetUserBadRequest with default headers values
func (*GetUserBadRequest) Error ¶
func (o *GetUserBadRequest) Error() string
type GetUserEntitlementsBadRequest ¶
type GetUserEntitlementsBadRequest struct { }
GetUserEntitlementsBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewGetUserEntitlementsBadRequest ¶
func NewGetUserEntitlementsBadRequest() *GetUserEntitlementsBadRequest
NewGetUserEntitlementsBadRequest creates a GetUserEntitlementsBadRequest with default headers values
func (*GetUserEntitlementsBadRequest) Error ¶
func (o *GetUserEntitlementsBadRequest) Error() string
type GetUserEntitlementsNotFound ¶
type GetUserEntitlementsNotFound struct { }
GetUserEntitlementsNotFound describes a response with status code 404, with default header values.
Not Found
func NewGetUserEntitlementsNotFound ¶
func NewGetUserEntitlementsNotFound() *GetUserEntitlementsNotFound
NewGetUserEntitlementsNotFound creates a GetUserEntitlementsNotFound with default headers values
func (*GetUserEntitlementsNotFound) Error ¶
func (o *GetUserEntitlementsNotFound) Error() string
type GetUserEntitlementsOK ¶
type GetUserEntitlementsOK struct {
Payload *models.UserEntitlementModel
}
GetUserEntitlementsOK describes a response with status code 200, with default header values.
Success
func NewGetUserEntitlementsOK ¶
func NewGetUserEntitlementsOK() *GetUserEntitlementsOK
NewGetUserEntitlementsOK creates a GetUserEntitlementsOK with default headers values
func (*GetUserEntitlementsOK) Error ¶
func (o *GetUserEntitlementsOK) Error() string
func (*GetUserEntitlementsOK) GetPayload ¶
func (o *GetUserEntitlementsOK) GetPayload() *models.UserEntitlementModel
type GetUserEntitlementsParams ¶
type GetUserEntitlementsParams 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 /* AccountID. The accountID of the user you wish to get. Format: int32 */ AccountID int32 /* ID. The ID of the user to retrieve. Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetUserEntitlementsParams contains all the parameters to send to the API endpoint
for the get user entitlements operation. Typically these are written to a http.Request.
func NewGetUserEntitlementsParams ¶
func NewGetUserEntitlementsParams() *GetUserEntitlementsParams
NewGetUserEntitlementsParams creates a new GetUserEntitlementsParams 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 NewGetUserEntitlementsParamsWithContext ¶
func NewGetUserEntitlementsParamsWithContext(ctx context.Context) *GetUserEntitlementsParams
NewGetUserEntitlementsParamsWithContext creates a new GetUserEntitlementsParams object with the ability to set a context for a request.
func NewGetUserEntitlementsParamsWithHTTPClient ¶
func NewGetUserEntitlementsParamsWithHTTPClient(client *http.Client) *GetUserEntitlementsParams
NewGetUserEntitlementsParamsWithHTTPClient creates a new GetUserEntitlementsParams object with the ability to set a custom HTTPClient for a request.
func NewGetUserEntitlementsParamsWithTimeout ¶
func NewGetUserEntitlementsParamsWithTimeout(timeout time.Duration) *GetUserEntitlementsParams
NewGetUserEntitlementsParamsWithTimeout creates a new GetUserEntitlementsParams object with the ability to set a timeout on a request.
func (*GetUserEntitlementsParams) SetAccountID ¶
func (o *GetUserEntitlementsParams) SetAccountID(accountID int32)
SetAccountID adds the accountId to the get user entitlements params
func (*GetUserEntitlementsParams) SetContext ¶
func (o *GetUserEntitlementsParams) SetContext(ctx context.Context)
SetContext adds the context to the get user entitlements params
func (*GetUserEntitlementsParams) SetDefaults ¶
func (o *GetUserEntitlementsParams) SetDefaults()
SetDefaults hydrates default values in the get user entitlements params (not the query body).
All values with no default are reset to their zero value.
func (*GetUserEntitlementsParams) SetHTTPClient ¶
func (o *GetUserEntitlementsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get user entitlements params
func (*GetUserEntitlementsParams) SetID ¶
func (o *GetUserEntitlementsParams) SetID(id int32)
SetID adds the id to the get user entitlements params
func (*GetUserEntitlementsParams) SetTimeout ¶
func (o *GetUserEntitlementsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get user entitlements params
func (*GetUserEntitlementsParams) SetXAvalaraClient ¶
func (o *GetUserEntitlementsParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the get user entitlements params
func (*GetUserEntitlementsParams) WithAccountID ¶
func (o *GetUserEntitlementsParams) WithAccountID(accountID int32) *GetUserEntitlementsParams
WithAccountID adds the accountID to the get user entitlements params
func (*GetUserEntitlementsParams) WithContext ¶
func (o *GetUserEntitlementsParams) WithContext(ctx context.Context) *GetUserEntitlementsParams
WithContext adds the context to the get user entitlements params
func (*GetUserEntitlementsParams) WithDefaults ¶
func (o *GetUserEntitlementsParams) WithDefaults() *GetUserEntitlementsParams
WithDefaults hydrates default values in the get user entitlements params (not the query body).
All values with no default are reset to their zero value.
func (*GetUserEntitlementsParams) WithHTTPClient ¶
func (o *GetUserEntitlementsParams) WithHTTPClient(client *http.Client) *GetUserEntitlementsParams
WithHTTPClient adds the HTTPClient to the get user entitlements params
func (*GetUserEntitlementsParams) WithID ¶
func (o *GetUserEntitlementsParams) WithID(id int32) *GetUserEntitlementsParams
WithID adds the id to the get user entitlements params
func (*GetUserEntitlementsParams) WithTimeout ¶
func (o *GetUserEntitlementsParams) WithTimeout(timeout time.Duration) *GetUserEntitlementsParams
WithTimeout adds the timeout to the get user entitlements params
func (*GetUserEntitlementsParams) WithXAvalaraClient ¶
func (o *GetUserEntitlementsParams) WithXAvalaraClient(xAvalaraClient *string) *GetUserEntitlementsParams
WithXAvalaraClient adds the xAvalaraClient to the get user entitlements params
func (*GetUserEntitlementsParams) WriteToRequest ¶
func (o *GetUserEntitlementsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetUserEntitlementsReader ¶
type GetUserEntitlementsReader struct {
// contains filtered or unexported fields
}
GetUserEntitlementsReader is a Reader for the GetUserEntitlements structure.
func (*GetUserEntitlementsReader) ReadResponse ¶
func (o *GetUserEntitlementsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetUserEntitlementsUnauthorized ¶
type GetUserEntitlementsUnauthorized struct { }
GetUserEntitlementsUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewGetUserEntitlementsUnauthorized ¶
func NewGetUserEntitlementsUnauthorized() *GetUserEntitlementsUnauthorized
NewGetUserEntitlementsUnauthorized creates a GetUserEntitlementsUnauthorized with default headers values
func (*GetUserEntitlementsUnauthorized) Error ¶
func (o *GetUserEntitlementsUnauthorized) Error() string
type GetUserNotFound ¶
type GetUserNotFound struct { }
GetUserNotFound describes a response with status code 404, with default header values.
Not Found
func NewGetUserNotFound ¶
func NewGetUserNotFound() *GetUserNotFound
NewGetUserNotFound creates a GetUserNotFound with default headers values
func (*GetUserNotFound) Error ¶
func (o *GetUserNotFound) Error() string
type GetUserOK ¶
GetUserOK describes a response with status code 200, with default header values.
Success
func NewGetUserOK ¶
func NewGetUserOK() *GetUserOK
NewGetUserOK creates a GetUserOK with default headers values
func (*GetUserOK) GetPayload ¶
type GetUserParams ¶
type GetUserParams struct { /* DollarInclude. Optional fetch commands. */ DollarInclude *string /* 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 /* AccountID. The accountID of the user you wish to get. Format: int32 */ AccountID int32 /* ID. The ID of the user to retrieve. Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
GetUserParams contains all the parameters to send to the API endpoint
for the get user operation. Typically these are written to a http.Request.
func NewGetUserParams ¶
func NewGetUserParams() *GetUserParams
NewGetUserParams creates a new GetUserParams 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 NewGetUserParamsWithContext ¶
func NewGetUserParamsWithContext(ctx context.Context) *GetUserParams
NewGetUserParamsWithContext creates a new GetUserParams object with the ability to set a context for a request.
func NewGetUserParamsWithHTTPClient ¶
func NewGetUserParamsWithHTTPClient(client *http.Client) *GetUserParams
NewGetUserParamsWithHTTPClient creates a new GetUserParams object with the ability to set a custom HTTPClient for a request.
func NewGetUserParamsWithTimeout ¶
func NewGetUserParamsWithTimeout(timeout time.Duration) *GetUserParams
NewGetUserParamsWithTimeout creates a new GetUserParams object with the ability to set a timeout on a request.
func (*GetUserParams) SetAccountID ¶
func (o *GetUserParams) SetAccountID(accountID int32)
SetAccountID adds the accountId to the get user params
func (*GetUserParams) SetContext ¶
func (o *GetUserParams) SetContext(ctx context.Context)
SetContext adds the context to the get user params
func (*GetUserParams) SetDefaults ¶
func (o *GetUserParams) SetDefaults()
SetDefaults hydrates default values in the get user params (not the query body).
All values with no default are reset to their zero value.
func (*GetUserParams) SetDollarInclude ¶
func (o *GetUserParams) SetDollarInclude(dollarInclude *string)
SetDollarInclude adds the dollarInclude to the get user params
func (*GetUserParams) SetHTTPClient ¶
func (o *GetUserParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get user params
func (*GetUserParams) SetID ¶
func (o *GetUserParams) SetID(id int32)
SetID adds the id to the get user params
func (*GetUserParams) SetTimeout ¶
func (o *GetUserParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get user params
func (*GetUserParams) SetXAvalaraClient ¶
func (o *GetUserParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the get user params
func (*GetUserParams) WithAccountID ¶
func (o *GetUserParams) WithAccountID(accountID int32) *GetUserParams
WithAccountID adds the accountID to the get user params
func (*GetUserParams) WithContext ¶
func (o *GetUserParams) WithContext(ctx context.Context) *GetUserParams
WithContext adds the context to the get user params
func (*GetUserParams) WithDefaults ¶
func (o *GetUserParams) WithDefaults() *GetUserParams
WithDefaults hydrates default values in the get user params (not the query body).
All values with no default are reset to their zero value.
func (*GetUserParams) WithDollarInclude ¶
func (o *GetUserParams) WithDollarInclude(dollarInclude *string) *GetUserParams
WithDollarInclude adds the dollarInclude to the get user params
func (*GetUserParams) WithHTTPClient ¶
func (o *GetUserParams) WithHTTPClient(client *http.Client) *GetUserParams
WithHTTPClient adds the HTTPClient to the get user params
func (*GetUserParams) WithID ¶
func (o *GetUserParams) WithID(id int32) *GetUserParams
WithID adds the id to the get user params
func (*GetUserParams) WithTimeout ¶
func (o *GetUserParams) WithTimeout(timeout time.Duration) *GetUserParams
WithTimeout adds the timeout to the get user params
func (*GetUserParams) WithXAvalaraClient ¶
func (o *GetUserParams) WithXAvalaraClient(xAvalaraClient *string) *GetUserParams
WithXAvalaraClient adds the xAvalaraClient to the get user params
func (*GetUserParams) WriteToRequest ¶
func (o *GetUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetUserReader ¶
type GetUserReader struct {
// contains filtered or unexported fields
}
GetUserReader is a Reader for the GetUser structure.
func (*GetUserReader) ReadResponse ¶
func (o *GetUserReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetUserUnauthorized ¶
type GetUserUnauthorized struct { }
GetUserUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewGetUserUnauthorized ¶
func NewGetUserUnauthorized() *GetUserUnauthorized
NewGetUserUnauthorized creates a GetUserUnauthorized with default headers values
func (*GetUserUnauthorized) Error ¶
func (o *GetUserUnauthorized) Error() string
type ListUsersByAccountBadRequest ¶
type ListUsersByAccountBadRequest struct { }
ListUsersByAccountBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewListUsersByAccountBadRequest ¶
func NewListUsersByAccountBadRequest() *ListUsersByAccountBadRequest
NewListUsersByAccountBadRequest creates a ListUsersByAccountBadRequest with default headers values
func (*ListUsersByAccountBadRequest) Error ¶
func (o *ListUsersByAccountBadRequest) Error() string
type ListUsersByAccountNotFound ¶
type ListUsersByAccountNotFound struct { }
ListUsersByAccountNotFound describes a response with status code 404, with default header values.
Not Found
func NewListUsersByAccountNotFound ¶
func NewListUsersByAccountNotFound() *ListUsersByAccountNotFound
NewListUsersByAccountNotFound creates a ListUsersByAccountNotFound with default headers values
func (*ListUsersByAccountNotFound) Error ¶
func (o *ListUsersByAccountNotFound) Error() string
type ListUsersByAccountOK ¶
type ListUsersByAccountOK struct {
Payload *models.UserModelFetchResult
}
ListUsersByAccountOK describes a response with status code 200, with default header values.
Success
func NewListUsersByAccountOK ¶
func NewListUsersByAccountOK() *ListUsersByAccountOK
NewListUsersByAccountOK creates a ListUsersByAccountOK with default headers values
func (*ListUsersByAccountOK) Error ¶
func (o *ListUsersByAccountOK) Error() string
func (*ListUsersByAccountOK) GetPayload ¶
func (o *ListUsersByAccountOK) GetPayload() *models.UserModelFetchResult
type ListUsersByAccountParams ¶
type ListUsersByAccountParams struct { /* DollarFilter. A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* SuppressNewUserEmail */ DollarFilter *string /* DollarInclude. Optional fetch commands. */ DollarInclude *string /* DollarOrderBy. A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. */ DollarOrderBy *string /* DollarSkip. If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. Format: int32 */ DollarSkip *int32 /* DollarTop. If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. Format: int32 */ DollarTop *int32 /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string /* AccountID. The accountID of the user you wish to list. Format: int32 */ AccountID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
ListUsersByAccountParams contains all the parameters to send to the API endpoint
for the list users by account operation. Typically these are written to a http.Request.
func NewListUsersByAccountParams ¶
func NewListUsersByAccountParams() *ListUsersByAccountParams
NewListUsersByAccountParams creates a new ListUsersByAccountParams 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 NewListUsersByAccountParamsWithContext ¶
func NewListUsersByAccountParamsWithContext(ctx context.Context) *ListUsersByAccountParams
NewListUsersByAccountParamsWithContext creates a new ListUsersByAccountParams object with the ability to set a context for a request.
func NewListUsersByAccountParamsWithHTTPClient ¶
func NewListUsersByAccountParamsWithHTTPClient(client *http.Client) *ListUsersByAccountParams
NewListUsersByAccountParamsWithHTTPClient creates a new ListUsersByAccountParams object with the ability to set a custom HTTPClient for a request.
func NewListUsersByAccountParamsWithTimeout ¶
func NewListUsersByAccountParamsWithTimeout(timeout time.Duration) *ListUsersByAccountParams
NewListUsersByAccountParamsWithTimeout creates a new ListUsersByAccountParams object with the ability to set a timeout on a request.
func (*ListUsersByAccountParams) SetAccountID ¶
func (o *ListUsersByAccountParams) SetAccountID(accountID int32)
SetAccountID adds the accountId to the list users by account params
func (*ListUsersByAccountParams) SetContext ¶
func (o *ListUsersByAccountParams) SetContext(ctx context.Context)
SetContext adds the context to the list users by account params
func (*ListUsersByAccountParams) SetDefaults ¶
func (o *ListUsersByAccountParams) SetDefaults()
SetDefaults hydrates default values in the list users by account params (not the query body).
All values with no default are reset to their zero value.
func (*ListUsersByAccountParams) SetDollarFilter ¶
func (o *ListUsersByAccountParams) SetDollarFilter(dollarFilter *string)
SetDollarFilter adds the dollarFilter to the list users by account params
func (*ListUsersByAccountParams) SetDollarInclude ¶
func (o *ListUsersByAccountParams) SetDollarInclude(dollarInclude *string)
SetDollarInclude adds the dollarInclude to the list users by account params
func (*ListUsersByAccountParams) SetDollarOrderBy ¶
func (o *ListUsersByAccountParams) SetDollarOrderBy(dollarOrderBy *string)
SetDollarOrderBy adds the dollarOrderBy to the list users by account params
func (*ListUsersByAccountParams) SetDollarSkip ¶
func (o *ListUsersByAccountParams) SetDollarSkip(dollarSkip *int32)
SetDollarSkip adds the dollarSkip to the list users by account params
func (*ListUsersByAccountParams) SetDollarTop ¶
func (o *ListUsersByAccountParams) SetDollarTop(dollarTop *int32)
SetDollarTop adds the dollarTop to the list users by account params
func (*ListUsersByAccountParams) SetHTTPClient ¶
func (o *ListUsersByAccountParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the list users by account params
func (*ListUsersByAccountParams) SetTimeout ¶
func (o *ListUsersByAccountParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the list users by account params
func (*ListUsersByAccountParams) SetXAvalaraClient ¶
func (o *ListUsersByAccountParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the list users by account params
func (*ListUsersByAccountParams) WithAccountID ¶
func (o *ListUsersByAccountParams) WithAccountID(accountID int32) *ListUsersByAccountParams
WithAccountID adds the accountID to the list users by account params
func (*ListUsersByAccountParams) WithContext ¶
func (o *ListUsersByAccountParams) WithContext(ctx context.Context) *ListUsersByAccountParams
WithContext adds the context to the list users by account params
func (*ListUsersByAccountParams) WithDefaults ¶
func (o *ListUsersByAccountParams) WithDefaults() *ListUsersByAccountParams
WithDefaults hydrates default values in the list users by account params (not the query body).
All values with no default are reset to their zero value.
func (*ListUsersByAccountParams) WithDollarFilter ¶
func (o *ListUsersByAccountParams) WithDollarFilter(dollarFilter *string) *ListUsersByAccountParams
WithDollarFilter adds the dollarFilter to the list users by account params
func (*ListUsersByAccountParams) WithDollarInclude ¶
func (o *ListUsersByAccountParams) WithDollarInclude(dollarInclude *string) *ListUsersByAccountParams
WithDollarInclude adds the dollarInclude to the list users by account params
func (*ListUsersByAccountParams) WithDollarOrderBy ¶
func (o *ListUsersByAccountParams) WithDollarOrderBy(dollarOrderBy *string) *ListUsersByAccountParams
WithDollarOrderBy adds the dollarOrderBy to the list users by account params
func (*ListUsersByAccountParams) WithDollarSkip ¶
func (o *ListUsersByAccountParams) WithDollarSkip(dollarSkip *int32) *ListUsersByAccountParams
WithDollarSkip adds the dollarSkip to the list users by account params
func (*ListUsersByAccountParams) WithDollarTop ¶
func (o *ListUsersByAccountParams) WithDollarTop(dollarTop *int32) *ListUsersByAccountParams
WithDollarTop adds the dollarTop to the list users by account params
func (*ListUsersByAccountParams) WithHTTPClient ¶
func (o *ListUsersByAccountParams) WithHTTPClient(client *http.Client) *ListUsersByAccountParams
WithHTTPClient adds the HTTPClient to the list users by account params
func (*ListUsersByAccountParams) WithTimeout ¶
func (o *ListUsersByAccountParams) WithTimeout(timeout time.Duration) *ListUsersByAccountParams
WithTimeout adds the timeout to the list users by account params
func (*ListUsersByAccountParams) WithXAvalaraClient ¶
func (o *ListUsersByAccountParams) WithXAvalaraClient(xAvalaraClient *string) *ListUsersByAccountParams
WithXAvalaraClient adds the xAvalaraClient to the list users by account params
func (*ListUsersByAccountParams) WriteToRequest ¶
func (o *ListUsersByAccountParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type ListUsersByAccountReader ¶
type ListUsersByAccountReader struct {
// contains filtered or unexported fields
}
ListUsersByAccountReader is a Reader for the ListUsersByAccount structure.
func (*ListUsersByAccountReader) ReadResponse ¶
func (o *ListUsersByAccountReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type ListUsersByAccountUnauthorized ¶
type ListUsersByAccountUnauthorized struct { }
ListUsersByAccountUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewListUsersByAccountUnauthorized ¶
func NewListUsersByAccountUnauthorized() *ListUsersByAccountUnauthorized
NewListUsersByAccountUnauthorized creates a ListUsersByAccountUnauthorized with default headers values
func (*ListUsersByAccountUnauthorized) Error ¶
func (o *ListUsersByAccountUnauthorized) Error() string
type QueryUsersBadRequest ¶
type QueryUsersBadRequest struct { }
QueryUsersBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewQueryUsersBadRequest ¶
func NewQueryUsersBadRequest() *QueryUsersBadRequest
NewQueryUsersBadRequest creates a QueryUsersBadRequest with default headers values
func (*QueryUsersBadRequest) Error ¶
func (o *QueryUsersBadRequest) Error() string
type QueryUsersOK ¶
type QueryUsersOK struct {
Payload *models.UserModelFetchResult
}
QueryUsersOK describes a response with status code 200, with default header values.
Success
func NewQueryUsersOK ¶
func NewQueryUsersOK() *QueryUsersOK
NewQueryUsersOK creates a QueryUsersOK with default headers values
func (*QueryUsersOK) Error ¶
func (o *QueryUsersOK) Error() string
func (*QueryUsersOK) GetPayload ¶
func (o *QueryUsersOK) GetPayload() *models.UserModelFetchResult
type QueryUsersParams ¶
type QueryUsersParams struct { /* DollarFilter. A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* SuppressNewUserEmail */ DollarFilter *string /* DollarInclude. Optional fetch commands. */ DollarInclude *string /* DollarOrderBy. A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. */ DollarOrderBy *string /* DollarSkip. If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. Format: int32 */ DollarSkip *int32 /* DollarTop. If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. Format: int32 */ DollarTop *int32 /* XAvalaraClient. Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . Default: "Swagger UI; 21.12.0; Custom; 1.0" */ XAvalaraClient *string Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
QueryUsersParams contains all the parameters to send to the API endpoint
for the query users operation. Typically these are written to a http.Request.
func NewQueryUsersParams ¶
func NewQueryUsersParams() *QueryUsersParams
NewQueryUsersParams creates a new QueryUsersParams 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 NewQueryUsersParamsWithContext ¶
func NewQueryUsersParamsWithContext(ctx context.Context) *QueryUsersParams
NewQueryUsersParamsWithContext creates a new QueryUsersParams object with the ability to set a context for a request.
func NewQueryUsersParamsWithHTTPClient ¶
func NewQueryUsersParamsWithHTTPClient(client *http.Client) *QueryUsersParams
NewQueryUsersParamsWithHTTPClient creates a new QueryUsersParams object with the ability to set a custom HTTPClient for a request.
func NewQueryUsersParamsWithTimeout ¶
func NewQueryUsersParamsWithTimeout(timeout time.Duration) *QueryUsersParams
NewQueryUsersParamsWithTimeout creates a new QueryUsersParams object with the ability to set a timeout on a request.
func (*QueryUsersParams) SetContext ¶
func (o *QueryUsersParams) SetContext(ctx context.Context)
SetContext adds the context to the query users params
func (*QueryUsersParams) SetDefaults ¶
func (o *QueryUsersParams) SetDefaults()
SetDefaults hydrates default values in the query users params (not the query body).
All values with no default are reset to their zero value.
func (*QueryUsersParams) SetDollarFilter ¶
func (o *QueryUsersParams) SetDollarFilter(dollarFilter *string)
SetDollarFilter adds the dollarFilter to the query users params
func (*QueryUsersParams) SetDollarInclude ¶
func (o *QueryUsersParams) SetDollarInclude(dollarInclude *string)
SetDollarInclude adds the dollarInclude to the query users params
func (*QueryUsersParams) SetDollarOrderBy ¶
func (o *QueryUsersParams) SetDollarOrderBy(dollarOrderBy *string)
SetDollarOrderBy adds the dollarOrderBy to the query users params
func (*QueryUsersParams) SetDollarSkip ¶
func (o *QueryUsersParams) SetDollarSkip(dollarSkip *int32)
SetDollarSkip adds the dollarSkip to the query users params
func (*QueryUsersParams) SetDollarTop ¶
func (o *QueryUsersParams) SetDollarTop(dollarTop *int32)
SetDollarTop adds the dollarTop to the query users params
func (*QueryUsersParams) SetHTTPClient ¶
func (o *QueryUsersParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the query users params
func (*QueryUsersParams) SetTimeout ¶
func (o *QueryUsersParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the query users params
func (*QueryUsersParams) SetXAvalaraClient ¶
func (o *QueryUsersParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the query users params
func (*QueryUsersParams) WithContext ¶
func (o *QueryUsersParams) WithContext(ctx context.Context) *QueryUsersParams
WithContext adds the context to the query users params
func (*QueryUsersParams) WithDefaults ¶
func (o *QueryUsersParams) WithDefaults() *QueryUsersParams
WithDefaults hydrates default values in the query users params (not the query body).
All values with no default are reset to their zero value.
func (*QueryUsersParams) WithDollarFilter ¶
func (o *QueryUsersParams) WithDollarFilter(dollarFilter *string) *QueryUsersParams
WithDollarFilter adds the dollarFilter to the query users params
func (*QueryUsersParams) WithDollarInclude ¶
func (o *QueryUsersParams) WithDollarInclude(dollarInclude *string) *QueryUsersParams
WithDollarInclude adds the dollarInclude to the query users params
func (*QueryUsersParams) WithDollarOrderBy ¶
func (o *QueryUsersParams) WithDollarOrderBy(dollarOrderBy *string) *QueryUsersParams
WithDollarOrderBy adds the dollarOrderBy to the query users params
func (*QueryUsersParams) WithDollarSkip ¶
func (o *QueryUsersParams) WithDollarSkip(dollarSkip *int32) *QueryUsersParams
WithDollarSkip adds the dollarSkip to the query users params
func (*QueryUsersParams) WithDollarTop ¶
func (o *QueryUsersParams) WithDollarTop(dollarTop *int32) *QueryUsersParams
WithDollarTop adds the dollarTop to the query users params
func (*QueryUsersParams) WithHTTPClient ¶
func (o *QueryUsersParams) WithHTTPClient(client *http.Client) *QueryUsersParams
WithHTTPClient adds the HTTPClient to the query users params
func (*QueryUsersParams) WithTimeout ¶
func (o *QueryUsersParams) WithTimeout(timeout time.Duration) *QueryUsersParams
WithTimeout adds the timeout to the query users params
func (*QueryUsersParams) WithXAvalaraClient ¶
func (o *QueryUsersParams) WithXAvalaraClient(xAvalaraClient *string) *QueryUsersParams
WithXAvalaraClient adds the xAvalaraClient to the query users params
func (*QueryUsersParams) WriteToRequest ¶
func (o *QueryUsersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type QueryUsersReader ¶
type QueryUsersReader struct {
// contains filtered or unexported fields
}
QueryUsersReader is a Reader for the QueryUsers structure.
func (*QueryUsersReader) ReadResponse ¶
func (o *QueryUsersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type QueryUsersUnauthorized ¶
type QueryUsersUnauthorized struct { }
QueryUsersUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewQueryUsersUnauthorized ¶
func NewQueryUsersUnauthorized() *QueryUsersUnauthorized
NewQueryUsersUnauthorized creates a QueryUsersUnauthorized with default headers values
func (*QueryUsersUnauthorized) Error ¶
func (o *QueryUsersUnauthorized) Error() string
type UpdateUserBadRequest ¶
type UpdateUserBadRequest struct { }
UpdateUserBadRequest describes a response with status code 400, with default header values.
Bad Request
func NewUpdateUserBadRequest ¶
func NewUpdateUserBadRequest() *UpdateUserBadRequest
NewUpdateUserBadRequest creates a UpdateUserBadRequest with default headers values
func (*UpdateUserBadRequest) Error ¶
func (o *UpdateUserBadRequest) Error() string
type UpdateUserNotFound ¶
type UpdateUserNotFound struct { }
UpdateUserNotFound describes a response with status code 404, with default header values.
Not Found
func NewUpdateUserNotFound ¶
func NewUpdateUserNotFound() *UpdateUserNotFound
NewUpdateUserNotFound creates a UpdateUserNotFound with default headers values
func (*UpdateUserNotFound) Error ¶
func (o *UpdateUserNotFound) Error() string
type UpdateUserOK ¶
UpdateUserOK describes a response with status code 200, with default header values.
Success
func NewUpdateUserOK ¶
func NewUpdateUserOK() *UpdateUserOK
NewUpdateUserOK creates a UpdateUserOK with default headers values
func (*UpdateUserOK) Error ¶
func (o *UpdateUserOK) Error() string
func (*UpdateUserOK) GetPayload ¶
func (o *UpdateUserOK) GetPayload() *models.UserModel
type UpdateUserParams ¶
type UpdateUserParams 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 /* AccountID. The accountID of the user you wish to update. Format: int32 */ AccountID int32 /* Body. The user object you wish to update. */ Body *models.UserModel /* ID. The ID of the user you wish to update. Format: int32 */ ID int32 Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
UpdateUserParams contains all the parameters to send to the API endpoint
for the update user operation. Typically these are written to a http.Request.
func NewUpdateUserParams ¶
func NewUpdateUserParams() *UpdateUserParams
NewUpdateUserParams creates a new UpdateUserParams 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 NewUpdateUserParamsWithContext ¶
func NewUpdateUserParamsWithContext(ctx context.Context) *UpdateUserParams
NewUpdateUserParamsWithContext creates a new UpdateUserParams object with the ability to set a context for a request.
func NewUpdateUserParamsWithHTTPClient ¶
func NewUpdateUserParamsWithHTTPClient(client *http.Client) *UpdateUserParams
NewUpdateUserParamsWithHTTPClient creates a new UpdateUserParams object with the ability to set a custom HTTPClient for a request.
func NewUpdateUserParamsWithTimeout ¶
func NewUpdateUserParamsWithTimeout(timeout time.Duration) *UpdateUserParams
NewUpdateUserParamsWithTimeout creates a new UpdateUserParams object with the ability to set a timeout on a request.
func (*UpdateUserParams) SetAccountID ¶
func (o *UpdateUserParams) SetAccountID(accountID int32)
SetAccountID adds the accountId to the update user params
func (*UpdateUserParams) SetBody ¶
func (o *UpdateUserParams) SetBody(body *models.UserModel)
SetBody adds the body to the update user params
func (*UpdateUserParams) SetContext ¶
func (o *UpdateUserParams) SetContext(ctx context.Context)
SetContext adds the context to the update user params
func (*UpdateUserParams) SetDefaults ¶
func (o *UpdateUserParams) SetDefaults()
SetDefaults hydrates default values in the update user params (not the query body).
All values with no default are reset to their zero value.
func (*UpdateUserParams) SetHTTPClient ¶
func (o *UpdateUserParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the update user params
func (*UpdateUserParams) SetID ¶
func (o *UpdateUserParams) SetID(id int32)
SetID adds the id to the update user params
func (*UpdateUserParams) SetTimeout ¶
func (o *UpdateUserParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the update user params
func (*UpdateUserParams) SetXAvalaraClient ¶
func (o *UpdateUserParams) SetXAvalaraClient(xAvalaraClient *string)
SetXAvalaraClient adds the xAvalaraClient to the update user params
func (*UpdateUserParams) WithAccountID ¶
func (o *UpdateUserParams) WithAccountID(accountID int32) *UpdateUserParams
WithAccountID adds the accountID to the update user params
func (*UpdateUserParams) WithBody ¶
func (o *UpdateUserParams) WithBody(body *models.UserModel) *UpdateUserParams
WithBody adds the body to the update user params
func (*UpdateUserParams) WithContext ¶
func (o *UpdateUserParams) WithContext(ctx context.Context) *UpdateUserParams
WithContext adds the context to the update user params
func (*UpdateUserParams) WithDefaults ¶
func (o *UpdateUserParams) WithDefaults() *UpdateUserParams
WithDefaults hydrates default values in the update user params (not the query body).
All values with no default are reset to their zero value.
func (*UpdateUserParams) WithHTTPClient ¶
func (o *UpdateUserParams) WithHTTPClient(client *http.Client) *UpdateUserParams
WithHTTPClient adds the HTTPClient to the update user params
func (*UpdateUserParams) WithID ¶
func (o *UpdateUserParams) WithID(id int32) *UpdateUserParams
WithID adds the id to the update user params
func (*UpdateUserParams) WithTimeout ¶
func (o *UpdateUserParams) WithTimeout(timeout time.Duration) *UpdateUserParams
WithTimeout adds the timeout to the update user params
func (*UpdateUserParams) WithXAvalaraClient ¶
func (o *UpdateUserParams) WithXAvalaraClient(xAvalaraClient *string) *UpdateUserParams
WithXAvalaraClient adds the xAvalaraClient to the update user params
func (*UpdateUserParams) WriteToRequest ¶
func (o *UpdateUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type UpdateUserReader ¶
type UpdateUserReader struct {
// contains filtered or unexported fields
}
UpdateUserReader is a Reader for the UpdateUser structure.
func (*UpdateUserReader) ReadResponse ¶
func (o *UpdateUserReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type UpdateUserUnauthorized ¶
type UpdateUserUnauthorized struct { }
UpdateUserUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewUpdateUserUnauthorized ¶
func NewUpdateUserUnauthorized() *UpdateUserUnauthorized
NewUpdateUserUnauthorized creates a UpdateUserUnauthorized with default headers values
func (*UpdateUserUnauthorized) Error ¶
func (o *UpdateUserUnauthorized) Error() string
Source Files
¶
- change_password_parameters.go
- change_password_responses.go
- create_users_parameters.go
- create_users_responses.go
- delete_user_parameters.go
- delete_user_responses.go
- get_user_entitlements_parameters.go
- get_user_entitlements_responses.go
- get_user_parameters.go
- get_user_responses.go
- list_users_by_account_parameters.go
- list_users_by_account_responses.go
- query_users_parameters.go
- query_users_responses.go
- update_user_parameters.go
- update_user_responses.go
- users_client.go