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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
docs/content/references/services/classes/GiftCardService.md
View File

@@ -1,5 +1,7 @@
# Class: GiftCardService
Provides layer to manipulate gift cards.
## Hierarchy
- `TransactionBaseService`<[`GiftCardService`](GiftCardService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;GiftCardService\&gt;.constructor
#### Defined in
[services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L46)
[packages/medusa/src/services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L46)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;GiftCardService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
@@ -54,7 +64,7 @@ ___
#### Defined in
[services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L37)
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L37)
___
@@ -64,7 +74,7 @@ ___
#### Defined in
[services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L34)
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L34)
___
@@ -74,7 +84,7 @@ ___
#### Defined in
[services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L35)
[packages/medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L35)
___
@@ -88,7 +98,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L39)
[packages/medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L39)
___
@@ -98,7 +108,7 @@ ___
#### Defined in
[services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L36)
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L36)
___
@@ -112,7 +122,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L40)
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L40)
___
@@ -128,7 +138,7 @@ ___
#### Defined in
[services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L42)
[packages/medusa/src/services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L42)
## Methods
@@ -136,6 +146,10 @@ ___
▸ `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 |
@@ -147,21 +161,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `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/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -169,19 +185,23 @@ ___
▸ **create**(`giftCard`): `Promise`<`GiftCard`\>
Creates a gift card with provided data given that the data is validated.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCard` | `CreateGiftCardInput` | |
| `giftCard` | `CreateGiftCardInput` | the gift card data to create |
#### Returns
`Promise`<`GiftCard`\>
the result of the create operation
#### Defined in
[services/gift-card.ts:155](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L155)
[packages/medusa/src/services/gift-card.ts:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L152)
___
@@ -201,7 +221,7 @@ ___
#### Defined in
[services/gift-card.ts:139](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L139)
[packages/medusa/src/services/gift-card.ts:137](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L137)
___
@@ -209,19 +229,23 @@ ___
▸ **delete**(`giftCardId`): `Promise`<`void` \| `GiftCard`\>
Deletes a gift card idempotently
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCardId` | `string` | |
| `giftCardId` | `string` | id of gift card to delete |
#### Returns
`Promise`<`void` \| `GiftCard`\>
the result of the delete operation
#### Defined in
[services/gift-card.ts:288](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L288)
[packages/medusa/src/services/gift-card.ts:282](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L282)
___
@@ -233,16 +257,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `QuerySelector`<`GiftCard`\> | |
| `config` | `FindConfig`<`GiftCard`\> | |
| `selector` | `QuerySelector`<`GiftCard`\> | the query object for find |
| `config` | `FindConfig`<`GiftCard`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<`GiftCard`[]\>
the result of the find operation
#### Defined in
[services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L114)
[packages/medusa/src/services/gift-card.ts:113](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L113)
___
@@ -254,16 +280,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `QuerySelector`<`GiftCard`\> | |
| `config` | `FindConfig`<`GiftCard`\> | |
| `selector` | `QuerySelector`<`GiftCard`\> | the query object for find |
| `config` | `FindConfig`<`GiftCard`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<[`GiftCard`[], `number`]\>
the result of the find operation
#### Defined in
[services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L84)
[packages/medusa/src/services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L84)
___
@@ -271,20 +299,24 @@ ___
▸ **retrieve**(`giftCardId`, `config?`): `Promise`<`GiftCard`\>
Gets a gift card by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCardId` | `string` | |
| `config` | `FindConfig`<`GiftCard`\> | |
| `giftCardId` | `string` | id of gift card to retrieve |
| `config` | `FindConfig`<`GiftCard`\> | optional values to include with gift card query |
#### Returns
`Promise`<`GiftCard`\>
the gift card
#### Defined in
[services/gift-card.ts:220](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L220)
[packages/medusa/src/services/gift-card.ts:216](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L216)
___
@@ -305,7 +337,7 @@ ___
#### Defined in
[services/gift-card.ts:229](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L229)
[packages/medusa/src/services/gift-card.ts:223](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L223)
___
@@ -326,7 +358,7 @@ ___
#### Defined in
[services/gift-card.ts:185](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L185)
[packages/medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L182)
___
@@ -350,7 +382,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -358,20 +390,24 @@ ___
▸ **update**(`giftCardId`, `update`): `Promise`<`GiftCard`\>
Updates a giftCard.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCardId` | `string` | |
| `update` | `UpdateGiftCardInput` | |
| `giftCardId` | `string` | giftCard id of giftCard to update |
| `update` | `UpdateGiftCardInput` | the data to update the giftCard with |
#### Returns
`Promise`<`GiftCard`\>
the result of the update operation
#### Defined in
[services/gift-card.ts:244](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L244)
[packages/medusa/src/services/gift-card.ts:236](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L236)
___
@@ -395,7 +431,7 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
___
@@ -403,10 +439,14 @@ ___
▸ `Static` **generateCode**(): `string`
Generates a 16 character gift card code
#### Returns
`string`
the generated gift card code
#### Defined in
[services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L68)
[packages/medusa/src/services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L68)