@gofynd/fdk-client-javascript 0.1.35 → 0.1.37

package/documentation/application/COMMON.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Common Methods
 Application configuration apis
+
 * [searchApplication](#searchapplication)
 * [getLocations](#getlocations)
 
@@ -14,6 +16,8 @@ Application configuration apis
 ## Methods with example and description
 
 
+
+
 ### searchApplication
 Search Application
 

package/documentation/application/COMMUNICATION.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Communication Methods
 Manages email, sms, push notifications sent to users
+
 * [getCommunicationConsent](#getcommunicationconsent)
 * [upsertCommunicationConsent](#upsertcommunicationconsent)
 * [upsertAppPushtoken](#upsertapppushtoken)
@@ -15,6 +17,8 @@ Manages email, sms, push notifications sent to users
 ## Methods with example and description
 
 
+
+
 ### getCommunicationConsent
 Get communication consent
 

package/documentation/application/CONFIGURATION.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Configuration Methods
 Application configuration apis
+
 * [getApplication](#getapplication)
 * [getOwnerInfo](#getownerinfo)
 * [getBasicDetails](#getbasicdetails)
@@ -28,6 +30,8 @@ Application configuration apis
 ## Methods with example and description
 
 
+
+
 ### getApplication
 Get current application details
 

package/documentation/application/CONTENT.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Content Methods
 Content System
+
 * [getAnnouncements](#getannouncements)
 * [getBlog](#getblog)
 * [getBlogs](#getblogs)
@@ -31,6 +33,8 @@ Content System
 ## Methods with example and description
 
 
+
+
 ### getAnnouncements
 Get live announcements
 
@@ -2313,26 +2317,6 @@ Success. Returns a list of pages along with their details. Check the example sho
  
  #### [NavigationReference](#NavigationReference)
 
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | acl | [string] |  no  |  |
- | tags | [string] |  no  |  |
- | _locale_language | [LocaleLanguage](#LocaleLanguage) |  no  |  |
- | image | string |  no  |  |
- | type | string |  no  |  |
- | action | [Action](#Action) |  no  |  |
- | active | boolean |  no  |  |
- | display | string |  no  |  |
- | sort_order | number |  no  |  |
- | sub_navigation | [[SubNavigationReference](#SubNavigationReference)] |  no  |  |
-
----
-
-
- 
- 
- #### [SubNavigationReference](#SubNavigationReference)
-
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
  | acl | [string] |  no  |  |
@@ -2479,6 +2463,7 @@ Success. Returns a list of pages along with their details. Check the example sho
  | url | string |  no  |  |
  | position | string |  no  |  |
  | attributes | string |  no  |  |
+ | pages | [string] |  no  |  |
  | content | string |  no  |  |
 
 ---
@@ -3264,6 +3249,7 @@ Success. Returns a list of pages along with their details. Check the example sho
  | position | string |  no  |  |
  | attributes | string |  no  |  |
  | content | string |  no  |  |
+ | pages | [string] |  no  |  |
  | __source | [TagSourceSchema](#TagSourceSchema) |  no  |  |
 
 ---
@@ -3320,6 +3306,7 @@ Success. Returns a list of pages along with their details. Check the example sho
  | productRequest | product-request | Symbolic link for Product Request: /product-request/ |
  | products | products | Symbolic link for Products: /products/ |
  | profile | profile | Symbolic link for Profile: /profile |
+ | profileOrderShipment | profile-order-shipment | Symbolic link for profile orders shipment: /profile/orders/shipment/:shipmentid |
  | profileBasic | profile-basic | Symbolic link for Basic Profile: /profile/details |
  | profileCompany | profile-company | Symbolic link for Profile Company: /profile/company |
  | profileEmails | profile-emails | Symbolic link for Profile Emails: /profile/email |

package/documentation/application/FILESTORAGE.md

@@ -2,10 +2,14 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## FileStorage Methods
 File Storage
+
+* [upload](#upload)
+
 * [startUpload](#startupload)
 * [completeUpload](#completeupload)
 * [signUrls](#signurls)
@@ -15,6 +19,87 @@ File Storage
 ## Methods with example and description
 
 
+
+
+### upload
+method which internally calls `startUpload` and `completeUpload` method to handle the whole file upload flow.
+
+
+```javascript
+// Promise
+const promise = fileStorage.upload({
+    data,
+    file_name,
+    content_type,
+    namespace,
+    size,
+    tags,
+});
+
+// Async/Await
+const data = await fileStorage.upload({
+    data,
+    file_name,
+    content_type,
+    namespace,
+    size,
+    tags,
+});
+```
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| data | file | yes | File which needs to be uploaded |
+| file_name | string | yes | Name of the file |
+| content_type | string | yes | type of file |
+| namespace | string | yes | Name of the bucket created for storing objects |
+| size | number | yes | File size |
+| tags | [string] | yes |  |
+
+
+Use this API to perform the upload of an arbitrarily sized buffer or blob.
+
+
+
+*Returned Response:*
+
+[CompleteResponse](#CompleteResponse)
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+    "file_name":"logo.png",
+    "file_path":"/path/to/file/logo.png",
+    "success":true,
+    "namespace":"namespace",
+    "content_type":"image/png",
+    "size":1024,
+    "operation":"putObject",
+    "tags":[],
+    "cdn":{
+        "url":"https://cdn.pixelbin.io/v2/logo.png",
+        "absolute_url":"https://cdn.pixelbin.io/v2/logo.png",
+        "relative_url":"logo.png"
+    },
+    "_id":"63dbbxxxxxxxxxxxxdecc69f",
+    "created_by":{
+        "username":"username_gofynd_com"
+    },
+    "created_on":"2023-01-01T12:00:00.000Z",
+    "modified_on":"2023-01-01T00:00:00.000Z"
+}
+```
+</details>
+
+---
+
+
+
+
+
 ### startUpload
 Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.
 

package/documentation/application/LEAD.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Lead Methods
 Handles communication between Staff and Users
+
 * [getTicket](#getticket)
 * [createHistory](#createhistory)
 * [createTicket](#createticket)
@@ -19,6 +21,8 @@ Handles communication between Staff and Users
 ## Methods with example and description
 
 
+
+
 ### getTicket
 Get Ticket with the specific id
 
@@ -1443,7 +1447,7 @@ Success
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
  | message | string |  yes  | Success message for form submission |
- | ticket | [Ticket](#Ticket) |  yes  | Ticket created on form submission |
+ | ticket | [Ticket](#Ticket) |  no  | Ticket created on form submission |
 
 ---
 
@@ -1789,7 +1793,7 @@ Success
  | created_on | [CreatedOn](#CreatedOn) |  no  | Details of company and application realated to the ticket |
  | response_id | string |  no  | Details of company and application realated to the ticket |
  | content | [TicketContent](#TicketContent) |  no  | Ticket conetent details |
- | category | string |  yes  | Category assigned to the ticket |
+ | category | [TicketCategory](#TicketCategory) |  yes  | Category assigned to the ticket |
  | sub_category | string |  no  | Sub-category assigned to the ticket |
  | source | [TicketSourceEnum](#TicketSourceEnum) |  yes  | Denotes if the ticket was created at company or application level |
  | status | [Status](#Status) |  yes  | Denotes in what state is the ticket |