@gradientedge/commercetools-utils 5.9.1 → 5.11.0

package/dist/cjs/models/associate-role.d.ts

@@ -0,0 +1,319 @@
+/**
+ * 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 } from './common.js';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
+export interface AssociateRole extends BaseResource {
+    /**
+     *	Unique identifier of the AssociateRole.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the AssociateRole.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the AssociateRole was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the AssociateRole was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	Present on resources updated 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 AssociateRole.
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	Whether the AssociateRole can be assigned to an Associate by a [buyer](/../api/associates-overview#buyer). If false, the AssociateRole can only be assigned using the [general endpoint](/../api/associates-overview#through-the-general-endpoints).
+     *
+     *
+     */
+    readonly buyerAssignable: boolean;
+    /**
+     *	Name of the AssociateRole.
+     *
+     *
+     */
+    readonly name?: string;
+    /**
+     *	List of Permissions for the AssociateRole.
+     *
+     *
+     */
+    readonly permissions: Permission[];
+    /**
+     *	Custom Fields for the AssociateRole.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+}
+export interface AssociateRoleDraft {
+    /**
+     *	User-defined unique identifier for the AssociateRole.
+     *
+     *
+     */
+    readonly key: string;
+    /**
+     *	Name of the AssociateRole.
+     *
+     *
+     */
+    readonly name?: string;
+    /**
+     *	Whether the AssociateRole can be assigned to an Associate by a [buyer](/../api/associates-overview#buyer).
+     *
+     *
+     */
+    readonly buyerAssignable?: boolean;
+    /**
+     *	List of Permissions for the AssociateRole.
+     *
+     *
+     */
+    readonly permissions?: Permission[];
+    /**
+     *	Custom Fields for the AssociateRole.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+/**
+ *	[Reference](ctp:api:type:TypeReference) to an [AssociateRole](ctp:api:type:AssociateRole) by its key.
+ *
+ */
+export interface AssociateRoleKeyReference {
+    readonly typeId: 'associate-role';
+    /**
+     *	Unique and immutable key of the referenced [AssociateRole](ctp:api:type:AssociateRole).
+     *
+     *
+     */
+    readonly key: string;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [AssociateRole](ctp:api:type:AssociateRole).
+ *
+ */
+export interface AssociateRolePagedQueryResponse {
+    /**
+     *	Number of requested [results](/../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;
+    /**
+     *	[AssociateRoles](ctp:api:type:AssociateRole) matching the query.
+     *
+     *
+     */
+    readonly results: AssociateRole[];
+}
+/**
+ *	[Reference](ctp:api:type:TypeReference) to an [AssociateRole](ctp:api:type:AssociateRole).
+ *
+ */
+export interface AssociateRoleReference {
+    readonly typeId: 'associate-role';
+    /**
+     *	Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded AssociateRole. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for AssociateRole.
+     *
+     *
+     */
+    readonly obj?: AssociateRole;
+}
+/**
+ *	[ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole).
+ *
+ */
+export interface AssociateRoleResourceIdentifier {
+    readonly typeId: 'associate-role';
+    /**
+     *	Unique identifier of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly id?: string;
+    /**
+     *	Unique key of the referenced [AssociateRole](ctp:api:type:AssociateRole). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly key?: string;
+}
+export interface AssociateRoleUpdate {
+    /**
+     *	Expected version of the AssociateRole on which the changes should be applied.
+     *	If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the AssociateRole.
+     *
+     *
+     */
+    readonly actions: AssociateRoleUpdateAction[];
+}
+export type AssociateRoleUpdateAction = AssociateRoleAddPermissionAction | AssociateRoleChangeBuyerAssignableAction | AssociateRoleRemovePermissionAction | AssociateRoleSetCustomFieldAction | AssociateRoleSetCustomTypeAction | AssociateRoleSetNameAction | AssociateRoleSetPermissionsAction;
+/**
+ *	Permissions grant granular access to [Business Units](ctp:api:type:BusinessUnit), [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), and [QuoteRequests](ctp:api:type:QuoteRequest).
+ *
+ */
+export type Permission = 'AcceptMyQuotes' | 'AcceptOthersQuotes' | 'AddChildUnits' | 'CreateMyCarts' | 'CreateMyOrdersFromMyCarts' | 'CreateMyOrdersFromMyQuotes' | 'CreateMyQuoteRequestsFromMyCarts' | 'CreateOrdersFromOthersCarts' | 'CreateOrdersFromOthersQuotes' | 'CreateOthersCarts' | 'CreateQuoteRequestsFromOthersCarts' | 'DeclineMyQuotes' | 'DeclineOthersQuotes' | 'DeleteMyCarts' | 'DeleteOthersCarts' | 'RenegotiateMyQuotes' | 'RenegotiateOthersQuotes' | 'UpdateAssociates' | 'UpdateBusinessUnitDetails' | 'UpdateMyCarts' | 'UpdateMyOrders' | 'UpdateMyQuoteRequests' | 'UpdateOthersCarts' | 'UpdateOthersOrders' | 'UpdateOthersQuoteRequests' | 'UpdateParentUnit' | 'ViewMyCarts' | 'ViewMyOrders' | 'ViewMyQuoteRequests' | 'ViewMyQuotes' | 'ViewOthersCarts' | 'ViewOthersOrders' | 'ViewOthersQuoteRequests' | 'ViewOthersQuotes' | string;
+/**
+ *	Adding a Permission to an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRolePermissionAdded](ctp:api:type:AssociateRolePermissionAddedMessage) Message.
+ *
+ */
+export interface AssociateRoleAddPermissionAction {
+    readonly action: 'addPermission';
+    /**
+     *	Permission to be added to the AssociateRole.
+     *
+     *
+     */
+    readonly permission: Permission;
+}
+/**
+ *	Changing the `buyerAssignable` value of an AssociateRole generates an [AssociateRoleBuyerAssignableChanged](ctp:api:type:AssociateRoleBuyerAssignableChangedMessage) Message.
+ *
+ */
+export interface AssociateRoleChangeBuyerAssignableAction {
+    readonly action: 'changeBuyerAssignable';
+    /**
+     *	The new value of the `buyerAssignable` field of the AssociateRole.
+     *
+     *
+     */
+    readonly buyerAssignable: boolean;
+}
+/**
+ *	Removing a Permission from an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRolePermissionRemoved](ctp:api:type:AssociateRolePermissionRemovedMessage) Message.
+ *
+ */
+export interface AssociateRoleRemovePermissionAction {
+    readonly action: 'removePermission';
+    /**
+     *	Permission to be removed from the AssociateRole.
+     *
+     *
+     */
+    readonly permission: Permission;
+}
+export interface AssociateRoleSetCustomFieldAction {
+    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.
+     *	Trying to remove a field that does not exist will fail with an [InvalidOperationError](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface AssociateRoleSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the AssociateRole with [Custom Fields](ctp:api:type:CustomFields).
+     *	If absent, any existing Type and Custom Fields are removed from the AssociateRole.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](ctp:api:type:CustomFields) for the AssociateRole.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+/**
+ *	Updating the name of an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRoleNameSet](ctp:api:type:AssociateRoleNameSetMessage) Message.
+ *
+ */
+export interface AssociateRoleSetNameAction {
+    readonly action: 'setName';
+    /**
+     *	New name to set.
+     *	If `name` is absent or `null`, the existing name, if any, will be removed.
+     *
+     *
+     */
+    readonly name?: string;
+}
+/**
+ *	Updating the Permissions on an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRolePermissionsSet](ctp:api:type:AssociateRolePermissionsSetMessage) Message.
+ *
+ */
+export interface AssociateRoleSetPermissionsAction {
+    readonly action: 'setPermissions';
+    /**
+     *	Overrides the current list of Permissions for the AssociateRole.
+     *
+     *
+     */
+    readonly permissions?: Permission[];
+}
+//# sourceMappingURL=associate-role.d.ts.map

package/dist/cjs/models/associate-role.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"associate-role.d.ts","sourceRoot":"","sources":["../../../src/lib/models/associate-role.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AACrE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAEnG,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD;;;;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,eAAe,EAAE,OAAO,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B;AACD,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAA;CACpC;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AACD;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;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,aAAa,EAAE,CAAA;CAClC;AACD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,aAAa,CAAA;CAC7B;AACD;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,yBAAyB,EAAE,CAAA;CAC9C;AACD,MAAM,MAAM,yBAAyB,GACjC,gCAAgC,GAChC,wCAAwC,GACxC,mCAAmC,GACnC,iCAAiC,GACjC,gCAAgC,GAChC,0BAA0B,GAC1B,iCAAiC,CAAA;AACrC;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,oBAAoB,GACpB,eAAe,GACf,eAAe,GACf,2BAA2B,GAC3B,4BAA4B,GAC5B,kCAAkC,GAClC,6BAA6B,GAC7B,8BAA8B,GAC9B,mBAAmB,GACnB,oCAAoC,GACpC,iBAAiB,GACjB,qBAAqB,GACrB,eAAe,GACf,mBAAmB,GACnB,qBAAqB,GACrB,yBAAyB,GACzB,kBAAkB,GAClB,2BAA2B,GAC3B,eAAe,GACf,gBAAgB,GAChB,uBAAuB,GACvB,mBAAmB,GACnB,oBAAoB,GACpB,2BAA2B,GAC3B,kBAAkB,GAClB,aAAa,GACb,cAAc,GACd,qBAAqB,GACrB,cAAc,GACd,iBAAiB,GACjB,kBAAkB,GAClB,yBAAyB,GACzB,kBAAkB,GAClB,MAAM,CAAA;AACV;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;CAChC;AACD;;;GAGG;AACH,MAAM,WAAW,wCAAwC;IACvD,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;CAClC;AACD;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;CAChC;AACD,MAAM,WAAW,iCAAiC;IAChD,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,gCAAgC;IAC/C,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;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB;AACD;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CACpC"}

package/dist/cjs/models/associate-role.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=associate-role.js.map

package/dist/cjs/models/associate-role.js.map

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

package/dist/cjs/models/attribute-group.d.ts

@@ -0,0 +1,253 @@
+/**
+ * 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 AttributeGroup extends BaseResource {
+    /**
+     *	Platform-generated unique identifier of the AttributeGroup.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the AttributeGroup.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the AttributeGroup was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the AttributeGroup 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;
+    /**
+     *	Name of the AttributeGroup.
+     *
+     *
+     */
+    readonly name: LocalizedString;
+    /**
+     *	Description of the AttributeGroup.
+     *
+     *
+     */
+    readonly description?: LocalizedString;
+    /**
+     *	[Attributes](ctp:api:type:AttributeDefinition) with unique values.
+     *
+     *
+     */
+    readonly attributes: AttributeReference[];
+    /**
+     *	User-defined unique identifier of the AttributeGroup.
+     *
+     *
+     */
+    readonly key?: string;
+}
+export interface AttributeGroupDraft {
+    /**
+     *	Name of the AttributeGroup.
+     *
+     *
+     */
+    readonly name: LocalizedString;
+    /**
+     *	Description of the AttributeGroup.
+     *
+     *
+     */
+    readonly description?: LocalizedString;
+    /**
+     *	[Attributes](ctp:api:type:AttributeDefinition) with unique values.
+     *
+     *
+     */
+    readonly attributes: AttributeReference[];
+    /**
+     *	User-defined unique identifier for the AttributeGroup.
+     *
+     *
+     */
+    readonly key?: string;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [AttributeGroup](ctp:api:type:AttributeGroup).
+ *
+ */
+export interface AttributeGroupPagedQueryResponse {
+    /**
+     *	Number of results requested in the query request.
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Offset supplied by the client or the server default.
+     *	It is the number of elements skipped, not a page number.
+     *
+     *
+     */
+    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;
+    /**
+     *	[AttributeGroups](ctp:api:type:AttributeGroup) matching the query.
+     *
+     *
+     */
+    readonly results: AttributeGroup[];
+}
+/**
+ *	[Reference](/../api/types#reference) to an [AttributeGroup](ctp:api:type:AttributeGroup).
+ *
+ */
+export interface AttributeGroupReference {
+    readonly typeId: 'attribute-group';
+    /**
+     *	Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded AttributeGroup. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for AttributeGroup.
+     *
+     *
+     */
+    readonly obj?: AttributeGroup;
+}
+/**
+ *	[ResourceIdentifier](/../api/types#resourceidentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup).
+ *
+ */
+export interface AttributeGroupResourceIdentifier {
+    readonly typeId: 'attribute-group';
+    /**
+     *	Platform-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly id?: string;
+    /**
+     *	User-generated unique identifier of the referenced [AttributeGroup](ctp:api:type:AttributeGroup). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly key?: string;
+}
+export interface AttributeGroupUpdate {
+    /**
+     *	Expected version of the AttributeGroup on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the AttributeGroup.
+     *
+     *
+     */
+    readonly actions: AttributeGroupUpdateAction[];
+}
+export type AttributeGroupUpdateAction = AttributeGroupAddAttributeAction | AttributeGroupChangeNameAction | AttributeGroupRemoveAttributeAction | AttributeGroupSetAttributesAction | AttributeGroupSetDescriptionAction | AttributeGroupSetKeyAction;
+export interface AttributeReference {
+    /**
+     *	The Attribute's `name` as given in its [AttributeDefinition](ctp:api:type:AttributeDefinition).
+     *
+     *
+     */
+    readonly key: string;
+}
+export interface AttributeGroupAddAttributeAction {
+    readonly action: 'addAttribute';
+    /**
+     *	Value to add.
+     *
+     *
+     */
+    readonly attribute: AttributeReference;
+}
+export interface AttributeGroupChangeNameAction {
+    readonly action: 'changeName';
+    /**
+     *	New value to set.
+     *	Must not be empty.
+     *
+     *
+     */
+    readonly name: LocalizedString;
+}
+export interface AttributeGroupRemoveAttributeAction {
+    readonly action: 'removeAttribute';
+    /**
+     *	Value to remove.
+     *
+     *
+     */
+    readonly attribute: AttributeReference;
+}
+export interface AttributeGroupSetAttributesAction {
+    readonly action: 'setAttributes';
+    /**
+     *	New unique values to set.
+     *
+     *
+     */
+    readonly attributes: AttributeReference[];
+}
+export interface AttributeGroupSetDescriptionAction {
+    readonly action: 'setDescription';
+    /**
+     *	Value to set.
+     *	If empty, any existing value will be removed.
+     *
+     *
+     */
+    readonly description?: LocalizedString;
+}
+export interface AttributeGroupSetKeyAction {
+    readonly action: 'setKey';
+    /**
+     *	If `key` is absent or `null`, the existing key, if any, will be removed.
+     *
+     *
+     */
+    readonly key?: string;
+}
+//# sourceMappingURL=attribute-group.d.ts.map

package/dist/cjs/models/attribute-group.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute-group.d.ts","sourceRoot":"","sources":["../../../src/lib/models/attribute-group.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAEtF,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD;;;;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,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,EAAE,CAAA;IACzC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,EAAE,CAAA;IACzC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;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,cAAc,EAAE,CAAA;CACnC;AACD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,cAAc,CAAA;CAC9B;AACD;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAA;CAC/C;AACD,MAAM,MAAM,0BAA0B,GAClC,gCAAgC,GAChC,8BAA8B,GAC9B,mCAAmC,GACnC,iCAAiC,GACjC,kCAAkC,GAClC,0BAA0B,CAAA;AAC9B,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAA;CACvC;AACD,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;CAC/B;AACD,MAAM,WAAW,mCAAmC;IAClD,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAA;CACvC;AACD,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,EAAE,CAAA;CAC1C;AACD,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;CACvC;AACD,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB"}

package/dist/cjs/models/attribute-group.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=attribute-group.js.map

package/dist/cjs/models/attribute-group.js.map

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