fix: overlapping branch names for generated PRs of references (#2097)

* fix overlapping branch names of generated references

* regenerate references
This commit is contained in:
Shahed Nasser
2022-08-25 17:47:58 +03:00
committed by GitHub
parent f7a63f1782
commit a8293af8e1
353 changed files with 5590 additions and 3821 deletions

View File

@@ -16,7 +16,7 @@
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `Object` |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
@@ -24,49 +24,73 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/idempotency-key.js:8](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L8)
[packages/medusa/src/services/idempotency-key.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L22)
## Properties
### configModule
### \_\_configModule\_\_
`Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
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)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### container
### \_\_container\_\_
`Protected` `Readonly` **container**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.container
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)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### idempotencyKeyRepository\_
`Protected` `Readonly` **idempotencyKeyRepository\_**: typeof `IdempotencyKeyRepository`
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L20)
___
### manager\_
`Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L17)
___
### transactionManager\_
`Protected` `Abstract` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/services/idempotency-key.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L18)
## Methods
@@ -105,13 +129,13 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[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)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### create
**create**(`payload`): `Promise`<`IdempotencyKeyModel`\>
**create**(`payload`): `Promise`<`IdempotencyKey`\>
Creates an idempotency key for a request.
If no idempotency key is provided in request, we will create a unique
@@ -121,23 +145,23 @@ identifier.
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | `any` | payload of request to create idempotency key for |
| `payload` | `CreateIdempotencyKeyInput` | payload of request to create idempotency key for |
#### Returns
`Promise`<`IdempotencyKeyModel`\>
`Promise`<`IdempotencyKey`\>
the created idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.js:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L52)
[packages/medusa/src/services/idempotency-key.ts:63](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L63)
___
### initializeRequest
**initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<`IdempotencyKeyModel`\>
**initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<`IdempotencyKey`\>
Execute the initial steps in a idempotent request.
@@ -147,24 +171,24 @@ Execute the initial steps in a idempotent request.
| :------ | :------ | :------ |
| `headerKey` | `string` | potential idempotency key from header |
| `reqMethod` | `string` | method of request |
| `reqParams` | `string` | params of request |
| `reqParams` | `Record`<`string`, `unknown`\> | params of request |
| `reqPath` | `string` | path of request |
#### Returns
`Promise`<`IdempotencyKeyModel`\>
`Promise`<`IdempotencyKey`\>
the existing or created idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.js:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L26)
[packages/medusa/src/services/idempotency-key.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L37)
___
### lock
**lock**(`idempotencyKey`): `Promise`<`any`\>
**lock**(`idempotencyKey`): `Promise`<`IdempotencyKey`\>
Locks an idempotency.
@@ -176,19 +200,19 @@ Locks an idempotency.
#### Returns
`Promise`<`any`\>
`Promise`<`IdempotencyKey`\>
result of the update operation
#### Defined in
[packages/medusa/src/services/idempotency-key.js:90](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L90)
[packages/medusa/src/services/idempotency-key.ts:105](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L105)
___
### retrieve
**retrieve**(`idempotencyKey`): `Promise`<`IdempotencyKeyModel`\>
**retrieve**(`idempotencyKey`): `Promise`<`IdempotencyKey`\>
Retrieves an idempotency key
@@ -200,13 +224,13 @@ Retrieves an idempotency key
#### Returns
`Promise`<`IdempotencyKeyModel`\>
`Promise`<`IdempotencyKey`\>
idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.js:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L73)
[packages/medusa/src/services/idempotency-key.ts:81](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L81)
___
@@ -230,13 +254,13 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[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)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
**update**(`idempotencyKey`, `update`): `Promise`<`any`\>
**update**(`idempotencyKey`, `update`): `Promise`<`IdempotencyKey`\>
Locks an idempotency.
@@ -245,23 +269,33 @@ Locks an idempotency.
| Name | Type | Description |
| :------ | :------ | :------ |
| `idempotencyKey` | `string` | key to update |
| `update` | `any` | update object |
| `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` | - |
#### Returns
`Promise`<`any`\>
`Promise`<`IdempotencyKey`\>
result of the update operation
#### Defined in
[packages/medusa/src/services/idempotency-key.js:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L117)
[packages/medusa/src/services/idempotency-key.ts:134](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L134)
___
### withTransaction
**withTransaction**(`transactionManager?`): `any`
**withTransaction**(`transactionManager?`): [`IdempotencyKeyService`](IdempotencyKeyService.md)
#### Parameters
@@ -271,7 +305,7 @@ ___
#### Returns
`any`
[`IdempotencyKeyService`](IdempotencyKeyService.md)
#### Inherited from
@@ -279,13 +313,13 @@ TransactionBaseService.withTransaction
#### Defined in
[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)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### workStage
**workStage**(`idempotencyKey`, `func`): `IdempotencyKeyModel`
**workStage**(`idempotencyKey`, `callback`): `Promise`<{ `error?`: `unknown` ; `key?`: `IdempotencyKey` }\>
Performs an atomic work stage.
An atomic work stage contains some related functionality, that needs to be
@@ -298,14 +332,14 @@ always consist of 2 or more of these phases. The required phases are
| Name | Type | Description |
| :------ | :------ | :------ |
| `idempotencyKey` | `string` | current idempotency key |
| `func` | `Function` | functionality to execute within the phase |
| `callback` | (`transactionManager`: `EntityManager`) => `Promise`<{ `recovery_point?`: `string` ; `response_body?`: `Record`<`string`, `unknown`\> ; `response_code?`: `number` }\> | functionality to execute within the phase |
#### Returns
`IdempotencyKeyModel`
`Promise`<{ `error?`: `unknown` ; `key?`: `IdempotencyKey` }\>
new updated idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.js:144](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L144)
[packages/medusa/src/services/idempotency-key.ts:163](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/idempotency-key.ts#L163)