-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Github Workflow
committed
Sep 12, 2024
1 parent
aed8402
commit 88bd036
Showing
4 changed files
with
126 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "partner_accounts": 1 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "title": "Get Partner Account Details (response)", | ||
| "description": "Get All Partner Accounts (Partner account details like website, provider, company details)", | ||
| "type": "object", | ||
| "required": [ | ||
| "echo_req", | ||
| "msg_type" | ||
| ], | ||
| "properties": { | ||
| "partner_accounts": { | ||
| "title": "partner_accounts", | ||
| "description": "Partner Accounts against a user", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "partner_settings": { | ||
| "description": "List of partner_settigns for all accounts associated as partners.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "binary_user_id": { | ||
| "description": "The user id.", | ||
| "type": "integer" | ||
| }, | ||
| "company_name": { | ||
| "description": "[Optional] Company name. Only applicable for partners of type company.", | ||
| "type": "string" | ||
| }, | ||
| "company_registration_no": { | ||
| "description": "[Optional] Company registration number. Only applicable for partners of type company.", | ||
| "type": "string" | ||
| }, | ||
| "partner_loginid": { | ||
| "description": "Partner's login ID", | ||
| "type": "string" | ||
| }, | ||
| "partner_type": { | ||
| "description": "Defines whether this partner is an individual or a company.", | ||
| "type": "string", | ||
| "enum": [ | ||
| "individual", | ||
| "company" | ||
| ] | ||
| }, | ||
| "platform_url": { | ||
| "description": "Platform URL for Dynamic works dashboard to be redirected from Partners Hub which will be set in BackOffice.", | ||
| "type": "string" | ||
| }, | ||
| "provider": { | ||
| "description": "Defines the provider platform.", | ||
| "type": "string", | ||
| "enum": [ | ||
| "myaffiliates", | ||
| "dynamicworks" | ||
| ] | ||
| }, | ||
| "website": { | ||
| "description": "Partner's Website URI/Promotional Platform", | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "echo_req": { | ||
| "description": "Echo of the request made.", | ||
| "type": "object" | ||
| }, | ||
| "msg_type": { | ||
| "description": "Action name of the request made.", | ||
| "type": "string", | ||
| "enum": [ | ||
| "partner_accounts" | ||
| ] | ||
| }, | ||
| "req_id": { | ||
| "description": "Optional field sent in request to map to response, present only when request contains `req_id`.", | ||
| "type": "integer" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "title": "Get Partner Account Details (request)", | ||
| "description": "Get All Partner Accounts (Partner account details like website, provider, company details)", | ||
| "type": "object", | ||
| "auth_required": 1, | ||
| "auth_scopes": [ | ||
| "read" | ||
| ], | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "partner_accounts" | ||
| ], | ||
| "properties": { | ||
| "partner_accounts": { | ||
| "description": "Must be `1`", | ||
| "type": "integer", | ||
| "enum": [ | ||
| 1 | ||
| ] | ||
| }, | ||
| "loginid": { | ||
| "description": "[Optional] The login id of the partner account. Mandatory when multiple tokens were provided during authorize.", | ||
| "type": "string", | ||
| "pattern": "^[A-Za-z]+[0-9]+$" | ||
| }, | ||
| "passthrough": { | ||
| "description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field.", | ||
| "type": "object" | ||
| }, | ||
| "req_id": { | ||
| "description": "[Optional] Used to map request to response.", | ||
| "type": "integer" | ||
| } | ||
| } | ||
| } |