chore(docs): Generated Services Reference (automated) (#2891)
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
8cbd627fb7
commit
a32a2c4cf1
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L39)
|
||||
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L39)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L27)
|
||||
[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L26)
|
||||
[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L28)
|
||||
[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L30)
|
||||
[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L31)
|
||||
[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L33)
|
||||
[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L33)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -151,7 +151,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:457](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L457)
|
||||
[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L498)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -208,7 +208,7 @@ the result of the count operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L158)
|
||||
[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L158)
|
||||
|
||||
___
|
||||
|
||||
@@ -235,7 +235,7 @@ the result of create
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:245](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L245)
|
||||
[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L285)
|
||||
|
||||
___
|
||||
|
||||
@@ -259,7 +259,7 @@ the result of the delete operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:505](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L505)
|
||||
[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L546)
|
||||
|
||||
___
|
||||
|
||||
@@ -287,7 +287,7 @@ the generated JSON web token
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L64)
|
||||
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -311,7 +311,7 @@ hashed password
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:232](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L232)
|
||||
[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L272)
|
||||
|
||||
___
|
||||
|
||||
@@ -334,7 +334,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L107)
|
||||
[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -357,7 +357,28 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L131)
|
||||
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
### listByEmail
|
||||
|
||||
▸ **listByEmail**(`email`, `config?`): `Promise`<`Customer`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `email` | `string` |
|
||||
| `config` | `FindConfig`<`Customer`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Customer`[]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L228)
|
||||
|
||||
___
|
||||
|
||||
@@ -378,7 +399,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:440](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L440)
|
||||
[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L481)
|
||||
|
||||
___
|
||||
|
||||
@@ -403,7 +424,7 @@ the customer document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L220)
|
||||
[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L253)
|
||||
|
||||
___
|
||||
|
||||
@@ -411,7 +432,9 @@ ___
|
||||
|
||||
▸ **retrieveByEmail**(`email`, `config?`): `Promise`<`Customer`\>
|
||||
|
||||
Gets a customer by email.
|
||||
Gets a registered customer by email.
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -428,7 +451,7 @@ the customer document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L194)
|
||||
[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L195)
|
||||
|
||||
___
|
||||
|
||||
@@ -453,7 +476,49 @@ the customer document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L207)
|
||||
[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L240)
|
||||
|
||||
___
|
||||
|
||||
### retrieveRegisteredByEmail
|
||||
|
||||
▸ **retrieveRegisteredByEmail**(`email`, `config?`): `Promise`<`Customer`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `email` | `string` |
|
||||
| `config` | `FindConfig`<`Customer`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Customer`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L218)
|
||||
|
||||
___
|
||||
|
||||
### retrieveUnregisteredByEmail
|
||||
|
||||
▸ **retrieveUnregisteredByEmail**(`email`, `config?`): `Promise`<`Customer`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `email` | `string` |
|
||||
| `config` | `FindConfig`<`Customer`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Customer`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L209)
|
||||
|
||||
___
|
||||
|
||||
@@ -474,7 +539,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L164)
|
||||
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
@@ -498,7 +563,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -523,7 +588,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L300)
|
||||
[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L341)
|
||||
|
||||
___
|
||||
|
||||
@@ -545,7 +610,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:412](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L412)
|
||||
[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L453)
|
||||
|
||||
___
|
||||
|
||||
@@ -570,7 +635,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:360](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L360)
|
||||
[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L401)
|
||||
|
||||
___
|
||||
|
||||
@@ -594,4 +659,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
Reference in New Issue
Block a user