@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/documentation/application/COMMUNICATION.md

@@ -9,8 +9,8 @@
 Manages email, sms, push notifications sent to users
 
 * [getCommunicationConsent](#getcommunicationconsent)
-* [upsertCommunicationConsent](#upsertcommunicationconsent)
 * [upsertAppPushtoken](#upsertapppushtoken)
+* [upsertCommunicationConsent](#upsertcommunicationconsent)
 
 
 
@@ -94,86 +94,6 @@ Success. Returns all available communication opt-ins along with the consent deta
 
 
 
----
-
-
-### upsertCommunicationConsent
-Upsert communication consent
-
-
-
-```javascript
-// Promise
-const promise = communication.upsertCommunicationConsent({  body : value });
-
-// Async/Await
-const data = await communication.upsertCommunicationConsent({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [CommunicationConsentReq](#CommunicationConsentReq) | yes | Request body |
-
-
-Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
-
-*Returned Response:*
-
-
-
-
-[CommunicationConsentRes](#CommunicationConsentRes)
-
-Success. Updates the channels for which user has consented. Check the example shown below or refer `CommunicationConsentRes` for more details.
-
-
-
-
-<details>
-<summary><i>&nbsp; Examples:</i></summary>
-
-
-<details>
-<summary><i>&nbsp; default</i></summary>
-
-```json
-{
-  "value": {
-    "appId": "000000000000000000000004",
-    "userId": "5e56021c4bda3ccab6d9f884",
-    "channels": {
-      "email": {
-        "response": "yes",
-        "displayName": "Email"
-      },
-      "sms": {
-        "response": "yes",
-        "displayName": "SMS"
-      },
-      "whatsapp": {
-        "response": "noaction",
-        "displayName": "WhatsApp"
-      }
-    }
-  }
-}
-```
-</details>
-
-</details>
-
-
-
-
-
-
-
-
-
 ---
 
 
@@ -294,171 +214,171 @@ Success. Check the example shown below or refer `PushtokenRes` for more details.
 ---
 
 
+### upsertCommunicationConsent
+Upsert communication consent
 
-### Schemas
 
- 
- 
- #### [CommunicationConsentReq](#CommunicationConsentReq)
 
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | response | string |  no  |  |
- | action | string |  no  |  |
- | channel | string |  no  |  |
+```javascript
+// Promise
+const promise = communication.upsertCommunicationConsent({  body : value });
 
----
+// Async/Await
+const data = await communication.upsertCommunicationConsent({  body : value });
+```
 
 
- 
- 
- #### [CommunicationConsentRes](#CommunicationConsentRes)
 
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | app_id | string |  no  |  |
- | user_id | string |  no  |  |
- | channels | [CommunicationConsentChannels](#CommunicationConsentChannels) |  no  |  |
 
----
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [CommunicationConsentReq](#CommunicationConsentReq) | yes | Request body |
 
 
- 
- 
- #### [CommunicationConsentChannelsEmail](#CommunicationConsentChannelsEmail)
+Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
 
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | response | string |  no  |  |
- | display_name | string |  no  |  |
+*Returned Response:*
+
+
+
+
+[CommunicationConsentRes](#CommunicationConsentRes)
+
+Success. Updates the channels for which user has consented. Check the example shown below or refer `CommunicationConsentRes` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; default</i></summary>
+
+```json
+{
+  "value": {
+    "appId": "000000000000000000000004",
+    "userId": "5e56021c4bda3ccab6d9f884",
+    "channels": {
+      "email": {
+        "response": "yes",
+        "displayName": "Email"
+      },
+      "sms": {
+        "response": "yes",
+        "displayName": "SMS"
+      },
+      "whatsapp": {
+        "response": "noaction",
+        "displayName": "WhatsApp"
+      }
+    }
+  }
+}
+```
+</details>
+
+</details>
 
----
 
 
- 
- 
- #### [CommunicationConsentChannelsSms](#CommunicationConsentChannelsSms)
 
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | response | string |  no  |  |
- | display_name | string |  no  |  |
 
----
 
 
- 
- 
- #### [CommunicationConsentChannelsWhatsapp](#CommunicationConsentChannelsWhatsapp)
 
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | response | string |  no  |  |
- | display_name | string |  no  |  |
- | country_code | string |  no  |  |
- | phone_number | string |  no  |  |
 
 ---
 
 
- 
- 
- #### [CommunicationConsentChannels](#CommunicationConsentChannels)
+
+### Schemas
+
+
+#### [BadRequestSchema](#BadRequestSchema)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | [CommunicationConsentChannelsEmail](#CommunicationConsentChannelsEmail) |  no  |  |
- | sms | [CommunicationConsentChannelsSms](#CommunicationConsentChannelsSms) |  no  |  |
- | whatsapp | [CommunicationConsentChannelsWhatsapp](#CommunicationConsentChannelsWhatsapp) |  no  |  |
+ | ---------- | ---- | -------- | ----------- || message | string |  no  |  || status | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [CommunicationConsent](#CommunicationConsent)
+#### [CommunicationConsent](#CommunicationConsent)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | app_id | string |  no  |  |
- | user_id | string |  no  |  |
- | channels | [CommunicationConsentChannels](#CommunicationConsentChannels) |  no  |  |
+ | ---------- | ---- | -------- | ----------- || app_id | string |  no  |  || channels | [CommunicationConsentChannels](#CommunicationConsentChannels) |  no  |  || user_id | string |  no  |  |
 
 ---
 
+#### [CommunicationConsentChannels](#CommunicationConsentChannels)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || email | [CommunicationConsentChannelsEmail](#CommunicationConsentChannelsEmail) |  no  |  || sms | [CommunicationConsentChannelsSms](#CommunicationConsentChannelsSms) |  no  |  || whatsapp | [CommunicationConsentChannelsWhatsapp](#CommunicationConsentChannelsWhatsapp) |  no  |  |
+
+---
 
- 
- 
- #### [BadRequestSchema](#BadRequestSchema)
+#### [CommunicationConsentChannelsEmail](#CommunicationConsentChannelsEmail)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | status | string |  no  | Response status. |
- | message | string |  no  | Failure message. |
+ | ---------- | ---- | -------- | ----------- || display_name | string |  no  |  || response | string |  no  |  |
 
 ---
 
+#### [CommunicationConsentChannelsSms](#CommunicationConsentChannelsSms)
 
- 
- 
- #### [NotFound](#NotFound)
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || display_name | string |  no  |  || response | string |  no  |  |
+
+---
+
+#### [CommunicationConsentChannelsWhatsapp](#CommunicationConsentChannelsWhatsapp)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  | Failure message. |
+ | ---------- | ---- | -------- | ----------- || country_code | string |  no  |  || display_name | string |  no  |  || phone_number | string |  no  |  || response | string |  no  |  |
 
 ---
 
+#### [CommunicationConsentReq](#CommunicationConsentReq)
 
- 
- 
- #### [PushtokenReq](#PushtokenReq)
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || action | string |  no  |  || channel | string |  no  |  || response | string |  no  |  |
+
+---
+
+#### [CommunicationConsentRes](#CommunicationConsentRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | action | string |  no  |  |
- | bundle_identifier | string |  no  |  |
- | push_token | string |  no  |  |
- | unique_device_id | string |  no  |  |
- | type | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || app_id | string |  no  |  || channels | [CommunicationConsentChannels](#CommunicationConsentChannels) |  no  |  || user_id | string |  no  |  |
 
 ---
 
+#### [NotFound](#NotFound)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || message | string |  no  |  |
+
+---
 
- 
- 
- #### [PushtokenRes](#PushtokenRes)
+#### [Page](#Page)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | bundle_identifier | string |  no  |  |
- | push_token | string |  no  |  |
- | unique_device_id | string |  no  |  |
- | type | string |  no  |  |
- | platform | string |  no  |  |
- | application_id | string |  no  |  |
- | user_id | string |  no  |  |
- | created_at | string |  no  |  |
- | updated_at | string |  no  |  |
- | expired_at | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || current | number |  no  |  || has_next | boolean |  no  |  || has_previous | boolean |  no  |  || item_total | number |  no  |  || next_id | string |  no  |  || size | number |  no  |  || type | string |  yes  |  |
 
 ---
 
+#### [PushtokenReq](#PushtokenReq)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || action | string |  no  |  || bundle_identifier | string |  no  |  || push_token | string |  no  |  || type | string |  no  |  || unique_device_id | string |  no  |  |
+
+---
 
- 
- 
- #### [Page](#Page)
+#### [PushtokenRes](#PushtokenRes)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | type | string |  yes  |  |
- | size | number |  no  |  |
- | current | number |  no  |  |
- | has_next | boolean |  no  |  |
- | item_total | number |  no  |  |
- | next_id | string |  no  |  |
- | has_previous | boolean |  no  |  |
+ | ---------- | ---- | -------- | ----------- || _id | string |  no  |  || application_id | string |  no  |  || bundle_identifier | string |  no  |  || created_at | string |  no  |  || expired_at | string |  no  |  || platform | string |  no  |  || push_token | string |  no  |  || type | string |  no  |  || unique_device_id | string |  no  |  || updated_at | string |  no  |  || user_id | string |  no  |  |
 
 ---