@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/documentation/application/FILESTORAGE.md

@@ -1,578 +0,0 @@
-
-
-
-
-
-##### [Back to Application docs](./README.md)
-
-## FileStorage Methods
-File Storage
-
-* [upload](#upload)
-
-* [startUpload](#startupload)
-* [completeUpload](#completeupload)
-* [signUrls](#signurls)
-
-
-
-## 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.
-
-
-
-```javascript
-// Promise
-const promise = fileStorage.startUpload({  namespace : value,
- body : value });
-
-// Async/Await
-const data = await fileStorage.startUpload({  namespace : value,
- body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| namespace | string | yes | Name of the bucket created for storing objects. |  
-| body | [StartRequest](#StartRequest) | yes | Request body |
-
-
-Use this API to perform the first step of uploading (i.e. **Start**) an arbitrarily sized buffer or blob.
-
-The three major steps are:
-* Start
-* Upload
-* Complete
-
-### Start
-Initiates the assets upload using `startUpload`.
-It returns a storage link in response.
-
-### Upload
-Use the storage link to upload a file (Buffer or Blob) to the File Storage.
-Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
-
-### Complete
-After successfully upload, call the `completeUpload` API to finish the upload process.
-This operation will return the URL of the uploaded file.
-
-
-*Returned Response:*
-
-
-
-
-[StartResponse](#StartResponse)
-
-Success. Next, call the `completeUpload` API and pass the response payload of this API to finish the upload process.
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### completeUpload
-Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
-
-
-
-```javascript
-// Promise
-const promise = fileStorage.completeUpload({  namespace : value,
- body : value });
-
-// Async/Await
-const data = await fileStorage.completeUpload({  namespace : value,
- body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| namespace | string | yes | Name of the bucket created for storing objects. |  
-| body | [StartResponse](#StartResponse) | yes | Request body |
-
-
-Use this API to perform the third step of uploading (i.e. **Complete**) an arbitrarily sized buffer or blob.
-
-The three major steps are:
-* Start
-* Upload
-* Complete
-
-### Start
-Initiates the assets upload using `startUpload`.
-It returns a storage link in response.
-
-### Upload
-Use the storage link to upload a file (Buffer or Blob) to the File Storage.
-Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
-
-### Complete
-After successfully upload, call the `completeUpload` API to finish the upload process.
-This operation will return the URL of the uploaded file.
-
-
-*Returned Response:*
-
-
-
-
-[CompleteResponse](#CompleteResponse)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### signUrls
-Explain here
-
-
-
-```javascript
-// Promise
-const promise = fileStorage.signUrls({  body : value });
-
-// Async/Await
-const data = await fileStorage.signUrls({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [SignUrlRequest](#SignUrlRequest) | yes | Request body |
-
-
-Describe here
-
-*Returned Response:*
-
-
-
-
-[SignUrlResponse](#SignUrlResponse)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-
-### Schemas
-
- 
- 
- #### [FailedResponse](#FailedResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  yes  |  |
-
----
-
-
- 
- 
- #### [CDN](#CDN)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | url | string |  yes  |  |
- | absolute_url | string |  no  |  |
- | relative_url | string |  no  |  |
-
----
-
-
- 
- 
- #### [Upload](#Upload)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | expiry | number |  yes  |  |
- | url | string |  yes  |  |
-
----
-
-
- 
- 
- #### [StartResponse](#StartResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | file_name | string |  yes  |  |
- | file_path | string |  yes  |  |
- | content_type | string |  yes  |  |
- | method | string |  no  |  |
- | namespace | string |  yes  |  |
- | operation | string |  yes  |  |
- | size | number |  yes  |  |
- | upload | [Upload](#Upload) |  yes  |  |
- | cdn | [CDN](#CDN) |  yes  |  |
- | tags | [string] |  no  |  |
-
----
-
-
- 
- 
- #### [StartRequest](#StartRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | file_name | string |  yes  |  |
- | content_type | string |  yes  |  |
- | size | number |  yes  |  |
- | tags | [string] |  no  |  |
- | params | string |  no  |  |
-
----
-
-
- 
- 
- #### [CompleteResponse](#CompleteResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  yes  |  |
- | file_name | string |  yes  |  |
- | file_path | string |  yes  |  |
- | content_type | string |  yes  |  |
- | namespace | string |  yes  |  |
- | operation | string |  yes  |  |
- | size | number |  yes  |  |
- | upload | [Upload](#Upload) |  yes  |  |
- | cdn | [CDN](#CDN) |  yes  |  |
- | success | boolean |  yes  |  |
- | tags | [string] |  no  |  |
- | created_on | string |  yes  |  |
- | modified_on | string |  yes  |  |
-
----
-
-
- 
- 
- #### [Opts](#Opts)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | attempts | number |  no  |  |
- | timestamp | number |  no  |  |
- | delay | number |  no  |  |
-
----
-
-
- 
- 
- #### [CopyFileTask](#CopyFileTask)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | id | string |  yes  |  |
- | name | string |  yes  |  |
- | data | [BulkRequest](#BulkRequest) |  yes  |  |
- | opts | [Opts](#Opts) |  yes  |  |
- | progress | number |  yes  |  |
- | delay | number |  yes  |  |
- | timestamp | number |  yes  |  |
- | attempts_made | number |  yes  |  |
- | stacktrace | [string] |  no  |  |
- | finished_on | number |  yes  |  |
- | processed_on | number |  yes  |  |
-
----
-
-
- 
- 
- #### [BulkUploadResponse](#BulkUploadResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | tracking_url | string |  yes  |  |
- | task | [CopyFileTask](#CopyFileTask) |  yes  |  |
-
----
-
-
- 
- 
- #### [ReqConfiguration](#ReqConfiguration)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | concurrency | number |  no  |  |
-
----
-
-
- 
- 
- #### [Destination](#Destination)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | namespace | string |  yes  |  |
- | rewrite | string |  yes  |  |
- | basepath | string |  no  |  |
-
----
-
-
- 
- 
- #### [BulkRequest](#BulkRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | urls | [string] |  yes  |  |
- | destination | [Destination](#Destination) |  yes  |  |
- | configuration | [ReqConfiguration](#ReqConfiguration) |  no  |  |
-
----
-
-
- 
- 
- #### [Urls](#Urls)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | url | string |  yes  |  |
- | signed_url | string |  yes  |  |
- | expiry | number |  yes  |  |
-
----
-
-
- 
- 
- #### [SignUrlResponse](#SignUrlResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | urls | [[Urls](#Urls)] |  yes  |  |
-
----
-
-
- 
- 
- #### [SignUrlRequest](#SignUrlRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | expiry | number |  yes  |  |
- | urls | [string] |  yes  |  |
-
----
-
-
- 
- 
- #### [Page](#Page)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | item_total | number |  no  |  |
- | next_id | string |  no  |  |
- | has_previous | boolean |  no  |  |
- | has_next | boolean |  no  |  |
- | current | number |  no  |  |
- | type | number |  yes  |  |
- | size | number |  no  |  |
-
----
-
-
- 
- 
- #### [DbRecord](#DbRecord)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  yes  |  |
- | tags | [string] |  yes  |  |
- | _id | string |  yes  |  |
- | file_name | string |  yes  |  |
- | operation | string |  no  |  |
- | namespace | string |  yes  |  |
- | content_type | string |  yes  |  |
- | file_path | string |  yes  |  |
- | upload | [Upload](#Upload) |  yes  |  |
- | cdn | [CDN](#CDN) |  yes  |  |
- | created_on | string |  yes  |  |
- | modified_on | string |  yes  |  |
-
----
-
-
- 
- 
- #### [BrowseResponse](#BrowseResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [[DbRecord](#DbRecord)] |  yes  |  |
- | page | [Page](#Page) |  yes  |  |
-
----
-
-
-
-