// 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 enrichment_runs 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 enrichment runs API client. func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService { return &Client{transport: transport, formats: formats} } // New creates a new enrichment runs 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 enrichment runs 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 enrichment runs 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 { // GetEnrichmentRun get one cited enrichment run. GetEnrichmentRun(params *GetEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrichmentRunOK, error) // GetEnrichmentRunContext get one cited enrichment run. GetEnrichmentRunContext(ctx context.Context, params *GetEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrichmentRunOK, error) // PostEnrichmentRun create a cited enrichment run. PostEnrichmentRun(params *PostEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrichmentRunCreated, error) // PostEnrichmentRunContext create a cited enrichment run. PostEnrichmentRunContext(ctx context.Context, params *PostEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrichmentRunCreated, error) SetTransport(transport runtime.ContextualTransport) } // GetEnrichmentRun gets one cited enrichment run. // // Return one durable same-tenant enrichment run with its cited candidates; requires research:enrichment-run:read. // // 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.GetEnrichmentRunContext] instead. func (a *Client) GetEnrichmentRun(params *GetEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrichmentRunOK, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.GetEnrichmentRunContext(ctx, params, authInfo, opts...) } // GetEnrichmentRunContext gets one cited enrichment run. // // Return one durable same-tenant enrichment run with its cited candidates; requires research:enrichment-run:read. // // Do not use the deprecated [GetEnrichmentRunParams.Context] with this method: it would be ignored. func (a *Client) GetEnrichmentRunContext(ctx context.Context, params *GetEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEnrichmentRunOK, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewGetEnrichmentRunParams() } op := &runtime.ClientOperation{ ID: "getEnrichmentRun", Method: "GET", PathPattern: "/enrichmentruns/{enrichmentRunId}", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &GetEnrichmentRunReader{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.(*GetEnrichmentRunOK) 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 getEnrichmentRun: API contract not enforced by server. Client expected to get an error, but got: %T", result) panic(msg) } // PostEnrichmentRun creates a cited enrichment run. // // Run bounded Account, shared-catalog Company Product, or tenant-owned Company Service web research, persist cited field candidates, and leave the authoritative subject unchanged; requires a native service principal with research:enrichment-run:create and active same-tenant contributing membership. // // 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.PostEnrichmentRunContext] instead. func (a *Client) PostEnrichmentRun(params *PostEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrichmentRunCreated, error) { var ctx context.Context if params.inner.ctx != nil { ctx = params.inner.ctx } else { ctx = context.Background() } return a.PostEnrichmentRunContext(ctx, params, authInfo, opts...) } // PostEnrichmentRunContext creates a cited enrichment run. // // Run bounded Account, shared-catalog Company Product, or tenant-owned Company Service web research, persist cited field candidates, and leave the authoritative subject unchanged; requires a native service principal with research:enrichment-run:create and active same-tenant contributing membership. // // Do not use the deprecated [PostEnrichmentRunParams.Context] with this method: it would be ignored. func (a *Client) PostEnrichmentRunContext(ctx context.Context, params *PostEnrichmentRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEnrichmentRunCreated, error) { // NOTE: parameters are not validated before sending if params == nil { params = NewPostEnrichmentRunParams() } op := &runtime.ClientOperation{ ID: "postEnrichmentRun", Method: "POST", PathPattern: "/enrichmentruns", ProducesMediaTypes: []string{"application/json"}, ConsumesMediaTypes: []string{"application/json"}, Schemes: []string{"http"}, Params: params, Reader: &PostEnrichmentRunReader{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.(*PostEnrichmentRunCreated) 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 postEnrichmentRun: 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 [EnrichmentRunsParams]. ctx context.Context }