// 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 enrollments 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 enrollments API client. func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService { return &Client{transport: transport, formats: formats} } // New creates a new enrollments 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 enrollments 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 enrollments 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 { // GetEnrollments get a list enrollments. GetEnrollments(params *GetEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrollmentsOK, error) // GetEnrollmentsContext get a list enrollments. GetEnrollmentsContext(ctx context.Context, params *GetEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrollmentsOK, error) // PostEnrollments create new enrollments. PostEnrollments(params *PostEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrollmentsOK, error) // PostEnrollmentsContext create new enrollments. PostEnrollmentsContext(ctx context.Context, params *PostEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrollmentsOK, error) // PutEnrollments update enrollment. PutEnrollments(params *PutEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEnrollmentsOK, error) // PutEnrollmentsContext update enrollment. PutEnrollmentsContext(ctx context.Context, params *PutEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEnrollmentsOK, error) SetTransport(transport runtime.ContextualTransport) } // GetEnrollments gets a list enrollments. // // Return a list of Enrollment 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.GetEnrollmentsContext] instead. func (a *Client) GetEnrollments(params *GetEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrollmentsOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.GetEnrollmentsContext(ctx, params, authInfo, opts...) } // GetEnrollmentsContext gets a list enrollments. // // Return a list of Enrollment records from the datastore. // // Do not use the deprecated [GetEnrollmentsParams.Context] with this method: it would be ignored. func (a *Client) GetEnrollmentsContext(ctx context.Context, params *GetEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrollmentsOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewGetEnrollmentsParams() } op := &runtime.ClientOperation{ ID: "getEnrollments", Method: "GET", PathPattern: "/enrollments", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &GetEnrollmentsReader{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.(*GetEnrollmentsOK) 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 getEnrollments: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PostEnrollments creates new enrollments. // // Create Enrollments. // // 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.PostEnrollmentsContext] instead. func (a *Client) PostEnrollments(params *PostEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrollmentsOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PostEnrollmentsContext(ctx, params, authInfo, opts...) } // PostEnrollmentsContext creates new enrollments. // // Create Enrollments. // // Do not use the deprecated [PostEnrollmentsParams.Context] with this method: it would be ignored. func (a *Client) PostEnrollmentsContext(ctx context.Context, params *PostEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrollmentsOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPostEnrollmentsParams() } op := &runtime.ClientOperation{ ID: "postEnrollments", Method: "POST", PathPattern: "/enrollments", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PostEnrollmentsReader{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.(*PostEnrollmentsOK) 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 postEnrollments: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PutEnrollments updates enrollment. // // Update Enrollment. // // 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.PutEnrollmentsContext] instead. func (a *Client) PutEnrollments(params *PutEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEnrollmentsOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PutEnrollmentsContext(ctx, params, authInfo, opts...) } // PutEnrollmentsContext updates enrollment. // // Update Enrollment. // // Do not use the deprecated [PutEnrollmentsParams.Context] with this method: it would be ignored. func (a *Client) PutEnrollmentsContext(ctx context.Context, params *PutEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEnrollmentsOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPutEnrollmentsParams() } op := &runtime.ClientOperation{ ID: "putEnrollments", Method: "PUT", PathPattern: "/enrollments", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PutEnrollmentsReader{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.(*PutEnrollmentsOK) 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 putEnrollments: 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 [EnrollmentsParams]. ctx context.Context }