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/FulfillmentProviderService.md
+135 -94
View File
@@ -1,4 +1,4 @@
# Class: FulfillmentProviderService
# FulfillmentProviderService
Helps retrieve fulfillment providers
@@ -12,12 +12,12 @@ Helps retrieve fulfillment providers
### constructor
• **new FulfillmentProviderService**(`container`)
**new FulfillmentProviderService**(`container`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `container` | `FulfillmentProviderContainer` |
#### Overrides
@@ -26,13 +26,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/fulfillment-provider.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L44)
[medusa/src/services/fulfillment-provider.ts:44](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L44)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -40,13 +40,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
@@ -54,13 +54,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
@@ -68,33 +68,33 @@ 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)
___
### container\_
• `Protected` `Readonly` **container\_**: `FulfillmentProviderContainer`
`Protected` `Readonly` **container\_**: `FulfillmentProviderContainer`
#### Defined in
[medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L40)
[medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L40)
___
### fulfillmentProviderRepository\_
• `Protected` `Readonly` **fulfillmentProviderRepository\_**: `Repository`<`FulfillmentProvider`\>
`Protected` `Readonly` **fulfillmentProviderRepository\_**: `Repository`<`FulfillmentProvider`\>
#### Defined in
[medusa/src/services/fulfillment-provider.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L42)
[medusa/src/services/fulfillment-provider.ts:42](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L42)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -102,13 +102,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
@@ -116,47 +116,47 @@ 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)
## 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 |
@@ -165,7 +165,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -173,80 +173,89 @@ 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)
___
### calculatePrice
▸ **calculatePrice**(`option`, `data`, `cart?`): `Promise`<`number`\>
**calculatePrice**(`option`, `data`, `cart?`): `Promise`<`number`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `option` | `ShippingOption` |
| `data` | `Record`<`string`, `unknown`\> |
| `data` | Record<`string`, `unknown`\> |
| `cart?` | `Order` \| `Cart` |
#### Returns
`Promise`<`number`\>
-`Promise`:
-`number`: (optional)
#### Defined in
[medusa/src/services/fulfillment-provider.ts:147](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L147)
[medusa/src/services/fulfillment-provider.ts:147](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L147)
___
### canCalculate
▸ **canCalculate**(`option`): `Promise`<`boolean`\>
**canCalculate**(`option`): `Promise`<`boolean`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `option` | `CalculateOptionPriceInput` |
#### Returns
`Promise`<`boolean`\>
-`Promise`:
-`boolean`: (optional)
#### Defined in
[medusa/src/services/fulfillment-provider.ts:122](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L122)
[medusa/src/services/fulfillment-provider.ts:122](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L122)
___
### cancelFulfillment
▸ **cancelFulfillment**(`fulfillment`): `Promise`<`Fulfillment`\>
**cancelFulfillment**(`fulfillment`): `Promise`<`Fulfillment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `fulfillment` | `Fulfillment` |
#### Returns
`Promise`<`Fulfillment`\>
-`Promise`:
-`Fulfillment`:
#### Defined in
[medusa/src/services/fulfillment-provider.ts:140](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L140)
[medusa/src/services/fulfillment-provider.ts:140](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L140)
___
### createFulfillment
▸ **createFulfillment**(`method`, `items`, `order`, `fulfillment`): `Promise`<`Record`<`string`, `unknown`\>\>
**createFulfillment**(`method`, `items`, `order`, `fulfillment`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `method` | `ShippingMethod` |
| `items` | `LineItem`[] |
| `order` | `CreateFulfillmentOrder` |
@@ -254,220 +263,252 @@ ___
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/fulfillment-provider.ts:107](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L107)
[medusa/src/services/fulfillment-provider.ts:107](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L107)
___
### createReturn
▸ **createReturn**(`returnOrder`): `Promise`<`Record`<`string`, `unknown`\>\>
**createReturn**(`returnOrder`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `returnOrder` | `CreateReturnType` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/fulfillment-provider.ts:165](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L165)
[medusa/src/services/fulfillment-provider.ts:165](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L165)
___
### list
▸ **list**(): `Promise`<`FulfillmentProvider`[]\>
**list**(): `Promise`<`FulfillmentProvider`[]\>
#### Returns
`Promise`<`FulfillmentProvider`[]\>
-`Promise`:
-`FulfillmentProvider[]`:
-`FulfillmentProvider`:
#### Defined in
[medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L67)
[medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L67)
___
### listFulfillmentOptions
▸ **listFulfillmentOptions**(`providerIds`): `Promise`<`FulfillmentOptions`[]\>
**listFulfillmentOptions**(`providerIds`): `Promise`<`FulfillmentOptions`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `providerIds` | `string`[] |
#### Returns
`Promise`<`FulfillmentOptions`[]\>
-`Promise`:
-`FulfillmentOptions[]`:
#### Defined in
[medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L75)
[medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L75)
___
### registerInstalledProviders
▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\>
**registerInstalledProviders**(`providers`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `providers` | `string`[] |
#### Returns
`Promise`<`void`\>
-`Promise`:
#### Defined in
[medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L53)
[medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L53)
___
### retrieveDocuments
▸ **retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\>
**retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\>
Fetches documents from the fulfillment provider
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `providerId` | `string` | the id of the provider |
| `fulfillmentData` | `Record`<`string`, `unknown`\> | the data relating to the fulfillment |
| `fulfillmentData` | Record<`string`, `unknown`\> | the data relating to the fulfillment |
| `documentType` | ``"label"`` \| ``"invoice"`` | the typ of |
#### Returns
`Promise`<`any`\>
document to fetch
-`Promise`: document to fetch
-`any`: (optional)
#### Defined in
[medusa/src/services/fulfillment-provider.ts:184](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L184)
[medusa/src/services/fulfillment-provider.ts:184](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L184)
___
### retrieveProvider
▸ **retrieveProvider**(`providerId`): `any`
**retrieveProvider**(`providerId`): `any`
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `providerId` | `string` | the provider id |
#### Returns
`any`
the payment fulfillment provider
-`any`: (optional) the payment fulfillment provider
#### Defined in
[medusa/src/services/fulfillment-provider.ts:96](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L96)
[medusa/src/services/fulfillment-provider.ts:96](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L96)
___
### 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)
___
### validateFulfillmentData
▸ **validateFulfillmentData**(`option`, `data`, `cart`): `Promise`<`Record`<`string`, `unknown`\>\>
**validateFulfillmentData**(`option`, `data`, `cart`): `Promise`<Record<`string`, `unknown`\>\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `option` | `ShippingOption` |
| `data` | `Record`<`string`, `unknown`\> |
| `cart` | `Record`<`string`, `unknown`\> \| `Cart` |
| `data` | Record<`string`, `unknown`\> |
| `cart` | Record<`string`, `unknown`\> \| `Cart` |
#### Returns
`Promise`<`Record`<`string`, `unknown`\>\>
`Promise`<Record<`string`, `unknown`\>\>
-`Promise`:
-`Record`:
-`string`: (optional)
-`unknown`: (optional)
#### Defined in
[medusa/src/services/fulfillment-provider.ts:127](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L127)
[medusa/src/services/fulfillment-provider.ts:127](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L127)
___
### validateOption
▸ **validateOption**(`option`): `Promise`<`boolean`\>
**validateOption**(`option`): `Promise`<`boolean`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `option` | `ShippingOption` |
#### Returns
`Promise`<`boolean`\>
-`Promise`:
-`boolean`: (optional)
#### Defined in
[medusa/src/services/fulfillment-provider.ts:160](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/fulfillment-provider.ts#L160)
[medusa/src/services/fulfillment-provider.ts:160](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/fulfillment-provider.ts#L160)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`FulfillmentProviderService`](FulfillmentProviderService.md)
**withTransaction**(`transactionManager?`): [`FulfillmentProviderService`](FulfillmentProviderService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`FulfillmentProviderService`](FulfillmentProviderService.md)
-`FulfillmentProviderService`:
#### 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)