// 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 lesson_progress 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 lesson progress API client. func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService { return &Client{transport: transport, formats: formats} } // New creates a new lesson progress 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 lesson progress 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 lesson progress 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 { // GetLessonProgresses get a list lesson progresses. GetLessonProgresses(params *GetLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetLessonProgressesOK, error) // GetLessonProgressesContext get a list lesson progresses. GetLessonProgressesContext(ctx context.Context, params *GetLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetLessonProgressesOK, error) // PostLessonProgresses create new lesson progresses. PostLessonProgresses(params *PostLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostLessonProgressesOK, error) // PostLessonProgressesContext create new lesson progresses. PostLessonProgressesContext(ctx context.Context, params *PostLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostLessonProgressesOK, error) // PutLessonProgresses update lesson progress. PutLessonProgresses(params *PutLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutLessonProgressesOK, error) // PutLessonProgressesContext update lesson progress. PutLessonProgressesContext(ctx context.Context, params *PutLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutLessonProgressesOK, error) SetTransport(transport runtime.ContextualTransport) } // GetLessonProgresses gets a list lesson progresses. // // Return a list of LessonProgress 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.GetLessonProgressesContext] instead. func (a *Client) GetLessonProgresses(params *GetLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetLessonProgressesOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.GetLessonProgressesContext(ctx, params, authInfo, opts...) } // GetLessonProgressesContext gets a list lesson progresses. // // Return a list of LessonProgress records from the datastore. // // Do not use the deprecated [GetLessonProgressesParams.Context] with this method: it would be ignored. func (a *Client) GetLessonProgressesContext(ctx context.Context, params *GetLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetLessonProgressesOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewGetLessonProgressesParams() } op := &runtime.ClientOperation{ ID: "getLessonProgresses", Method: "GET", PathPattern: "/lessonprogress", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &GetLessonProgressesReader{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.(*GetLessonProgressesOK) 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 getLessonProgresses: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PostLessonProgresses creates new lesson progresses. // // Create LessonProgresses. // // 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.PostLessonProgressesContext] instead. func (a *Client) PostLessonProgresses(params *PostLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostLessonProgressesOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PostLessonProgressesContext(ctx, params, authInfo, opts...) } // PostLessonProgressesContext creates new lesson progresses. // // Create LessonProgresses. // // Do not use the deprecated [PostLessonProgressesParams.Context] with this method: it would be ignored. func (a *Client) PostLessonProgressesContext(ctx context.Context, params *PostLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostLessonProgressesOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPostLessonProgressesParams() } op := &runtime.ClientOperation{ ID: "postLessonProgresses", Method: "POST", PathPattern: "/lessonprogress", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PostLessonProgressesReader{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.(*PostLessonProgressesOK) 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 postLessonProgresses: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PutLessonProgresses updates lesson progress. // // Update LessonProgress. // // 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.PutLessonProgressesContext] instead. func (a *Client) PutLessonProgresses(params *PutLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutLessonProgressesOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PutLessonProgressesContext(ctx, params, authInfo, opts...) } // PutLessonProgressesContext updates lesson progress. // // Update LessonProgress. // // Do not use the deprecated [PutLessonProgressesParams.Context] with this method: it would be ignored. func (a *Client) PutLessonProgressesContext(ctx context.Context, params *PutLessonProgressesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutLessonProgressesOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPutLessonProgressesParams() } op := &runtime.ClientOperation{ ID: "putLessonProgresses", Method: "PUT", PathPattern: "/lessonprogress", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PutLessonProgressesReader{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.(*PutLessonProgressesOK) 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 putLessonProgresses: 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 [LessonProgressParams]. ctx context.Context }