Members
object
# constant RO
RewardOps Node SDK global object.
Contains the entire public toolkit for the Node SDK, including configuration, authorization, and API request methods.
For API request methods, all params
parameters are passed directly to the RewardOps API. Available parameters
can be viewed on the RewardOps API console. As a rule, path parameters
(i.e., required program
, reward
, and order
IDs) are passed as the first argument to SDK methods, while other
parameters should appear in a params
object.
Properties:
Name | Type | Description |
---|---|---|
api |
module:api~api
|
API call helper object. |
auth |
module:auth~auth
|
Authorization token properties and actions object. |
config |
module:config~config
|
SDK configurations object. |
emitter |
module:emitter~emitter
|
Event emitter instance. |
program |
module:resources/programs~program
|
Get a |
programs |
module:resources/programs~programs
|
A program-specific context type object with |
setLogFilePath |
module:utils/logger~setLogFilePath
|
Sets the path for the log file and enable file logging. |
urls |
module:urls
|
All exports from the |
version |
string
|
RewardOps Node SDK package version. |
- Copyright:
- 2015–2020 RewardOps Inc.
object
# constant RO
RewardOps Node SDK global object.
Contains the entire public toolkit for the Node SDK, including configuration, authorization, and API request methods.
For API request methods, all params
parameters are passed directly to the RewardOps API. Available parameters
can be viewed on the RewardOps API console. As a rule, path parameters
(i.e., required program
, reward
, and order
IDs) are passed as the first argument to SDK methods, while other
parameters should appear in a params
object.
Properties:
Name | Type | Description |
---|---|---|
api |
module:api~api
|
API call helper object. |
auth |
module:auth~auth
|
Authorization token properties and actions object. |
config |
module:config~config
|
SDK configurations object. |
emitter |
module:emitter~emitter
|
Event emitter instance. |
program |
module:resources/programs~program
|
Get a |
programs |
module:resources/programs~programs
|
A program-specific context type object with |
setLogFilePath |
module:utils/logger~setLogFilePath
|
Sets the path for the log file and enable file logging. |
urls |
module:urls
|
All exports from the |
version |
string
|
RewardOps Node SDK package version. |
- Copyright:
- 2015–2020 RewardOps Inc.