@gradientedge/commercetools-utils 5.27.1 → 5.28.0

package/dist/cjs/types/models/approval-flow.d.ts

@@ -0,0 +1,264 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { ApprovalRule, RuleApprover } from './approval-rule.js';
+import { Associate, BusinessUnitKeyReference } from './business-unit.js';
+import { BaseResource, CreatedBy, LastModifiedBy } from './common.js';
+import { OrderReference } from './order.js';
+import { CustomFields, FieldContainer, TypeResourceIdentifier } from './type.js';
+export interface ApprovalFlow extends BaseResource {
+    /**
+     *	Unique identifier of the Approval Flow.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the Approval Flow.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the Approval Flow was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	IDs and references that created the ApprovalFlow.
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
+    /**
+     *	Date and time (UTC) the Approval Flow was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	IDs and references that last modified the ApprovalFlow.
+     *
+     *
+     */
+    readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	[Order](ctp:api:type:Order) that needs to be approved.
+     *
+     *
+     */
+    readonly order: OrderReference;
+    /**
+     *	[Business Unit](ctp:api:type:BusinessUnit) the Approval Flow belongs to.
+     *
+     *
+     */
+    readonly businessUnit: BusinessUnitKeyReference;
+    /**
+     *	Approval Rules that matched the [Order](ctp:api:type:Order).
+     *
+     *
+     */
+    readonly rules: ApprovalRule[];
+    /**
+     *	Indicates whether the Approval Flow is under review, approved, or rejected.
+     *
+     *
+     */
+    readonly status: ApprovalFlowStatus;
+    /**
+     *	Present when the [status](ctp:api:type:ApprovalFlowStatus) of the Approval Flow is `Rejected`.
+     *
+     *
+     */
+    readonly rejection?: ApprovalFlowRejection;
+    /**
+     *	Existing approvals in the Approval Flow.
+     *
+     *
+     */
+    readonly approvals: ApprovalFlowApproval[];
+    /**
+     *	Associate Roles that can approve according to the approver hierarchy tiers defined in `rules`.
+     *	Associates are allowed to reject even after they have given approval, as long as the current approver hierarchy tier still contains their role.
+     *
+     *
+     */
+    readonly eligibleApprovers: RuleApprover[];
+    /**
+     *	Associate Roles required for approval based on the approver hierarchy tiers defined in `rules` across all remaining tiers.
+     *
+     *
+     */
+    readonly pendingApprovers: RuleApprover[];
+    /**
+     *	Associate Roles required for approval based on the approver hierarchy tiers defined in `rules` only for the currently active tier(s).
+     *
+     *
+     */
+    readonly currentTierPendingApprovers: RuleApprover[];
+    /**
+     *	Custom Fields on the Approval Flow.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+}
+export interface ApprovalFlowApproval {
+    /**
+     *	Associate who approved the [Approval Flow](ctp:api:type:ApprovalFlow).
+     *
+     *
+     */
+    readonly approver: Associate;
+    /**
+     *	Date and time (UTC) the [Approval Flow](ctp:api:type:ApprovalFlow) was approved.
+     *
+     *
+     */
+    readonly approvedAt: string;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ApprovalFlow](ctp:api:type:ApprovalFlow).
+ *
+ */
+export interface ApprovalFlowPagedQueryResponse {
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	Actual number of results returned.
+     *
+     *
+     */
+    readonly count: number;
+    /**
+     *	Total number of results matching the query.
+     *	This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+     *	This field is returned by default.
+     *	For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
+     *	When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
+     *
+     *
+     */
+    readonly total?: number;
+    /**
+     *	Approval Flows matching the query.
+     *
+     *
+     */
+    readonly results: ApprovalFlow[];
+}
+export interface ApprovalFlowRejection {
+    /**
+     *	Associate who rejected the [Approval Flow](ctp:api:type:ApprovalFlow).
+     *
+     *
+     */
+    readonly rejecter: Associate;
+    /**
+     *	Date and time (UTC) the [Approval Flow](ctp:api:type:ApprovalFlow) was rejected.
+     *
+     *
+     */
+    readonly rejectedAt: string;
+    /**
+     *	The reason for the rejection of the [Approval Flow](ctp:api:type:ApprovalFlow).
+     *
+     *
+     */
+    readonly reason?: string;
+}
+/**
+ *	Indicates whether the [Approval Flow](ctp:api:type:ApprovalFlow) is under review, approved, or rejected.
+ *
+ */
+export type ApprovalFlowStatus = 'Approved' | 'Pending' | 'Rejected' | string;
+export interface ApprovalFlowUpdate {
+    /**
+     *	Expected version of the [Approval Flow](ctp:api:type:ApprovalFlow) to which the changes should be applied.
+     *	If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the [Approval Flow](ctp:api:type:ApprovalFlow).
+     *
+     *
+     */
+    readonly actions: ApprovalFlowUpdateAction[];
+}
+export type ApprovalFlowUpdateAction = ApprovalFlowApproveAction | ApprovalFlowRejectAction | ApprovalFlowSetCustomFieldAction | ApprovalFlowSetCustomTypeAction;
+/**
+ *	This update action allows an [Associate](ctp:api:type:Associate) to approve an Approval Flow. The process takes into account all [Associate Roles](ctp:api:type:AssociateRole) held by the Associate, aligning with the matched [Approval Rules](ctp:api:type:ApprovalRule) and their respective approver hierarchies.
+ *
+ *	When every required Associate has given their approval, the Approval Flow achieves a fully approved state, automatically updating its status to `Approved`. An Associate is eligible to approve only if their roles are within tiers of the Approval Rule hierarchy that are yet to be fully approved or rejected. As such, an Associate may be able to give their approval more than once.
+ *
+ */
+export interface ApprovalFlowApproveAction {
+    readonly action: 'approve';
+}
+/**
+ *	This update action allows an [Associate](ctp:api:type:Associate) to reject an Approval Flow, setting its status to `Rejected`.
+ *	The process takes into account all [Associate Roles](ctp:api:type:AssociateRole) held by the Associate, aligning with the matched [Approval Rules](ctp:api:type:ApprovalRule) and their respective approver hierarchies.
+ *	Even a single rejection in the process will result in the rejection of the entire Approval Flow.
+ *
+ *	An Associate is eligible to reject only if their roles are within tiers of the Approval Rule hierarchy that are yet to be rejected. An Associate may alter a prior approval into a rejection.
+ *
+ */
+export interface ApprovalFlowRejectAction {
+    readonly action: 'reject';
+    /**
+     *	The reason for the rejection of the [Approval Flow](ctp:api:type:ApprovalFlow).
+     *
+     *
+     */
+    readonly reason?: string;
+}
+export interface ApprovalFlowSetCustomFieldAction {
+    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 ApprovalFlowSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the ApprovalFlow with [Custom Fields](ctp:api:type:CustomFields).
+     *	If absent, any existing Type and Custom Fields are removed from the ApprovalFlow.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](ctp:api:type:CustomFields) fields for the ApprovalFlow.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+//# sourceMappingURL=approval-flow.d.ts.map

package/dist/cjs/types/models/approval-flow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"approval-flow.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/models/approval-flow.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,SAAS,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AACxE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAEhF,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,wBAAwB,CAAA;IAC/C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,oBAAoB,EAAE,CAAA;IAC1C;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,EAAE,YAAY,EAAE,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,YAAY,EAAE,CAAA;IACzC;;;;OAIG;IACH,QAAQ,CAAC,2BAA2B,EAAE,YAAY,EAAE,CAAA;IACpD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B;AACD,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC5B;AACD;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,CAAA;CACjC;AACD,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AACD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,MAAM,CAAA;AAC7E,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,wBAAwB,EAAE,CAAA;CAC7C;AACD,MAAM,MAAM,wBAAwB,GAChC,yBAAyB,GACzB,wBAAwB,GACxB,gCAAgC,GAChC,+BAA+B,CAAA;AACnC;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;CAC3B;AACD;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AACD,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAA;CACrB;AACD,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;CACjC"}

package/dist/cjs/types/models/approval-flow.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=approval-flow.js.map

package/dist/cjs/types/models/approval-flow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"approval-flow.js","sourceRoot":"","sources":["../../../../src/lib/types/models/approval-flow.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/dist/cjs/types/models/approval-rule.d.ts

@@ -0,0 +1,415 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { AssociateRoleKeyReference, AssociateRoleResourceIdentifier } from './associate-role.js';
+import { BusinessUnitKeyReference } from './business-unit.js';
+import { BaseResource, CreatedBy, LastModifiedBy } from './common.js';
+import { CustomFields, FieldContainer, TypeResourceIdentifier } from './type.js';
+export interface ApprovalRule extends BaseResource {
+    /**
+     *	Unique identifier of the Approval Rule.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the Approval Rule.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the Approval Rule was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	IDs and references that created the ApprovalRule.
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
+    /**
+     *	Date and time (UTC) the Approval Rule was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	IDs and references that last modified the ApprovalRule.
+     *
+     *
+     */
+    readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	User-defined unique identifier of the Approval Rule. Must be unique within a [Business Unit](ctp:api:type:BusinessUnit).
+     *
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Name of the Approval Rule.
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	Description of the Approval Rule.
+     *
+     *
+     */
+    readonly description?: string;
+    /**
+     *	Indicates whether the Approval Rule should be matched against [Orders](ctp:api:type:Order) or not.
+     *
+     *
+     */
+    readonly status: ApprovalRuleStatus;
+    /**
+     *	The [Order Predicate](/../api/projects/predicates#order-predicates) describing the [Orders](ctp:api:type:Order) the Approval Rule should match against.
+     *
+     *
+     */
+    readonly predicate: string;
+    /**
+     *	The hierarchy of approvers within the Approval Rule.
+     *
+     *
+     */
+    readonly approvers: ApproverHierarchy;
+    /**
+     *	The [Associate Roles](ctp:api:type:AssociateRole) customers must hold for their Order to require approval.
+     *
+     *
+     */
+    readonly requesters: RuleRequester[];
+    /**
+     *	The [Business Unit](ctp:api:type:BusinessUnit) the Approval Rule belongs to.
+     *
+     *
+     */
+    readonly businessUnit: BusinessUnitKeyReference;
+    /**
+     *	Custom Fields on the Approval Rule.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+}
+export interface ApprovalRuleDraft {
+    /**
+     *	User-defined unique identifier of the Approval Rule. Uniqueness is enforced within the Business Unit.
+     *
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Name of the Approval Rule.
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	Description of the Approval Rule.
+     *
+     *
+     */
+    readonly description?: string;
+    /**
+     *	Indicates whether the Approval Rule should be matched against [Orders](ctp:api:type:Order) or not.
+     *
+     *
+     */
+    readonly status: ApprovalRuleStatus;
+    /**
+     *	The [predicate](/../api/predicates/predicate-operators) describing the [Orders](ctp:api:type:Order) the Approval Rule should match against.
+     *
+     *
+     */
+    readonly predicate: string;
+    /**
+     *	The hierarchy of approvers within the Approval Rule.
+     *
+     *
+     */
+    readonly approvers: ApproverHierarchyDraft;
+    /**
+     *	The [Associate Roles](ctp:api:type:AssociateRole) customers must hold for their Order to require approval.
+     *
+     *
+     */
+    readonly requesters: RuleRequesterDraft[];
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ApprovalRule](ctp:api:type:ApprovalRule).
+ *
+ */
+export interface ApprovalRulePagedQueryResponse {
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	Actual number of results returned.
+     *
+     *
+     */
+    readonly count: number;
+    /**
+     *	Total number of results matching the query.
+     *	This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+     *	This field is returned by default.
+     *	For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
+     *	When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
+     *
+     *
+     */
+    readonly total?: number;
+    /**
+     *	Approval Rules matching the query.
+     *
+     *
+     */
+    readonly results: ApprovalRule[];
+}
+/**
+ *	Indicates whether the Approval Rule should be matched against [Orders](ctp:api:type:Order) or not.
+ *
+ */
+export type ApprovalRuleStatus = 'Active' | 'Inactive' | string;
+export interface ApprovalRuleUpdate {
+    /**
+     *	Expected version of the [ApprovalRule](ctp:api:type:ApprovalRule) to which the changes should be applied.
+     *	If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the [ApprovalRule](ctp:api:type:ApprovalRule).
+     *
+     *
+     */
+    readonly actions: ApprovalRuleUpdateAction[];
+}
+export type ApprovalRuleUpdateAction = ApprovalRuleSetApproversAction | ApprovalRuleSetCustomFieldAction | ApprovalRuleSetCustomTypeAction | ApprovalRuleSetDescriptionAction | ApprovalRuleSetKeyAction | ApprovalRuleSetNameAction | ApprovalRuleSetPredicateAction | ApprovalRuleSetRequestersAction | ApprovalRuleSetStatusAction;
+/**
+ *	Setting the approvers for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleApproversSet](ctp:api:type:ApprovalRuleApproversSetMessage) Message.
+ *
+ */
+export interface ApprovalRuleSetApproversAction {
+    readonly action: 'setApprovers';
+    /**
+     *	New approvers to set for the Approval Rule.
+     *
+     *
+     */
+    readonly approvers: ApproverHierarchyDraft;
+}
+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;
+}
+/**
+ *	Setting the description for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleDescriptionSet](ctp:api:type:ApprovalRuleDescriptionSetMessage) Message.
+ *
+ */
+export interface ApprovalRuleSetDescriptionAction {
+    readonly action: 'setDescription';
+    /**
+     *	New description to set for the Approval Rule.
+     *
+     */
+    readonly description?: string;
+}
+/**
+ *	Setting the key for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleKeySet](ctp:api:type:ApprovalRuleKeySetMessage) Message.
+ *
+ */
+export interface ApprovalRuleSetKeyAction {
+    readonly action: 'setKey';
+    /**
+     *	Value to set. Must be unique within a Business Unit. If empty, any existing value will be removed.
+     *
+     *
+     */
+    readonly key?: string;
+}
+/**
+ *	Setting the name for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleNameSet](ctp:api:type:ApprovalRuleNameSetMessage) Message.
+ *
+ */
+export interface ApprovalRuleSetNameAction {
+    readonly action: 'setName';
+    /**
+     *	New name to set for the Approval Rule.
+     *
+     */
+    readonly name: string;
+}
+/**
+ *	Setting the [Order Predicate](/../api/projects/predicates#order-predicates) for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRulePredicateSet](ctp:api:type:ApprovalRulePredicateSetMessage) Message.
+ *
+ */
+export interface ApprovalRuleSetPredicateAction {
+    readonly action: 'setPredicate';
+    /**
+     *	A valid [Order Predicate](/../api/projects/predicates#order-predicates) to set for the Approval Rule.
+     *
+     */
+    readonly predicate: string;
+}
+/**
+ *	Sets the requesters for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleRequestersSet](ctp:api:type:ApprovalRuleRequestersSetMessage) Message.
+ *
+ */
+export interface ApprovalRuleSetRequestersAction {
+    readonly action: 'setRequesters';
+    /**
+     *	New requesters to set for the Approval Rule.
+     *
+     *
+     */
+    readonly requesters: RuleRequesterDraft[];
+}
+/**
+ *	Setting the status for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleStatusSet](ctp:api:type:ApprovalRuleStatusSetMessage) Message.
+ *
+ */
+export interface ApprovalRuleSetStatusAction {
+    readonly action: 'setStatus';
+    /**
+     *	New status to set for the Approval Rule.
+     *
+     */
+    readonly status: ApprovalRuleStatus;
+}
+export interface ApproverConjunction {
+    /**
+     *	All of the nested disjunctions must be approved in order for the conjunction to be considered approved.
+     *
+     *
+     */
+    readonly and: ApproverDisjunction[];
+}
+export interface ApproverConjunctionDraft {
+    /**
+     *	All of the nested disjunctions must be approved in order for the conjunction to be considered approved.
+     *
+     *
+     */
+    readonly and: ApproverDisjunctionDraft[];
+}
+export interface ApproverDisjunction {
+    /**
+     *	Any of the nested approvers must approve in order for the disjunction to be considered approved.
+     *
+     *
+     */
+    readonly or: RuleApprover[];
+}
+export interface ApproverDisjunctionDraft {
+    /**
+     *	Any of the nested approvers must approve in order for the disjunction to be considered approved.
+     *
+     *
+     */
+    readonly or: RuleApproverDraft[];
+}
+/**
+ *	Describes the order in which [Associates](ctp:api:type:Associate) can approve the matched [Order](ctp:api:type:Order).
+ *
+ */
+export interface ApproverHierarchy {
+    /**
+     *	All of the nested conjunctions must be approved in order for the hierarchy to be considered approved.
+     *
+     *
+     */
+    readonly tiers: ApproverConjunction[];
+}
+/**
+ *	Describes the sequence in which [Associates](ctp:api:type:Associate) can approve an [Order](ctp:api:type:Order).
+ *
+ */
+export interface ApproverHierarchyDraft {
+    /**
+     *	Nested conjunctions representing tiers of approvers in a hierarchy.
+     *
+     *
+     */
+    readonly tiers: ApproverConjunctionDraft[];
+}
+export interface RuleApprover {
+    /**
+     *	The Associate Role that is allowed to approve at a given stage in the approval process.
+     *
+     *
+     */
+    readonly associateRole: AssociateRoleKeyReference;
+}
+export interface RuleApproverDraft {
+    /**
+     *	Any Associate with this Role can approve.
+     *
+     *
+     */
+    readonly associateRole: AssociateRoleResourceIdentifier;
+}
+export interface RuleRequester {
+    /**
+     *	The [Associate Role](ctp:api:type:AssociateRole) that an [Associate](ctp:api:type) must hold for the Approval Rule to apply to the Orders they create.
+     *
+     *
+     */
+    readonly associateRole: AssociateRoleKeyReference;
+}
+export interface RuleRequesterDraft {
+    /**
+     *	The [Associate Role](ctp:api:type:AssociateRole) that an [Associate](ctp:api:type) must hold for the Approval Rule to apply to the Orders they create.
+     *
+     *
+     */
+    readonly associateRole: AssociateRoleResourceIdentifier;
+}
+//# sourceMappingURL=approval-rule.d.ts.map