lib/api/sfgate/sfgate_client/users/get_users_parameters.go

307 lines
6.6 KiB
Go
Raw Normal View History

2021-07-31 03:05:02 +00:00
// Code generated by go-swagger; DO NOT EDIT.
2021-08-05 19:37:53 +00:00
// (c) 2012-2020 by Taxnexus, Inc.
2021-07-31 03:05:02 +00:00
// All rights reserved worldwide.
// Proprietary product; unlicensed use is not allowed
2021-08-05 19:37:53 +00:00
package users
2021-07-31 03:05:02 +00:00
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
"context"
"net/http"
"time"
"github.com/go-openapi/errors"
"github.com/go-openapi/runtime"
cr "github.com/go-openapi/runtime/client"
"github.com/go-openapi/strfmt"
2021-08-05 19:37:53 +00:00
"github.com/go-openapi/swag"
2021-07-31 03:05:02 +00:00
)
// NewGetUsersParams creates a new GetUsersParams 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 NewGetUsersParams() *GetUsersParams {
return &GetUsersParams{
timeout: cr.DefaultTimeout,
}
}
// NewGetUsersParamsWithTimeout creates a new GetUsersParams object
// with the ability to set a timeout on a request.
func NewGetUsersParamsWithTimeout(timeout time.Duration) *GetUsersParams {
return &GetUsersParams{
timeout: timeout,
}
}
// NewGetUsersParamsWithContext creates a new GetUsersParams object
// with the ability to set a context for a request.
func NewGetUsersParamsWithContext(ctx context.Context) *GetUsersParams {
return &GetUsersParams{
Context: ctx,
}
}
// NewGetUsersParamsWithHTTPClient creates a new GetUsersParams object
// with the ability to set a custom HTTPClient for a request.
func NewGetUsersParamsWithHTTPClient(client *http.Client) *GetUsersParams {
return &GetUsersParams{
HTTPClient: client,
}
}
/* GetUsersParams contains all the parameters to send to the API endpoint
for the get users operation.
Typically these are written to a http.Request.
*/
type GetUsersParams struct {
2021-08-05 19:37:53 +00:00
/* Active.
2021-08-14 22:34:08 +00:00
Only retrieve active records?
2021-08-05 19:37:53 +00:00
*/
Active *bool
2021-07-31 03:05:02 +00:00
/* Apikey.
2021-08-05 19:37:53 +00:00
Taxnexus Id of the User to be retrieved
2021-07-31 03:05:02 +00:00
*/
Apikey *string
2021-08-05 19:37:53 +00:00
/* Limit.
How many objects to return at one time
Format: int64
*/
Limit *int64
/* Offset.
2021-08-14 22:34:08 +00:00
How many objects to skip?
2021-08-05 19:37:53 +00:00
Format: int64
*/
Offset *int64
/* UserID.
Taxnexus Id of the User to be retrieved
*/
UserID *string
2021-07-31 03:05:02 +00:00
timeout time.Duration
Context context.Context
HTTPClient *http.Client
}
// WithDefaults hydrates default values in the get users params (not the query body).
//
// All values with no default are reset to their zero value.
func (o *GetUsersParams) WithDefaults() *GetUsersParams {
o.SetDefaults()
return o
}
// SetDefaults hydrates default values in the get users params (not the query body).
//
// All values with no default are reset to their zero value.
func (o *GetUsersParams) SetDefaults() {
// no default values defined for this parameter
}
// WithTimeout adds the timeout to the get users params
func (o *GetUsersParams) WithTimeout(timeout time.Duration) *GetUsersParams {
o.SetTimeout(timeout)
return o
}
// SetTimeout adds the timeout to the get users params
func (o *GetUsersParams) SetTimeout(timeout time.Duration) {
o.timeout = timeout
}
// WithContext adds the context to the get users params
func (o *GetUsersParams) WithContext(ctx context.Context) *GetUsersParams {
o.SetContext(ctx)
return o
}
// SetContext adds the context to the get users params
func (o *GetUsersParams) SetContext(ctx context.Context) {
o.Context = ctx
}
// WithHTTPClient adds the HTTPClient to the get users params
func (o *GetUsersParams) WithHTTPClient(client *http.Client) *GetUsersParams {
o.SetHTTPClient(client)
return o
}
// SetHTTPClient adds the HTTPClient to the get users params
func (o *GetUsersParams) SetHTTPClient(client *http.Client) {
o.HTTPClient = client
}
2021-08-05 19:37:53 +00:00
// WithActive adds the active to the get users params
func (o *GetUsersParams) WithActive(active *bool) *GetUsersParams {
o.SetActive(active)
return o
}
// SetActive adds the active to the get users params
func (o *GetUsersParams) SetActive(active *bool) {
o.Active = active
}
2021-07-31 03:05:02 +00:00
// WithApikey adds the apikey to the get users params
func (o *GetUsersParams) WithApikey(apikey *string) *GetUsersParams {
o.SetApikey(apikey)
return o
}
// SetApikey adds the apikey to the get users params
func (o *GetUsersParams) SetApikey(apikey *string) {
o.Apikey = apikey
}
2021-08-05 19:37:53 +00:00
// WithLimit adds the limit to the get users params
func (o *GetUsersParams) WithLimit(limit *int64) *GetUsersParams {
o.SetLimit(limit)
return o
}
// SetLimit adds the limit to the get users params
func (o *GetUsersParams) SetLimit(limit *int64) {
o.Limit = limit
}
// WithOffset adds the offset to the get users params
func (o *GetUsersParams) WithOffset(offset *int64) *GetUsersParams {
o.SetOffset(offset)
return o
}
// SetOffset adds the offset to the get users params
func (o *GetUsersParams) SetOffset(offset *int64) {
o.Offset = offset
}
// WithUserID adds the userID to the get users params
func (o *GetUsersParams) WithUserID(userID *string) *GetUsersParams {
o.SetUserID(userID)
return o
}
// SetUserID adds the userId to the get users params
func (o *GetUsersParams) SetUserID(userID *string) {
o.UserID = userID
}
2021-07-31 03:05:02 +00:00
// WriteToRequest writes these params to a swagger request
func (o *GetUsersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error {
if err := r.SetTimeout(o.timeout); err != nil {
return err
}
var res []error
2021-08-05 19:37:53 +00:00
if o.Active != nil {
// query param active
var qrActive bool
if o.Active != nil {
qrActive = *o.Active
}
qActive := swag.FormatBool(qrActive)
if qActive != "" {
if err := r.SetQueryParam("active", qActive); err != nil {
return err
}
}
}
2021-07-31 03:05:02 +00:00
if o.Apikey != nil {
// query param apikey
var qrApikey string
if o.Apikey != nil {
qrApikey = *o.Apikey
}
qApikey := qrApikey
if qApikey != "" {
if err := r.SetQueryParam("apikey", qApikey); err != nil {
return err
}
}
}
2021-08-05 19:37:53 +00:00
if o.Limit != nil {
// query param limit
var qrLimit int64
if o.Limit != nil {
qrLimit = *o.Limit
}
qLimit := swag.FormatInt64(qrLimit)
if qLimit != "" {
if err := r.SetQueryParam("limit", qLimit); err != nil {
return err
}
}
}
if o.Offset != nil {
// query param offset
var qrOffset int64
if o.Offset != nil {
qrOffset = *o.Offset
}
qOffset := swag.FormatInt64(qrOffset)
if qOffset != "" {
if err := r.SetQueryParam("offset", qOffset); err != nil {
return err
}
}
}
if o.UserID != nil {
// query param userId
var qrUserID string
if o.UserID != nil {
qrUserID = *o.UserID
}
qUserID := qrUserID
if qUserID != "" {
if err := r.SetQueryParam("userId", qUserID); err != nil {
return err
}
}
}
2021-07-31 03:05:02 +00:00
if len(res) > 0 {
return errors.CompositeValidationError(res...)
}
return nil
}