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
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

224
www/apps/docs/content/references/services/classes/SystemPaymentProviderService.md
View File

@@ -1,4 +1,4 @@
# Class: SystemPaymentProviderService
# SystemPaymentProviderService
## Hierarchy
@@ -10,12 +10,12 @@
### constructor
• **new SystemPaymentProviderService**(`_`)
**new SystemPaymentProviderService**(`_`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Overrides
@@ -24,13 +24,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L6)
[medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L6)
## 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,13 +66,13 @@ 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)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -80,13 +80,13 @@ 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)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -94,57 +94,57 @@ 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)
___
### identifier
▪ `Static` **identifier**: `string` = `"system"`
`Static` **identifier**: `string` = `"system"`
#### Defined in
[medusa/src/services/system-payment-provider.ts:4](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L4)
[medusa/src/services/system-payment-provider.ts:4](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L4)
## 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 |
@@ -153,7 +153,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -161,252 +161,304 @@ 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)
___
### authorizePayment
▸ **authorizePayment**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**authorizePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L22)
[medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L22)
___
### cancelPayment
▸ **cancelPayment**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**cancelPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L46)
[medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L46)
___
### capturePayment
▸ **capturePayment**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**capturePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L38)
[medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L38)
___
### createPayment
▸ **createPayment**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**createPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L10)
[medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L10)
___
### deletePayment
▸ **deletePayment**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**deletePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L34)
[medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L34)
___
### getPaymentData
▸ **getPaymentData**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**getPaymentData**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L18)
[medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L18)
___
### getStatus
▸ **getStatus**(`_`): `Promise`<`string`\>
**getStatus**(`_`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`string`\>
-`Promise`:
-`string`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L14)
[medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L14)
___
### refundPayment
▸ **refundPayment**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**refundPayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L42)
[medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L42)
___
### 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)
___
### updatePayment
▸ **updatePayment**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**updatePayment**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L30)
[medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L30)
___
### updatePaymentData
▸ **updatePaymentData**(`_`): `Promise`<`Record`<`string`, `unknown`\>\>
**updatePaymentData**(`_`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `_` | `any` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/system-payment-provider.ts#L26)
[medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/system-payment-provider.ts#L26)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](SystemPaymentProviderService.md)
**withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](SystemPaymentProviderService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`SystemPaymentProviderService`](SystemPaymentProviderService.md)
-`SystemProviderService`:
#### 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)