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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/content/references/services/classes/FulfillmentProviderService.md
View File

@@ -1,5 +1,7 @@
# Class: FulfillmentProviderService
Helps retrive fulfillment providers
## Constructors
### constructor
@@ -14,7 +16,7 @@
#### Defined in
[services/fulfillment-provider.js:7](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L7)
[packages/medusa/src/services/fulfillment-provider.js:7](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L7)
## Methods
@@ -36,7 +38,7 @@
#### Defined in
[services/fulfillment-provider.js:79](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L79)
[packages/medusa/src/services/fulfillment-provider.js:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L79)
___
@@ -56,7 +58,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:64](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L64)
[packages/medusa/src/services/fulfillment-provider.js:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L64)
___
@@ -76,7 +78,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:74](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L74)
[packages/medusa/src/services/fulfillment-provider.js:74](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L74)
___
@@ -99,7 +101,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L59)
[packages/medusa/src/services/fulfillment-provider.js:59](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L59)
___
@@ -119,7 +121,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L89)
[packages/medusa/src/services/fulfillment-provider.js:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L89)
___
@@ -133,7 +135,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L23)
[packages/medusa/src/services/fulfillment-provider.js:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L23)
___
@@ -153,7 +155,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L30)
[packages/medusa/src/services/fulfillment-provider.js:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L30)
___
@@ -173,7 +175,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L12)
[packages/medusa/src/services/fulfillment-provider.js:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L12)
___
@@ -181,13 +183,15 @@ ___
▸ **retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\>
Fetches documents from the fulfillment provider
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `providerId` | `string` | |
| `fulfillmentData` | `any` | |
| `documentType` | ``"label"`` \| ``"invoice"`` | |
| `providerId` | `string` | the id of the provider |
| `fulfillmentData` | `any` | the data relating to the fulfillment |
| `documentType` | ``"label"`` \| ``"invoice"`` | the typ of document to fetch |
#### Returns
@@ -195,7 +199,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L102)
[packages/medusa/src/services/fulfillment-provider.js:102](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L102)
___
@@ -207,15 +211,17 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `provider_id` | `string` | |
| `provider_id` | `string` | the provider id |
#### Returns
`FulfillmentService`
the payment fulfillment provider
#### Defined in
[services/fulfillment-provider.js:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L48)
[packages/medusa/src/services/fulfillment-provider.js:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L48)
___
@@ -237,7 +243,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:69](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L69)
[packages/medusa/src/services/fulfillment-provider.js:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L69)
___
@@ -257,4 +263,4 @@ ___
#### Defined in
[services/fulfillment-provider.js:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L84)
[packages/medusa/src/services/fulfillment-provider.js:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L84)