chore(docs): Generated JS Client Reference (#5421)

* chore(docs): Generated JS Client Reference (automated) * fix js client reference * fix links --------- Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed nasser <shahednasser@gmail.com>
2023-10-20 14:01:27 +03:00
parent 83f46b9b32
commit 9dcd62c731
1604 changed files with 211689 additions and 151746 deletions
@@ -0,0 +1,119 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# CollectionsResource
+
+[collections](../../modules/collections.mdx).CollectionsResource
+
+## Methods
+
+### list
+
+▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\>
+
+#### Parameters
+
+<ParameterTypes parameters={[
+  {
+    "name": "query",
+    "type": "[`StoreGetCollectionsParams`](../../internal/classes/admin_discounts.internal.internal.StoreGetCollectionsParams.mdx)",
+    "description": "is optional. Can contain a limit and offset for the returned list",
+    "optional": true,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "customHeaders",
+    "type": "Record<`string`, `any`\\>",
+    "description": "",
+    "optional": false,
+    "defaultValue": "`{}`",
+    "children": []
+  }
+]} />
+
+#### Returns
+
+[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\>
+
+<ParameterTypes parameters={[
+  {
+    "name": "ResponsePromise",
+    "type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\\>",
+    "optional": false,
+    "defaultValue": "",
+    "description": "",
+    "children": [
+      {
+        "name": "StoreCollectionsListRes",
+        "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[]  }",
+        "description": "",
+        "optional": false,
+        "defaultValue": "",
+        "children": []
+      }
+    ]
+  }
+]} />
+
+#### Description
+
+Retrieves a list of collections
+
+___
+
+### retrieve
+
+▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\>
+
+#### Parameters
+
+<ParameterTypes parameters={[
+  {
+    "name": "id",
+    "type": "`string`",
+    "description": "id of the collection",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "customHeaders",
+    "type": "Record<`string`, `any`\\>",
+    "description": "",
+    "optional": false,
+    "defaultValue": "`{}`",
+    "children": []
+  }
+]} />
+
+#### Returns
+
+[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\>
+
+<ParameterTypes parameters={[
+  {
+    "name": "ResponsePromise",
+    "type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\\>",
+    "optional": false,
+    "defaultValue": "",
+    "description": "",
+    "children": [
+      {
+        "name": "StoreCollectionsRes",
+        "type": "`object`",
+        "description": "",
+        "optional": false,
+        "defaultValue": "",
+        "children": []
+      }
+    ]
+  }
+]} />
+
+#### Description
+
+Retrieves a single collection