lib/api/sfgate/sfgate_client/documents/documents_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 documents

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

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

	// GetDocuments get a list documents.
	GetDocuments(params *GetDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetDocumentsOK, error)

	// GetDocumentsContext get a list documents.
	GetDocumentsContext(ctx context.Context, params *GetDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetDocumentsOK, error)

	// PostDocuments create new documents.
	PostDocuments(params *PostDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostDocumentsCreated, error)

	// PostDocumentsContext create new documents.
	PostDocumentsContext(ctx context.Context, params *PostDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostDocumentsCreated, error)

	// PutDocuments update documents.
	PutDocuments(params *PutDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutDocumentsOK, error)

	// PutDocumentsContext update documents.
	PutDocumentsContext(ctx context.Context, params *PutDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutDocumentsOK, error)

	SetTransport(transport runtime.ContextualTransport)
}

// GetDocuments gets a list documents.
//
// Return a list of Document 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.GetDocumentsContext] instead.
func (a *Client) GetDocuments(params *GetDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetDocumentsOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

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

// GetDocumentsContext gets a list documents.
//
// Return a list of Document records from the datastore.
//
// Do not use the deprecated [GetDocumentsParams.Context] with this method: it would be ignored.
func (a *Client) GetDocumentsContext(ctx context.Context, params *GetDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetDocumentsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewGetDocumentsParams()
	}

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

// PostDocuments creates new documents.
//
// Create Documents in Salesforce.
//
// 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.PostDocumentsContext] instead.
func (a *Client) PostDocuments(params *PostDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostDocumentsCreated, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

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

// PostDocumentsContext creates new documents.
//
// Create Documents in Salesforce.
//
// Do not use the deprecated [PostDocumentsParams.Context] with this method: it would be ignored.
func (a *Client) PostDocumentsContext(ctx context.Context, params *PostDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostDocumentsCreated, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPostDocumentsParams()
	}

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

// PutDocuments updates documents.
//
// Update Document in Salesforce.
//
// 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.PutDocumentsContext] instead.
func (a *Client) PutDocuments(params *PutDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutDocumentsOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

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

// PutDocumentsContext updates documents.
//
// Update Document in Salesforce.
//
// Do not use the deprecated [PutDocumentsParams.Context] with this method: it would be ignored.
func (a *Client) PutDocumentsContext(ctx context.Context, params *PutDocumentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutDocumentsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPutDocumentsParams()
	}

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