// Code generated by go-swagger; DO NOT EDIT. // (c) 2012-2020 by Taxnexus, Inc. // All rights reserved worldwide. // Proprietary product; unlicensed use is not allowed package users import ( "context" "fmt" "time" "github.com/go-openapi/runtime" httptransport "github.com/go-openapi/runtime/client" "github.com/go-openapi/strfmt" ) // New creates a new users API client. func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService { return &Client{transport: transport, formats: formats} } // New creates a new users API client with basic auth credentials. // // It takes the following parameters: // - host: http host (github.com). // - basePath: any base path for the API client ("/v1", "/v3"). // - scheme: http scheme ("http", "https"). // - user: user for basic authentication header. // - password: password for basic authentication header. func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService { transport := httptransport.New(host, basePath, []string{scheme}) transport.DefaultAuthentication = httptransport.BasicAuth(user, password) return &Client{transport: transport, formats: strfmt.Default} } // New creates a new users API client with a bearer token for authentication. // // It takes the following parameters: // - host: http host (github.com). // - basePath: any base path for the API client ("/v1", "/v3"). // - scheme: http scheme ("http", "https"). // - bearerToken: bearer token for Bearer authentication header. func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService { transport := httptransport.New(host, basePath, []string{scheme}) transport.DefaultAuthentication = httptransport.BearerToken(bearerToken) return &Client{transport: transport, formats: strfmt.Default} } // Client for users API. type Client struct { transport runtime.ContextualTransport formats strfmt.Registry } // ClientOption may be used to customize the behavior of Client methods. type ClientOption func(*runtime.ClientOperation) // ClientService is the interface for Client methods. type ClientService interface { // GetUsers get a list users. GetUsers(params *GetUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUsersOK, error) // GetUsersContext get a list users. GetUsersContext(ctx context.Context, params *GetUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUsersOK, error) // PostUsers create new users. PostUsers(params *PostUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOK, error) // PostUsersContext create new users. PostUsersContext(ctx context.Context, params *PostUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOK, error) // PostUsersOnboard async onboard new users. PostUsersOnboard(params *PostUsersOnboardParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOnboardOK, error) // PostUsersOnboardContext async onboard new users. PostUsersOnboardContext(ctx context.Context, params *PostUsersOnboardParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOnboardOK, error) // PutUsers update existing users. PutUsers(params *PutUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutUsersOK, error) // PutUsersContext update existing users. PutUsersContext(ctx context.Context, params *PutUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutUsersOK, error) SetTransport(transport runtime.ContextualTransport) } // GetUsers gets a list users. // // Return a list of User records from the datastore. // // This method does not support injected context. // However, timeout and opentracing contexts are honored whenever enabled. // // If you need to pass a specific context, use [Client.GetUsersContext] instead. func (a *Client) GetUsers(params *GetUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUsersOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.GetUsersContext(ctx, params, authInfo, opts...) } // GetUsersContext gets a list users. // // Return a list of User records from the datastore. // // Do not use the deprecated [GetUsersParams.Context] with this method: it would be ignored. func (a *Client) GetUsersContext(ctx context.Context, params *GetUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetUsersOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewGetUsersParams() } op := &runtime.ClientOperation{ ID: "getUsers", Method: "GET", PathPattern: "/users", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &GetUsersReader{formats: a.formats}, AuthInfo: authInfo, Client: params.HTTPClient, } for _, opt := range opts { opt(op) } result, err := a.transport.SubmitContext(ctx, op) if err != nil { return nil, err } // only one success response has to be checked success, ok := result.(*GetUsersOK) if ok { return success, nil } // unexpected success response. // no default response is defined. // // safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue msg := fmt.Sprintf("unexpected success response for getUsers: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PostUsers creates new users. // // Create new Users. // // This method does not support injected context. // However, timeout and opentracing contexts are honored whenever enabled. // // If you need to pass a specific context, use [Client.PostUsersContext] instead. func (a *Client) PostUsers(params *PostUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PostUsersContext(ctx, params, authInfo, opts...) } // PostUsersContext creates new users. // // Create new Users. // // Do not use the deprecated [PostUsersParams.Context] with this method: it would be ignored. func (a *Client) PostUsersContext(ctx context.Context, params *PostUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPostUsersParams() } op := &runtime.ClientOperation{ ID: "postUsers", Method: "POST", PathPattern: "/users", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PostUsersReader{formats: a.formats}, AuthInfo: authInfo, Client: params.HTTPClient, } for _, opt := range opts { opt(op) } result, err := a.transport.SubmitContext(ctx, op) if err != nil { return nil, err } // only one success response has to be checked success, ok := result.(*PostUsersOK) if ok { return success, nil } // unexpected success response. // no default response is defined. // // safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue msg := fmt.Sprintf("unexpected success response for postUsers: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PostUsersOnboard asyncs onboard new users. // // Async onboard new users. // // This method does not support injected context. // However, timeout and opentracing contexts are honored whenever enabled. // // If you need to pass a specific context, use [Client.PostUsersOnboardContext] instead. func (a *Client) PostUsersOnboard(params *PostUsersOnboardParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOnboardOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PostUsersOnboardContext(ctx, params, authInfo, opts...) } // PostUsersOnboardContext asyncs onboard new users. // // Async onboard new users. // // Do not use the deprecated [PostUsersOnboardParams.Context] with this method: it would be ignored. func (a *Client) PostUsersOnboardContext(ctx context.Context, params *PostUsersOnboardParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostUsersOnboardOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPostUsersOnboardParams() } op := &runtime.ClientOperation{ ID: "postUsersOnboard", Method: "POST", PathPattern: "/users/onboard", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PostUsersOnboardReader{formats: a.formats}, AuthInfo: authInfo, Client: params.HTTPClient, } for _, opt := range opts { opt(op) } result, err := a.transport.SubmitContext(ctx, op) if err != nil { return nil, err } // only one success response has to be checked success, ok := result.(*PostUsersOnboardOK) if ok { return success, nil } // unexpected success response. // no default response is defined. // // safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue msg := fmt.Sprintf("unexpected success response for postUsersOnboard: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PutUsers updates existing users. // // Update existing users. // // This method does not support injected context. // However, timeout and opentracing contexts are honored whenever enabled. // // If you need to pass a specific context, use [Client.PutUsersContext] instead. func (a *Client) PutUsers(params *PutUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutUsersOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PutUsersContext(ctx, params, authInfo, opts...) } // PutUsersContext updates existing users. // // Update existing users. // // Do not use the deprecated [PutUsersParams.Context] with this method: it would be ignored. func (a *Client) PutUsersContext(ctx context.Context, params *PutUsersParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutUsersOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPutUsersParams() } op := &runtime.ClientOperation{ ID: "putUsers", Method: "PUT", PathPattern: "/users", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PutUsersReader{formats: a.formats}, AuthInfo: authInfo, Client: params.HTTPClient, } for _, opt := range opts { opt(op) } result, err := a.transport.SubmitContext(ctx, op) if err != nil { return nil, err } // only one success response has to be checked success, ok := result.(*PutUsersOK) if ok { return success, nil } // unexpected success response. // no default response is defined. // // safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue msg := fmt.Sprintf("unexpected success response for putUsers: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // SetTransport changes the transport on the client func (a *Client) SetTransport(transport runtime.ContextualTransport) { a.transport = transport } // innerParams captures internal fields so they don't conflict with user-supplied parameters. type innerParams struct { timeout time.Duration // Deprecated: use the operation call with context to pass the context instead of [UsersParams]. ctx context.Context }