classy-pay-client
Simple client for Classy Pay.
installation
$ yarn install classy-pay-client
usage
PayClient.request(appId, method, resource, payload, params, callback)
const PayClient = apiUrl: 'https://pay.classy.org' timeout: 10000 token: 'YOUR_TOKEN' secret: 'YOUR_SECRET'; PayClient; PayClient;
Functions
- getHeaders(context, method, resource, payload) ⇒
Object
Get all the necessary headers for the request.
- getQs(appId, params) ⇒
Object
Build the request query.
- getOptions(context, appId, method, resource, payload, params) ⇒
Object
Get the request options.
- getResult(error, response, body) ⇒
Object
Get the response for http request.
- request(context, appId, method, resource, payload, params, callback)
A general Pay request.
- getMax(context, appId, resource) ⇒
Number
Retrieve the total number of objects for the resource.
- getAll(context, appId, resource, max, collection) ⇒
Promise
Get all the objects for a resource.
- forList(context, appId, resource, callback)
Get all objects.
- forObject(context, appId, method, resource, body, callback)
Get an object.
- list(context, appId, resource, callback) ⇒
Array
Get a list of objects for a resource.
- get(context, appId, resource, callback) ⇒
Object
Get an object given a resource.
- post(context, appId, resource, object, callback) ⇒
Object
Create an object at a resource.
- put(context, appId, resource, object, callback) ⇒
Object
Update an object at a resource.
- del(context, appId, resource, callback) ⇒
Object
Remove an object at a resource.
Object
getHeaders(context, method, resource, payload) ⇒ Get all the necessary headers for the request.
Kind: 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 |
Object
getQs(appId, params) ⇒ Build the request query.
Kind: global function
Returns: Object
- params for request
Param | Type | Description |
---|---|---|
appId | Number |
the pay application id |
params | Object |
params passed by client user |
Object
getOptions(context, appId, method, resource, payload, params) ⇒ Get the request options.
Kind: 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 |
Object
getResult(error, response, body) ⇒ Get the response for http request.
Kind: 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 |
request(context, appId, method, resource, payload, params, callback)
A general Pay request.
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 |
Number
getMax(context, appId, resource) ⇒ Retrieve the total number of objects for the resource.
Kind: 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 |
Promise
getAll(context, appId, resource, max, collection) ⇒ Get all the objects for a resource.
Kind: 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 |
forList(context, appId, resource, callback)
Get all objects.
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 |
forObject(context, appId, method, resource, body, callback)
Get an object.
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 |
Array
list(context, appId, resource, callback) ⇒ Get a list of objects for a resource.
Kind: 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 |
Object
get(context, appId, resource, callback) ⇒ Get an object given a resource.
Kind: 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 |
Object
post(context, appId, resource, object, callback) ⇒ Create an object at a resource.
Kind: 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 |
Object
put(context, appId, resource, object, callback) ⇒ Update an object at a resource.
Kind: 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 |
Object
del(context, appId, resource, callback) ⇒ Remove an object at a resource.
Kind: 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 |