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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

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-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx
View File

@@ -18,11 +18,11 @@ in the near future use the AbstractPaymentProcessor instead
## Constructors
### constructor
#### constructor
`Protected **new AbstractPaymentService**(container, config?)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -106,29 +106,13 @@ in the near future use the AbstractPaymentProcessor instead
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -136,6 +120,8 @@ 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
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -157,7 +143,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -189,7 +175,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -207,11 +193,11 @@ Promise&#60;TResult&#62;
___
### authorizePayment
#### authorizePayment
`Abstract **authorizePayment**(paymentSession, context): Promise&#60;&#123; data: [Data](../types/Data.mdx) ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) &#125;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -234,7 +220,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;&#123; data: [Data](../types/Data.mdx) ; status: [PaymentSessionStatus](../enums/PaymentSessionStatus.mdx) &#125;&#62;
@@ -254,13 +240,13 @@ Promise&#60;&#123; data: [Data](../types/Data.mdx) ; status: [PaymentSessionStat
___
### cancelPayment
#### cancelPayment
`Abstract **cancelPayment**(payment): Promise&#60;[Data](../types/Data.mdx)&#62;`
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -274,7 +260,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -296,13 +282,13 @@ in the near future
___
### capturePayment
#### capturePayment
`Abstract **capturePayment**(payment): Promise&#60;[Data](../types/Data.mdx)&#62;`
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -316,7 +302,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -338,11 +324,11 @@ in the near future
___
### createPayment
#### createPayment
`Abstract **createPayment**(context): Promise&#60;[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -356,7 +342,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)&#62;
@@ -376,7 +362,7 @@ Promise&#60;[PaymentSessionResponse](../types/PaymentSessionResponse.mdx)&#62;
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -390,7 +376,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -412,13 +398,13 @@ in the near future use `createPayment(context: Cart & PaymentContext): Promise<P
___
### deletePayment
#### deletePayment
`Abstract **deletePayment**(paymentSession): Promise&#60;void&#62;`
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -432,7 +418,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -454,11 +440,11 @@ in the near future
___
### getIdentifier
#### getIdentifier
`**getIdentifier**(): string`
#### Returns
##### Returns
`string`
@@ -476,11 +462,11 @@ ___
___
### getPaymentData
#### getPaymentData
`Abstract **getPaymentData**(paymentSession): Promise&#60;[Data](../types/Data.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -494,7 +480,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -514,13 +500,13 @@ Promise&#60;[Data](../types/Data.mdx)&#62;
___
### getStatus
#### getStatus
`Abstract **getStatus**(data): Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;`
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -534,7 +520,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;[PaymentSessionStatus](../enums/PaymentSessionStatus.mdx)&#62;
@@ -556,13 +542,13 @@ in the near future
___
### refundPayment
#### refundPayment
`Abstract **refundPayment**(payment, refundAmount): Promise&#60;[Data](../types/Data.mdx)&#62;`
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -585,7 +571,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -607,11 +593,11 @@ in the near future
___
### retrievePayment
#### retrievePayment
`Abstract **retrievePayment**(paymentData): Promise&#60;[Data](../types/Data.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -625,7 +611,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -645,13 +631,13 @@ Promise&#60;[Data](../types/Data.mdx)&#62;
___
### retrieveSavedMethods
#### retrieveSavedMethods
`**retrieveSavedMethods**(customer): Promise&#60;[Data](../types/Data.mdx)[]&#62;`
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -665,7 +651,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)[]&#62;
@@ -687,11 +673,11 @@ in the near future
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -705,7 +691,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -723,11 +709,11 @@ ___
___
### updatePayment
#### updatePayment
`Abstract **updatePayment**(paymentSessionData, context): Promise&#60;Record&#60;string, unknown&#62; \| [PaymentSessionResponse](../types/PaymentSessionResponse.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -750,7 +736,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62; \| [PaymentSessionResponse](../types/PaymentSessionResponse.mdx)&#62;
@@ -770,7 +756,7 @@ Promise&#60;Record&#60;string, unknown&#62; \| [PaymentSessionResponse](../types
This will be
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -793,7 +779,7 @@ This will be
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -815,11 +801,11 @@ in the near future use `updatePayment(paymentSessionData: PaymentSessionData, co
___
### updatePaymentData
#### updatePaymentData
`Abstract **updatePaymentData**(paymentSessionData, data): Promise&#60;[Data](../types/Data.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -842,7 +828,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Data](../types/Data.mdx)&#62;
@@ -862,11 +848,11 @@ Promise&#60;[Data](../types/Data.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [AbstractPaymentService](AbstractPaymentService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -880,7 +866,7 @@ ___
}
]} />
#### Returns
##### Returns
[AbstractPaymentService](AbstractPaymentService.mdx)