@gofynd/fdk-client-javascript 0.1.35 → 0.1.37

package/documentation/platform/CONFIGURATION.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Platform docs](./README.md)
 
 ## Configuration Methods
 Application configuration apis
+
 * [getBuildConfig](#getbuildconfig)
 * [updateBuildConfig](#updatebuildconfig)
 * [getPreviousVersions](#getpreviousversions)
@@ -58,6 +60,8 @@ Application configuration apis
 ## Methods with example and description
 
 
+
+
 ### getBuildConfig
 Get latest build config
 

package/documentation/platform/CONTENT.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Platform docs](./README.md)
 
 ## Content Methods
 Content System
+
 * [getAnnouncementsList](#getannouncementslist)
 * [createAnnouncement](#createannouncement)
 * [getAnnouncementById](#getannouncementbyid)
@@ -80,6 +82,8 @@ Content System
 ## Methods with example and description
 
 
+
+
 ### getAnnouncementsList
 Get a list of announcements
 
@@ -1351,7 +1355,7 @@ Use this to get all data loaders of an application
 
 [DataLoadersSchema](#DataLoadersSchema)
 
-Success. Refer `DataLoaderResponseSchema` for more details.
+Success. Refer `DataLoadersSchema` for more details.
 
 
 
@@ -7952,26 +7956,6 @@ Success. Returns a JSON object of components. Refer `PageSchema` for more detail
  
  #### [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  |  |
@@ -8118,6 +8102,7 @@ Success. Returns a JSON object of components. Refer `PageSchema` for more detail
  | url | string |  no  |  |
  | position | string |  no  |  |
  | attributes | string |  no  |  |
+ | pages | [string] |  no  |  |
  | content | string |  no  |  |
 
 ---
@@ -8903,6 +8888,7 @@ Success. Returns a JSON object of components. Refer `PageSchema` for more detail
  | position | string |  no  |  |
  | attributes | string |  no  |  |
  | content | string |  no  |  |
+ | pages | [string] |  no  |  |
  | __source | [TagSourceSchema](#TagSourceSchema) |  no  |  |
 
 ---
@@ -8959,6 +8945,7 @@ Success. Returns a JSON object of components. Refer `PageSchema` for more detail
  | 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/platform/DISCOUNT.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Platform docs](./README.md)
 
 ## Discount Methods
 Discount
+
 * [getDiscounts](#getdiscounts)
 * [createDiscount](#creatediscount)
 * [getDiscount](#getdiscount)
@@ -22,6 +24,8 @@ Discount
 ## Methods with example and description
 
 
+
+
 ### getDiscounts
 Fetch discount list.
 

package/documentation/platform/FILESTORAGE.md

@@ -2,10 +2,14 @@
 
 
 
+
 ##### [Back to Platform docs](./README.md)
 
 ## FileStorage Methods
 File Storage
+
+* [upload](#upload)
+
 * [startUpload](#startupload)
 * [completeUpload](#completeupload)
 * [appStartUpload](#appstartupload)
@@ -22,6 +26,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
 This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
 

package/documentation/platform/INVENTORY.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Platform docs](./README.md)
 
 ## Inventory Methods
 
+
 * [getJobsByCompany](#getjobsbycompany)
 * [updateJob](#updatejob)
 * [createJob](#createjob)
@@ -24,6 +26,8 @@
 ## Methods with example and description
 
 
+
+
 ### getJobsByCompany
 Get Job Configs For A Company
 

package/documentation/platform/LEAD.md

@@ -2,10 +2,12 @@
 
 
 
+
 ##### [Back to Platform docs](./README.md)
 
 ## Lead Methods
 Handles communication between Administrator <-> Staff and Staff <-> Users
+
 * [getTickets](#gettickets)
 * [createTicket](#createticket)
 * [getTickets](#gettickets)
@@ -36,6 +38,8 @@ Handles communication between Administrator <-> Staff and Staff <-> Users
 ## Methods with example and description
 
 
+
+
 ### getTickets
 Gets the list of company level tickets and/or ticket filters depending on query params
 
@@ -4288,7 +4292,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 |
 
 ---
 
@@ -4634,7 +4638,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 |