chore(docs): Generated Services Reference (automated) (#3719)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
3838067a54
commit
198f39f8d4
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L25)
|
||||
[medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L25)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
### idempotencyKeyRepository\_
|
||||
|
||||
• `Protected` `Readonly` **idempotencyKeyRepository\_**: typeof `IdempotencyKeyRepository`
|
||||
• `Protected` `Readonly` **idempotencyKeyRepository\_**: `Repository`<`IdempotencyKey`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L23)
|
||||
[medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,13 +84,13 @@ ___
|
||||
|
||||
• `Protected` **manager\_**: `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L20)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,13 +98,31 @@ ___
|
||||
|
||||
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L21)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
|
||||
## Accessors
|
||||
|
||||
### activeManager\_
|
||||
|
||||
• `Protected` `get` **activeManager_**(): `EntityManager`
|
||||
|
||||
#### Returns
|
||||
|
||||
`EntityManager`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.activeManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -143,7 +161,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -169,7 +187,7 @@ the created idempotency key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L67)
|
||||
[medusa/src/services/idempotency-key.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +214,7 @@ the existing or created idempotency key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L41)
|
||||
[medusa/src/services/idempotency-key.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -220,13 +238,13 @@ result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L116)
|
||||
[medusa/src/services/idempotency-key.ts:138](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`idempotencyKey`): `Promise`<`IdempotencyKey`\>
|
||||
▸ **retrieve**(`idempotencyKeyOrSelector`): `Promise`<`IdempotencyKey`\>
|
||||
|
||||
Retrieves an idempotency key
|
||||
|
||||
@@ -234,7 +252,7 @@ Retrieves an idempotency key
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `idempotencyKey` | `string` | key to retrieve |
|
||||
| `idempotencyKeyOrSelector` | `string` \| `Selector`<`IdempotencyKey`\> | key or selector to retrieve |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -244,7 +262,7 @@ idempotency key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L85)
|
||||
[medusa/src/services/idempotency-key.ts:86](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -268,7 +286,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -283,17 +301,7 @@ Locks an idempotency.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `idempotencyKey` | `string` | key to update |
|
||||
| `update` | `Object` | update object |
|
||||
| `update.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
|
||||
| `update.id?` | `string` | - |
|
||||
| `update.idempotency_key?` | `string` | - |
|
||||
| `update.locked_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
|
||||
| `update.recovery_point?` | `string` | - |
|
||||
| `update.request_method?` | `string` | - |
|
||||
| `update.request_params?` | { [x: string]: unknown; } | - |
|
||||
| `update.request_path?` | `string` | - |
|
||||
| `update.response_body?` | { [x: string]: unknown; } | - |
|
||||
| `update.response_code?` | `number` | - |
|
||||
| `update` | `DeepPartial`<`IdempotencyKey`\> | update object |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -303,7 +311,7 @@ result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L145)
|
||||
[medusa/src/services/idempotency-key.ts:167](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
@@ -327,7 +335,7 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -356,4 +364,4 @@ new updated idempotency key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L174)
|
||||
[medusa/src/services/idempotency-key.ts:196](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L196)
|
||||
|
||||
Reference in New Issue
Block a user