@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/documentation/platform/PARTNER.md

@@ -1,220 +0,0 @@
-
-
-
-
-
-##### [Back to Platform docs](./README.md)
-
-## Partner Methods
-Partner configuration apis
-
-* [addProxyPath](#addproxypath)
-* [removeProxyPath](#removeproxypath)
-
-
-
-## Methods with example and description
-
-
-
-
-### addProxyPath
-Create proxy URL for the external URL
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").partner.addProxyPath({  extensionId : value,
- body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").partner.addProxyPath({  extensionId : value,
- body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| extensionId | string | yes | Extension id for which proxy URL will be generated |  
-| body | [AddProxyReq](#AddProxyReq) | yes | Request body |
-
-
-Use this API to generate proxy URL for the external URL
-
-*Returned Response:*
-
-
-
-
-[AddProxyResponse](#AddProxyResponse)
-
-Proxy created successfully
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "_id": "607406b8a472cd527303692f",
-  "attached_path": "test",
-  "proxy_url": "https://www.abc.com",
-  "company_id": "1",
-  "application_id": "000000000000000000000004",
-  "extension_id": "6073280be899ea5b1150fd9d",
-  "created_at": "2021-04-12T08:37:12.077Z",
-  "modified_at": "2021-04-12T08:37:12.077Z"
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### removeProxyPath
-Remove proxy URL for the external URL
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").partner.removeProxyPath({  extensionId : value,
- attachedPath : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").partner.removeProxyPath({  extensionId : value,
- attachedPath : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| extensionId | string | yes | Extension id for which proxy URL needs to be removed |   
-| attachedPath | string | yes | Attachaed path slug |  
-
-
-
-Use this API to remove the proxy URL which is already generated for the external URL
-
-*Returned Response:*
-
-
-
-
-[RemoveProxyResponse](#RemoveProxyResponse)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "message": "Proxy URL deleted",
-  "data": {
-    "_id": "607406b8a472cd527303692f",
-    "attached_path": "test",
-    "proxy_url": "https://www.abc.com",
-    "company_id": "1",
-    "application_id": "000000000000000000000004",
-    "extension_id": "6073280be899ea5b1150fd9d",
-    "created_at": "2021-04-12T08:37:12.077Z",
-    "modified_at": "2021-04-12T08:37:12.077Z"
-  }
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-
-### Schemas
-
- 
- 
- #### [AddProxyReq](#AddProxyReq)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | attached_path | string |  no  | Proxy path slug |
- | proxy_url | string |  no  | The external URL for which the proxy URL will be generated |
-
----
-
-
- 
- 
- #### [AddProxyResponse](#AddProxyResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | attached_path | string |  no  |  |
- | proxy_url | string |  no  |  |
- | company_id | string |  no  |  |
- | application_id | string |  no  |  |
- | extension_id | string |  no  |  |
- | created_at | string |  no  |  |
- | modified_at | string |  no  |  |
-
----
-
-
- 
- 
- #### [RemoveProxyResponse](#RemoveProxyResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
- | data | string |  no  |  |
-
----
-
-
- 
- 
- #### [APIError](#APIError)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | code | string |  no  |  |
- | message | string |  no  |  |
- | info | string |  no  | Error code description link |
- | request_id | string |  no  |  |
- | meta | string |  no  |  |
-
----
-
-
-
-