new agreements(domainOrOptionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
domainOrOptions |
string
|
object
|
<optional>
|
The project domain or options object. If object, see the object's optional properties.
Properties
| Name |
Type |
Attributes |
Description |
domain |
string
|
<optional>
|
The project domain |
token |
object
|
<optional>
|
auth token - object with value property and optional headerOrQueryName and isQuery properties |
|
- Source:
Methods
get(xPrivateLabelId, xMarketId, keys)
Retrieve Legal Agreements for provided agreements keys
Parameters:
| Name |
Type |
Description |
xPrivateLabelId |
integer
|
PrivateLabelId to operate as, if different from JWT |
xMarketId |
string
|
Unique identifier of the Market used to retrieve/translate Legal Agreements |
keys |
array
|
Keys for Agreements whose details are to be retrieved |
- Source:
setToken(value, headerOrQueryName, isQuery)
Set Token
Parameters:
| Name |
Type |
Description |
value |
string
|
token's value |
headerOrQueryName |
string
|
the header or query name to send the token at |
isQuery |
boolean
|
true if send the token as query param, otherwise, send as header param |
- Source: