asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
fbdcb780668c19a202575a53dc84f71c9252060d
medusa-store/docs/content/references/services/classes/ClaimService.md
github-actions[bot] fbdcb78066 chore(docs): Generated Services Reference (automated) (#2206) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-09-14 13:26:03 +03:00

557 lines
13 KiB
Markdown
Raw Blame History

# Class: ClaimService
## Hierarchy
- `TransactionBaseService`
↳ **`ClaimService`**
## Constructors
### constructor
• **new ClaimService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L83)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### addressRepository\_
• `Protected` `Readonly` **addressRepository\_**: typeof `AddressRepository`
#### Defined in
[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L66)
___
### claimItemService\_
• `Protected` `Readonly` **claimItemService\_**: [`ClaimItemService`](ClaimItemService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L70)
___
### claimRepository\_
• `Protected` `Readonly` **claimRepository\_**: typeof `ClaimRepository`
#### Defined in
[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L67)
___
### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L71)
___
### fulfillmentProviderService\_
• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](FulfillmentProviderService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L72)
___
### fulfillmentService\_
• `Protected` `Readonly` **fulfillmentService\_**: [`FulfillmentService`](FulfillmentService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L73)
___
### inventoryService\_
• `Protected` `Readonly` **inventoryService\_**: [`InventoryService`](InventoryService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L74)
___
### lineItemRepository\_
• `Protected` `Readonly` **lineItemRepository\_**: typeof `LineItemRepository`
#### Defined in
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L69)
___
### lineItemService\_
• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L75)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L63)
___
### paymentProviderService\_
• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](PaymentProviderService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L76)
___
### regionService\_
• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L77)
___
### returnService\_
• `Protected` `Readonly` **returnService\_**: [`ReturnService`](ReturnService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L78)
___
### shippingMethodRepository\_
• `Protected` `Readonly` **shippingMethodRepository\_**: typeof `ShippingMethodRepository`
#### Defined in
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L68)
___
### shippingOptionService\_
• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L79)
___
### taxProviderService\_
• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L80)
___
### totalsService\_
• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](TotalsService.md)
#### Defined in
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L81)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L64)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `CANCELED` | `string` |
| `CREATED` | `string` |
| `FULFILLMENT_CREATED` | `string` |
| `REFUND_PROCESSED` | `string` |
| `SHIPMENT_CREATED` | `string` |
| `UPDATED` | `string` |
#### Defined in
[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L54)
## Methods
### atomicPhase\_
▸ `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` |
#### Parameters
| Name | Type | 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 |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### cancel
▸ **cancel**(`id`): `Promise`<`ClaimOrder`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
#### Returns
`Promise`<`ClaimOrder`\>
#### Defined in
[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L761)
___
### cancelFulfillment
▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<`ClaimOrder`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `fulfillmentId` | `string` |
#### Returns
`Promise`<`ClaimOrder`\>
#### Defined in
[packages/medusa/src/services/claim.ts:609](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L609)
___
### create
▸ **create**(`data`): `Promise`<`ClaimOrder`\>
Creates a Claim on an Order. Claims consists of items that are claimed and
optionally items to be sent as replacement for the claimed items. The
shipping address that the new items will be shipped to
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateClaimInput` | the object containing all data required to create a claim |
#### Returns
`Promise`<`ClaimOrder`\>
created claim
#### Defined in
[packages/medusa/src/services/claim.ts:213](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L213)
___
### createFulfillment
▸ **createFulfillment**(`id`, `config?`): `Promise`<`ClaimOrder`\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the object containing all data required to create a claim |
| `config` | `Object` | config object |
| `config.metadata?` | `Record`<`string`, `unknown`\> | config metadata |
| `config.no_notification?` | `boolean` | config no notification |
#### Returns
`Promise`<`ClaimOrder`\>
created claim
#### Defined in
[packages/medusa/src/services/claim.ts:463](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L463)
___
### createShipment
▸ **createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<`ClaimOrder`\>
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `id` | `string` | `undefined` |
| `fulfillmentId` | `string` | `undefined` |
| `trackingLinks` | { `tracking_number`: `string` }[] | `[]` |
| `config` | `Object` | `undefined` |
| `config.metadata` | `Object` | `{}` |
| `config.no_notification` | `undefined` | `undefined` |
#### Returns
`Promise`<`ClaimOrder`\>
#### Defined in
[packages/medusa/src/services/claim.ts:681](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L681)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`ClaimOrder`[]\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | the query object for find |
| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings |
#### Returns
`Promise`<`ClaimOrder`[]\>
the result of the find operation
#### Defined in
[packages/medusa/src/services/claim.ts:817](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L817)
___
### processRefund
▸ **processRefund**(`id`): `Promise`<`ClaimOrder`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
#### Returns
`Promise`<`ClaimOrder`\>
#### Defined in
[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L635)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimOrder`\>
Gets an order by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the claim order to retrieve |
| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings |
#### Returns
`Promise`<`ClaimOrder`\>
the order document
#### Defined in
[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L837)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`id`, `data`): `Promise`<`ClaimOrder`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `data` | `UpdateClaimInput` |
#### Returns
`Promise`<`ClaimOrder`\>
#### Defined in
[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/claim.ts#L125)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`ClaimService`](ClaimService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`ClaimService`](ClaimService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
Reference in New Issue View Git Blame Copy Permalink