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

chore(docs): Generated Services Reference (automated) (#2663)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-28 11:02:51 +02:00
committed by GitHub
parent d9f9d7ac28
commit 6aee2e2265
54 changed files with 2320 additions and 1474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
docs/content/references/services/classes/PaymentCollectionService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/payment-collection.ts:57](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L57)
[packages/medusa/src/services/payment-collection.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L52)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:53](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L53)
[packages/medusa/src/services/payment-collection.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L48)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L51)
[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L46)
___
@@ -86,7 +86,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L49)
[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L44)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:55](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L55)
[packages/medusa/src/services/payment-collection.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L50)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:52](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L52)
[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L47)
___
@@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/payment-collection.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L50)
[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L45)
___
@@ -135,15 +135,11 @@ ___
| `CREATED` | `string` |
| `DELETED` | `string` |
| `PAYMENT_AUTHORIZED` | `string` |
| `PAYMENT_CAPTURED` | `string` |
| `PAYMENT_CAPTURE_FAILED` | `string` |
| `REFUND_CREATED` | `string` |
| `REFUND_FAILED` | `string` |
| `UPDATED` | `string` |
#### Defined in
[packages/medusa/src/services/payment-collection.ts:38](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L38)
[packages/medusa/src/services/payment-collection.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L37)
## Methods
@@ -182,7 +178,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
___
@@ -203,68 +199,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:373](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L373)
___
### capture
▸ **capture**(`paymentId`): `Promise`<`Payment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentId` | `string` |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:522](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L522)
___
### captureAll
▸ **captureAll**(`paymentCollectionId`): `Promise`<`Payment`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentCollectionId` | `string` |
#### Returns
`Promise`<`Payment`[]\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:541](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L541)
___
### capturePayment
▸ `Private` **capturePayment**(`payCol`, `payment`): `Promise`<`Payment`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payCol` | `PaymentCollection` |
| `payment` | `Payment` |
#### Returns
`Promise`<`Payment`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:451](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L451)
[packages/medusa/src/services/payment-collection.ts:390](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L390)
___
@@ -284,7 +219,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:97](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L97)
[packages/medusa/src/services/payment-collection.ts:92](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L92)
___
@@ -304,7 +239,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:155](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L155)
[packages/medusa/src/services/payment-collection.ts:150](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L150)
___
@@ -325,7 +260,27 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:193](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L193)
[packages/medusa/src/services/payment-collection.ts:188](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L188)
___
### markAsAuthorized
▸ **markAsAuthorized**(`paymentCollectionId`): `Promise`<`PaymentCollection`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentCollectionId` | `string` |
#### Returns
`Promise`<`PaymentCollection`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:368](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L368)
___
@@ -339,7 +294,7 @@ ___
| :------ | :------ |
| `paymentCollectionId` | `string` |
| `sessionId` | `string` |
| `sessionInput` | `PaymentCollectionSessionInput` |
| `sessionInput` | `Omit`<`PaymentCollectionSessionInput`, ``"amount"``\> |
#### Returns
@@ -347,76 +302,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:298](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L298)
___
### refund
▸ **refund**(`paymentId`, `amount`, `reason`, `note?`): `Promise`<`Refund`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentId` | `string` |
| `amount` | `number` |
| `reason` | `string` |
| `note?` | `string` |
#### Returns
`Promise`<`Refund`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:632](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L632)
___
### refundAll
▸ **refundAll**(`paymentCollectionId`, `reason`, `note?`): `Promise`<`Refund`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentCollectionId` | `string` |
| `reason` | `string` |
| `note?` | `string` |
#### Returns
`Promise`<`Refund`[]\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:655](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L655)
___
### refundPayment
▸ `Private` **refundPayment**(`payCol`, `payment`, `amount`, `reason`, `note?`): `Promise`<`Refund`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payCol` | `PaymentCollection` |
| `payment` | `Payment` |
| `amount` | `number` |
| `reason` | `string` |
| `note?` | `string` |
#### Returns
`Promise`<`Refund`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:560](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L560)
[packages/medusa/src/services/payment-collection.ts:293](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L293)
___
@@ -437,7 +323,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L74)
[packages/medusa/src/services/payment-collection.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L69)
___
@@ -458,7 +344,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:201](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L201)
[packages/medusa/src/services/payment-collection.ts:196](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L196)
___
@@ -482,7 +368,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
___
@@ -497,19 +383,17 @@ ___
| `paymentCollectionId` | `string` |
| `data` | `Object` |
| `data.amount?` | `number` |
| `data.authorized_amount?` | `number` |
| `data.captured_amount?` | `number` |
| `data.authorized_amount?` | ``null`` \| `number` |
| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.created_by?` | `string` |
| `data.currency?` | { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } |
| `data.currency_code?` | `string` |
| `data.deleted_at?` | ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.description?` | `string` |
| `data.description?` | ``null`` \| `string` |
| `data.id?` | `string` |
| `data.metadata?` | { [x: string]: unknown; } |
| `data.payment_sessions?` | (`undefined` \| { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {...)[] |
| `data.payments?` | (`undefined` \| { swap\_id?: string \| undefined; swap?: { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; ... 21 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; })[] |
| `data.refunded_amount?` | `number` |
| `data.region?` | { name?: string \| undefined; currency\_code?: string \| undefined; currency?: { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.region_id?` | `string` |
| `data.status?` | `PaymentCollectionStatus` |
@@ -522,7 +406,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-collection.ts:126](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/services/payment-collection.ts#L126)
[packages/medusa/src/services/payment-collection.ts:121](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L121)
___
@@ -546,4 +430,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)