@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/documentation/platform/COMMON.md

@@ -1,452 +0,0 @@
-
-
-
-
-
-##### [Back to Platform docs](./README.md)
-
-## Common Methods
-Application configuration apis
-
-* [searchApplication](#searchapplication)
-* [getLocations](#getlocations)
-
-
-
-## Methods with example and description
-
-
-
-
-### searchApplication
-Search Application
-
-
-
-```javascript
-// Promise
-const promise = common.searchApplication({  authorization : value,
- query : value });
-
-// Async/Await
-const data = await common.searchApplication({  authorization : value,
- query : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| authorization | string | no |  |    
-| query | string | no | Provide application name |  
-
-
-
-Provide application name or domain url
-
-*Returned Response:*
-
-
-
-
-[ApplicationResponse](#ApplicationResponse)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "application": {
-    "website": {
-      "enabled": true,
-      "basepath": "/"
-    },
-    "cors": {
-      "domains": []
-    },
-    "auth": {
-      "enabled": true
-    },
-    "description": "test",
-    "channel_type": "store",
-    "cache_ttl": -1,
-    "internal": false,
-    "is_active": true,
-    "mode": "live",
-    "_id": "620b931ee7bfb11f910bf4a3",
-    "company_id": 2,
-    "name": "test",
-    "owner": "5b9b98150df588546aaea6d2",
-    "logo": {
-      "secure_url": "https://hdn-1.addsale.com/x0/company/164/applications/5efc9913f474c329718e3690/application/pictures/free-logo/original/olqHM8LNr-JioMart-Groceries.png"
-    },
-    "favicon": {
-      "secure_url": "https://hdn-1.addsale.com/x0/company/164/applications/5efc9913f474c329718e3690/application/pictures/free-logo/original/olqHM8LNr-JioMart-Groceries.png"
-    },
-    "banner": {
-      "secure_url": "https://hdn-1.addsale.com/x0/company/164/applications/5efc9913f474c329718e3690/application/pictures/landscape-banner/original/D2fr98CUH-JioMart-Groceries.png"
-    },
-    "token": "tPQv0nc23",
-    "tokens": [
-      {
-        "token": "tPQv0nc23",
-        "created_at": "2022-02-15T11:48:46.909Z"
-      }
-    ],
-    "domains": [
-      {
-        "verified": true,
-        "is_primary": true,
-        "is_shortlink": true,
-        "_id": "620b931ee7bfb11f910bf4a4",
-        "name": "qckvv5lhp.hostfynd.dev"
-      }
-    ],
-    "redirections": [],
-    "meta": [],
-    "created_at": "2022-02-15T11:48:46.909Z",
-    "modified_at": "2022-02-15T11:48:46.909Z",
-    "__v": 0,
-    "domain": {
-      "verified": true,
-      "is_primary": true,
-      "is_shortlink": true,
-      "_id": "620b931ee7bfb11f910bf4a4",
-      "name": "qckvv5lhp.hostfynd.dev"
-    },
-    "id": "620b931ee7bfb11f910bf4a3"
-  }
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### getLocations
-Get countries, states, cities
-
-
-
-```javascript
-// Promise
-const promise = common.getLocations({  locationType : value,
- id : value });
-
-// Async/Await
-const data = await common.getLocations({  locationType : value,
- id : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| locationType | string | no | Provide location type to query on. Possible values : country, state, city |    
-| id | string | no | Field is optional when location_type is country. If querying for state, provide id of country. If querying for city, provide id of state. |  
-
-
-
-
-
-*Returned Response:*
-
-
-
-
-[Locations](#Locations)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-
-### Schemas
-
- 
- 
- #### [ApplicationResponse](#ApplicationResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | application | [Application](#Application) |  no  |  |
-
----
-
-
- 
- 
- #### [Currency](#Currency)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | is_active | boolean |  no  |  |
- | name | string |  no  |  |
- | code | string |  no  |  |
- | created_at | string |  no  |  |
- | updated_at | string |  no  |  |
- | decimal_digits | number |  no  |  |
- | symbol | string |  no  |  |
-
----
-
-
- 
- 
- #### [Domain](#Domain)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | verified | boolean |  no  |  |
- | is_primary | boolean |  no  |  |
- | is_shortlink | boolean |  no  |  |
- | _id | string |  no  |  |
- | name | string |  no  |  |
- | is_predefined | boolean |  no  | Domain is hosting domain or not. |
-
----
-
-
- 
- 
- #### [ApplicationWebsite](#ApplicationWebsite)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | enabled | boolean |  no  |  |
- | basepath | string |  no  |  |
-
----
-
-
- 
- 
- #### [ApplicationCors](#ApplicationCors)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | domains | [string] |  no  |  |
-
----
-
-
- 
- 
- #### [ApplicationAuth](#ApplicationAuth)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | enabled | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [ApplicationRedirections](#ApplicationRedirections)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | redirect_from | string |  no  |  |
- | redirect_to | string |  no  |  |
- | type | string |  no  |  |
-
----
-
-
- 
- 
- #### [ApplicationMeta](#ApplicationMeta)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | name | string |  no  |  |
- | value | string |  no  |  |
-
----
-
-
- 
- 
- #### [SecureUrl](#SecureUrl)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | secure_url | string |  no  |  |
-
----
-
-
- 
- 
- #### [Application](#Application)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | website | [ApplicationWebsite](#ApplicationWebsite) |  no  |  |
- | cors | [ApplicationCors](#ApplicationCors) |  no  |  |
- | auth | [ApplicationAuth](#ApplicationAuth) |  no  |  |
- | description | string |  no  |  |
- | channel_type | string |  no  |  |
- | cache_ttl | number |  no  |  |
- | is_internal | boolean |  no  |  |
- | is_active | boolean |  no  |  |
- | _id | string |  no  |  |
- | name | string |  no  |  |
- | owner | string |  no  |  |
- | company_id | number |  no  |  |
- | token | string |  no  |  |
- | redirections | [[ApplicationRedirections](#ApplicationRedirections)] |  no  |  |
- | meta | [[ApplicationMeta](#ApplicationMeta)] |  no  |  |
- | created_at | string |  no  |  |
- | updated_at | string |  no  |  |
- | __v | number |  no  |  |
- | banner | [SecureUrl](#SecureUrl) |  no  |  |
- | logo | [SecureUrl](#SecureUrl) |  no  |  |
- | favicon | [SecureUrl](#SecureUrl) |  no  |  |
- | domains | [[Domain](#Domain)] |  no  |  |
- | app_type | string |  no  |  |
- | mobile_logo | [SecureUrl](#SecureUrl) |  no  |  |
- | domain | [Domain](#Domain) |  no  |  |
-
----
-
-
- 
- 
- #### [NotFound](#NotFound)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
-
----
-
-
- 
- 
- #### [BadRequest](#BadRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  | Failure message. |
-
----
-
-
- 
- 
- #### [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  |  |
-
----
-
-
- 
- 
- #### [LocationDefaultLanguage](#LocationDefaultLanguage)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | name | string |  no  |  |
- | code | string |  no  |  |
-
----
-
-
- 
- 
- #### [LocationDefaultCurrency](#LocationDefaultCurrency)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | name | string |  no  |  |
- | symbol | string |  no  |  |
- | code | string |  no  |  |
-
----
-
-
- 
- 
- #### [LocationCountry](#LocationCountry)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | capital | string |  no  |  |
- | currency | string |  no  |  |
- | iso2 | string |  no  |  |
- | iso3 | string |  no  |  |
- | name | string |  no  |  |
- | parent | string |  no  |  |
- | phone_code | string |  no  |  |
- | type | string |  no  |  |
- | uid | number |  no  |  |
- | __v | number |  no  |  |
- | _id | string |  no  |  |
- | default_currency | [LocationDefaultCurrency](#LocationDefaultCurrency) |  no  |  |
- | default_language | [LocationDefaultLanguage](#LocationDefaultLanguage) |  no  |  |
-
----
-
-
- 
- 
- #### [Locations](#Locations)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [string] |  no  |  |
-
----
-
-
-
-