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,176 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# AddressesResource
+
+[addresses](../../modules/addresses.mdx).AddressesResource
+
+## Methods
+
+### addAddress
+
+▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
+
+Adds an address to a customers saved addresses
+
+#### Parameters
+
+<ParameterTypes parameters={[
+  {
+    "name": "payload",
+    "type": "[`StorePostCustomersCustomerAddressesReq`](../../internal/classes/addresses.internal.StorePostCustomersCustomerAddressesReq.mdx)",
+    "description": "contains information to create an address",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "customHeaders",
+    "type": "Record<`string`, `any`\\>",
+    "description": "",
+    "optional": false,
+    "defaultValue": "`{}`",
+    "children": []
+  }
+]} />
+
+#### Returns
+
+[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
+
+<ParameterTypes parameters={[
+  {
+    "name": "ResponsePromise",
+    "type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\\>",
+    "optional": false,
+    "defaultValue": "",
+    "description": "",
+    "children": [
+      {
+        "name": "StoreCustomersRes",
+        "type": "`object`",
+        "description": "",
+        "optional": false,
+        "defaultValue": "",
+        "children": []
+      }
+    ]
+  }
+]} />
+
+___
+
+### deleteAddress
+
+▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
+
+Deletes an address of a customer
+
+#### Parameters
+
+<ParameterTypes parameters={[
+  {
+    "name": "address_id",
+    "type": "`string`",
+    "description": "id of the address to delete",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "customHeaders",
+    "type": "Record<`string`, `any`\\>",
+    "description": "",
+    "optional": false,
+    "defaultValue": "`{}`",
+    "children": []
+  }
+]} />
+
+#### Returns
+
+[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
+
+<ParameterTypes parameters={[
+  {
+    "name": "ResponsePromise",
+    "type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\\>",
+    "optional": false,
+    "defaultValue": "",
+    "description": "",
+    "children": [
+      {
+        "name": "StoreCustomersRes",
+        "type": "`object`",
+        "description": "",
+        "optional": false,
+        "defaultValue": "",
+        "children": []
+      }
+    ]
+  }
+]} />
+
+___
+
+### updateAddress
+
+▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
+
+Update an address of a customer
+
+#### Parameters
+
+<ParameterTypes parameters={[
+  {
+    "name": "address_id",
+    "type": "`string`",
+    "description": "id of customer",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "payload",
+    "type": "[`StorePostCustomersCustomerAddressesAddressReq`](../../internal/classes/addresses.internal.StorePostCustomersCustomerAddressesAddressReq.mdx)",
+    "description": "address update",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "customHeaders",
+    "type": "Record<`string`, `any`\\>",
+    "description": "",
+    "optional": false,
+    "defaultValue": "`{}`",
+    "children": []
+  }
+]} />
+
+#### Returns
+
+[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
+
+<ParameterTypes parameters={[
+  {
+    "name": "ResponsePromise",
+    "type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\\>",
+    "optional": false,
+    "defaultValue": "",
+    "description": "",
+    "children": [
+      {
+        "name": "StoreCustomersRes",
+        "type": "`object`",
+        "description": "",
+        "optional": false,
+        "defaultValue": "",
+        "children": []
+      }
+    ]
+  }
+]} />