@commercetools/history-sdk 3.4.0 → 3.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -161,6 +161,31 @@ export interface AssetSource {
161
161
  */
162
162
  readonly contentType: string;
163
163
  }
164
+ export interface Associate {
165
+ /**
166
+ *
167
+ */
168
+ readonly associateRoleAssignments: AssociateRoleAssignment[];
169
+ /**
170
+ *
171
+ */
172
+ readonly customer: Reference;
173
+ }
174
+ export interface AssociateRoleAssignment {
175
+ /**
176
+ *
177
+ */
178
+ readonly associateRole: KeyReference;
179
+ /**
180
+ * Determines whether an [AssociateRoleAssignment](ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units.
181
+ *
182
+ */
183
+ readonly inheritance: AssociateRoleInheritanceMode;
184
+ }
185
+ /**
186
+ * Determines whether an [AssociateRoleAssignment](ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units.
187
+ */
188
+ export type AssociateRoleInheritanceMode = 'Disabled' | 'Enabled' | string;
164
189
  export type AttributeConstraintEnum = 'CombinationUnique' | 'None' | 'SameForAll' | 'Unique' | string;
165
190
  export interface AttributeDefinition {
166
191
  /**
@@ -206,6 +231,18 @@ export interface AttributeType {
206
231
  readonly name: string;
207
232
  }
208
233
  export type AuthenticationMode = 'ExternalAuth' | 'Password' | string;
234
+ /**
235
+ * Determines whether a Business Unit can inherit Associates from a parent.
236
+ */
237
+ export type BusinessUnitAssociateMode = 'Explicit' | 'ExplicitAndFromParent' | string;
238
+ /**
239
+ * Indicates whether the Business Unit can be edited and used in [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), or [Quotes](ctp:api:type:Quote).
240
+ */
241
+ export type BusinessUnitStatus = 'Active' | 'Inactive' | string;
242
+ /**
243
+ * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.
244
+ */
245
+ export type BusinessUnitStoreMode = 'Explicit' | 'FromParent' | string;
209
246
  export interface CategoryOrderHints {
210
247
  [key: string]: string;
211
248
  }
@@ -615,8 +652,19 @@ export interface ProductVariantChannelAvailability {
615
652
  export interface ProductVariantChannelAvailabilityMap {
616
653
  [key: string]: ProductVariantChannelAvailability;
617
654
  }
655
+ export interface ProductVariantSelection {
656
+ /**
657
+ *
658
+ */
659
+ readonly type: ProductVariantSelectionTypeEnum;
660
+ /**
661
+ *
662
+ */
663
+ readonly skus: string[];
664
+ }
665
+ export type ProductVariantSelectionTypeEnum = 'exclusion' | 'inclusion' | string;
618
666
  export type QuoteRequestState = 'Accepted' | 'Cancelled' | 'Closed' | 'Rejected' | 'Submitted' | string;
619
- export type QuoteState = 'Accepted' | 'Declined' | 'Failed' | 'Pending' | 'Withdrawn' | string;
667
+ export type QuoteState = 'Accepted' | 'Declined' | 'DeclinedForRenegotiation' | 'Failed' | 'Pending' | 'Withdrawn' | string;
620
668
  export interface Reference {
621
669
  /**
622
670
  *
@@ -627,7 +675,7 @@ export interface Reference {
627
675
  */
628
676
  readonly typeId: ReferenceTypeId;
629
677
  }
630
- export type ReferenceTypeId = 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-selection' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone' | string;
678
+ export type ReferenceTypeId = 'associate-role' | 'business-unit' | 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-selection' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone' | string;
631
679
  export interface Reservation {
632
680
  /**
633
681
  *
@@ -646,6 +694,20 @@ export interface Reservation {
646
694
  */
647
695
  readonly checkoutStartedAt: string;
648
696
  }
697
+ export interface ResourceIdentifier {
698
+ /**
699
+ *
700
+ */
701
+ readonly id: string;
702
+ /**
703
+ *
704
+ */
705
+ readonly key: string;
706
+ /**
707
+ *
708
+ */
709
+ readonly typeId: ReferenceTypeId;
710
+ }
649
711
  export interface ReturnInfo {
650
712
  /**
651
713
  *
@@ -861,10 +923,12 @@ export interface TaxedItemPrice {
861
923
  }
862
924
  export interface TaxedPrice {
863
925
  /**
926
+ * Total net price of the Order.
864
927
  *
865
928
  */
866
929
  readonly totalNet: Money;
867
930
  /**
931
+ * Total gross price of the Order.
868
932
  *
869
933
  */
870
934
  readonly totalGross: Money;
@@ -7,14 +7,31 @@ import { LocalizedString, Money, Reference } from './common';
7
7
  /**
8
8
  * Provides descriptive information specific to the resource.
9
9
  */
10
- export type Label = CustomObjectLabel | CustomerLabel | LocalizedLabel | OrderLabel | PaymentLabel | ProductLabel | QuoteLabel | QuoteRequestLabel | ReviewLabel | StagedQuoteLabel | StringLabel;
10
+ export type Label = BusinessUnitLabel | CustomObjectLabel | CustomerLabel | LocalizedLabel | OrderLabel | PaymentLabel | ProductLabel | QuoteLabel | QuoteRequestLabel | ReviewLabel | StagedQuoteLabel | StringLabel;
11
+ export interface BusinessUnitLabel {
12
+ readonly type: 'BusinessUnitLabel';
13
+ /**
14
+ * User-defined unique identifier of the [Business Unit](ctp:api:type:BusinessUnit).
15
+ *
16
+ */
17
+ readonly key: string;
18
+ /**
19
+ * Name of the Business Unit.
20
+ *
21
+ */
22
+ readonly name: string;
23
+ }
11
24
  export interface CustomObjectLabel {
12
25
  readonly type: 'CustomObjectLabel';
13
26
  /**
27
+ * User-defined unique identifier of the CustomObject within the defined `container`.
28
+ *
14
29
  *
15
30
  */
16
31
  readonly key: string;
17
32
  /**
33
+ * Namespace to group Custom Objects.
34
+ *
18
35
  *
19
36
  */
20
37
  readonly container: string;
@@ -22,14 +39,20 @@ export interface CustomObjectLabel {
22
39
  export interface CustomerLabel {
23
40
  readonly type: 'CustomerLabel';
24
41
  /**
42
+ * Given name (first name) of the Customer.
43
+ *
25
44
  *
26
45
  */
27
46
  readonly firstName: string;
28
47
  /**
48
+ * Family name (last name) of the Customer.
49
+ *
29
50
  *
30
51
  */
31
52
  readonly lastName: string;
32
53
  /**
54
+ * User-defined unique identifier of the [Customer](ctp:api:type:Customer).
55
+ *
33
56
  *
34
57
  */
35
58
  readonly customerNumber: string;
@@ -37,6 +60,8 @@ export interface CustomerLabel {
37
60
  export interface LocalizedLabel {
38
61
  readonly type: 'LocalizedLabel';
39
62
  /**
63
+ * Changed value.
64
+ *
40
65
  *
41
66
  */
42
67
  readonly value: LocalizedString;
@@ -44,10 +69,14 @@ export interface LocalizedLabel {
44
69
  export interface OrderLabel {
45
70
  readonly type: 'OrderLabel';
46
71
  /**
72
+ * Email address of the Customer that the Order belongs to.
73
+ *
47
74
  *
48
75
  */
49
76
  readonly customerEmail: string;
50
77
  /**
78
+ * User-defined unique identifier of the Order that is unique across a Project.
79
+ *
51
80
  *
52
81
  */
53
82
  readonly orderNumber: string;
@@ -55,10 +84,14 @@ export interface OrderLabel {
55
84
  export interface PaymentLabel {
56
85
  readonly type: 'PaymentLabel';
57
86
  /**
87
+ * User-defined unique identifier of the Payment.
88
+ *
58
89
  *
59
90
  */
60
91
  readonly key: string;
61
92
  /**
93
+ * Money value the Payment intends to receive from the Customer.
94
+ *
62
95
  *
63
96
  */
64
97
  readonly amountPlanned: Money;
@@ -66,10 +99,14 @@ export interface PaymentLabel {
66
99
  export interface ProductLabel {
67
100
  readonly type: 'ProductLabel';
68
101
  /**
102
+ * User-defined identifier used in a deep-link URL for the Product.
103
+ *
69
104
  *
70
105
  */
71
106
  readonly slug: LocalizedString;
72
107
  /**
108
+ * Name of the Product.
109
+ *
73
110
  *
74
111
  */
75
112
  readonly name: LocalizedString;
@@ -77,18 +114,26 @@ export interface ProductLabel {
77
114
  export interface QuoteLabel {
78
115
  readonly type: 'QuoteLabel';
79
116
  /**
117
+ * User-defined unique identifier of the Quote.
118
+ *
80
119
  *
81
120
  */
82
121
  readonly key: string;
83
122
  /**
123
+ * The [Buyer](/../api/quotes-overview#buyer) who requested the Quote.
124
+ *
84
125
  *
85
126
  */
86
127
  readonly customer: Reference;
87
128
  /**
129
+ * Staged Quote related to the Quote.
130
+ *
88
131
  *
89
132
  */
90
133
  readonly stagedQuote: Reference;
91
134
  /**
135
+ * Quote Request related to the Quote.
136
+ *
92
137
  *
93
138
  */
94
139
  readonly quoteRequest: Reference;
@@ -96,10 +141,14 @@ export interface QuoteLabel {
96
141
  export interface QuoteRequestLabel {
97
142
  readonly type: 'QuoteRequestLabel';
98
143
  /**
144
+ * User-defined unique identifier of the Quote Request.
145
+ *
99
146
  *
100
147
  */
101
148
  readonly key: string;
102
149
  /**
150
+ * The [Buyer](/../api/quotes-overview#buyer) who raised the Quote Request.
151
+ *
103
152
  *
104
153
  */
105
154
  readonly customer: Reference;
@@ -107,10 +156,14 @@ export interface QuoteRequestLabel {
107
156
  export interface ReviewLabel {
108
157
  readonly type: 'ReviewLabel';
109
158
  /**
159
+ * User-defined unique identifier of the Review.
160
+ *
110
161
  *
111
162
  */
112
163
  readonly key: string;
113
164
  /**
165
+ * Title of the Review.
166
+ *
114
167
  *
115
168
  */
116
169
  readonly title: string;
@@ -118,14 +171,20 @@ export interface ReviewLabel {
118
171
  export interface StagedQuoteLabel {
119
172
  readonly type: 'StagedQuoteLabel';
120
173
  /**
174
+ * User-defined unique identifier of the Staged Quote.
175
+ *
121
176
  *
122
177
  */
123
178
  readonly key: string;
124
179
  /**
180
+ * The [Buyer](/../api/quotes-overview#buyer) who requested the Quote.
181
+ *
125
182
  *
126
183
  */
127
184
  readonly customer: Reference;
128
185
  /**
186
+ * Quote Request related to the Staged Quote.
187
+ *
129
188
  *
130
189
  */
131
190
  readonly quoteRequest: Reference;
@@ -133,6 +192,8 @@ export interface StagedQuoteLabel {
133
192
  export interface StringLabel {
134
193
  readonly type: 'StringLabel';
135
194
  /**
195
+ * Changed value.
196
+ *
136
197
  *
137
198
  */
138
199
  readonly value: string;
@@ -4,5 +4,4 @@
4
4
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
5
  */
6
6
  import { ClientRequest } from './common-types';
7
- export declare function stringifyURLString(object: string | Record<string, any> | Array<Array<string>>, stringifier?: (object: string | Record<string, any> | Array<Array<string>> | URLSearchParams) => string): string;
8
7
  export declare function buildRelativeUri(commonRequest: ClientRequest): string;
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "name": "@commercetools/history-sdk",
7
- "version": "3.4.0",
7
+ "version": "3.4.2",
8
8
  "engines": {
9
9
  "node": ">=14"
10
10
  },
@@ -38,7 +38,7 @@
38
38
  "@commercetools/sdk-middleware-logger": "^3.0.0"
39
39
  },
40
40
  "devDependencies": {
41
- "@commercetools/platform-sdk": "4.9.0",
41
+ "@commercetools/platform-sdk": "4.10.1",
42
42
  "@types/uuid": "9.0.1",
43
43
  "organize-imports-cli": "0.10.0",
44
44
  "tsconfig-replace-paths": "0.0.13",