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

chore(docs): Generated References (#5516)

Browse Source 
Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-02 09:16:47 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/PaymentService.md
+80 -71
View File
@@ -1,4 +1,4 @@
# Class: PaymentService
# PaymentService
## Hierarchy
@@ -10,12 +10,12 @@
### constructor
• **new PaymentService**(`«destructured»`)
**new PaymentService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `«destructured»` | `InjectedDependencies` |
#### Overrides
@@ -24,13 +24,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/payment.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L39)
[medusa/src/services/payment.ts:39](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L39)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -38,13 +38,13 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
@@ -52,13 +52,13 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -66,23 +66,23 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### eventBusService\_
• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
`Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L27)
[medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L27)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -90,33 +90,33 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### paymentProviderService\_
• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](PaymentProviderService.md)
`Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](PaymentProviderService.md)
#### Defined in
[medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L28)
[medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L28)
___
### paymentRepository\_
• `Protected` `Readonly` **paymentRepository\_**: `Repository`<`Payment`\>
`Protected` `Readonly` **paymentRepository\_**: `Repository`<`Payment`\>
#### Defined in
[medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L29)
[medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L29)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -124,13 +124,13 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
`Static` `Readonly` **Events**: `Object`
#### Type declaration
@@ -145,47 +145,47 @@ ___
#### Defined in
[medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L30)
[medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L30)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
-`EntityManager`:
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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` |
| `TResult` | `object` |
| `TError` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | 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 |
@@ -194,7 +194,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -202,68 +202,70 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### capture
▸ **capture**(`paymentOrId`): `Promise`<`Payment`\>
**capture**(`paymentOrId`): `Promise`<`Payment`\>
Captures a payment.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `paymentOrId` | `string` \| `Payment` | the id or the class instance of the payment |
#### Returns
`Promise`<`Payment`\>
the payment captured.
-`Promise`: the payment captured.
-`Payment`:
#### Defined in
[medusa/src/services/payment.ts:153](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L153)
[medusa/src/services/payment.ts:153](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L153)
___
### create
▸ **create**(`paymentInput`): `Promise`<`Payment`\>
**create**(`paymentInput`): `Promise`<`Payment`\>
Created a new payment.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `paymentInput` | `PaymentDataInput` | info to create the payment |
#### Returns
`Promise`<`Payment`\>
the payment created.
-`Promise`: the payment created.
-`Payment`:
#### Defined in
[medusa/src/services/payment.ts:92](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L92)
[medusa/src/services/payment.ts:92](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L92)
___
### refund
▸ **refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<`Refund`\>
**refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<`Refund`\>
refunds a payment.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `paymentOrId` | `string` \| `Payment` | the id or the class instance of the payment |
| `amount` | `number` | the amount to be refunded from the payment |
| `reason` | `string` | the refund reason |
@@ -273,24 +275,25 @@ refunds a payment.
`Promise`<`Refund`\>
the refund created.
-`Promise`: the refund created.
-`Refund`:
#### Defined in
[medusa/src/services/payment.ts:202](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L202)
[medusa/src/services/payment.ts:202](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L202)
___
### retrieve
▸ **retrieve**(`paymentId`, `config?`): `Promise`<`Payment`\>
**retrieve**(`paymentId`, `config?`): `Promise`<`Payment`\>
Retrieves a payment by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `paymentId` | `string` | the id of the payment |
| `config` | `FindConfig`<`Payment`\> | the config to retrieve the payment |
@@ -298,83 +301,89 @@ Retrieves a payment by id.
`Promise`<`Payment`\>
the payment.
-`Promise`: the payment.
-`Payment`:
#### Defined in
[medusa/src/services/payment.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L58)
[medusa/src/services/payment.ts:58](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L58)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
-`boolean`: (optional)
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### update
▸ **update**(`paymentId`, `data`): `Promise`<`Payment`\>
**update**(`paymentId`, `data`): `Promise`<`Payment`\>
Updates a payment in order to link it to an order or a swap.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `paymentId` | `string` | the id of the payment |
| `data` | `Object` | order_id or swap_id to link the payment |
| `data.order_id?` | `string` | - |
| `data.swap_id?` | `string` | - |
| `data` | `object` | order_id or swap_id to link the payment |
| `data.order_id?` | `string` |
| `data.swap_id?` | `string` |
#### Returns
`Promise`<`Payment`\>
the payment updated.
-`Promise`: the payment updated.
-`Payment`:
#### Defined in
[medusa/src/services/payment.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/payment.ts#L121)
[medusa/src/services/payment.ts:121](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/payment.ts#L121)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`PaymentService`](PaymentService.md)
**withTransaction**(`transactionManager?`): [`PaymentService`](PaymentService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`PaymentService`](PaymentService.md)
-`default`:
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)