Classes

handlers/AddFundingAccountHandler

module:ApiClient~handlers/AddFundingAccountHandler

handlers/CreateCustomerHandler

module:ApiClient~handlers/CreateCustomerHandler

handlers/CreatePaymentHandler

module:ApiClient~handlers/CreatePaymentHandler

handlers/CreateRecurringPaymentSetupHandler

module:ApiClient~handlers/CreateRecurringPaymentSetupHandler

handlers/CreateRefundHandler

module:ApiClient~handlers/CreateRefundHandler

handlers/DeleteFundingAccountHandler

module:ApiClient~handlers/DeleteFundingAccountHandler

handlers/DeletePaymentHandler

module:ApiClient~handlers/DeletePaymentHandler

handlers/DeletePaymentSetupHandler

module:ApiClient~handlers/DeletePaymentSetupHandler

handlers/DeleteRecordPaymentHandler

module:ApiClient~handlers/DeleteRecordPaymentHandler

handlers/GetCustomerAccountHandler

module:ApiClient~handlers/GetCustomerAccountHandler

handlers/GetCustomerHandler

module:ApiClient~handlers/GetCustomerHandler

handlers/GetFundingAccountHandler

module:ApiClient~handlers/GetFundingAccountHandler

handlers/GetPaymentHandler

module:ApiClient~handlers/GetPaymentHandler

handlers/GetPaymentSetupHandler

module:ApiClient~handlers/GetPaymentSetupHandler

handlers/GetRecordPaymentHandler

module:ApiClient~handlers/GetRecordPaymentHandler

handlers/GetRefundHandler

module:ApiClient~handlers/GetRefundHandler

handlers/RecordPaymentHandler

module:ApiClient~handlers/RecordPaymentHandler

handlers/RenewCustomerAccountHandler

module:ApiClient~handlers/RenewCustomerAccountHandler

handlers/ReplaceFundingAccountHandler

module:ApiClient~handlers/ReplaceFundingAccountHandler

handlers/RetrieveCustomerAccountsHandler

module:ApiClient~handlers/RetrieveCustomerAccountsHandler

handlers/RetrieveCustomerAccountsPageHandler

module:ApiClient~handlers/RetrieveCustomerAccountsPageHandler

handlers/RetrieveCustomersHandler

module:ApiClient~handlers/RetrieveCustomersHandler

handlers/RetrieveCustomersPageHandler

module:ApiClient~handlers/RetrieveCustomersPageHandler

handlers/RetrieveFeePaymentHandler

module:ApiClient~handlers/RetrieveFeePaymentHandler

handlers/RetrieveFundingAccountsHandler

module:ApiClient~handlers/RetrieveFundingAccountsHandler

handlers/RetrieveFundingAccountsPageHandler

module:ApiClient~handlers/RetrieveFundingAccountsPageHandler

handlers/RetrievePaymentSetupsHandler

module:ApiClient~handlers/RetrievePaymentSetupsHandler

handlers/RetrievePaymentsHandler

module:ApiClient~handlers/RetrievePaymentsHandler

handlers/RetrieveRecordPaymentsHandler

module:ApiClient~handlers/RetrieveRecordPaymentsHandler

handlers/RetrieveRefundsHandler

module:ApiClient~handlers/RetrieveRefundsHandler

handlers/SimplePaymentHandler

module:ApiClient~handlers/SimplePaymentHandler

handlers/UpdateCustomerHandler

module:ApiClient~handlers/UpdateCustomerHandler

handlers/UpdateFundingAccountHandler

module:ApiClient~handlers/UpdateFundingAccountHandler

handlers/UpdatePaymentHandler

module:ApiClient~handlers/UpdatePaymentHandler

handlers/UpdatePaymentSetupHandler

module:ApiClient~handlers/UpdatePaymentSetupHandler

Members

static, readonly CollectionFormatEnum :String

ApiClient.js, line 228

Enumeration of collection format separator strategies.

Properties:

Name	Type	Description
CSV	String	Comma-separated values. Value: csv
SSV	String	Space-separated values. Value: ssv
TSV	String	Tab-separated values. Value: tsv
PIPES	String	Pipe(|)-separated values. Value: pipes
MULTI	String	Native array. Value: multi

static instance :module:ApiClient

ApiClient.js, line 832

The default API client implementation.

authentications :Array.<String>

ApiClient.js, line 44

The authentication methods to be included for all API calls.

basePath :String

ApiClient.js, line 38

The base URL against which to resolve every API call's (relative) path.

Default Value:

• https://api.orbipay.com/payments/v1

cache :Boolean

ApiClient.js, line 66

If set to false an additional timestamp parameter is added to all API GET calls to prevent browser caching

Default Value:

• true

defaultHeaders :Array.<String>

ApiClient.js, line 51

The default HTTP headers to be included for all API calls.

Default Value:

• {}

enableCookies

ApiClient.js, line 73

If set to true, the client will save the cookies from each server response, and return them in the next request.

Default Value:

• false

timeout :Number

ApiClient.js, line 58

The default HTTP timeout for all API calls.

Default Value:

• 60

Methods

static constructFromObject(data, obj)

ApiClient.js, line 613

Constructs a new map or array model from REST data.

Parameters:

Name	Type	Description
data	Object | Array	The REST data.
obj	Object | Array	The target object or array.

static convertToType(data, type)

ApiClient.js, line 547

Converts a value to the specified type.

Parameters:

Name	Type	Description
data	String | Object	The data to convert, as a string or object.
type	String | Array.<String> | Object.<String, Object> | function	The type to return. Pass a string for simple types or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type: all properties on data will be converted to this type.

Returns:

-

An instance of the specified type or null or undefined if data is null or undefined.

static parseDate(str) → {Date}

ApiClient.js, line 534

Parses an ISO-8601 string representation of a date value.

Parameters:

Name	Type	Description
str	String	The date value as a string.

Returns:

Date -

The parsed date object.

applyAuthToRequest(request, authNames)

ApiClient.js, line 289

Applies authentication headers to the request.

Parameters:

Name	Type	Description
request	Object	The request object created by a superagent() call.
authNames	Array.<String>	An array of authentication method names.

buildCollectionParam(param, collectionFormat) → {String|Array}

ApiClient.js, line 263

Builds a string representation of an array-type actual parameter, according to the given collection format.

Parameters:

Name	Type	Description
param	Array	An array parameter.
collectionFormat	module:ApiClient.CollectionFormatEnum	The array element separator strategy.

Returns:

String | Array -

A string representation of the supplied collection, using the specified delimiter. Returns param as is if collectionFormat is multi.

buildUrl(path, pathParams) → {String}

ApiClient.js, line 116

Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values. NOTE: query parameters are not handled here.

Parameters:

Name	Type	Description
path	String	The path to append to the base URL.
pathParams	Object	The parameter values to append.

Returns:

String -

The encoded path with parameter values substituted.

callApi(path, httpMethod, pathParams, queryParams, collectionQueryParams, headerParams, formParams, bodyParam, authNames, contentTypes, accepts, returnType, callback) → {Object}

ApiClient.js, line 374

Invokes the REST service using the supplied settings and parameters.

Parameters:

Name	Type	Description
path	String	The base URL to invoke.
httpMethod	String	The HTTP method to use.
pathParams	Object.<String, String>	A map of path parameters and their values.
queryParams	Object.<String, Object>	A map of query parameters and their values.
collectionQueryParams	Object.<String, Object>	A map of collection query parameters and their values.
headerParams	Object.<String, Object>	A map of header parameters and their values.
formParams	Object.<String, Object>	A map of form parameters and their values.
bodyParam	Object	The value to pass as the request body.
authNames	Array.<String>	An array of authentication type names.
contentTypes	Array.<String>	An array of request MIME types.
accepts	Array.<String>	An array of acceptable response MIME types.
returnType	String | Array | ObjectFunction	The required type to return; can be a string for simple types or the constructor for a complex type.
callback	module:ApiClient~callApiCallback	The callback function.

Returns:

Object -

The SuperAgent request object.

deserialize(response, returnType)

ApiClient.js, line 334

Deserializes an HTTP response body into a value of the specified type.

Parameters:

Name	Type	Description
response	Object	A SuperAgent response object.
returnType	String | Array.<String> | Object.<String, Object> | function	The type to return. Pass a string for simple types or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type: all properties on data will be converted to this type.

Returns:

-

A value of the specified type.

isFileParam(param) → {Boolean}

ApiClient.js, line 172

Checks whether the given parameter value represents file-like content.

Parameters:

Name	Type	Description
param		The parameter to check.

Returns:

Boolean -

true if param represents a file.

isJsonMime(contentType) → {Boolean}

ApiClient.js, line 149

Checks whether the given content type represents JSON.
JSON content type examples:

• application/json
• application/json; charset=UTF8
• APPLICATION/JSON

Parameters:

Name	Type	Description
contentType	String	The MIME content type to check.

Returns:

Boolean -

true if contentType represents JSON, otherwise false.

jsonPreferredMime(contentTypes) → {String}

ApiClient.js, line 158

Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.

Parameters:

Name	Type	Description
contentTypes	Array.<String>

Returns:

String -

The chosen content type, preferring JSON.

normalizeParams(params) → {Object.<String, Object>}

ApiClient.js, line 208

Normalizes parameter values:

• remove nils
• keep files and arrays
• format to string with `paramToString` for other cases

Parameters:

Name	Type	Description
params	Object.<String, Object>	The parameters as object properties.

Returns:

Object.<String, Object> -

normalized parameters.

paramToString(param) → {String}

ApiClient.js, line 99

Returns a string representation for an actual parameter.

Parameters:

Name	Type	Description
param		The actual parameter.

Returns:

String -

The string representation of param.

Type Definitions

callApiCallback(error, data, response)

ApiClient.js, line 348

Callback function to receive the result of the operation.

Parameters:

Name	Type	Description
error	String	Error message, if any.
data		The data returned by the service call.
response	String	The complete HTTP response.