chore(docs): Generated References (automated) (#8532)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and 
GitHub committed
1 parent
f659c6d8bd
commit
fdc94f6482
217 files changed
+835367
-228454
No files matched your search
-25
@@ -10,31 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateReturnReasons` method. This belongs to the Order Module.
|
||||
|
||||
## updateReturnReasons(data, sharedContext?): Promise<[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]>
|
||||
|
||||
This method updates existing return reasons.
|
||||
|
||||
### Example
|
||||
|
||||
```ts
|
||||
const returnReasons = await orderModuleService.updateReturnReasons([{
|
||||
selector: {
|
||||
id: "13"
|
||||
},
|
||||
data: {
|
||||
label: "Damaged"
|
||||
}
|
||||
}])
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[UpdateOrderReturnReasonWithSelectorDTO](../../../interfaces/order.UpdateOrderReturnReasonWithSelectorDTO/page.mdx)[]","description":"The filters that specifies which\nreturn reasons to update, and the data to update in them.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"Partial<[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)>","description":"The filters specifying which return reasons to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"Partial<[UpdateOrderReturnReasonDTO](../../../interfaces/order.UpdateOrderReturnReasonDTO/page.mdx)>","description":"The data of the return reasons to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/order.Context/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the curLine truncated
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]>","optional":false,"defaultValue":"","description":"The updated return reasons.","expandable":false,"children":[{"name":"OrderReturnReasonDTO[]","type":"[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"OrderReturnReasonDTO","type":"`object`","description":"The order return reason details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="updateReturnReasons"/>
|
||||
|
||||
## updateReturnReasons(selector, data, sharedContext?): Promise<[OrderReturnReasonDTO](../../../interfaces/order.OrderReturnReasonDTO/page.mdx)[]>
|
||||
|
||||
This method updates existing return reasons matching the specified filters.
|
||||
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: orderReference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# UpdateOrderReturnReasonWithSelectorDTO
|
||||
|
||||
The attributes to update in the return reason with filters
|
||||
specifying which return reasons to update.
|
||||
|
||||
<TypeList types={[{"name":"selector","type":"Partial<[OrderReturnReasonDTO](../order.OrderReturnReasonDTO/page.mdx)>","description":"The filters specifying which return reasons to update.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The parent return reason ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"[OrderReturnReasonDTO](../order.OrderReturnReasonDTO/page.mdx)","description":"The associated order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"return_reason_children","type":"[OrderReturnReasonDTO](../order.OrderReturnReasonDTO/page.mdx)[]","description":"The return reason children of the order return reason.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The unique value of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the return reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the return reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the return reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the return reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":Line truncated
|
||||
@@ -6,6 +6,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# ChangeActionType
|
||||
|
||||
**ChangeActionType**: `"CANCEL"` \| `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"`
|
||||
**ChangeActionType**: `"CANCEL"` \| `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"ITEM_UPDATE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"`
|
||||
|
||||
The change action's type.
|
||||
Reference in new issue
Block a user