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

chore(docs): Generated Services Reference (automated) (#2528)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-03 10:09:19 +02:00
committed by GitHub
co-authored by olivermrbl
parent bb95afabbb
commit f5d6652026
52 changed files with 2242 additions and 1236 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/services/classes/CustomerGroupService.md
+42 -20
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/customer-group.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L33)
[packages/medusa/src/services/customer-group.ts:33](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L33)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L30)
[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L30)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L31)
[packages/medusa/src/services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L31)
___
@@ -86,7 +86,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L27)
[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L27)
___
@@ -100,7 +100,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L28)
[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L28)
## Methods
@@ -125,7 +125,7 @@ the customer group after insertion
#### Defined in
[packages/medusa/src/services/customer-group.ts:92](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L92)
[packages/medusa/src/services/customer-group.ts:92](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L92)
___
@@ -164,7 +164,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -196,7 +196,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/customer-group.ts:68](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L68)
[packages/medusa/src/services/customer-group.ts:68](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L68)
___
@@ -220,7 +220,29 @@ a promise
#### Defined in
[packages/medusa/src/services/customer-group.ts:174](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L174)
[packages/medusa/src/services/customer-group.ts:156](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L156)
___
### handleCreationFail
▸ `Private` **handleCreationFail**(`id`, `ids`, `error`): `Promise`<`never`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `ids` | `string`[] |
| `error` | `any` |
#### Returns
`Promise`<`never`\>
#### Defined in
[packages/medusa/src/services/customer-group.ts:259](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L259)
___
@@ -234,7 +256,7 @@ List customer groups.
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableCustomerGroupProps` | the query object for find |
| `selector` | `Selector`<`CustomerGroup`\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`CustomerGroup`\> | the config to be used for find |
#### Returns
@@ -245,7 +267,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/customer-group.ts:197](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L197)
[packages/medusa/src/services/customer-group.ts:179](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L179)
___
@@ -259,7 +281,7 @@ Retrieve a list of customer groups and total count of records that match the que
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableCustomerGroupProps` | the query object for find |
| `selector` | `Selector`<`CustomerGroup`\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`CustomerGroup`\> | the config to be used for find |
#### Returns
@@ -270,7 +292,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/customer-group.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L216)
[packages/medusa/src/services/customer-group.ts:197](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L197)
___
@@ -295,7 +317,7 @@ the customergroup with the provided id
#### Defined in
[packages/medusa/src/services/customer-group.ts:252](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L252)
[packages/medusa/src/services/customer-group.ts:238](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L238)
___
@@ -316,7 +338,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer-group.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L45)
[packages/medusa/src/services/customer-group.ts:45](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L45)
___
@@ -340,7 +362,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -365,7 +387,7 @@ resulting customer group
#### Defined in
[packages/medusa/src/services/customer-group.ts:141](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L141)
[packages/medusa/src/services/customer-group.ts:123](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/services/customer-group.ts#L123)
___
@@ -389,4 +411,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa/src/interfaces/transaction-base-service.ts#L13)