documents

package
v0.0.0-...-5f4f26f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 13, 2019 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for documents API

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client

New creates a new documents API client.

func (*Client) DeleteDocument 

func (a *Client) DeleteDocument(params *DeleteDocumentParams) (*DeleteDocumentNoContent, error)

DeleteDocument deletes document

The delete document service allows the consumer to delete a document. The deleted <br>document will not be returned in the get documents API. The HTTP response code is 204 (success without content).<br>Documents can be deleted only if the document related dataset attributes are subscribed.<br>

func (*Client) DownloadDocument 

func (a *Client) DownloadDocument(params *DownloadDocumentParams) (*DownloadDocumentOK, error)

DownloadDocument downloads a document

The get document details service allows consumers to download a document. The document is provided in base64.<br>Documents can be downloaded only if the document related dataset attributes are subscribed. <br>

func (*Client) GetDocuments 

func (a *Client) GetDocuments(params *GetDocumentsParams) (*GetDocumentsOK, error)

GetDocuments gets documents

The get documents service allows customers to search or retrieve metadata related to documents. <br>The API returns the document as per the input parameters passed. If no date range is provided then all downloaded <br>documents will be retrieved. Details of deleted documents or documents associated to closed providerAccount will not be returned <br>Metadata related to documents can be searched or retrieved only if the document related dataset attributes are subscribed. <br>

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type DeleteDocumentBadRequest 

type DeleteDocumentBadRequest struct {
	Payload *models.YodleeError
}

DeleteDocumentBadRequest handles this case with default header values.

Y800 : Invalid value for documentID

func NewDeleteDocumentBadRequest 

func NewDeleteDocumentBadRequest() *DeleteDocumentBadRequest

NewDeleteDocumentBadRequest creates a DeleteDocumentBadRequest with default headers values

func (*DeleteDocumentBadRequest) Error 

func (o *DeleteDocumentBadRequest) Error() string

func (*DeleteDocumentBadRequest) GetPayload 

func (o *DeleteDocumentBadRequest) GetPayload() *models.YodleeError

type DeleteDocumentNoContent 

type DeleteDocumentNoContent struct {
}

DeleteDocumentNoContent handles this case with default header values.

OK

func NewDeleteDocumentNoContent 

func NewDeleteDocumentNoContent() *DeleteDocumentNoContent

NewDeleteDocumentNoContent creates a DeleteDocumentNoContent with default headers values

func (*DeleteDocumentNoContent) Error 

func (o *DeleteDocumentNoContent) Error() string

type DeleteDocumentNotFound 

type DeleteDocumentNotFound struct {
}

DeleteDocumentNotFound handles this case with default header values.

Not Found

func NewDeleteDocumentNotFound 

func NewDeleteDocumentNotFound() *DeleteDocumentNotFound

NewDeleteDocumentNotFound creates a DeleteDocumentNotFound with default headers values

func (*DeleteDocumentNotFound) Error 

func (o *DeleteDocumentNotFound) Error() string

type DeleteDocumentParams 

type DeleteDocumentParams struct {

	/*DocumentID
	  documentId

	*/
	DocumentID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DeleteDocumentParams contains all the parameters to send to the API endpoint for the delete document operation typically these are written to a http.Request

func NewDeleteDocumentParams 

func NewDeleteDocumentParams() *DeleteDocumentParams

NewDeleteDocumentParams creates a new DeleteDocumentParams object with the default values initialized.

func NewDeleteDocumentParamsWithContext 

func NewDeleteDocumentParamsWithContext(ctx context.Context) *DeleteDocumentParams

NewDeleteDocumentParamsWithContext creates a new DeleteDocumentParams object with the default values initialized, and the ability to set a context for a request

func NewDeleteDocumentParamsWithHTTPClient 

func NewDeleteDocumentParamsWithHTTPClient(client *http.Client) *DeleteDocumentParams

NewDeleteDocumentParamsWithHTTPClient creates a new DeleteDocumentParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewDeleteDocumentParamsWithTimeout 

func NewDeleteDocumentParamsWithTimeout(timeout time.Duration) *DeleteDocumentParams

NewDeleteDocumentParamsWithTimeout creates a new DeleteDocumentParams object with the default values initialized, and the ability to set a timeout on a request

func (*DeleteDocumentParams) SetContext 

func (o *DeleteDocumentParams) SetContext(ctx context.Context)

SetContext adds the context to the delete document params

func (*DeleteDocumentParams) SetDocumentID 

func (o *DeleteDocumentParams) SetDocumentID(documentID string)

SetDocumentID adds the documentId to the delete document params

func (*DeleteDocumentParams) SetHTTPClient 

func (o *DeleteDocumentParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the delete document params

func (*DeleteDocumentParams) SetTimeout 

func (o *DeleteDocumentParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the delete document params

func (*DeleteDocumentParams) WithContext 

func (o *DeleteDocumentParams) WithContext(ctx context.Context) *DeleteDocumentParams

WithContext adds the context to the delete document params

func (*DeleteDocumentParams) WithDocumentID 

func (o *DeleteDocumentParams) WithDocumentID(documentID string) *DeleteDocumentParams

WithDocumentID adds the documentID to the delete document params

func (*DeleteDocumentParams) WithHTTPClient 

func (o *DeleteDocumentParams) WithHTTPClient(client *http.Client) *DeleteDocumentParams

WithHTTPClient adds the HTTPClient to the delete document params

func (*DeleteDocumentParams) WithTimeout 

func (o *DeleteDocumentParams) WithTimeout(timeout time.Duration) *DeleteDocumentParams

WithTimeout adds the timeout to the delete document params

func (*DeleteDocumentParams) WriteToRequest 

func (o *DeleteDocumentParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DeleteDocumentReader 

type DeleteDocumentReader struct {
	// contains filtered or unexported fields
}

DeleteDocumentReader is a Reader for the DeleteDocument structure.

func (*DeleteDocumentReader) ReadResponse 

func (o *DeleteDocumentReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DeleteDocumentUnauthorized 

type DeleteDocumentUnauthorized struct {
}

DeleteDocumentUnauthorized handles this case with default header values.

Unauthorized

func NewDeleteDocumentUnauthorized 

func NewDeleteDocumentUnauthorized() *DeleteDocumentUnauthorized

NewDeleteDocumentUnauthorized creates a DeleteDocumentUnauthorized with default headers values

func (*DeleteDocumentUnauthorized) Error 

func (o *DeleteDocumentUnauthorized) Error() string

type DownloadDocumentBadRequest 

type DownloadDocumentBadRequest struct {
	Payload *models.YodleeError
}

DownloadDocumentBadRequest handles this case with default header values.

Y800 : Invalid value for documentID

func NewDownloadDocumentBadRequest 

func NewDownloadDocumentBadRequest() *DownloadDocumentBadRequest

NewDownloadDocumentBadRequest creates a DownloadDocumentBadRequest with default headers values

func (*DownloadDocumentBadRequest) Error 

func (o *DownloadDocumentBadRequest) Error() string

func (*DownloadDocumentBadRequest) GetPayload 

func (o *DownloadDocumentBadRequest) GetPayload() *models.YodleeError

type DownloadDocumentNotFound 

type DownloadDocumentNotFound struct {
}

DownloadDocumentNotFound handles this case with default header values.

Not Found

func NewDownloadDocumentNotFound 

func NewDownloadDocumentNotFound() *DownloadDocumentNotFound

NewDownloadDocumentNotFound creates a DownloadDocumentNotFound with default headers values

func (*DownloadDocumentNotFound) Error 

func (o *DownloadDocumentNotFound) Error() string

type DownloadDocumentOK 

type DownloadDocumentOK struct {
	Payload *models.DocumentDownloadResponse
}

DownloadDocumentOK handles this case with default header values.

OK

func NewDownloadDocumentOK 

func NewDownloadDocumentOK() *DownloadDocumentOK

NewDownloadDocumentOK creates a DownloadDocumentOK with default headers values

func (*DownloadDocumentOK) Error 

func (o *DownloadDocumentOK) Error() string

func (*DownloadDocumentOK) GetPayload 

func (o *DownloadDocumentOK) GetPayload() *models.DocumentDownloadResponse

type DownloadDocumentParams 

type DownloadDocumentParams struct {

	/*DocumentID
	  documentId

	*/
	DocumentID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DownloadDocumentParams contains all the parameters to send to the API endpoint for the download document operation typically these are written to a http.Request

func NewDownloadDocumentParams 

func NewDownloadDocumentParams() *DownloadDocumentParams

NewDownloadDocumentParams creates a new DownloadDocumentParams object with the default values initialized.

func NewDownloadDocumentParamsWithContext 

func NewDownloadDocumentParamsWithContext(ctx context.Context) *DownloadDocumentParams

NewDownloadDocumentParamsWithContext creates a new DownloadDocumentParams object with the default values initialized, and the ability to set a context for a request

func NewDownloadDocumentParamsWithHTTPClient 

func NewDownloadDocumentParamsWithHTTPClient(client *http.Client) *DownloadDocumentParams

NewDownloadDocumentParamsWithHTTPClient creates a new DownloadDocumentParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewDownloadDocumentParamsWithTimeout 

func NewDownloadDocumentParamsWithTimeout(timeout time.Duration) *DownloadDocumentParams

NewDownloadDocumentParamsWithTimeout creates a new DownloadDocumentParams object with the default values initialized, and the ability to set a timeout on a request

func (*DownloadDocumentParams) SetContext 

func (o *DownloadDocumentParams) SetContext(ctx context.Context)

SetContext adds the context to the download document params

func (*DownloadDocumentParams) SetDocumentID 

func (o *DownloadDocumentParams) SetDocumentID(documentID string)

SetDocumentID adds the documentId to the download document params

func (*DownloadDocumentParams) SetHTTPClient 

func (o *DownloadDocumentParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the download document params

func (*DownloadDocumentParams) SetTimeout 

func (o *DownloadDocumentParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the download document params

func (*DownloadDocumentParams) WithContext 

func (o *DownloadDocumentParams) WithContext(ctx context.Context) *DownloadDocumentParams

WithContext adds the context to the download document params

func (*DownloadDocumentParams) WithDocumentID 

func (o *DownloadDocumentParams) WithDocumentID(documentID string) *DownloadDocumentParams

WithDocumentID adds the documentID to the download document params

func (*DownloadDocumentParams) WithHTTPClient 

func (o *DownloadDocumentParams) WithHTTPClient(client *http.Client) *DownloadDocumentParams

WithHTTPClient adds the HTTPClient to the download document params

func (*DownloadDocumentParams) WithTimeout 

func (o *DownloadDocumentParams) WithTimeout(timeout time.Duration) *DownloadDocumentParams

WithTimeout adds the timeout to the download document params

func (*DownloadDocumentParams) WriteToRequest 

func (o *DownloadDocumentParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DownloadDocumentReader 

type DownloadDocumentReader struct {
	// contains filtered or unexported fields
}

DownloadDocumentReader is a Reader for the DownloadDocument structure.

func (*DownloadDocumentReader) ReadResponse 

func (o *DownloadDocumentReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DownloadDocumentUnauthorized 

type DownloadDocumentUnauthorized struct {
}

DownloadDocumentUnauthorized handles this case with default header values.

Unauthorized

func NewDownloadDocumentUnauthorized 

func NewDownloadDocumentUnauthorized() *DownloadDocumentUnauthorized

NewDownloadDocumentUnauthorized creates a DownloadDocumentUnauthorized with default headers values

func (*DownloadDocumentUnauthorized) Error 

func (o *DownloadDocumentUnauthorized) Error() string

type GetDocumentsBadRequest 

type GetDocumentsBadRequest struct {
	Payload *models.YodleeError
}

GetDocumentsBadRequest handles this case with default header values.

Y800 : Invalid value for accountId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for docType

func NewGetDocumentsBadRequest 

func NewGetDocumentsBadRequest() *GetDocumentsBadRequest

NewGetDocumentsBadRequest creates a GetDocumentsBadRequest with default headers values

func (*GetDocumentsBadRequest) Error 

func (o *GetDocumentsBadRequest) Error() string

func (*GetDocumentsBadRequest) GetPayload 

func (o *GetDocumentsBadRequest) GetPayload() *models.YodleeError

type GetDocumentsNotFound 

type GetDocumentsNotFound struct {
}

GetDocumentsNotFound handles this case with default header values.

Not Found

func NewGetDocumentsNotFound 

func NewGetDocumentsNotFound() *GetDocumentsNotFound

NewGetDocumentsNotFound creates a GetDocumentsNotFound with default headers values

func (*GetDocumentsNotFound) Error 

func (o *GetDocumentsNotFound) Error() string

type GetDocumentsOK 

type GetDocumentsOK struct {
	Payload *models.DocumentResponse
}

GetDocumentsOK handles this case with default header values.

OK

func NewGetDocumentsOK 

func NewGetDocumentsOK() *GetDocumentsOK

NewGetDocumentsOK creates a GetDocumentsOK with default headers values

func (*GetDocumentsOK) Error 

func (o *GetDocumentsOK) Error() string

func (*GetDocumentsOK) GetPayload 

func (o *GetDocumentsOK) GetPayload() *models.DocumentResponse

type GetDocumentsParams 

type GetDocumentsParams struct {

	/*Keyword
	  The string used to search a document by its name.

	*/
	Keyword *string
	/*AccountID
	  The unique identifier of an account. Retrieve documents for a given accountId.

	*/
	AccountID *string
	/*DocType
	  Accepts only one of the following valid document types: STMT, TAX, and EBILL.

	*/
	DocType *string
	/*FromDate
	  The date from which documents have to be retrieved.

	*/
	FromDate *string
	/*ToDate
	  The date to which documents have to be retrieved.

	*/
	ToDate *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetDocumentsParams contains all the parameters to send to the API endpoint for the get documents operation typically these are written to a http.Request

func NewGetDocumentsParams 

func NewGetDocumentsParams() *GetDocumentsParams

NewGetDocumentsParams creates a new GetDocumentsParams object with the default values initialized.

func NewGetDocumentsParamsWithContext 

func NewGetDocumentsParamsWithContext(ctx context.Context) *GetDocumentsParams

NewGetDocumentsParamsWithContext creates a new GetDocumentsParams object with the default values initialized, and the ability to set a context for a request

func NewGetDocumentsParamsWithHTTPClient 

func NewGetDocumentsParamsWithHTTPClient(client *http.Client) *GetDocumentsParams

NewGetDocumentsParamsWithHTTPClient creates a new GetDocumentsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetDocumentsParamsWithTimeout 

func NewGetDocumentsParamsWithTimeout(timeout time.Duration) *GetDocumentsParams

NewGetDocumentsParamsWithTimeout creates a new GetDocumentsParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetDocumentsParams) SetAccountID 

func (o *GetDocumentsParams) SetAccountID(accountID *string)

SetAccountID adds the accountId to the get documents params

func (*GetDocumentsParams) SetContext 

func (o *GetDocumentsParams) SetContext(ctx context.Context)

SetContext adds the context to the get documents params

func (*GetDocumentsParams) SetDocType 

func (o *GetDocumentsParams) SetDocType(docType *string)

SetDocType adds the docType to the get documents params

func (*GetDocumentsParams) SetFromDate 

func (o *GetDocumentsParams) SetFromDate(fromDate *string)

SetFromDate adds the fromDate to the get documents params

func (*GetDocumentsParams) SetHTTPClient 

func (o *GetDocumentsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get documents params

func (*GetDocumentsParams) SetKeyword 

func (o *GetDocumentsParams) SetKeyword(keyword *string)

SetKeyword adds the keyword to the get documents params

func (*GetDocumentsParams) SetTimeout 

func (o *GetDocumentsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get documents params

func (*GetDocumentsParams) SetToDate 

func (o *GetDocumentsParams) SetToDate(toDate *string)

SetToDate adds the toDate to the get documents params

func (*GetDocumentsParams) WithAccountID 

func (o *GetDocumentsParams) WithAccountID(accountID *string) *GetDocumentsParams

WithAccountID adds the accountID to the get documents params

func (*GetDocumentsParams) WithContext 

func (o *GetDocumentsParams) WithContext(ctx context.Context) *GetDocumentsParams

WithContext adds the context to the get documents params

func (*GetDocumentsParams) WithDocType 

func (o *GetDocumentsParams) WithDocType(docType *string) *GetDocumentsParams

WithDocType adds the docType to the get documents params

func (*GetDocumentsParams) WithFromDate 

func (o *GetDocumentsParams) WithFromDate(fromDate *string) *GetDocumentsParams

WithFromDate adds the fromDate to the get documents params

func (*GetDocumentsParams) WithHTTPClient 

func (o *GetDocumentsParams) WithHTTPClient(client *http.Client) *GetDocumentsParams

WithHTTPClient adds the HTTPClient to the get documents params

func (*GetDocumentsParams) WithKeyword 

func (o *GetDocumentsParams) WithKeyword(keyword *string) *GetDocumentsParams

WithKeyword adds the keyword to the get documents params

func (*GetDocumentsParams) WithTimeout 

func (o *GetDocumentsParams) WithTimeout(timeout time.Duration) *GetDocumentsParams

WithTimeout adds the timeout to the get documents params

func (*GetDocumentsParams) WithToDate 

func (o *GetDocumentsParams) WithToDate(toDate *string) *GetDocumentsParams

WithToDate adds the toDate to the get documents params

func (*GetDocumentsParams) WriteToRequest 

func (o *GetDocumentsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetDocumentsReader 

type GetDocumentsReader struct {
	// contains filtered or unexported fields
}

GetDocumentsReader is a Reader for the GetDocuments structure.

func (*GetDocumentsReader) ReadResponse 

func (o *GetDocumentsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetDocumentsUnauthorized 

type GetDocumentsUnauthorized struct {
}

GetDocumentsUnauthorized handles this case with default header values.

Unauthorized

func NewGetDocumentsUnauthorized 

func NewGetDocumentsUnauthorized() *GetDocumentsUnauthorized

NewGetDocumentsUnauthorized creates a GetDocumentsUnauthorized with default headers values

func (*GetDocumentsUnauthorized) Error 

func (o *GetDocumentsUnauthorized) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.