Client for Classy Pay.
npm install classy-pay-client$ yarn install classy-pay-client
PayClient.request(appId, method, resource, payload, params, callback)
``javascript
const PayClient = require('classy-pay-client')({
apiUrl: 'https://pay.classy.org',
timeout: 10000,
token: 'YOUR_TOKEN'
secret: 'YOUR_SECRET'
});
PayClient.get(0, '/transaction/1', (error, result) => {
if (error) {
console.log(error);
} else {
console.log(result);
}
});
PayClient.request(0, 'GET', '/transaction/1', null, null, (error, result) => {
if (error) {
console.log(error);
} else {
console.log(result);
}
});
``
ObjectGet all the necessary headers for the request.
ObjectBuild the request query.
ObjectGet the request options.
ObjectGet the response for http request.
A general Pay request.
NumberRetrieve the total number of objects for the resource.
PromiseGet all the objects for a resource.
Get all objects.
Get an object.
ArrayGet a list of objects for a resource.
ObjectGet an object given a resource.
ObjectCreate an object at a resource.
ObjectUpdate an object at a resource.
ObjectRemove an object at a resource.
ObjectKind: global function
Returns: Object - the headers objects
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the request context |
| method | String | the HTTP method for the request |
| resource | String | the resource being requested |
| payload | Object | the body of the request |
ObjectKind: global function
Returns: Object - params for request
| Param | Type | Description |
| --- | --- | --- |
| appId | Number | the pay application id |
| params | Object | params passed by client user |
ObjectKind: global function
Returns: Object - the options for the request
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the request context |
| appId | Number | the pay application id |
| method | String | the http method |
| resource | String | the resource for the request |
| payload | Object | the body of the request |
| params | Object | the params provided by the caller |
ObjectKind: global function
Returns: Object - a well formed response object
| Param | Type | Description |
| --- | --- | --- |
| error | Object | the error |
| response | Object | the http response |
| body | Object | the body of the response |
Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| method | String | the http method |
| resource | String | the pay resource |
| payload | Object | the payload for the request |
| params | Object | the parameters for the request |
| callback | Method | a callback |
NumberKind: global function
Returns: Number - the total number of objects for the resource
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
PromiseKind: global function
Returns: Promise - a promise when resolved populates the collection
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
| max | Number | total objects to retrieve |
| collection | Array | the collection to add objects to |
Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
| callback | function | the callback |
Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| method | String | the http method |
| resource | String | the pay resource |
| body | Object | the body of the request |
| callback | function | the callback |
ArrayKind: global function
Returns: Array - an array of objects
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
| callback | function | the callback |
ObjectKind: global function
Returns: Object - an object
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
| callback | function | the callback |
ObjectKind: global function
Returns: Object - the created object
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
| object | Object | the object to create |
| callback | function | the callback |
ObjectKind: global function
Returns: Object - the updated object
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
| object | Object | the updated object |
| callback | function | the callback |
ObjectKind: global function
Returns: Object - the removed object
| Param | Type | Description |
| --- | --- | --- |
| context | Object | the context for the request |
| appId | Number | the pay application id |
| resource | String | the pay resource |
| callback | function | the callback |