Ahmed/dapi 683/feat filter dropdown app manager desktop

README.md

@@ -42,19 +42,15 @@ To ensure smooth running and contribution to this project, please make sure you
 
     git clone [email protected]:deriv-com/deriv-api-docs.git
 
-### Install Dependencies
+### Prepare for run - (Install Dependencies & Build)
 
-    npm ci   // Clean Install
-
-or
-
-    npm i   // Install
+    npm run bootstrap
 
 ### Run the Project
 
 After successfully building the project, you can execute or debug it using the Terminal by running the following command.
 
-    npm run start:dev
+    npm run dev
 
 ### Build the Project
 

_data/v3.yml

@@ -159,6 +159,10 @@ groups:
         title: P2P Ping
       - name: p2p_settings
         title: P2P Settings
+      - name: partner_settings
+        title: Get Partner-Specific Account Settings
+      - name: partner_settings_update
+        title: Set Partner Account Settings
       - name: payment_methods
         title: Payment Methods
       - name: paymentagent_create

config/v3/get_account_status/receive.json

@@ -526,7 +526,7 @@
                     ]
                 },
                 "status": {
-                    "description": "Account status. Possible status: \n- `address_verified`: client's address is verified by third party services. \n- `allow_document_upload`: client is allowed to upload documents. \n- `age_verification`: client is age-verified. \n- `authenticated`: client is fully authenticated. \n- `cashier_locked`: cashier is locked. \n- `crs_tin_information`: client has updated tax related information. \n- `deposit_locked`: deposit is not allowed. \n- `disabled`: account is disabled. \n- `document_expired`: client's submitted proof-of-identity documents have expired. \n- `document_expiring_soon`: client's submitted proof-of-identity documents are expiring within a month. \n- `dxtrade_password_not_set`: Deriv X password is not set. \n- `financial_assessment_not_complete`: client should complete their financial assessment. \n- `financial_information_not_complete`: client has not completed financial assessment. \n- `financial_risk_approval`: client has accepted financial risk disclosure. \n- `max_turnover_limit_not_set`: client has not set financial limits on their account. Applies to UK and Malta clients. \n- `mt5_password_not_set`: MT5 password is not set. \n- `mt5_withdrawal_locked`: MT5 deposits allowed, but withdrawal is not allowed. \n- `needs_affiliate_coc_approval`: user must approve the Affiliate's Code of Conduct Agreement. \n- `no_trading`: trading is disabled. \n- `no_withdrawal_or_trading`: client cannot trade or withdraw but can deposit. \n- `p2p_blocked_for_pa`: p2p is blocked for the current payment agent client. \n- `pa_withdrawal_explicitly_allowed`: withdrawal through payment agent is allowed. \n- `password_reset_required`: this client must reset their password.  \n- `professional`: this client has opted for a professional account. \n- `professional_requested`: this client has requested for a professional account. \n- `professional_rejected`: this client's request for a professional account has been rejected. \n- `social_signup`: this client is using social signup. \n- `trading_experience_not_complete`: client has not completed the trading experience questionnaire. \n- `ukgc_funds_protection`: client has acknowledged UKGC funds protection notice. \n- `unwelcome`: client cannot deposit or buy contracts, but can withdraw or sell contracts. \n- `withdrawal_locked`: deposits allowed but withdrawals are not allowed. \n- `deposit_attempt`: this prevent a client from changing the account currency after deposit attempt. \n- `poi_name_mismatch`: client POI documents name mismatch. \n- `allow_poa_resubmission`: the client can resubmit POA documents. \n- `allow_poi_resubmission`: the client can resubmit POI documents. \n- `shared_payment_method`: the client has been sharing payment methods. \n- `personal_details_locked`: client is not allowed to edit personal profile details. \n- `transfers_blocked`: it block any transfer between two accounts. \n- `df_deposit_requires_poi`: the DF deposit will be blocked until the client gets age verified. \n- `authenticated_with_idv_photoid`: the client has been fully authenticated by IDV. \n- `idv_revoked`: the client used to be fully authenticated by IDV but it was taken away due to compliance criteria. \n- `mt5_additional_kyc_required`: client tax information, place of birth and account opening reason is missing. \n- `poi_expiring_soon`: the POI documents of the client will get expired soon, allow them to reupload POI documents. \n- `poa_expiring_soon`: the POA documents of the client will get outdated soon, allow them to reupload POA documents. \n- `tin_manually_approved`: the client's tax_identification_number has been manually approved as client is not applicable for tax_identification_number",
+                    "description": "Account status. Possible status: \n- `address_verified`: client's address is verified by third party services. \n- `allow_document_upload`: client is allowed to upload documents. \n- `age_verification`: client is age-verified. \n- `authenticated`: client is fully authenticated. \n- `cashier_locked`: cashier is locked. \n- `crs_tin_information`: client has updated tax related information. \n- `deposit_locked`: deposit is not allowed. \n- `disabled`: account is disabled. \n- `document_expired`: client's submitted proof-of-identity documents have expired. \n- `document_expiring_soon`: client's submitted proof-of-identity documents are expiring within a month. \n- `dxtrade_password_not_set`: Deriv X password is not set. \n- `financial_assessment_not_complete`: client should complete their financial assessment. \n- `financial_information_not_complete`: client has not completed financial assessment. \n- `financial_risk_approval`: client has accepted financial risk disclosure. \n- `max_turnover_limit_not_set`: client has not set financial limits on their account. Applies to UK and Malta clients. \n- `mt5_password_not_set`: MT5 password is not set. \n- `mt5_withdrawal_locked`: MT5 deposits allowed, but withdrawal is not allowed. \n- `needs_affiliate_coc_approval`: user must approve the Affiliate's Code of Conduct Agreement. \n- `no_trading`: trading is disabled. \n- `no_withdrawal_or_trading`: client cannot trade or withdraw but can deposit. \n- `p2p_blocked_for_pa`: p2p is blocked for the current payment agent client. \n- `pa_withdrawal_explicitly_allowed`: withdrawal through payment agent is allowed. \n- `password_reset_required`: this client must reset their password.  \n- `professional`: this client has opted for a professional account. \n- `professional_requested`: this client has requested for a professional account. \n- `professional_rejected`: this client's request for a professional account has been rejected. \n- `social_signup`: this client is using social signup. \n- `trading_experience_not_complete`: client has not completed the trading experience questionnaire. \n- `unwelcome`: client cannot deposit or buy contracts, but can withdraw or sell contracts. \n- `withdrawal_locked`: deposits allowed but withdrawals are not allowed. \n- `deposit_attempt`: this prevent a client from changing the account currency after deposit attempt. \n- `poi_name_mismatch`: client POI documents name mismatch. \n- `allow_poa_resubmission`: the client can resubmit POA documents. \n- `allow_poi_resubmission`: the client can resubmit POI documents. \n- `shared_payment_method`: the client has been sharing payment methods. \n- `personal_details_locked`: client is not allowed to edit personal profile details. \n- `transfers_blocked`: it block any transfer between two accounts. \n- `df_deposit_requires_poi`: the DF deposit will be blocked until the client gets age verified. \n- `authenticated_with_idv_photoid`: the client has been fully authenticated by IDV. \n- `idv_revoked`: the client used to be fully authenticated by IDV but it was taken away due to compliance criteria. \n- `mt5_additional_kyc_required`: client tax information, place of birth and account opening reason is missing. \n- `poi_expiring_soon`: the POI documents of the client will get expired soon, allow them to reupload POI documents. \n- `poa_expiring_soon`: the POA documents of the client will get outdated soon, allow them to reupload POA documents. \n- `tin_manually_approved`: the client's tax_identification_number has been manually approved as client is not applicable for tax_identification_number",
                     "type": "array",
                     "items": {
                         "type": "string"

config/v3/get_settings/receive.json

@@ -216,6 +216,10 @@
                             "description": "(Optional) Indicates the timestamp for the next verify attempt",
                             "type": "integer"
                         },
+                        "session_timestamp": {
+                            "description": "(Optional) Indicates the timestamp for the current's session email code expiry",
+                            "type": "integer"
+                        },
                         "verified": {
                             "description": "Indicates the verification status of the client's phone number.",
                             "type": "integer",

config/v3/landing_company/receive.json

@@ -1560,14 +1560,6 @@
                         1
                     ]
                 },
-                "ukgc_funds_protection": {
-                    "description": "Flag to indicate ukgc funds protection setting.",
-                    "type": "integer",
-                    "enum": [
-                        0,
-                        1
-                    ]
-                },
                 "virtual_company": {
                     "description": "Virtual Company",
                     "type": "string"

config/v3/mt5_new_account/send.json

@@ -155,7 +155,8 @@
                 "p01_ts03",
                 "p01_ts04",
                 "p02_ts02",
-                "p03_ts01"
+                "p03_ts01",
+                "p03_ts02"
             ]
         },
         "state": {

config/v3/partner_settings/example.json

@@ -0,0 +1,3 @@
+{
+    "partner_settings": 1
+}

config/v3/partner_settings/receive.json

@@ -0,0 +1,72 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Get Partner-Specific Account Settings (response)",
+    "description": "Get Partner Settings (Partner Type, Company Details etc)",
+    "type": "object",
+    "required": [
+        "echo_req",
+        "msg_type"
+    ],
+    "properties": {
+        "partner_settings": {
+            "title": "partner_settings",
+            "description": "Partner-specific information and settings.",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "company_name": {
+                    "description": "[Optional] Company name. Only applicable for partners of type company.",
+                    "type": "string",
+                    "pattern": "^(?!.*\\s{2,})[\\p{L}\\s'.-]{2,50}$",
+                    "sensitive": 1
+                },
+                "company_registration_number": {
+                    "description": "[Optional] Company registration number. Only applicable for partners of type company.",
+                    "type": "string",
+                    "pattern": "^(?!^$|\\s+)[A-Za-z0-9.\\/\\s-]{0,25}$"
+                },
+                "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",
+                    "pattern": "^[\\w_@./:#&+-]*$"
+                },
+                "provider": {
+                    "description": "Defines the provider platform.",
+                    "type": "string",
+                    "enum": [
+                        "myaffiliates",
+                        "dynamicworks"
+                    ]
+                },
+                "website": {
+                    "description": "Partner's Website URI/Promotional Platform",
+                    "type": "string",
+                    "pattern": "^[\\w_@./:#&+-]*$"
+                }
+            }
+        },
+        "echo_req": {
+            "description": "Echo of the request made.",
+            "type": "object"
+        },
+        "msg_type": {
+            "description": "Action name of the request made.",
+            "type": "string",
+            "enum": [
+                "partner_settings"
+            ]
+        },
+        "req_id": {
+            "description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
+            "type": "integer"
+        }
+    }
+}

config/v3/partner_settings/send.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Get Partner-Specific Account Settings (request)",
+    "description": "Get Partner Settings (Partner Type, Company Details etc)",
+    "type": "object",
+    "auth_required": 1,
+    "auth_scopes": [
+        "read"
+    ],
+    "additionalProperties": false,
+    "required": [
+        "partner_settings"
+    ],
+    "properties": {
+        "partner_settings": {
+            "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"
+        }
+    }
+}

config/v3/partner_settings_update/example.json

@@ -0,0 +1,7 @@
+{
+    "partner_settings_update": 1,
+    "company_name": "XYZ New Corp",
+    "company_registration_no": "ABC322",
+    "partner_type": "company",
+    "website": "www.newxyz.com"
+}

config/v3/partner_settings_update/receive.json

@@ -0,0 +1,32 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Set Partner Account Settings (response)",
+    "description": "A message with Partner Settings",
+    "type": "object",
+    "required": [
+        "echo_req",
+        "msg_type"
+    ],
+    "properties": {
+        "partner_settings_update": {
+            "title": "partner_settings_update",
+            "description": "1 on success",
+            "type": "integer"
+        },
+        "echo_req": {
+            "description": "Echo of the request made.",
+            "type": "object"
+        },
+        "msg_type": {
+            "description": "Action name of the request made.",
+            "type": "string",
+            "enum": [
+                "partner_settings_update"
+            ]
+        },
+        "req_id": {
+            "description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
+            "type": "integer"
+        }
+    }
+}

config/v3/partner_settings_update/send.json

@@ -0,0 +1,60 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Set Partner Account Settings (request)",
+    "description": "A message with Partner Settings",
+    "type": "object",
+    "auth_required": 1,
+    "auth_scopes": [
+        "admin"
+    ],
+    "additionalProperties": false,
+    "required": [
+        "partner_settings_update"
+    ],
+    "properties": {
+        "partner_settings_update": {
+            "description": "Must be `1`",
+            "type": "integer",
+            "enum": [
+                1
+            ]
+        },
+        "company_name": {
+            "description": "[Optional] Company name. Only applicable for partners of type company.",
+            "type": "string",
+            "pattern": "^(?!.*\\s{2,})[\\p{L}\\s'.-]{2,50}$",
+            "sensitive": 1
+        },
+        "company_registration_no": {
+            "description": "[Optional] Company registration number. Only applicable for partners of type company.",
+            "type": "string",
+            "pattern": "^(?!^$|\\s+)[A-Za-z0-9.\\/\\s-]{0,25}$"
+        },
+        "partner_type": {
+            "description": "Defines whether this partner is an individual or a company.",
+            "type": "string",
+            "enum": [
+                "individual",
+                "company"
+            ]
+        },
+        "website": {
+            "description": "Partner's Website URI/Promotional Platform",
+            "type": "string",
+            "pattern": "^[\\w_@./:#&+-]*$"
+        },
+        "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"
+        }
+    }
+}