lib/api/research/research_client/observations/observations_client.go

// 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 observations

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 observations API client.
func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService {
	return &Client{transport: transport, formats: formats}
}

// New creates a new observations 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 observations 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 observations 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 {

	// DeleteObservation delete an observation.
	DeleteObservation(params *DeleteObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteObservationOK, error)

	// DeleteObservationContext delete an observation.
	DeleteObservationContext(ctx context.Context, params *DeleteObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteObservationOK, error)

	// GetObservations get a list of observations.
	GetObservations(params *GetObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetObservationsOK, error)

	// GetObservationsContext get a list of observations.
	GetObservationsContext(ctx context.Context, params *GetObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetObservationsOK, error)

	// PostObservations add a new observation to salesforce devops net.
	PostObservations(params *PostObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostObservationsOK, error)

	// PostObservationsContext add a new observation to salesforce devops net.
	PostObservationsContext(ctx context.Context, params *PostObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostObservationsOK, error)

	// PutObservation update a single observation.
	PutObservation(params *PutObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutObservationOK, error)

	// PutObservationContext update a single observation.
	PutObservationContext(ctx context.Context, params *PutObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutObservationOK, error)

	SetTransport(transport runtime.ContextualTransport)
}

// DeleteObservation deletes an observation.
//
// Delete Observation record.
//
// 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.DeleteObservationContext] instead.
func (a *Client) DeleteObservation(params *DeleteObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteObservationOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.DeleteObservationContext(ctx, params, authInfo, opts...)
}

// DeleteObservationContext deletes an observation.
//
// Delete Observation record.
//
// Do not use the deprecated [DeleteObservationParams.Context] with this method: it would be ignored.
func (a *Client) DeleteObservationContext(ctx context.Context, params *DeleteObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteObservationOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewDeleteObservationParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "deleteObservation",
		Method:             "DELETE",
		PathPattern:        "/observations",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &DeleteObservationReader{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.(*DeleteObservationOK)
	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 deleteObservation: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// GetObservations gets a list of observations.
//
// Return a list of all available Observations.
//
// 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.GetObservationsContext] instead.
func (a *Client) GetObservations(params *GetObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetObservationsOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.GetObservationsContext(ctx, params, authInfo, opts...)
}

// GetObservationsContext gets a list of observations.
//
// Return a list of all available Observations.
//
// Do not use the deprecated [GetObservationsParams.Context] with this method: it would be ignored.
func (a *Client) GetObservationsContext(ctx context.Context, params *GetObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetObservationsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewGetObservationsParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "getObservations",
		Method:             "GET",
		PathPattern:        "/observations",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &GetObservationsReader{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.(*GetObservationsOK)
	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 getObservations: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// PostObservations adds a new observation to salesforce devops net.
//
// Observation record to be added.
//
// 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.PostObservationsContext] instead.
func (a *Client) PostObservations(params *PostObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostObservationsOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.PostObservationsContext(ctx, params, authInfo, opts...)
}

// PostObservationsContext adds a new observation to salesforce devops net.
//
// Observation record to be added.
//
// Do not use the deprecated [PostObservationsParams.Context] with this method: it would be ignored.
func (a *Client) PostObservationsContext(ctx context.Context, params *PostObservationsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostObservationsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPostObservationsParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "postObservations",
		Method:             "POST",
		PathPattern:        "/observations",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &PostObservationsReader{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.(*PostObservationsOK)
	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 postObservations: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// PutObservation updates a single observation.
//
// Update a single observation specified by observationId.
//
// 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.PutObservationContext] instead.
func (a *Client) PutObservation(params *PutObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutObservationOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.PutObservationContext(ctx, params, authInfo, opts...)
}

// PutObservationContext updates a single observation.
//
// Update a single observation specified by observationId.
//
// Do not use the deprecated [PutObservationParams.Context] with this method: it would be ignored.
func (a *Client) PutObservationContext(ctx context.Context, params *PutObservationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutObservationOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPutObservationParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "putObservation",
		Method:             "PUT",
		PathPattern:        "/observations",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &PutObservationReader{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.(*PutObservationOK)
	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 putObservation: 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 [ObservationsParams].
	ctx context.Context
}