@commercetools/platform-sdk
Advanced tools
Comparing version 7.18.0 to 7.19.0
@@ -9,2 +9,3 @@ /** | ||
import { BaseResource, CreatedBy, LastModifiedBy } from "./common.js"; | ||
import { CustomFields, FieldContainer, TypeResourceIdentifier } from "./type.js"; | ||
export interface ApprovalRule extends BaseResource { | ||
@@ -95,2 +96,8 @@ /** | ||
readonly businessUnit: BusinessUnitKeyReference; | ||
/** | ||
* Custom Fields on the Approval Rule. | ||
* | ||
* | ||
*/ | ||
readonly custom?: CustomFields; | ||
} | ||
@@ -201,3 +208,3 @@ export interface ApprovalRuleDraft { | ||
} | ||
export type ApprovalRuleUpdateAction = ApprovalRuleSetApproversAction | ApprovalRuleSetDescriptionAction | ApprovalRuleSetKeyAction | ApprovalRuleSetNameAction | ApprovalRuleSetPredicateAction | ApprovalRuleSetRequestersAction | ApprovalRuleSetStatusAction; | ||
export type ApprovalRuleUpdateAction = ApprovalRuleSetApproversAction | ApprovalRuleSetCustomFieldAction | ApprovalRuleSetCustomTypeAction | ApprovalRuleSetDescriptionAction | ApprovalRuleSetKeyAction | ApprovalRuleSetNameAction | ApprovalRuleSetPredicateAction | ApprovalRuleSetRequestersAction | ApprovalRuleSetStatusAction; | ||
/** | ||
@@ -216,2 +223,35 @@ * Setting the approvers for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleApproversSet](ctp:api:type:ApprovalRuleApproversSetMessage) Message. | ||
} | ||
export interface ApprovalRuleSetCustomFieldAction { | ||
readonly action: 'setCustomField'; | ||
/** | ||
* Name of the [Custom Field](ctp:api:type:CustomFields). | ||
* | ||
* | ||
*/ | ||
readonly name: string; | ||
/** | ||
* If `value` is absent or `null`, this field will be removed if it exists. | ||
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. | ||
* If `value` is provided, it is set for the field defined by `name`. | ||
* | ||
* | ||
*/ | ||
readonly value?: any; | ||
} | ||
export interface ApprovalRuleSetCustomTypeAction { | ||
readonly action: 'setCustomType'; | ||
/** | ||
* Defines the [Type](ctp:api:type:Type) that extends the ApprovalRule with [Custom Fields](ctp:api:type:CustomFields). | ||
* If absent, any existing Type and Custom Fields are removed from the ApprovalRule. | ||
* | ||
* | ||
*/ | ||
readonly type?: TypeResourceIdentifier; | ||
/** | ||
* Sets the [Custom Fields](ctp:api:type:CustomFields) fields for the ApprovalRule. | ||
* | ||
* | ||
*/ | ||
readonly fields?: FieldContainer; | ||
} | ||
/** | ||
@@ -218,0 +258,0 @@ * Setting the description for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleDescriptionSet](ctp:api:type:ApprovalRuleDescriptionSetMessage) Message. |
@@ -197,3 +197,3 @@ /** | ||
/** | ||
* `cart`, `order`, `payment`, `customer`, `quote-request`, `staged-quote`, `quote`, `business-unit`, and `shopping-list` are supported. | ||
* The resource that triggers the Extension. | ||
* | ||
@@ -200,0 +200,0 @@ * |
@@ -100,3 +100,3 @@ /** | ||
/** | ||
* The CloudEventsFormat can be used with any [Destination](#destination), and the payload is delivered in the `JSON Event Format`. [AzureEventGridDestination](ctp:api:type:AzureEventGridDestination) offers native support to filter and route CloudEvents. | ||
* The CloudEventsFormat can be used with any [Destination](#destination-1), and the payload is delivered in the `JSON Event Format`. [AzureEventGridDestination](ctp:api:type:AzureEventGridDestination) offers native support to filter and route CloudEvents. | ||
* | ||
@@ -103,0 +103,0 @@ */ |
@@ -47,3 +47,3 @@ /** | ||
*/ | ||
export type CustomFieldReferenceValue = 'approval-flow' | 'associate-role' | 'business-unit' | 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'key-value-document' | 'order' | 'product' | 'product-type' | 'review' | 'shipping-method' | 'state' | 'zone' | string; | ||
export type CustomFieldReferenceValue = 'approval-flow' | 'approval-rule' | 'associate-role' | 'business-unit' | 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'key-value-document' | 'order' | 'product' | 'product-type' | 'review' | 'shipping-method' | 'state' | 'zone' | string; | ||
/** | ||
@@ -236,3 +236,3 @@ * Serves as value of the `custom` field on a resource or data type customized with a [Type](ctp:api:type:Type). | ||
*/ | ||
export type ResourceTypeId = 'address' | 'approval-flow' | 'asset' | 'associate-role' | 'business-unit' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'product-tailoring' | 'quote' | 'review' | 'shipping' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'standalone-price' | 'store' | 'transaction' | string; | ||
export type ResourceTypeId = 'address' | 'approval-flow' | 'approval-rule' | 'asset' | 'associate-role' | 'business-unit' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'product-tailoring' | 'quote' | 'review' | 'shipping' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'standalone-price' | 'store' | 'transaction' | string; | ||
export interface Type extends BaseResource { | ||
@@ -239,0 +239,0 @@ /** |
@@ -7,3 +7,3 @@ { | ||
"name": "@commercetools/platform-sdk", | ||
"version": "7.18.0", | ||
"version": "7.19.0", | ||
"engines": { | ||
@@ -10,0 +10,0 @@ "node": ">=14" |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
7333653
164623