asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
* 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>
This commit is contained in:
github-actions[bot]
2023-10-20 14:01:27 +03:00
committed by GitHub
co-authored by olivermrbl Shahed nasser
parent 83f46b9b32
commit 9dcd62c731
1604 changed files with 211689 additions and 151746 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx
+332
View File
@@ -0,0 +1,332 @@
---
displayed_sidebar: jsClientSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CustomerResource
[customers](../../modules/customers.mdx).CustomerResource
## Properties
<ParameterTypes parameters={[
{
"name": "addresses",
"type": "[`AddressesResource`](../../addresses/classes/addresses.AddressesResource.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "paymentMethods",
"type": "[`PaymentMethodsResource`](../../payment_methods/classes/payment_methods.PaymentMethodsResource.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Creates a customer
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`StorePostCustomersReq`](../../internal/classes/admin_discounts.internal.internal.StorePostCustomersReq.mdx)",
"description": "information of customer",
"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": []
}
]
}
]} />
___
### generatePasswordToken
▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
Generates a reset password token, which can be used to reset the password.
The token is not returned but should be sent out to the customer in an email.
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`StorePostCustomersCustomerPasswordTokenReq`](../../internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerPasswordTokenReq.mdx)",
"description": "info used to generate token",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)",
"optional": false,
"defaultValue": "",
"description": "",
"children": []
}
]} />
___
### listOrders
▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\>
Retrieve customer orders
#### Parameters
<ParameterTypes parameters={[
{
"name": "params",
"type": "[`StoreGetCustomersCustomerOrdersParams`](../../internal/classes/admin_discounts.internal.internal.StoreGetCustomersCustomerOrdersParams.mdx)",
"description": "optional params to retrieve orders",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"description": "",
"optional": false,
"defaultValue": "`{}`",
"children": []
}
]} />
#### Returns
[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\>
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\\>",
"optional": false,
"defaultValue": "",
"description": "",
"children": [
{
"name": "StoreCustomersListOrdersRes",
"type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx)[] }",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />
___
### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Resets customer password
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`StorePostCustomersResetPasswordReq`](../../internal/classes/admin_discounts.internal.internal.StorePostCustomersResetPasswordReq.mdx)",
"description": "info used to reset customer password",
"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": []
}
]
}
]} />
___
### retrieve
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Retrieves the customer that is currently logged
#### Parameters
<ParameterTypes parameters={[
{
"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": []
}
]
}
]} />
___
### update
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Updates a customer
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`StorePostCustomersCustomerReq`](../../internal/classes/admin_discounts.internal.internal.StorePostCustomersCustomerReq.mdx)",
"description": "information to update customer with",
"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": []
}
]
}
]} />