c51dce164d
* fixed typedoc plugin's escape strategy * move props comments to the associated property * regenerate references
144 lines
3.5 KiB
Plaintext
144 lines
3.5 KiB
Plaintext
---
|
|
displayed_sidebar: servicesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# OrderItemChange
|
|
|
|
An order item change is a change made within an order edit to an order's items. These changes are not reflected on the original order until the order edit is confirmed.
|
|
|
|
## Constructors
|
|
|
|
### constructor
|
|
|
|
`**new OrderItemChange**()`
|
|
|
|
An order item change is a change made within an order edit to an order's items. These changes are not reflected on the original order until the order edit is confirmed.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "created_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was created.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "deleted_at",
|
|
"type": "`null` \\| `Date`",
|
|
"description": "The date with timezone at which the resource was deleted.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The order item change's ID",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "line_item",
|
|
"type": "[LineItem](LineItem.mdx)",
|
|
"description": "The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "line_item_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the cloned line item.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order_edit",
|
|
"type": "[OrderEdit](OrderEdit.mdx)",
|
|
"description": "The details of the order edit the item change is associated with.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order_edit_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the order edit",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_line_item",
|
|
"type": "[LineItem](LineItem.mdx)",
|
|
"description": "The details of the original line item this item change references. This is used if the item change updates or deletes the original item.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_line_item_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the original line item in the order",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "[OrderEditItemChangeType](../enums/OrderEditItemChangeType.mdx)",
|
|
"description": "The order item change's status",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was updated.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|
|
|
|
## Methods
|
|
|
|
### beforeInsert
|
|
|
|
`Private **beforeInsert**(): void`
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "void",
|
|
"type": "`void`",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"description": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|