@gradientedge/commercetools-utils 5.27.2 → 5.28.0

package/dist/mjs/types/models/channel.d.ts

@@ -0,0 +1,380 @@
+/**
+ * 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 { Address, BaseResource, CreatedBy, GeoJson, LastModifiedBy, LocalizedString, _BaseAddress } from './common.js';
+import { ReviewRatingStatistics } from './review.js';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
+export interface Channel extends BaseResource {
+    /**
+     *	Unique identifier of the Channel.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the Channel.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the Channel was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the Channel was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	IDs and references that last modified the Channel.
+     *
+     *
+     */
+    readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	IDs and references that created the Channel.
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
+    /**
+     *	User-defined unique identifier of the Channel.
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	Roles of the Channel.
+     *
+     *
+     */
+    readonly roles: ChannelRoleEnum[];
+    /**
+     *	Name of the Channel.
+     *
+     *
+     */
+    readonly name?: LocalizedString;
+    /**
+     *	Description of the Channel.
+     *
+     *
+     */
+    readonly description?: LocalizedString;
+    /**
+     *	Address where the Channel is located (for example, if the Channel is a physical store).
+     *
+     *
+     */
+    readonly address?: Address;
+    /**
+     *	Statistics about the review ratings taken into account for the Channel.
+     *
+     *
+     */
+    readonly reviewRatingStatistics?: ReviewRatingStatistics;
+    /**
+     *	Custom Fields defined for the Channel.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+    /**
+     *	GeoJSON geometry object encoding the geo location of the Channel.
+     *
+     *
+     */
+    readonly geoLocation?: GeoJson;
+}
+export interface ChannelDraft {
+    /**
+     *	User-defined unique identifier for the Channel.
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	Roles of the Channel.
+     *	Each channel must have at least one role.
+     *	If not specified, then `InventorySupply` is assigned by default.
+     *
+     *
+     */
+    readonly roles?: ChannelRoleEnum[];
+    /**
+     *	Name of the Channel.
+     *
+     *
+     */
+    readonly name?: LocalizedString;
+    /**
+     *	Description of the Channel.
+     *
+     *
+     */
+    readonly description?: LocalizedString;
+    /**
+     *	Address where the Channel is located.
+     *
+     *
+     */
+    readonly address?: _BaseAddress;
+    /**
+     *	Custom fields defined for the Channel.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+    /**
+     *	GeoJSON geometry object encoding the geo location of the Channel.
+     *	Currently, only the [Point](ctp:api:type:GeoJsonPoint) type is supported.
+     *
+     *
+     */
+    readonly geoLocation?: GeoJson;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [Channel](ctp:api:type:Channel).
+ *
+ */
+export interface ChannelPagedQueryResponse {
+    /**
+     *	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;
+    /**
+     *	[Channels](ctp:api:type:Channel) matching the query.
+     *
+     *
+     */
+    readonly results: Channel[];
+}
+/**
+ *	[Reference](ctp:api:type:Reference) to a [Channel](ctp:api:type:Channel).
+ *
+ */
+export interface ChannelReference {
+    readonly typeId: 'channel';
+    /**
+     *	Unique identifier of the referenced [Channel](ctp:api:type:Channel).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded Channel.
+     *	Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Channels.
+     *
+     *
+     */
+    readonly obj?: Channel;
+}
+/**
+ *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
+ *
+ */
+export interface ChannelResourceIdentifier {
+    readonly typeId: 'channel';
+    /**
+     *	Unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `key` is absent.
+     *
+     *
+     */
+    readonly id?: string;
+    /**
+     *	User-defined unique identifier of the referenced [Channel](ctp:api:type:Channel). Required if `id` is absent.
+     *
+     *
+     */
+    readonly key?: string;
+}
+/**
+ *	Describes the purpose and type of the Channel. A Channel can have one or more roles.
+ *
+ */
+export type ChannelRoleEnum = 'InventorySupply' | 'OrderExport' | 'OrderImport' | 'Primary' | 'ProductDistribution' | string;
+export interface ChannelUpdate {
+    /**
+     *	Expected version of the Channel on 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 Channel.
+     *
+     *
+     */
+    readonly actions: ChannelUpdateAction[];
+}
+export type ChannelUpdateAction = ChannelAddRolesAction | ChannelChangeDescriptionAction | ChannelChangeKeyAction | ChannelChangeNameAction | ChannelRemoveRolesAction | ChannelSetAddressAction | ChannelSetAddressCustomFieldAction | ChannelSetAddressCustomTypeAction | ChannelSetCustomFieldAction | ChannelSetCustomTypeAction | ChannelSetGeoLocationAction | ChannelSetRolesAction;
+export interface ChannelAddRolesAction {
+    readonly action: 'addRoles';
+    /**
+     *	Value to append to the array.
+     *
+     *
+     */
+    readonly roles: ChannelRoleEnum[];
+}
+export interface ChannelChangeDescriptionAction {
+    readonly action: 'changeDescription';
+    /**
+     *	New value to set. Must not be empty.
+     *
+     *
+     */
+    readonly description: LocalizedString;
+}
+export interface ChannelChangeKeyAction {
+    readonly action: 'changeKey';
+    /**
+     *	New value to set. Must not be empty.
+     *
+     *
+     */
+    readonly key: string;
+}
+export interface ChannelChangeNameAction {
+    readonly action: 'changeName';
+    /**
+     *	New value to set. Must not be empty.
+     *
+     *
+     */
+    readonly name: LocalizedString;
+}
+export interface ChannelRemoveRolesAction {
+    readonly action: 'removeRoles';
+    /**
+     *	Value to remove from the array.
+     *
+     *
+     */
+    readonly roles: ChannelRoleEnum[];
+}
+export interface ChannelSetAddressAction {
+    readonly action: 'setAddress';
+    /**
+     *	Value to set. If empty, any existing value will be removed.
+     *
+     *
+     */
+    readonly address?: _BaseAddress;
+}
+export interface ChannelSetAddressCustomFieldAction {
+    readonly action: 'setAddressCustomField';
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	Specifies the format of the value of the Custom Field defined by `name`.
+     *	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.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface ChannelSetAddressCustomTypeAction {
+    readonly action: 'setAddressCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the `address` with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the `address`.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `address`.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface ChannelSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    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 ChannelSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the Channel with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the Channel.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Channel.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface ChannelSetGeoLocationAction {
+    readonly action: 'setGeoLocation';
+    /**
+     *	Value to set.
+     *
+     *
+     */
+    readonly geoLocation?: GeoJson;
+}
+export interface ChannelSetRolesAction {
+    readonly action: 'setRoles';
+    /**
+     *	Value to set. If not specified, then `InventorySupply` is assigned by default.
+     *
+     *
+     */
+    readonly roles: ChannelRoleEnum[];
+}
+//# sourceMappingURL=channel.d.ts.map

package/dist/mjs/types/models/channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/models/channel.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AACtH,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAEnG,MAAM,WAAW,OAAQ,SAAQ,YAAY;IAC3C;;;;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,KAAK,EAAE,eAAe,EAAE,CAAA;IACjC;;;;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,sBAAsB,CAAC,EAAE,sBAAsB,CAAA;IACxD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAC/B;AACD,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,CAAA;IAClC;;;;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,YAAY,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAA;IACnC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAC/B;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;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,OAAO,EAAE,CAAA;CAC5B;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAA;CACvB;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B;;;;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,eAAe,GACvB,iBAAiB,GACjB,aAAa,GACb,aAAa,GACb,SAAS,GACT,qBAAqB,GACrB,MAAM,CAAA;AACV,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,EAAE,CAAA;CACxC;AACD,MAAM,MAAM,mBAAmB,GAC3B,qBAAqB,GACrB,8BAA8B,GAC9B,sBAAsB,GACtB,uBAAuB,GACvB,wBAAwB,GACxB,uBAAuB,GACvB,kCAAkC,GAClC,iCAAiC,GACjC,2BAA2B,GAC3B,0BAA0B,GAC1B,2BAA2B,GAC3B,qBAAqB,CAAA;AACzB,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,EAAE,CAAA;CAClC;AACD,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAA;CACtC;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;CAC/B;AACD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,EAAE,CAAA;CAClC;AACD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAA;CAChC;AACD,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAA;CACrB;AACD,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAA;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;CACjC;AACD,MAAM,WAAW,2BAA2B;IAC1C,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,0BAA0B;IACzC,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;AACD,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAC/B;AACD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,EAAE,CAAA;CAClC"}

package/dist/mjs/types/models/channel.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=channel.js.map

package/dist/mjs/types/models/channel.js.map

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