@gradientedge/commercetools-utils 5.9.1 → 5.11.0

package/dist/mjs/models/state.d.ts

@@ -0,0 +1,341 @@
+/**
+ * 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 { BaseResource, CreatedBy, LastModifiedBy, LocalizedString } from './common.js';
+export interface State extends BaseResource {
+    /**
+     *	Unique identifier of the State.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the State.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the State was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the State was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked).
+     *
+     *
+     */
+    readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked).
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
+    /**
+     *	User-defined unique identifier of the State.
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	Indicates to which resource or object types the State is assigned to.
+     *
+     *
+     */
+    readonly type: StateTypeEnum;
+    /**
+     *	Name of the State.
+     *
+     *
+     */
+    readonly name?: LocalizedString;
+    /**
+     *	Description of the State.
+     *
+     *
+     */
+    readonly description?: LocalizedString;
+    /**
+     *	`true` for an initial State, the first State in a workflow.
+     *
+     *
+     */
+    readonly initial: boolean;
+    /**
+     *	`true` for States that are an integral part of the [Project](ctp:api:type:Project). Those States cannot be deleted and their `key` cannot be changed.
+     *
+     *
+     */
+    readonly builtIn: boolean;
+    /**
+     *	Roles the State can fulfill for [Reviews](ctp:api:type:Review) and [Line Items](ctp:api:type:LineItem).
+     *
+     *
+     */
+    readonly roles?: StateRoleEnum[];
+    /**
+     *	- list of States of the same `type` that the current State can be transitioned to. For example, when the current State is the _Initial_ State of [StateType](ctp:api:type:StateTypeEnum) `OrderState` and this list contains the reference to the _Shipped_ `OrderState`, the transition _Initial_ -> _Shipped_ is allowed.
+     *	- if empty, no transitions are allowed from the current State, defining the current State as final for this workflow.
+     *	- if not set, the validation is turned off and the current State can be transitioned to any other State of the same `type` as the current State.
+     *
+     *
+     */
+    readonly transitions?: StateReference[];
+}
+export interface StateDraft {
+    /**
+     *	User-defined unique identifier for the State.
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	Specify to which resource or object type the State is assigned to.
+     *
+     *
+     */
+    readonly type: StateTypeEnum;
+    /**
+     *	Name of the State.
+     *
+     *
+     */
+    readonly name?: LocalizedString;
+    /**
+     *	Description of the State.
+     *
+     *
+     */
+    readonly description?: LocalizedString;
+    /**
+     *	Set to `false` if the State is not the first step in a workflow.
+     *
+     *
+     */
+    readonly initial?: boolean;
+    /**
+     *	If suitable, assign predifined roles the State can fulfill in case the State's `type` is `LineItemState` or `ReviewState`.
+     *
+     *
+     */
+    readonly roles?: StateRoleEnum[];
+    /**
+     *	Define the list of States of the same `type` to which the current State can be transitioned to.
+     *
+     *	- If, for example, the current State is the _Initial_ State of [StateType](ctp:api:type:StateTypeEnum) `OrderState` and you want to allow the transition _Initial_ -> _Shipped_, then add the [StateResourceIdentifier](ctp:api:type:StateResourceIdentifier) to the _Shipped_ `OrderState` to this list.
+     *	- Set to empty list for not allowing any transition from the current State and defining it as final State for a workflow.
+     *	- Do not set this field at all to turn off validation and allowing transitions to any other State of the same `type` as the current State.
+     *
+     *
+     */
+    readonly transitions?: StateResourceIdentifier[];
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [State](ctp:api:type:State).
+ *
+ */
+export interface StatePagedQueryResponse {
+    /**
+     *	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;
+    /**
+     *	[States](ctp:api:type:State) matching the query.
+     *
+     *
+     */
+    readonly results: State[];
+}
+/**
+ *	[Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State).
+ *
+ */
+export interface StateReference {
+    readonly typeId: 'state';
+    /**
+     *	Unique identifier of the referenced [State](ctp:api:type:State).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded State. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for States.
+     *
+     *
+     */
+    readonly obj?: State;
+}
+/**
+ *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
+ *
+ */
+export interface StateResourceIdentifier {
+    readonly typeId: 'state';
+    /**
+     *	Unique identifier of the referenced [State](ctp:api:type:State). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly id?: string;
+    /**
+     *	User-defined unique identifier of the referenced [State](ctp:api:type:State). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly key?: string;
+}
+/**
+ *	For some resource types, a State can fulfill the following predefined roles:
+ *
+ */
+export type StateRoleEnum = 'Return' | 'ReviewIncludedInStatistics' | string;
+/**
+ *	Resource or object type the State can be assigned to.
+ *
+ */
+export type StateTypeEnum = 'LineItemState' | 'OrderState' | 'PaymentState' | 'ProductState' | 'QuoteRequestState' | 'QuoteState' | 'ReviewState' | 'StagedQuoteState' | string;
+export interface StateUpdate {
+    /**
+     *	Expected version of the State on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the State.
+     *
+     *
+     */
+    readonly actions: StateUpdateAction[];
+}
+export type StateUpdateAction = StateAddRolesAction | StateChangeInitialAction | StateChangeKeyAction | StateChangeTypeAction | StateRemoveRolesAction | StateSetDescriptionAction | StateSetNameAction | StateSetRolesAction | StateSetTransitionsAction;
+export interface StateAddRolesAction {
+    readonly action: 'addRoles';
+    /**
+     *	Value to append to the array.
+     *
+     *
+     */
+    readonly roles: StateRoleEnum[];
+}
+export interface StateChangeInitialAction {
+    readonly action: 'changeInitial';
+    /**
+     *	Set to `true` for defining the State as initial State in a state machine and making it the first step in a workflow.
+     *
+     *
+     */
+    readonly initial: boolean;
+}
+export interface StateChangeKeyAction {
+    readonly action: 'changeKey';
+    /**
+     *	New value to set.
+     *	Must not be empty.
+     *
+     *
+     */
+    readonly key: string;
+}
+export interface StateChangeTypeAction {
+    readonly action: 'changeType';
+    /**
+     *	Resource or object types the State shall be assigned to.
+     *	Must not be empty.
+     *
+     *
+     */
+    readonly type: StateTypeEnum;
+}
+export interface StateRemoveRolesAction {
+    readonly action: 'removeRoles';
+    /**
+     *	Roles to remove from the State.
+     *
+     *
+     */
+    readonly roles: StateRoleEnum[];
+}
+export interface StateSetDescriptionAction {
+    readonly action: 'setDescription';
+    /**
+     *	Value to set.
+     *	If empty, any existing value will be removed.
+     *
+     *
+     */
+    readonly description: LocalizedString;
+}
+export interface StateSetNameAction {
+    readonly action: 'setName';
+    /**
+     *	Value to set.
+     *	If empty, any existing value will be removed.
+     *
+     *
+     */
+    readonly name: LocalizedString;
+}
+export interface StateSetRolesAction {
+    readonly action: 'setRoles';
+    /**
+     *	Value to set.
+     *	If empty, any existing value will be removed.
+     *
+     *
+     */
+    readonly roles: StateRoleEnum[];
+}
+export interface StateSetTransitionsAction {
+    readonly action: 'setTransitions';
+    /**
+     *	Value to set.
+     *	If empty, any existing value will be removed.
+     *
+     *	Possible transformations of the current State to other States of the same `type` (for example, _Initial_ -> _Shipped_).
+     *	When performing a `transitionState` update action and `transitions` is set, the currently referenced State must have a transition to the new State.
+     *
+     *	If `transitions` is an empty list, it means the current State is a final State and no further transitions are allowed.
+     *	If `transitions` is not set, the validation is turned off.
+     *
+     *	When performing a `transitionState` update action, any other State of the same `type` can be transitioned to.
+     *
+     *
+     */
+    readonly transitions?: StateResourceIdentifier[];
+}
+//# sourceMappingURL=state.d.ts.map

package/dist/mjs/models/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../src/lib/models/state.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAEtF,MAAM,WAAW,KAAM,SAAQ,YAAY;IACzC;;;;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,cAAc,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IAChC;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,cAAc,EAAE,CAAA;CACxC;AACD,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IAChC;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,EAAE,CAAA;CACjD;AACD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;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,KAAK,EAAE,CAAA;CAC1B;AACD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,KAAK,CAAA;CACrB;AACD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,4BAA4B,GAAG,MAAM,CAAA;AAC5E;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,YAAY,GACZ,cAAc,GACd,cAAc,GACd,mBAAmB,GACnB,YAAY,GACZ,aAAa,GACb,kBAAkB,GAClB,MAAM,CAAA;AACV,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,iBAAiB,EAAE,CAAA;CACtC;AACD,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,wBAAwB,GACxB,oBAAoB,GACpB,qBAAqB,GACrB,sBAAsB,GACtB,yBAAyB,GACzB,kBAAkB,GAClB,mBAAmB,GACnB,yBAAyB,CAAA;AAC7B,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AACD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;CAC7B;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAA;CACtC;AACD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;CAC/B;AACD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,EAAE,CAAA;CACjD"}

package/dist/mjs/models/state.js

@@ -0,0 +1,7 @@
+/**
+ * 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/.
+ */
+export {};
+//# sourceMappingURL=state.js.map

package/dist/mjs/models/state.js.map

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

package/dist/mjs/models/store-country.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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/.
+ */
+export interface StoreCountry {
+    /**
+     *	Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+     *
+     *
+     */
+    readonly code: string;
+}
+//# sourceMappingURL=store-country.d.ts.map

package/dist/mjs/models/store-country.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-country.d.ts","sourceRoot":"","sources":["../../../src/lib/models/store-country.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB"}

package/dist/mjs/models/store-country.js

@@ -0,0 +1,7 @@
+/**
+ * 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/.
+ */
+export {};
+//# sourceMappingURL=store-country.js.map

package/dist/mjs/models/store-country.js.map

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