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

chore(docs): Generated JS Client Reference (automated) (#2660)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-28 11:02:11 +02:00
committed by GitHub
co-authored by olivermrbl
parent 3cee0bc8fc
commit ee14155eb7
238 changed files with 2768 additions and 1718 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/js-client/classes/AdminPaymentsResource.md
+72
View File
@@ -0,0 +1,72 @@
# Class: AdminPaymentsResource
## Hierarchy
- `default`
↳ **`AdminPaymentsResource`**
## Methods
### capturePayment
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\>
#### Defined in
[medusa-js/src/resources/admin/payments.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payments.ts#L27)
___
### refundPayment
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostPaymentRefundsReq`](internal-16.AdminPostPaymentRefundsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\>
#### Defined in
[medusa-js/src/resources/admin/payments.ts:35](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payments.ts#L35)
___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `query?` | [`GetPaymentsParams`](internal-16.GetPaymentsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\>
#### Defined in
[medusa-js/src/resources/admin/payments.ts:12](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payments.ts#L12)