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

docs: updated services reference (#1809)

Browse Source
This commit is contained in:
Shahed Nasser
2022-07-06 17:11:05 +03:00
committed by GitHub
parent ae5c88b891
commit 5f6107e505
45 changed files with 4374 additions and 1479 deletions
Download Patch File Download Diff File Expand all files Collapse all files

317
docs/content/references/services/classes/CustomerService.md
View File

@@ -2,11 +2,9 @@
Provides layer to manipulate customers.
**`implements`** {BaseService}
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`<[`CustomerService`](CustomerService.md)\>
↳ **`CustomerService`**
@@ -20,18 +18,96 @@ Provides layer to manipulate customers.
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `Object` |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
BaseService.constructor
TransactionBaseService&lt;CustomerService\&gt;.constructor
#### Defined in
[services/customer.js:20](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L20)
[services/customer.ts:40](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L40)
## Properties
### addressRepository\_
• `Protected` `Readonly` **addressRepository\_**: typeof `AddressRepository`
#### Defined in
[services/customer.ts:28](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L28)
___
### configModule
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
TransactionBaseService.container
___
### customerRepository\_
• `Protected` `Readonly` **customerRepository\_**: typeof `CustomerRepository`
#### Defined in
[services/customer.ts:27](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L27)
___
### eventBusService\_
• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[services/customer.ts:29](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L29)
___
### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[services/customer.ts:31](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L31)
___
### transactionManager\_
• `Protected` `Readonly` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[services/customer.ts:32](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L32)
___
### Events
▪ `Static` **Events**: `Object`
@@ -46,52 +122,91 @@ BaseService.constructor
#### Defined in
[services/customer.js:14](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L14)
[services/customer.ts:34](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L34)
## Methods
### addAddress
▸ **addAddress**(`customerId`, `address`): `Promise`<`any`\>
▸ **addAddress**(`customerId`, `address`): `Promise`<`Customer` \| `Address`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customerId` | `any` |
| `address` | `any` |
| `customerId` | `string` |
| `address` | `AddressCreatePayload` |
#### Returns
`Promise`<`any`\>
`Promise`<`Customer` \| `Address`\>
#### Defined in
[services/customer.js:479](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L479)
[services/customer.ts:471](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L471)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
### count
▸ **count**(): `Promise`<`any`\>
▸ **count**(): `Promise`<`number`\>
Return the total number of documents in database
#### Returns
`Promise`<`any`\>
`Promise`<`number`\>
the result of the count operation
#### Defined in
[services/customer.js:192](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L192)
[services/customer.ts:161](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L161)
___
### create
▸ **create**(`customer`): `Promise`<`any`\>
▸ **create**(`customer`): `Promise`<`Customer`\>
Creates a customer from an email - customers can have accounts associated,
e.g. to login and view order history, etc. If a password is provided the
@@ -102,49 +217,23 @@ used to hold details of customers.
| Name | Type | Description |
| :------ | :------ | :------ |
| `customer` | `any` | the customer to create |
| `customer` | `CreateCustomerInput` | the customer to create |
#### Returns
`Promise`<`any`\>
`Promise`<`Customer`\>
the result of create
#### Defined in
[services/customer.js:290](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L290)
___
### decorate
▸ **decorate**(`customer`, `fields?`, `expandFields?`): `Customer`
Decorates a customer.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `customer` | `Customer` | `undefined` | the cart to decorate. |
| `fields` | `string`[] | `[]` | the fields to include. |
| `expandFields` | `string`[] | `[]` | fields to expand. |
#### Returns
`Customer`
return the decorated customer.
#### Defined in
[services/customer.js:547](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L547)
[services/customer.ts:255](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L255)
___
### delete
▸ **delete**(`customerId`): `Promise`<`any`\>
▸ **delete**(`customerId`): `Promise`<`void` \| `Customer`\>
Deletes a customer from a given customer id.
@@ -156,19 +245,19 @@ Deletes a customer from a given customer id.
#### Returns
`Promise`<`any`\>
`Promise`<`void` \| `Customer`\>
the result of the delete operation.
#### Defined in
[services/customer.js:523](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L523)
[services/customer.ts:519](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L519)
___
### generateResetPasswordToken
▸ **generateResetPasswordToken**(`customerId`): `string`
▸ **generateResetPasswordToken**(`customerId`): `Promise`<`string`\>
Generate a JSON Web token, that will be sent to a customer, that wishes to
reset password.
@@ -184,13 +273,13 @@ which is always 15 minutes.
#### Returns
`string`
`Promise`<`string`\>
the generated JSON web token
#### Defined in
[services/customer.js:67](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L67)
[services/customer.ts:65](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L65)
___
@@ -214,74 +303,74 @@ hashed password
#### Defined in
[services/customer.js:277](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L277)
[services/customer.ts:242](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L242)
___
### list
▸ **list**(`selector?`, `config?`): `Promise`<`any`\>
▸ **list**(`selector?`, `config?`): `Promise`<`Customer`[]\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | the query object for find |
| `config` | `any` | the config object containing query settings |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
`Promise`<`any`\>
`Promise`<`Customer`[]\>
the result of the find operation
#### Defined in
[services/customer.js:106](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L106)
[services/customer.ts:108](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L108)
___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<`any`\>
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Customer`[], `number`]\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | the query object for find |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
`Promise`<`any`\>
`Promise`<[`Customer`[], `number`]\>
the result of the find operation
#### Defined in
[services/customer.js:147](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L147)
[services/customer.ts:133](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L133)
___
### removeAddress
▸ **removeAddress**(`customerId`, `addressId`): `Promise`<`any`\>
▸ **removeAddress**(`customerId`, `addressId`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customerId` | `any` |
| `addressId` | `any` |
| `customerId` | `string` |
| `addressId` | `string` |
#### Returns
`Promise`<`any`\>
`Promise`<`void`\>
#### Defined in
[services/customer.js:460](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L460)
[services/customer.ts:454](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L454)
___
@@ -296,7 +385,7 @@ Gets a customer by id.
| Name | Type | Description |
| :------ | :------ | :------ |
| `customerId` | `string` | the id of the customer to get. |
| `config` | `any` | the config object containing query settings |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
@@ -306,7 +395,7 @@ the customer document.
#### Defined in
[services/customer.js:205](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L205)
[services/customer.ts:228](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L228)
___
@@ -321,7 +410,7 @@ Gets a customer by email.
| Name | Type | Description |
| :------ | :------ | :------ |
| `email` | `string` | the email of the customer to get. |
| `config` | `any` | the config object containing query settings |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
@@ -331,7 +420,7 @@ the customer document.
#### Defined in
[services/customer.js:230](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L230)
[services/customer.ts:198](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L198)
___
@@ -346,7 +435,7 @@ Gets a customer by phone.
| Name | Type | Description |
| :------ | :------ | :------ |
| `phone` | `string` | the phone of the customer to get. |
| `config` | `any` | the config object containing query settings |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
@@ -356,13 +445,58 @@ the customer document.
#### Defined in
[services/customer.js:254](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L254)
[services/customer.ts:213](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L213)
___
### retrieve\_
▸ `Private` **retrieve_**(`selector`, `config?`): `Promise`<`Customer`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `selector` | `Selector`<`Customer`\> |
| `config` | `FindConfig`<`Customer`\> |
#### Returns
`Promise`<`Customer`\>
#### Defined in
[services/customer.ts:168](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L168)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
### update
▸ **update**(`customerId`, `update`): `Promise`<`any`\>
▸ **update**(`customerId`, `update`): `Promise`<`Customer`\>
Updates a customer.
@@ -371,45 +505,45 @@ Updates a customer.
| Name | Type | Description |
| :------ | :------ | :------ |
| `customerId` | `string` | the id of the variant. Must be a string that can be casted to an ObjectId |
| `update` | `any` | an object with the update values. |
| `update` | `UpdateCustomerInput` | an object with the update values. |
#### Returns
`Promise`<`any`\>
`Promise`<`Customer`\>
resolves to the update result.
#### Defined in
[services/customer.js:346](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L346)
[services/customer.ts:310](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L310)
___
### updateAddress
▸ **updateAddress**(`customerId`, `addressId`, `address`): `Promise`<`any`\>
▸ **updateAddress**(`customerId`, `addressId`, `address`): `Promise`<`Address`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customerId` | `any` |
| `addressId` | `any` |
| `address` | `any` |
| `customerId` | `string` |
| `addressId` | `string` |
| `address` | `StorePostCustomersCustomerAddressesAddressReq` |
#### Returns
`Promise`<`any`\>
`Promise`<`Address`\>
#### Defined in
[services/customer.js:441](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L441)
[services/customer.ts:426](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L426)
___
### updateBillingAddress\_
▸ **updateBillingAddress_**(`customer`, `addressOrId`, `addrRepo`): `Promise`<`any`\>
▸ **updateBillingAddress_**(`customer`, `addressOrId`): `Promise`<`void`\>
Updates the customers' billing address.
@@ -418,35 +552,38 @@ Updates the customers' billing address.
| Name | Type | Description |
| :------ | :------ | :------ |
| `customer` | `Customer` | the Customer to update |
| `addressOrId` | `any` | the value to set the billing address to |
| `addrRepo` | `any` | address repository |
| `addressOrId` | `undefined` \| `string` \| `DeepPartial`<`Address`\> | the value to set the billing address to |
#### Returns
`Promise`<`any`\>
`Promise`<`void`\>
the result of the update operation
#### Defined in
[services/customer.js:408](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L408)
[services/customer.ts:374](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/customer.ts#L374)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`CustomerService`](CustomerService.md)
▸ **withTransaction**(`transactionManager?`): [`CustomerService`](CustomerService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `any` |
| `transactionManager?` | `EntityManager` |
#### Returns
[`CustomerService`](CustomerService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[services/customer.js:41](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/customer.js#L41)
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L16)