providers

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: 11 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 providers API

func New 

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

New creates a new providers API client.

func (*Client) GetAllProviders 

func (a *Client) GetAllProviders(params *GetAllProvidersParams) (*GetAllProvidersOK, error)

GetAllProviders gets providers

The get provider service is used to get all the providers that are enabled, <br>search a provider service by name or routing number and get popular sites of a region. <br>The valid values for priority are: <br> 1. cobrand: Returns providers enabled for the cobrand (Default priority)<br> 2. popular: Returns providers popular among users of the customer<br><br>Datasets,attributes and containers that are enabled for the customer alone will be returned in the response<br>Input for the dataset$filter should adhere to the following expression:<br><dataset.name>[<attribute.name>.container[<container> OR <container>] OR <attribute.name>.container[<container>]] <br>OR <dataset.name>[<attribute.name> OR <attribute.name>]<br><b>dataset$filter value examples:</b><br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank OR investment OR creditCard]]<br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA[ACCOUNT_DETAILS.container[bank OR investment] OR HOLDINGS.container[bank]] OR ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA<br>BASIC_AGG_DATA OR ACCT_PROFILE<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENT <br>BASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ] <br><br><b>Note:</b> <br>1. When this service is invoked without any filters, the service performs slowly and takes a few minutes to return data in the response.<br>2. The recommendation is to use this service with filters when used in a flow involving user interactions.

func (*Client) GetProvider 

func (a *Client) GetProvider(params *GetProviderParams) (*GetProviderOK, error)

GetProvider gets provider details

The get provider detail service is used to get detailed information including the login form for a provider.<br>The response is a provider object that includes information such as name of the provider, <br>provider's base URL, a list of containers supported by the provider, the login form details of the provider, etc.<br>Only enabled datasets, attributes and containers gets returned in the response.<br>

func (*Client) GetProvidersCount 

func (a *Client) GetProvidersCount(params *GetProvidersCountParams) (*GetProvidersCountOK, error)

GetProvidersCount gets providers count

The count service provides the total number of providers that get returned in the GET /providers depending on the input parameters passed.<br>If you are implementing pagination for providers, call this endpoint before calling GET /providers to know the number of providers that are returned for the input parameters passed.<br>The functionality of the input parameters remains the same as that of the GET /providers endpoint<br>.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type GetAllProvidersBadRequest 

type GetAllProvidersBadRequest struct {
	Payload *models.YodleeError
}

GetAllProvidersBadRequest handles this case with default header values.

Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have atleast 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API

func NewGetAllProvidersBadRequest 

func NewGetAllProvidersBadRequest() *GetAllProvidersBadRequest

NewGetAllProvidersBadRequest creates a GetAllProvidersBadRequest with default headers values

func (*GetAllProvidersBadRequest) Error 

func (o *GetAllProvidersBadRequest) Error() string

func (*GetAllProvidersBadRequest) GetPayload 

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

type GetAllProvidersNotFound 

type GetAllProvidersNotFound struct {
}

GetAllProvidersNotFound handles this case with default header values.

Not Found

func NewGetAllProvidersNotFound 

func NewGetAllProvidersNotFound() *GetAllProvidersNotFound

NewGetAllProvidersNotFound creates a GetAllProvidersNotFound with default headers values

func (*GetAllProvidersNotFound) Error 

func (o *GetAllProvidersNotFound) Error() string

type GetAllProvidersOK 

type GetAllProvidersOK struct {
	Payload *models.ProviderResponse
}

GetAllProvidersOK handles this case with default header values.

OK

func NewGetAllProvidersOK 

func NewGetAllProvidersOK() *GetAllProvidersOK

NewGetAllProvidersOK creates a GetAllProvidersOK with default headers values

func (*GetAllProvidersOK) Error 

func (o *GetAllProvidersOK) Error() string

func (*GetAllProvidersOK) GetPayload 

func (o *GetAllProvidersOK) GetPayload() *models.ProviderResponse

type GetAllProvidersParams 

type GetAllProvidersParams struct {

	/*Capability
	  CHALLENGE_DEPOSIT_VERIFICATION

	*/
	Capability *string
	/*DatasetDollarFilter
	  Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.

	*/
	DatasetDollarFilter *string
	/*Name
	  Name in minimum 1 character or routing number.

	*/
	Name *string
	/*Priority
	  Search priority

	*/
	Priority *string
	/*Skip
	  skip (Min 0) - This is not applicable along with 'name' parameter.

	*/
	Skip *int32
	/*Top
	  top (Max 500) - This is not applicable along with 'name' parameter.

	*/
	Top *int32

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

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

func NewGetAllProvidersParams 

func NewGetAllProvidersParams() *GetAllProvidersParams

NewGetAllProvidersParams creates a new GetAllProvidersParams object with the default values initialized.

func NewGetAllProvidersParamsWithContext 

func NewGetAllProvidersParamsWithContext(ctx context.Context) *GetAllProvidersParams

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

func NewGetAllProvidersParamsWithHTTPClient 

func NewGetAllProvidersParamsWithHTTPClient(client *http.Client) *GetAllProvidersParams

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

func NewGetAllProvidersParamsWithTimeout 

func NewGetAllProvidersParamsWithTimeout(timeout time.Duration) *GetAllProvidersParams

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

func (*GetAllProvidersParams) SetCapability 

func (o *GetAllProvidersParams) SetCapability(capability *string)

SetCapability adds the capability to the get all providers params

func (*GetAllProvidersParams) SetContext 

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

SetContext adds the context to the get all providers params

func (*GetAllProvidersParams) SetDatasetDollarFilter 

func (o *GetAllProvidersParams) SetDatasetDollarFilter(datasetDollarFilter *string)

SetDatasetDollarFilter adds the datasetDollar Filter to the get all providers params

func (*GetAllProvidersParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get all providers params

func (*GetAllProvidersParams) SetName 

func (o *GetAllProvidersParams) SetName(name *string)

SetName adds the name to the get all providers params

func (*GetAllProvidersParams) SetPriority 

func (o *GetAllProvidersParams) SetPriority(priority *string)

SetPriority adds the priority to the get all providers params

func (*GetAllProvidersParams) SetSkip 

func (o *GetAllProvidersParams) SetSkip(skip *int32)

SetSkip adds the skip to the get all providers params

func (*GetAllProvidersParams) SetTimeout 

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

SetTimeout adds the timeout to the get all providers params

func (*GetAllProvidersParams) SetTop 

func (o *GetAllProvidersParams) SetTop(top *int32)

SetTop adds the top to the get all providers params

func (*GetAllProvidersParams) WithCapability 

func (o *GetAllProvidersParams) WithCapability(capability *string) *GetAllProvidersParams

WithCapability adds the capability to the get all providers params

func (*GetAllProvidersParams) WithContext 

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

WithContext adds the context to the get all providers params

func (*GetAllProvidersParams) WithDatasetDollarFilter 

func (o *GetAllProvidersParams) WithDatasetDollarFilter(datasetDollarFilter *string) *GetAllProvidersParams

WithDatasetDollarFilter adds the datasetDollarFilter to the get all providers params

func (*GetAllProvidersParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get all providers params

func (*GetAllProvidersParams) WithName 

func (o *GetAllProvidersParams) WithName(name *string) *GetAllProvidersParams

WithName adds the name to the get all providers params

func (*GetAllProvidersParams) WithPriority 

func (o *GetAllProvidersParams) WithPriority(priority *string) *GetAllProvidersParams

WithPriority adds the priority to the get all providers params

func (*GetAllProvidersParams) WithSkip 

func (o *GetAllProvidersParams) WithSkip(skip *int32) *GetAllProvidersParams

WithSkip adds the skip to the get all providers params

func (*GetAllProvidersParams) WithTimeout 

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

WithTimeout adds the timeout to the get all providers params

func (*GetAllProvidersParams) WithTop 

func (o *GetAllProvidersParams) WithTop(top *int32) *GetAllProvidersParams

WithTop adds the top to the get all providers params

func (*GetAllProvidersParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetAllProvidersReader 

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

GetAllProvidersReader is a Reader for the GetAllProviders structure.

func (*GetAllProvidersReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetAllProvidersUnauthorized 

type GetAllProvidersUnauthorized struct {
}

GetAllProvidersUnauthorized handles this case with default header values.

Unauthorized

func NewGetAllProvidersUnauthorized 

func NewGetAllProvidersUnauthorized() *GetAllProvidersUnauthorized

NewGetAllProvidersUnauthorized creates a GetAllProvidersUnauthorized with default headers values

func (*GetAllProvidersUnauthorized) Error 

func (o *GetAllProvidersUnauthorized) Error() string

type GetProviderBadRequest 

type GetProviderBadRequest struct {
	Payload *models.YodleeError
}

GetProviderBadRequest handles this case with default header values.

Y800 : Invalid value for providerId

func NewGetProviderBadRequest 

func NewGetProviderBadRequest() *GetProviderBadRequest

NewGetProviderBadRequest creates a GetProviderBadRequest with default headers values

func (*GetProviderBadRequest) Error 

func (o *GetProviderBadRequest) Error() string

func (*GetProviderBadRequest) GetPayload 

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

type GetProviderNotFound 

type GetProviderNotFound struct {
}

GetProviderNotFound handles this case with default header values.

Not Found

func NewGetProviderNotFound 

func NewGetProviderNotFound() *GetProviderNotFound

NewGetProviderNotFound creates a GetProviderNotFound with default headers values

func (*GetProviderNotFound) Error 

func (o *GetProviderNotFound) Error() string

type GetProviderOK 

type GetProviderOK struct {
	Payload *models.ProviderDetailResponse
}

GetProviderOK handles this case with default header values.

OK

func NewGetProviderOK 

func NewGetProviderOK() *GetProviderOK

NewGetProviderOK creates a GetProviderOK with default headers values

func (*GetProviderOK) Error 

func (o *GetProviderOK) Error() string

func (*GetProviderOK) GetPayload 

func (o *GetProviderOK) GetPayload() *models.ProviderDetailResponse

type GetProviderParams 

type GetProviderParams struct {

	/*ProviderID
	  providerId

	*/
	ProviderID int64

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

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

func NewGetProviderParams 

func NewGetProviderParams() *GetProviderParams

NewGetProviderParams creates a new GetProviderParams object with the default values initialized.

func NewGetProviderParamsWithContext 

func NewGetProviderParamsWithContext(ctx context.Context) *GetProviderParams

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

func NewGetProviderParamsWithHTTPClient 

func NewGetProviderParamsWithHTTPClient(client *http.Client) *GetProviderParams

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

func NewGetProviderParamsWithTimeout 

func NewGetProviderParamsWithTimeout(timeout time.Duration) *GetProviderParams

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

func (*GetProviderParams) SetContext 

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

SetContext adds the context to the get provider params

func (*GetProviderParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get provider params

func (*GetProviderParams) SetProviderID 

func (o *GetProviderParams) SetProviderID(providerID int64)

SetProviderID adds the providerId to the get provider params

func (*GetProviderParams) SetTimeout 

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

SetTimeout adds the timeout to the get provider params

func (*GetProviderParams) WithContext 

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

WithContext adds the context to the get provider params

func (*GetProviderParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get provider params

func (*GetProviderParams) WithProviderID 

func (o *GetProviderParams) WithProviderID(providerID int64) *GetProviderParams

WithProviderID adds the providerID to the get provider params

func (*GetProviderParams) WithTimeout 

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

WithTimeout adds the timeout to the get provider params

func (*GetProviderParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetProviderReader 

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

GetProviderReader is a Reader for the GetProvider structure.

func (*GetProviderReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetProviderUnauthorized 

type GetProviderUnauthorized struct {
}

GetProviderUnauthorized handles this case with default header values.

Unauthorized

func NewGetProviderUnauthorized 

func NewGetProviderUnauthorized() *GetProviderUnauthorized

NewGetProviderUnauthorized creates a GetProviderUnauthorized with default headers values

func (*GetProviderUnauthorized) Error 

func (o *GetProviderUnauthorized) Error() string

type GetProvidersCountBadRequest 

type GetProvidersCountBadRequest struct {
	Payload *models.YodleeError
}

GetProvidersCountBadRequest handles this case with default header values.

Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have at least 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API

func NewGetProvidersCountBadRequest 

func NewGetProvidersCountBadRequest() *GetProvidersCountBadRequest

NewGetProvidersCountBadRequest creates a GetProvidersCountBadRequest with default headers values

func (*GetProvidersCountBadRequest) Error 

func (o *GetProvidersCountBadRequest) Error() string

func (*GetProvidersCountBadRequest) GetPayload 

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

type GetProvidersCountNotFound 

type GetProvidersCountNotFound struct {
}

GetProvidersCountNotFound handles this case with default header values.

Not Found

func NewGetProvidersCountNotFound 

func NewGetProvidersCountNotFound() *GetProvidersCountNotFound

NewGetProvidersCountNotFound creates a GetProvidersCountNotFound with default headers values

func (*GetProvidersCountNotFound) Error 

func (o *GetProvidersCountNotFound) Error() string

type GetProvidersCountOK 

type GetProvidersCountOK struct {
	Payload *models.ProvidersCountResponse
}

GetProvidersCountOK handles this case with default header values.

OK

func NewGetProvidersCountOK 

func NewGetProvidersCountOK() *GetProvidersCountOK

NewGetProvidersCountOK creates a GetProvidersCountOK with default headers values

func (*GetProvidersCountOK) Error 

func (o *GetProvidersCountOK) Error() string

func (*GetProvidersCountOK) GetPayload 

func (o *GetProvidersCountOK) GetPayload() *models.ProvidersCountResponse

type GetProvidersCountParams 

type GetProvidersCountParams struct {

	/*Capability
	  CHALLENGE_DEPOSIT_VERIFICATION

	*/
	Capability *string
	/*DatasetDollarFilter
	  Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.

	*/
	DatasetDollarFilter *string
	/*Name
	  Name in minimum 1 character or routing number.

	*/
	Name *string
	/*Priority
	  Search priority

	*/
	Priority *string

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

GetProvidersCountParams contains all the parameters to send to the API endpoint for the get providers count operation typically these are written to a http.Request

func NewGetProvidersCountParams 

func NewGetProvidersCountParams() *GetProvidersCountParams

NewGetProvidersCountParams creates a new GetProvidersCountParams object with the default values initialized.

func NewGetProvidersCountParamsWithContext 

func NewGetProvidersCountParamsWithContext(ctx context.Context) *GetProvidersCountParams

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

func NewGetProvidersCountParamsWithHTTPClient 

func NewGetProvidersCountParamsWithHTTPClient(client *http.Client) *GetProvidersCountParams

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

func NewGetProvidersCountParamsWithTimeout 

func NewGetProvidersCountParamsWithTimeout(timeout time.Duration) *GetProvidersCountParams

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

func (*GetProvidersCountParams) SetCapability 

func (o *GetProvidersCountParams) SetCapability(capability *string)

SetCapability adds the capability to the get providers count params

func (*GetProvidersCountParams) SetContext 

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

SetContext adds the context to the get providers count params

func (*GetProvidersCountParams) SetDatasetDollarFilter 

func (o *GetProvidersCountParams) SetDatasetDollarFilter(datasetDollarFilter *string)

SetDatasetDollarFilter adds the datasetDollar Filter to the get providers count params

func (*GetProvidersCountParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get providers count params

func (*GetProvidersCountParams) SetName 

func (o *GetProvidersCountParams) SetName(name *string)

SetName adds the name to the get providers count params

func (*GetProvidersCountParams) SetPriority 

func (o *GetProvidersCountParams) SetPriority(priority *string)

SetPriority adds the priority to the get providers count params

func (*GetProvidersCountParams) SetTimeout 

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

SetTimeout adds the timeout to the get providers count params

func (*GetProvidersCountParams) WithCapability 

func (o *GetProvidersCountParams) WithCapability(capability *string) *GetProvidersCountParams

WithCapability adds the capability to the get providers count params

func (*GetProvidersCountParams) WithContext 

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

WithContext adds the context to the get providers count params

func (*GetProvidersCountParams) WithDatasetDollarFilter 

func (o *GetProvidersCountParams) WithDatasetDollarFilter(datasetDollarFilter *string) *GetProvidersCountParams

WithDatasetDollarFilter adds the datasetDollarFilter to the get providers count params

func (*GetProvidersCountParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get providers count params

func (*GetProvidersCountParams) WithName 

func (o *GetProvidersCountParams) WithName(name *string) *GetProvidersCountParams

WithName adds the name to the get providers count params

func (*GetProvidersCountParams) WithPriority 

func (o *GetProvidersCountParams) WithPriority(priority *string) *GetProvidersCountParams

WithPriority adds the priority to the get providers count params

func (*GetProvidersCountParams) WithTimeout 

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

WithTimeout adds the timeout to the get providers count params

func (*GetProvidersCountParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetProvidersCountReader 

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

GetProvidersCountReader is a Reader for the GetProvidersCount structure.

func (*GetProvidersCountReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type GetProvidersCountUnauthorized 

type GetProvidersCountUnauthorized struct {
}

GetProvidersCountUnauthorized handles this case with default header values.

Unauthorized

func NewGetProvidersCountUnauthorized 

func NewGetProvidersCountUnauthorized() *GetProvidersCountUnauthorized

NewGetProvidersCountUnauthorized creates a GetProvidersCountUnauthorized with default headers values

func (*GetProvidersCountUnauthorized) Error 

func (o *GetProvidersCountUnauthorized) 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.