@gofynd/fdk-client-javascript 0.1.35

package/documentation/application/COMMUNICATION.md

@@ -0,0 +1,463 @@
+
+
+
+
+##### [Back to Application docs](./README.md)
+
+## Communication Methods
+Manages email, sms, push notifications sent to users
+* [getCommunicationConsent](#getcommunicationconsent)
+* [upsertCommunicationConsent](#upsertcommunicationconsent)
+* [upsertAppPushtoken](#upsertapppushtoken)
+
+
+
+## Methods with example and description
+
+
+### getCommunicationConsent
+Get communication consent
+
+
+
+```javascript
+// Promise
+const promise = communication.getCommunicationConsent();
+
+// Async/Await
+const data = await communication.getCommunicationConsent();
+```
+
+
+
+
+
+
+Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp.
+
+*Returned Response:*
+
+
+
+
+[CommunicationConsent](#CommunicationConsent)
+
+Success. Returns all available communication opt-ins along with the consent details. Check the example shown below or refer `CommunicationConsent` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; default</i></summary>
+
+```json
+{
+  "value": {
+    "app_id": "000000000000000000000004",
+    "user_id": "5e56021c4bda3ccab6d9f884",
+    "channels": {
+      "email": {
+        "response": "yes",
+        "display_name": "Email"
+      },
+      "sms": {
+        "response": "yes",
+        "display_name": "SMS"
+      },
+      "whatsapp": {
+        "response": "yes",
+        "display_name": "WhatsApp",
+        "country_code": "91",
+        "phone_number": "9869821300"
+      }
+    }
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### 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>
+
+
+
+
+
+
+
+
+
+---
+
+
+### upsertAppPushtoken
+Upsert push token of a user
+
+
+
+```javascript
+// Promise
+const promise = communication.upsertAppPushtoken({  body : value });
+
+// Async/Await
+const data = await communication.upsertAppPushtoken({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [PushtokenReq](#PushtokenReq) | yes | Request body |
+
+
+Use this API to update and insert the push token of the user.
+
+*Returned Response:*
+
+
+
+
+[PushtokenRes](#PushtokenRes)
+
+Success. Check the example shown below or refer `PushtokenRes` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; create</i></summary>
+
+```json
+{
+  "value": {
+    "_id": "601b6924d8ea9a061570a09f",
+    "bundle_identifier": "000002",
+    "push_token": "45",
+    "unique_device_id": "3",
+    "type": "fynd-platform",
+    "platform": "web",
+    "application_id": "000000000000000000000004",
+    "user_id": "5e56021c4bda3ccab6d9f884",
+    "created_at": "2021-02-04T03:25:24.765Z",
+    "updated_at": "2021-02-04T03:25:51.152Z"
+  }
+}
+```
+</details>
+
+<details>
+<summary><i>&nbsp; update</i></summary>
+
+```json
+{
+  "value": {
+    "_id": "601b6924d8ea9a061570a09f",
+    "bundle_identifier": "000002",
+    "push_token": "45",
+    "unique_device_id": "3",
+    "type": "fynd-platform",
+    "platform": "web",
+    "application_id": "000000000000000000000004",
+    "user_id": "5e56021c4bda3ccab6d9f884",
+    "created_at": "2021-02-04T03:25:24.765Z",
+    "updated_at": "2021-02-04T03:25:51.152Z"
+  }
+}
+```
+</details>
+
+<details>
+<summary><i>&nbsp; reset</i></summary>
+
+```json
+{
+  "value": {
+    "_id": "601b6924d8ea9a061570a09f",
+    "bundle_identifier": "000002",
+    "push_token": "45",
+    "unique_device_id": "3",
+    "type": "fynd-platform",
+    "platform": "web",
+    "application_id": "000000000000000000000004",
+    "user_id": "5e56021c4bda3ccab6d9f884",
+    "created_at": "2021-02-04T03:25:24.765Z",
+    "updated_at": "2021-02-04T03:25:51.152Z",
+    "expired_at": "2021-02-05T03:25:51.138Z"
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+
+### Schemas
+
+ 
+ 
+ #### [CommunicationConsentReq](#CommunicationConsentReq)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | response | string |  no  |  |
+ | action | string |  no  |  |
+ | channel | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CommunicationConsentRes](#CommunicationConsentRes)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | app_id | string |  no  |  |
+ | user_id | string |  no  |  |
+ | channels | [CommunicationConsentChannels](#CommunicationConsentChannels) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CommunicationConsentChannelsEmail](#CommunicationConsentChannelsEmail)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | response | string |  no  |  |
+ | display_name | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [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)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | email | [CommunicationConsentChannelsEmail](#CommunicationConsentChannelsEmail) |  no  |  |
+ | sms | [CommunicationConsentChannelsSms](#CommunicationConsentChannelsSms) |  no  |  |
+ | whatsapp | [CommunicationConsentChannelsWhatsapp](#CommunicationConsentChannelsWhatsapp) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CommunicationConsent](#CommunicationConsent)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | app_id | string |  no  |  |
+ | user_id | string |  no  |  |
+ | channels | [CommunicationConsentChannels](#CommunicationConsentChannels) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BadRequestSchema](#BadRequestSchema)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | status | string |  no  | Response status. |
+ | message | string |  no  | Failure message. |
+
+---
+
+
+ 
+ 
+ #### [NotFound](#NotFound)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | message | string |  no  | Failure message. |
+
+---
+
+
+ 
+ 
+ #### [PushtokenReq](#PushtokenReq)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | action | string |  no  |  |
+ | bundle_identifier | string |  no  |  |
+ | push_token | string |  no  |  |
+ | unique_device_id | string |  no  |  |
+ | type | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [PushtokenRes](#PushtokenRes)
+
+ | 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  |  |
+
+---
+
+
+ 
+ 
+ #### [Page](#Page)
+
+ | 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  |  |
+
+---
+
+
+
+