@commercetools/history-sdk 3.1.0 → 3.2.0
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.
- package/CHANGELOG.md +59 -0
- package/dist/commercetools-history-sdk.browser.cjs.js +19 -46
- package/dist/commercetools-history-sdk.browser.esm.js +19 -46
- package/dist/commercetools-history-sdk.cjs.dev.js +19 -46
- package/dist/commercetools-history-sdk.cjs.prod.js +19 -46
- package/dist/commercetools-history-sdk.esm.js +19 -46
- package/dist/declarations/src/generated/models/change-history.d.ts +5 -5
- package/dist/declarations/src/generated/models/change-value.d.ts +2 -2
- package/dist/declarations/src/generated/models/change.d.ts +1 -1
- package/dist/declarations/src/generated/models/common.d.ts +28 -28
- package/dist/declarations/src/generated/models/label.d.ts +1 -1
- package/dist/declarations/src/generated/shared/utils/common-types.d.ts +5 -5
- package/dist/declarations/src/generated/shared/utils/middleware.d.ts +1 -1
- package/package.json +4 -4
|
@@ -11,7 +11,6 @@ function _defineProperty(obj, key, value) {
|
|
|
11
11
|
} else {
|
|
12
12
|
obj[key] = value;
|
|
13
13
|
}
|
|
14
|
-
|
|
15
14
|
return obj;
|
|
16
15
|
}
|
|
17
16
|
|
|
@@ -20,56 +19,45 @@ function _defineProperty(obj, key, value) {
|
|
|
20
19
|
* Please don't change this file manually but run `rmf-codegen generate <raml_file_path> -o <output_path> -t typescript_client` to update it.
|
|
21
20
|
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
22
21
|
*/
|
|
23
|
-
|
|
24
22
|
function isDefined(value) {
|
|
25
23
|
return typeof value !== 'undefined' && value !== null;
|
|
26
24
|
}
|
|
27
|
-
|
|
28
25
|
function cleanObject(obj) {
|
|
29
26
|
return Object.keys(obj).reduce((result, key) => {
|
|
30
27
|
const value = obj[key];
|
|
31
|
-
|
|
32
28
|
if (Array.isArray(value)) {
|
|
33
29
|
const values = value.filter(isDefined);
|
|
34
|
-
|
|
35
30
|
if (!values.length) {
|
|
36
31
|
return result;
|
|
37
32
|
}
|
|
38
|
-
|
|
39
|
-
|
|
33
|
+
return {
|
|
34
|
+
...result,
|
|
40
35
|
[key]: values
|
|
41
36
|
};
|
|
42
37
|
}
|
|
43
|
-
|
|
44
38
|
if (isDefined(value)) {
|
|
45
|
-
return {
|
|
39
|
+
return {
|
|
40
|
+
...result,
|
|
46
41
|
[key]: value
|
|
47
42
|
};
|
|
48
43
|
}
|
|
49
|
-
|
|
50
44
|
return result;
|
|
51
45
|
}, {});
|
|
52
46
|
}
|
|
53
|
-
|
|
54
47
|
function formatQueryString(variableMap) {
|
|
55
48
|
const map = cleanObject(variableMap);
|
|
56
49
|
const result = stringify(map);
|
|
57
|
-
|
|
58
50
|
if (result === '') {
|
|
59
51
|
return '';
|
|
60
52
|
}
|
|
61
|
-
|
|
62
53
|
return `?${result}`;
|
|
63
54
|
}
|
|
64
|
-
|
|
65
55
|
function buildRelativeUri(commonRequest) {
|
|
66
56
|
const pathMap = commonRequest.pathVariables;
|
|
67
57
|
var uri = commonRequest.uriTemplate;
|
|
68
|
-
|
|
69
58
|
for (const param in pathMap) {
|
|
70
59
|
uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
|
|
71
60
|
}
|
|
72
|
-
|
|
73
61
|
const resQuery = formatQueryString(commonRequest.queryParams || {});
|
|
74
62
|
return `${uri}${resQuery}`;
|
|
75
63
|
}
|
|
@@ -77,22 +65,18 @@ function buildRelativeUri(commonRequest) {
|
|
|
77
65
|
class ApiRequest {
|
|
78
66
|
constructor(request, requestExecutor) {
|
|
79
67
|
this.requestExecutor = requestExecutor;
|
|
80
|
-
|
|
81
68
|
_defineProperty(this, "request", void 0);
|
|
82
|
-
|
|
83
|
-
|
|
69
|
+
this.request = {
|
|
70
|
+
...request,
|
|
84
71
|
uri: buildRelativeUri(request)
|
|
85
72
|
};
|
|
86
73
|
}
|
|
87
|
-
|
|
88
74
|
clientRequest() {
|
|
89
75
|
return this.request;
|
|
90
76
|
}
|
|
91
|
-
|
|
92
77
|
execute() {
|
|
93
78
|
return this.requestExecutor(this.request);
|
|
94
79
|
}
|
|
95
|
-
|
|
96
80
|
}
|
|
97
81
|
|
|
98
82
|
/**
|
|
@@ -102,24 +86,22 @@ class ApiRequest {
|
|
|
102
86
|
*/
|
|
103
87
|
/**
|
|
104
88
|
**/
|
|
105
|
-
|
|
106
89
|
class ByProjectKeyByResourceTypeByIDRequestBuilder {
|
|
107
90
|
constructor(args) {
|
|
108
91
|
this.args = args;
|
|
109
92
|
}
|
|
110
|
-
|
|
111
93
|
get(methodArgs) {
|
|
112
94
|
return new ApiRequest({
|
|
113
95
|
baseUri: this.args.baseUri,
|
|
114
96
|
method: 'GET',
|
|
115
97
|
uriTemplate: '/{projectKey}/{resourceType}/{ID}',
|
|
116
98
|
pathVariables: this.args.pathArgs,
|
|
117
|
-
headers: {
|
|
99
|
+
headers: {
|
|
100
|
+
...(methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers)
|
|
118
101
|
},
|
|
119
102
|
queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
|
|
120
103
|
}, this.args.executeRequest);
|
|
121
104
|
}
|
|
122
|
-
|
|
123
105
|
}
|
|
124
106
|
|
|
125
107
|
/**
|
|
@@ -129,34 +111,32 @@ class ByProjectKeyByResourceTypeByIDRequestBuilder {
|
|
|
129
111
|
*/
|
|
130
112
|
/**
|
|
131
113
|
**/
|
|
132
|
-
|
|
133
114
|
class ByProjectKeyByResourceTypeRequestBuilder {
|
|
134
115
|
constructor(args) {
|
|
135
116
|
this.args = args;
|
|
136
117
|
}
|
|
137
|
-
|
|
138
118
|
withIDValue(childPathArgs) {
|
|
139
119
|
return new ByProjectKeyByResourceTypeByIDRequestBuilder({
|
|
140
|
-
pathArgs: {
|
|
120
|
+
pathArgs: {
|
|
121
|
+
...this.args.pathArgs,
|
|
141
122
|
...childPathArgs
|
|
142
123
|
},
|
|
143
124
|
executeRequest: this.args.executeRequest,
|
|
144
125
|
baseUri: this.args.baseUri
|
|
145
126
|
});
|
|
146
127
|
}
|
|
147
|
-
|
|
148
128
|
get(methodArgs) {
|
|
149
129
|
return new ApiRequest({
|
|
150
130
|
baseUri: this.args.baseUri,
|
|
151
131
|
method: 'GET',
|
|
152
132
|
uriTemplate: '/{projectKey}/{resourceType}',
|
|
153
133
|
pathVariables: this.args.pathArgs,
|
|
154
|
-
headers: {
|
|
134
|
+
headers: {
|
|
135
|
+
...(methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers)
|
|
155
136
|
},
|
|
156
137
|
queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
|
|
157
138
|
}, this.args.executeRequest);
|
|
158
139
|
}
|
|
159
|
-
|
|
160
140
|
}
|
|
161
141
|
|
|
162
142
|
/**
|
|
@@ -166,55 +146,50 @@ class ByProjectKeyByResourceTypeRequestBuilder {
|
|
|
166
146
|
*/
|
|
167
147
|
/**
|
|
168
148
|
**/
|
|
169
|
-
|
|
170
149
|
class ByProjectKeyRequestBuilder {
|
|
171
150
|
constructor(args) {
|
|
172
151
|
this.args = args;
|
|
173
152
|
}
|
|
174
|
-
|
|
175
153
|
withResourceTypeValue(childPathArgs) {
|
|
176
154
|
return new ByProjectKeyByResourceTypeRequestBuilder({
|
|
177
|
-
pathArgs: {
|
|
155
|
+
pathArgs: {
|
|
156
|
+
...this.args.pathArgs,
|
|
178
157
|
...childPathArgs
|
|
179
158
|
},
|
|
180
159
|
executeRequest: this.args.executeRequest,
|
|
181
160
|
baseUri: this.args.baseUri
|
|
182
161
|
});
|
|
183
162
|
}
|
|
184
|
-
|
|
185
163
|
get(methodArgs) {
|
|
186
164
|
return new ApiRequest({
|
|
187
165
|
baseUri: this.args.baseUri,
|
|
188
166
|
method: 'GET',
|
|
189
167
|
uriTemplate: '/{projectKey}',
|
|
190
168
|
pathVariables: this.args.pathArgs,
|
|
191
|
-
headers: {
|
|
169
|
+
headers: {
|
|
170
|
+
...(methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.headers)
|
|
192
171
|
},
|
|
193
172
|
queryParams: methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.queryArgs
|
|
194
173
|
}, this.args.executeRequest);
|
|
195
174
|
}
|
|
196
|
-
|
|
197
175
|
}
|
|
198
176
|
|
|
199
177
|
class ApiRoot {
|
|
200
178
|
constructor(args) {
|
|
201
179
|
_defineProperty(this, "executeRequest", void 0);
|
|
202
|
-
|
|
203
180
|
_defineProperty(this, "baseUri", void 0);
|
|
204
|
-
|
|
205
181
|
this.executeRequest = args.executeRequest;
|
|
206
182
|
this.baseUri = args.baseUri || 'https://history.europe-west1.gcp.commercetools.com';
|
|
207
183
|
}
|
|
208
|
-
|
|
209
184
|
withProjectKeyValue(childPathArgs) {
|
|
210
185
|
return new ByProjectKeyRequestBuilder({
|
|
211
|
-
pathArgs: {
|
|
186
|
+
pathArgs: {
|
|
187
|
+
...childPathArgs
|
|
212
188
|
},
|
|
213
189
|
executeRequest: this.executeRequest,
|
|
214
190
|
baseUri: this.baseUri
|
|
215
191
|
});
|
|
216
192
|
}
|
|
217
|
-
|
|
218
193
|
}
|
|
219
194
|
|
|
220
195
|
/**
|
|
@@ -222,19 +197,17 @@ class ApiRoot {
|
|
|
222
197
|
* Please don't change this file manually but run `rmf-codegen generate <raml_file_path> -o <output_path> -t typescript_client` to update it.
|
|
223
198
|
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
224
199
|
*/
|
|
200
|
+
|
|
225
201
|
const createExecutorFromMiddlewares = (executor, midds) => {
|
|
226
202
|
if (!midds || midds.length == 0) {
|
|
227
203
|
return executor;
|
|
228
204
|
}
|
|
229
|
-
|
|
230
205
|
const reduced = midds.reduce(reduceMiddleware);
|
|
231
206
|
return middlewareToExecutor(reduced, executor);
|
|
232
207
|
};
|
|
233
|
-
|
|
234
208
|
function reduceMiddleware(middleware1, middleware2) {
|
|
235
209
|
return (request, executor) => middleware1(request, middlewareToExecutor(middleware2, executor));
|
|
236
210
|
}
|
|
237
|
-
|
|
238
211
|
function middlewareToExecutor(middleware, executor) {
|
|
239
212
|
return request => middleware(request, executor);
|
|
240
213
|
}
|
|
@@ -114,12 +114,12 @@ export interface RecordPagedQueryResponse {
|
|
|
114
114
|
* The value must be one of the following:
|
|
115
115
|
*
|
|
116
116
|
*/
|
|
117
|
-
export
|
|
117
|
+
export type ChangeHistoryResourceType = 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'key-value-document' | 'order' | 'payment' | 'product' | 'product-discount' | 'product-selection' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shopping-list' | 'staged-quote' | 'state' | 'store' | 'tax-category' | 'type' | 'zone' | string;
|
|
118
118
|
/**
|
|
119
119
|
* This type consists of one enum value:
|
|
120
120
|
*
|
|
121
121
|
*/
|
|
122
|
-
export
|
|
122
|
+
export type DateStringFilter = 'now' | string;
|
|
123
123
|
export interface ErrorObject {
|
|
124
124
|
/**
|
|
125
125
|
*
|
|
@@ -203,9 +203,9 @@ export interface ModifiedBy {
|
|
|
203
203
|
*/
|
|
204
204
|
readonly isPlatformClient: boolean;
|
|
205
205
|
}
|
|
206
|
-
export
|
|
206
|
+
export type PlatformInitiatedChange = 'changeLineItemName' | 'changeReviewRatingStatistics' | 'excludeAll' | 'setApplicationVersion' | 'setIsValid' | 'setVariantAvailability' | string;
|
|
207
207
|
/**
|
|
208
208
|
* Values for the Source enumeration.
|
|
209
209
|
*/
|
|
210
|
-
export
|
|
211
|
-
export
|
|
210
|
+
export type Source = 'ApiClient' | 'ImpEx' | 'MerchantCenter' | string;
|
|
211
|
+
export type UpdateType = 'addAddress' | 'addAsset' | 'addAttributeDefinition' | 'addBillingAddressId' | 'addDelivery' | 'addEnumValue' | 'addExternalImage' | 'addFieldDefinition' | 'addInterfaceInteraction' | 'addItemShippingAddress' | 'addLineItem' | 'addLocalizedEnumValue' | 'addLocation' | 'addParcelToDelivery' | 'addPayment' | 'addPlainEnumValue' | 'addPrice' | 'addReturnInfo' | 'addRoles' | 'addShippingAddressId' | 'addTaxRate' | 'addTextLineItem' | 'addToCategory' | 'addTransaction' | 'addVariant' | 'changeAddress' | 'changeAmountPlanned' | 'changeAssetName' | 'changeAssetOrder' | 'changeAttributeConstraint' | 'changeAttributeName' | 'changeAttributeOrderByName' | 'changeCartDiscounts' | 'changeCartPredicate' | 'changeDescription' | 'changeEmail' | 'changeEnumKey' | 'changeEnumValueLabel' | 'changeEnumValueOrder' | 'changeFieldDefinitionOrder' | 'changeGroups' | 'changeInitial' | 'changeInputHint' | 'changeIsActive' | 'changeIsSearchable' | 'changeKey' | 'changeLabel' | 'changeLineItemQuantity' | 'changeLineItemsOrder' | 'changeLocalizedEnumValueLabel' | 'changeLocalizedEnumValueOrder' | 'changeMasterVariant' | 'changeName' | 'changeOrderHint' | 'changeOrderState' | 'changeParent' | 'changePaymentState' | 'changePlainEnumValueLabel' | 'changePredicate' | 'changePrice' | 'changeQuantity' | 'changeRequiresDiscountCode' | 'changeReviewRatingStatistics' | 'changeShipmentState' | 'changeSlug' | 'changeSortOrder' | 'changeStackingMode' | 'changeTarget' | 'changeTextLineItemName' | 'changeTextLineItemQuantity' | 'changeTextLineItemsOrder' | 'changeTransactionInteractionId' | 'changeTransactionState' | 'changeTransactionTimestamp' | 'changeType' | 'changeValue' | 'publish' | 'removeAddress' | 'removeAsset' | 'removeAttributeDefinition' | 'removeBillingAddressId' | 'removeDelivery' | 'removeEnumValues' | 'removeFieldDefinition' | 'removeFromCategory' | 'removeImage' | 'removeItemShippingAddress' | 'removeLineItem' | 'removeLocation' | 'removeParcelFromDelivery' | 'removePayment' | 'removePrice' | 'removeRoles' | 'removeShippingAddressId' | 'removeTaxRate' | 'removeTextLineItem' | 'removeVariant' | 'setAddress' | 'setAnonymousId' | 'setAssetCustomField' | 'setAssetCustomType' | 'setAssetDescription' | 'setAssetSources' | 'setAssetTags' | 'setAsssetKey' | 'setAttribute' | 'setAuthorName' | 'setBillingAddress' | 'setCartPredicate' | 'setCategoryOrderHint' | 'setCompanyName' | 'setCustomField' | 'setCustomLineItemCustomField' | 'setCustomLineItemCustomType' | 'setCustomLineItemShippingDetails' | 'setCustomType' | 'setCustomer' | 'setCustomerEmail' | 'setCustomerGroup' | 'setCustomerId' | 'setCustomerNumber' | 'setDateOfBirth' | 'setDefaultBillingAddress' | 'setDefaultShippingAddress' | 'setDeleteDaysAfterLastModification' | 'setDeliveryAddress' | 'setDeliveryItems' | 'setDescription' | 'setDiscountedPrice' | 'setDistributionChannels' | 'setExpectedDelivery' | 'setExternalId' | 'setFirstName' | 'setGeoLocation' | 'setImageLabel' | 'setInputTip' | 'setInterfaceId' | 'setKey' | 'setLanguages' | 'setLastName' | 'setLineItemCustomField' | 'setLineItemCustomType' | 'setLineItemShippingDetails' | 'setLocale' | 'setMaxApplications' | 'setMaxApplicationsPerCustomer' | 'setMetaDescription' | 'setMetaKeywords' | 'setMetaTitle' | 'setMethodInfoInterface' | 'setMethodInfoMethod' | 'setMethodInfoName' | 'setMiddleName' | 'setName' | 'setOrderNumber' | 'setParcelItems' | 'setParcelMeasurements' | 'setParcelTrackingData' | 'setPassword' | 'setProductPriceCustomField' | 'setProductPriceCustomType' | 'setProductVariantKey' | 'setRating' | 'setRestockableInDays' | 'setReturnPaymentState' | 'setReturnShipmentState' | 'setRoles' | 'setSalutation' | 'setSearchKeywords' | 'setShippingAddress' | 'setSku' | 'setSlug' | 'setStatusInterfaceCode' | 'setStatusInterfaceText' | 'setStore' | 'setStores' | 'setSupplyChannel' | 'setTarget' | 'setTaxCategory' | 'setText' | 'setTextLineItemCustomField' | 'setTextLineItemCustomType' | 'setTextLineItemDescription' | 'setTitle' | 'setTransitions' | 'setValidFrom' | 'setValidFromAndUntil' | 'setValidUntil' | 'setVariantAvailability' | 'setVatId' | 'transitionCustomLineItemState' | 'transitionLineItemState' | 'transitionState' | 'unpublish' | 'updateItemShippingAddress' | 'updateSyncInfo' | 'verifyEmail' | string;
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
5
5
|
*/
|
|
6
6
|
import { Address, DeliveryItem, LocalizedString, Money, Parcel, Reference, SelectionMode, TaxedPrice, TaxRate } from './common';
|
|
7
|
-
export
|
|
8
|
-
export
|
|
7
|
+
export type ChangeTargetChangeValue = ChangeTargetCustomLineItemsChangeValue | ChangeTargetLineItemsChangeValue | ChangeTargetMultiBuyCustomLineItemsChangeValue | ChangeTargetMultiBuyLineItemsChangeValue | ChangeTargetShippingChangeValue;
|
|
8
|
+
export type ChangeValueChangeValue = ChangeValueAbsoluteChangeValue | ChangeValueExternalChangeValue | ChangeValueGiftLineItemChangeValue | ChangeValueRelativeChangeValue;
|
|
9
9
|
export interface AssetChangeValue {
|
|
10
10
|
/**
|
|
11
11
|
*
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { AssetChangeValue, AttributeValue, ChangeTargetChangeValue, ChangeValueChangeValue, CustomFieldExpandedValue, CustomShippingMethodChangeValue, DeliveryChangeValue, EnumValue, FieldDefinitionOrderValue, InventoryQuantityValue, LocalizedEnumValue, ParcelChangeValue, SetCartClassificationShippingRateInputValue, SetCartScoreShippingRateInputValue, ShippingMethodChangeValue, ShippingMethodTaxAmountChangeValue, ShoppingListLineItemValue, TextLineItemValue, TransactionChangeValue, ValidFromAndUntilValue } from './change-value';
|
|
7
7
|
import { Address, Asset, AssetSource, AttributeConstraintEnum, AttributeDefinition, AuthenticationMode, CategoryOrderHints, ChannelRole, CustomFields, CustomLineItem, Delivery, DeliveryItem, DiscountCodeInfo, DiscountedLineItemPrice, DiscountedLineItemPriceForQuantity, FieldDefinition, GeoLocation, Image, ItemShippingDetails, ItemState, LineItem, LocalizedString, Location, Money, OrderState, Parcel, ParcelMeasurements, PaymentInfo, PaymentState, Price, ProductSelectionSetting, ProductVariantAvailability, QuoteRequestState, QuoteState, Reference, Reservation, ReturnInfo, ReturnPaymentState, ReturnShipmentState, ReviewRatingStatistics, RoundingMode, SearchKeywords, ShipmentState, StackingMode, StagedQuoteState, StateRole, StateType, SyncInfo, TaxCalculationMode, TaxedItemPrice, TaxedPrice, TaxMode, TaxRate, TextInputHint, TextLineItem, TrackingData, Transaction, TransactionState, Variant } from './common';
|
|
8
|
-
export
|
|
8
|
+
export type Change = AddAddressChange | AddAssetChange | AddAttributeDefinitionChange | AddBillingAddressIdChange | AddChannelRolesChange | AddCustomLineItemChange | AddDeliveryChange | AddDiscountCodeChange | AddEnumValueChange | AddExternalImageChange | AddFieldDefinitionChange | AddInterfaceInteractionChange | AddItemShippingAddressesChange | AddLocalizedEnumValueChange | AddLocationChange | AddOrderLineItemChange | AddParcelToDeliveryChange | AddPaymentChange | AddPlainEnumValueChange | AddPriceChange | AddProductChange | AddPropertyChange | AddReturnInfoChange | AddShippingAddressIdChange | AddShoppingListLineItemChange | AddStateRolesChange | AddTaxRateChange | AddTextLineItemChange | AddToCategoryChange | AddTransactionChange | AddVariantChange | ChangeAddressChange | ChangeAmountAuthorizedChange | ChangeAmountPlannedChange | ChangeAssetNameChange | ChangeAssetOrderChange | ChangeAttributeConstraintChange | ChangeAttributeOrderByNameChange | ChangeCartDiscountsChange | ChangeCartPredicateChange | ChangeCustomLineItemQuantityChange | ChangeDescriptionChange | ChangeEmailChange | ChangeEnumValueLabelChange | ChangeEnumValueOrderChange | ChangeFieldDefinitionOrderChange | ChangeGroupsChange | ChangeInitialChange | ChangeInputHintChange | ChangeIsActiveChange | ChangeIsSearchableChange | ChangeKeyChange | ChangeLabelChange | ChangeLineItemQuantityChange | ChangeLocalizedDescriptionChange | ChangeLocalizedEnumValueLabelChange | ChangeLocalizedEnumValueOrderChange | ChangeLocalizedNameChange | ChangeMasterVariantChange | ChangeNameChange | ChangeOrderHintChange | ChangeOrderStateChange | ChangeParentChange | ChangePaymentStateChange | ChangePlainEnumValueLabelChange | ChangePlainEnumValueOrderChange | ChangePredicateChange | ChangePriceChange | ChangeQuantityChange | ChangeQuoteRequestStateChange | ChangeQuoteStateChange | ChangeRequiresDiscountCodeChange | ChangeReviewRatingStatisticsChange | ChangeShipmentStateChange | ChangeShoppingListLineItemQuantityChange | ChangeShoppingListLineItemsOrderChange | ChangeSlugChange | ChangeSortOrderChange | ChangeStackingModeChange | ChangeStagedQuoteStateChange | ChangeStateTypeChange | ChangeTargetChange | ChangeTaxCalculationModeChange | ChangeTaxModeChange | ChangeTaxRoundingModeChange | ChangeTextLineItemNameChange | ChangeTextLineItemQuantityChange | ChangeTextLineItemsOrderChange | ChangeTransactionInteractionIdChange | ChangeTransactionStateChange | ChangeTransactionTimestampChange | ChangeValueChange | MoveImageToPositionChange | PublishChange | RemoveAddressChange | RemoveAssetChange | RemoveAttributeDefinitionChange | RemoveBillingAddressIdChange | RemoveChannelRolesChange | RemoveCustomLineItemChange | RemoveDeliveryItemsChange | RemoveDiscountCodeChange | RemoveEnumValuesChange | RemoveFieldDefinitionChange | RemoveFromCategoryChange | RemoveImageChange | RemoveItemShippingAddressesChange | RemoveLocalizedEnumValuesChange | RemoveLocationChange | RemoveOrderLineItemChange | RemoveParcelFromDeliveryChange | RemovePaymentChange | RemovePriceChange | RemoveProductChange | RemovePropertyChange | RemoveShippingAddressIdChange | RemoveShoppingListLineItemChange | RemoveStateRolesChange | RemoveTaxRateChange | RemoveTextLineItemChange | RemoveVariantChange | SetAddressChange | SetAnonymousIdChange | SetApplicationVersionChange | SetAssetCustomFieldChange | SetAssetCustomTypeChange | SetAssetDescriptionChange | SetAssetKeyChange | SetAssetSourcesChange | SetAssetTagsChange | SetAttributeChange | SetAuthenticationModeChange | SetAuthorNameChange | SetBillingAddressChange | SetCartPredicateChange | SetCategoryOrderHintChange | SetChannelRolesChange | SetCompanyNameChange | SetCountryChange | SetCustomFieldChange | SetCustomLineItemCustomFieldChange | SetCustomLineItemCustomTypeChange | SetCustomLineItemMoneyChange | SetCustomLineItemShippingDetailsChange | SetCustomLineItemTaxAmountChange | SetCustomLineItemTaxCategoryChange | SetCustomLineItemTaxRateChange | SetCustomLineItemTaxedPriceChange | SetCustomLineItemTotalPriceChange | SetCustomShippingMethodChange | SetCustomTypeChange | SetCustomerChange | SetCustomerEmailChange | SetCustomerGroupChange | SetCustomerIdChange | SetCustomerNumberChange | SetDateOfBirthChange | SetDefaultBillingAddressChange | SetDefaultShippingAddressChange | SetDeleteDaysAfterLastModificationChange | SetDeliveryAddressChange | SetDeliveryItemsChange | SetDescriptionChange | SetDiscountedPriceChange | SetDistributionChannelsChange | SetExpectedDeliveryChange | SetExternalIdChange | SetFirstNameChange | SetGeoLocationChange | SetImageLabelChange | SetInputTipChange | SetInterfaceIdChange | SetIsValidChange | SetKeyChange | SetLanguagesChange | SetLastNameChange | SetLineItemDeactivatedAtChange | SetLineItemDiscountedPriceChange | SetLineItemDiscountedPricePerQuantityChange | SetLineItemDistributionChannelChange | SetLineItemPriceChange | SetLineItemProductKeyChange | SetLineItemProductSlugChange | SetLineItemShippingDetailsChange | SetLineItemTaxAmountChange | SetLineItemTaxRateChange | SetLineItemTaxedPriceChange | SetLineItemTotalPriceChange | SetLocaleChange | SetLocalizedDescriptionChange | SetMaxApplicationsChange | SetMaxApplicationsPerCustomerChange | SetMetaDescriptionChange | SetMetaKeywordsChange | SetMetaTitleChange | SetMethodInfoInterfaceChange | SetMethodInfoMethodChange | SetMethodInfoNameChange | SetMiddleNameChange | SetNameChange | SetOrderLineItemCustomFieldChange | SetOrderLineItemCustomTypeChange | SetOrderNumberChange | SetOrderTaxedPriceChange | SetOrderTotalPriceChange | SetOrderTotalTaxChange | SetParcelItemsChange | SetParcelMeasurementsChange | SetParcelTrackingDataChange | SetPricesChange | SetProductCountChange | SetProductPriceCustomFieldChange | SetProductPriceCustomTypeChange | SetProductSelectionsChange | SetProductVariantKeyChange | SetPropertyChange | SetRatingChange | SetReservationsChange | SetRestockableInDaysChange | SetReturnPaymentStateChange | SetReturnShipmentStateChange | SetSalutationChange | SetSearchKeywordsChange | SetSellerCommentChange | SetShippingAddressChange | SetShippingInfoPriceChange | SetShippingInfoTaxedPriceChange | SetShippingMethodChange | SetShippingMethodTaxAmountChange | SetShippingMethodTaxRateChange | SetShippingRateChange | SetShippingRateInputChange | SetShoppingListLineItemCustomFieldChange | SetShoppingListLineItemCustomTypeChange | SetSkuChange | SetSlugChange | SetStateRolesChange | SetStatusInterfaceCodeChange | SetStatusInterfaceTextChange | SetStoreChange | SetStoresChange | SetSupplyChannelChange | SetSupplyChannelsChange | SetTargetChange | SetTaxCategoryChange | SetTextChange | SetTextLineItemCustomFieldChange | SetTextLineItemCustomTypeChange | SetTextLineItemDescriptionChange | SetTitleChange | SetTransitionsChange | SetValidFromAndUntilChange | SetValidFromChange | SetValidToChange | SetValidUntilChange | SetValueChange | SetVariantAvailabilityChange | SetVatIdChange | TransitionCustomLineItemStateChange | TransitionLineItemStateChange | TransitionStateChange | UnknownChange | UnpublishChange | UpdateSyncInfoChange | VerifyEmailChange;
|
|
9
9
|
export interface AddAddressChange {
|
|
10
10
|
readonly type: 'AddAddressChange';
|
|
11
11
|
/**
|
|
@@ -161,7 +161,7 @@ export interface AssetSource {
|
|
|
161
161
|
*/
|
|
162
162
|
readonly contentType: string;
|
|
163
163
|
}
|
|
164
|
-
export
|
|
164
|
+
export type AttributeConstraintEnum = 'CombinationUnique' | 'None' | 'SameForAll' | 'Unique' | string;
|
|
165
165
|
export interface AttributeDefinition {
|
|
166
166
|
/**
|
|
167
167
|
*
|
|
@@ -205,11 +205,11 @@ export interface AttributeType {
|
|
|
205
205
|
*/
|
|
206
206
|
readonly name: string;
|
|
207
207
|
}
|
|
208
|
-
export
|
|
208
|
+
export type AuthenticationMode = 'ExternalAuth' | 'Password' | string;
|
|
209
209
|
export interface CategoryOrderHints {
|
|
210
210
|
[key: string]: string;
|
|
211
211
|
}
|
|
212
|
-
export
|
|
212
|
+
export type ChannelRole = 'InventorySupply' | 'OrderExport' | 'OrderImport' | 'Primary' | 'ProductDistribution' | string;
|
|
213
213
|
export interface CustomFields {
|
|
214
214
|
/**
|
|
215
215
|
*
|
|
@@ -301,7 +301,7 @@ export interface DiscountCodeInfo {
|
|
|
301
301
|
*/
|
|
302
302
|
readonly state: DiscountCodeState;
|
|
303
303
|
}
|
|
304
|
-
export
|
|
304
|
+
export type DiscountCodeState = 'ApplicationStoppedByPreviousDiscount' | 'DoesNotMatchCart' | 'MatchesCart' | 'MaxApplicationReached' | 'NotActive' | 'NotValid' | string;
|
|
305
305
|
export interface DiscountedLineItemPortion {
|
|
306
306
|
/**
|
|
307
307
|
*
|
|
@@ -511,8 +511,8 @@ export interface Money {
|
|
|
511
511
|
*/
|
|
512
512
|
readonly type: MoneyType;
|
|
513
513
|
}
|
|
514
|
-
export
|
|
515
|
-
export
|
|
514
|
+
export type MoneyType = 'centPrecision' | 'highPrecision' | string;
|
|
515
|
+
export type OrderState = 'Cancelled' | 'Complete' | 'Confirmed' | 'Open' | string;
|
|
516
516
|
export interface Parcel {
|
|
517
517
|
/**
|
|
518
518
|
*
|
|
@@ -559,7 +559,7 @@ export interface PaymentInfo {
|
|
|
559
559
|
*/
|
|
560
560
|
readonly payments: Reference[];
|
|
561
561
|
}
|
|
562
|
-
export
|
|
562
|
+
export type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending' | string;
|
|
563
563
|
export interface Price {
|
|
564
564
|
/**
|
|
565
565
|
*
|
|
@@ -615,8 +615,8 @@ export interface ProductVariantChannelAvailability {
|
|
|
615
615
|
export interface ProductVariantChannelAvailabilityMap {
|
|
616
616
|
[key: string]: ProductVariantChannelAvailability;
|
|
617
617
|
}
|
|
618
|
-
export
|
|
619
|
-
export
|
|
618
|
+
export type QuoteRequestState = 'Accepted' | 'Cancelled' | 'Closed' | 'Rejected' | 'Submitted' | string;
|
|
619
|
+
export type QuoteState = 'Accepted' | 'Declined' | 'Failed' | 'Pending' | 'Withdrawn' | string;
|
|
620
620
|
export interface Reference {
|
|
621
621
|
/**
|
|
622
622
|
*
|
|
@@ -627,7 +627,7 @@ export interface Reference {
|
|
|
627
627
|
*/
|
|
628
628
|
readonly typeId: ReferenceTypeId;
|
|
629
629
|
}
|
|
630
|
-
export
|
|
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;
|
|
631
631
|
export interface Reservation {
|
|
632
632
|
/**
|
|
633
633
|
*
|
|
@@ -695,8 +695,8 @@ export interface ReturnItem {
|
|
|
695
695
|
*/
|
|
696
696
|
readonly createdAt: string;
|
|
697
697
|
}
|
|
698
|
-
export
|
|
699
|
-
export
|
|
698
|
+
export type ReturnPaymentState = 'Initial' | 'NonRefundable' | 'NotRefunded' | 'Refunded' | string;
|
|
699
|
+
export type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable' | string;
|
|
700
700
|
export interface ReviewRatingStatistics {
|
|
701
701
|
/**
|
|
702
702
|
* Average rating of one target This number is rounded with 5 decimals.
|
|
@@ -724,7 +724,7 @@ export interface ReviewRatingStatistics {
|
|
|
724
724
|
*/
|
|
725
725
|
readonly ratingsDistribution: any;
|
|
726
726
|
}
|
|
727
|
-
export
|
|
727
|
+
export type RoundingMode = 'HalfDown' | 'HalfEven' | 'HalfUp' | string;
|
|
728
728
|
export interface SearchKeyword {
|
|
729
729
|
/**
|
|
730
730
|
*
|
|
@@ -738,8 +738,8 @@ export interface SearchKeyword {
|
|
|
738
738
|
export interface SearchKeywords {
|
|
739
739
|
[key: string]: SearchKeyword[];
|
|
740
740
|
}
|
|
741
|
-
export
|
|
742
|
-
export
|
|
741
|
+
export type SelectionMode = 'Cheapest' | 'MostExpensive' | string;
|
|
742
|
+
export type ShipmentState = 'Backorder' | 'Delayed' | 'Partial' | 'Pending' | 'Ready' | 'Shipped' | string;
|
|
743
743
|
export interface ShippingRate {
|
|
744
744
|
/**
|
|
745
745
|
*
|
|
@@ -765,11 +765,11 @@ export interface ShippingRatePriceTier {
|
|
|
765
765
|
*/
|
|
766
766
|
readonly type: ShippingRateTierType;
|
|
767
767
|
}
|
|
768
|
-
export
|
|
769
|
-
export
|
|
770
|
-
export
|
|
771
|
-
export
|
|
772
|
-
export
|
|
768
|
+
export type ShippingRateTierType = 'CartClassification' | 'CartScore' | 'CartValue' | string;
|
|
769
|
+
export type StackingMode = 'Stacking' | 'StopAfterThisDiscount' | string;
|
|
770
|
+
export type StagedQuoteState = 'Closed' | 'InProgress' | 'Sent' | string;
|
|
771
|
+
export type StateRole = 'Return' | 'ReviewIncludedInStatistics' | string;
|
|
772
|
+
export type StateType = 'LineItemState' | 'OrderState' | 'PaymentState' | 'ProductState' | 'ReviewState' | string;
|
|
773
773
|
export interface SubRate {
|
|
774
774
|
/**
|
|
775
775
|
*
|
|
@@ -801,8 +801,8 @@ export interface SyncInfo {
|
|
|
801
801
|
*/
|
|
802
802
|
readonly syncedAt: string;
|
|
803
803
|
}
|
|
804
|
-
export
|
|
805
|
-
export
|
|
804
|
+
export type TaxCalculationMode = 'LineItemLevel' | 'UnitPriceLevel' | string;
|
|
805
|
+
export type TaxMode = 'Disabled' | 'External' | 'ExternalAmount' | 'Platform' | string;
|
|
806
806
|
/**
|
|
807
807
|
* Shape of the value for `addTaxRate` and `removeTaxRate` actions
|
|
808
808
|
*/
|
|
@@ -861,7 +861,7 @@ export interface TaxedPrice {
|
|
|
861
861
|
*/
|
|
862
862
|
readonly totalGross: Money;
|
|
863
863
|
}
|
|
864
|
-
export
|
|
864
|
+
export type TextInputHint = 'MultiLine' | 'SingleLine' | string;
|
|
865
865
|
export interface TextLineItem {
|
|
866
866
|
/**
|
|
867
867
|
*
|
|
@@ -915,12 +915,12 @@ export interface TrackingData {
|
|
|
915
915
|
}
|
|
916
916
|
export interface Transaction {
|
|
917
917
|
/**
|
|
918
|
-
*
|
|
918
|
+
* Unique identifier of the Transaction.
|
|
919
919
|
*
|
|
920
920
|
*/
|
|
921
921
|
readonly id: string;
|
|
922
922
|
/**
|
|
923
|
-
*
|
|
923
|
+
* Time at which the transaction took place.
|
|
924
924
|
*
|
|
925
925
|
*/
|
|
926
926
|
readonly timestamp: string;
|
|
@@ -933,7 +933,7 @@ export interface Transaction {
|
|
|
933
933
|
*/
|
|
934
934
|
readonly amount: Money;
|
|
935
935
|
/**
|
|
936
|
-
*
|
|
936
|
+
* Identifier used by the interface that manages the transaction (usually the PSP). If a matching interaction was logged in the `interfaceInteractions` array, the corresponding interaction should be findable with this ID.
|
|
937
937
|
*
|
|
938
938
|
*/
|
|
939
939
|
readonly interactionId: string;
|
|
@@ -942,8 +942,8 @@ export interface Transaction {
|
|
|
942
942
|
*/
|
|
943
943
|
readonly state: TransactionState;
|
|
944
944
|
}
|
|
945
|
-
export
|
|
946
|
-
export
|
|
945
|
+
export type TransactionState = 'Failure' | 'Initial' | 'Pending' | 'Success' | string;
|
|
946
|
+
export type TransactionType = 'Authorization' | 'CancelAuthorization' | 'Charge' | 'Chargeback' | 'Refund' | string;
|
|
947
947
|
export interface Variant {
|
|
948
948
|
/**
|
|
949
949
|
*
|
|
@@ -7,7 +7,7 @@ import { LocalizedString, Money, Reference } from './common';
|
|
|
7
7
|
/**
|
|
8
8
|
* Provides descriptive information specific to the resource.
|
|
9
9
|
*/
|
|
10
|
-
export
|
|
10
|
+
export type Label = CustomObjectLabel | CustomerLabel | LocalizedLabel | OrderLabel | PaymentLabel | ProductLabel | QuoteLabel | QuoteRequestLabel | ReviewLabel | StagedQuoteLabel | StringLabel;
|
|
11
11
|
export interface CustomObjectLabel {
|
|
12
12
|
readonly type: 'CustomObjectLabel';
|
|
13
13
|
/**
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
* Please don't change this file manually but run `rmf-codegen generate <raml_file_path> -o <output_path> -t typescript_client` to update it.
|
|
4
4
|
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
5
5
|
*/
|
|
6
|
-
export
|
|
7
|
-
export
|
|
8
|
-
export
|
|
6
|
+
export type MethodType = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE';
|
|
7
|
+
export type QueryParam = string | string[] | number | number[] | boolean | boolean[] | undefined;
|
|
8
|
+
export type VariableMap = {
|
|
9
9
|
[key: string]: QueryParam;
|
|
10
10
|
};
|
|
11
11
|
export interface ClientRequest {
|
|
@@ -18,9 +18,9 @@ export interface ClientRequest {
|
|
|
18
18
|
queryParams?: VariableMap;
|
|
19
19
|
body?: any;
|
|
20
20
|
}
|
|
21
|
-
export
|
|
21
|
+
export type ClientResponse<T = any> = {
|
|
22
22
|
body: T;
|
|
23
23
|
statusCode?: number;
|
|
24
24
|
headers?: Object;
|
|
25
25
|
};
|
|
26
|
-
export
|
|
26
|
+
export type executeRequest = (request: ClientRequest) => Promise<ClientResponse>;
|
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
5
5
|
*/
|
|
6
6
|
import { ClientRequest, ClientResponse, executeRequest } from './common-types';
|
|
7
|
-
export
|
|
7
|
+
export type Middleware = (request: ClientRequest, executor: executeRequest) => Promise<ClientResponse>;
|
|
8
8
|
export declare const createExecutorFromMiddlewares: (executor: executeRequest, midds?: Middleware[]) => executeRequest;
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
6
|
"name": "@commercetools/history-sdk",
|
|
7
|
-
"version": "3.
|
|
7
|
+
"version": "3.2.0",
|
|
8
8
|
"engines": {
|
|
9
9
|
"node": ">=14"
|
|
10
10
|
},
|
|
@@ -32,15 +32,15 @@
|
|
|
32
32
|
"./dist/commercetools-history-sdk.esm.js": "./dist/commercetools-history-sdk.browser.esm.js"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@commercetools/sdk-client-v2": "^2.
|
|
35
|
+
"@commercetools/sdk-client-v2": "^2.1.1",
|
|
36
36
|
"@commercetools/sdk-middleware-auth": "^7.0.0",
|
|
37
37
|
"@commercetools/sdk-middleware-http": "^7.0.0",
|
|
38
38
|
"@commercetools/sdk-middleware-logger": "^3.0.0",
|
|
39
39
|
"querystring": "^0.2.1"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@commercetools/platform-sdk": "4.
|
|
43
|
-
"@types/uuid": "
|
|
42
|
+
"@commercetools/platform-sdk": "4.3.0",
|
|
43
|
+
"@types/uuid": "9.0.0",
|
|
44
44
|
"organize-imports-cli": "0.10.0",
|
|
45
45
|
"tsconfig-replace-paths": "0.0.11",
|
|
46
46
|
"uuid": "9.0.0"
|