@commercetools/history-sdk 2.3.0 → 2.5.1
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 +37 -0
- package/README.md +1 -1
- package/dist/declarations/src/generated/client/by-project-key-by-resource-type-by-id-request-builder.d.ts +2 -1
- package/dist/declarations/src/generated/client/by-project-key-by-resource-type-request-builder.d.ts +2 -1
- package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts +2 -1
- package/dist/declarations/src/generated/index.d.ts +1 -0
- package/dist/declarations/src/generated/models/change-history.d.ts +211 -0
- package/dist/declarations/src/generated/models/change-value.d.ts +22 -1
- package/dist/declarations/src/generated/models/change.d.ts +9 -7
- package/dist/declarations/src/generated/models/common.d.ts +32 -206
- package/package.json +11 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,42 @@
|
|
|
1
1
|
# @commercetools/history-sdk
|
|
2
2
|
|
|
3
|
+
## 2.5.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#258](https://github.com/commercetools/commercetools-sdk-typescript/pull/258) [`ba52d38`](https://github.com/commercetools/commercetools-sdk-typescript/commit/ba52d38a0a00299de61f554ae753cfb984401d79) Thanks [@github-actions](https://github.com/apps/github-actions)! - Update generated SDKs
|
|
8
|
+
|
|
9
|
+
- add support for Standalone Prices
|
|
10
|
+
|
|
11
|
+
* [#266](https://github.com/commercetools/commercetools-sdk-typescript/pull/266) [`fd29fa7`](https://github.com/commercetools/commercetools-sdk-typescript/commit/fd29fa759f906040d76a889c2d3fbfbdf2ac6617) Thanks [@github-actions](https://github.com/apps/github-actions)! - Platform SDK updates:
|
|
12
|
+
|
|
13
|
+
- Fix /me/email/confirm arguments and return type (https://github.com/commercetools/commercetools-sdk-typescript/issues/274)
|
|
14
|
+
|
|
15
|
+
## 2.5.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- [#257](https://github.com/commercetools/commercetools-sdk-typescript/pull/257) [`facc47b`](https://github.com/commercetools/commercetools-sdk-typescript/commit/facc47ba50b00056adc232d7c75a2849cdcc6689) Thanks [@ajimae](https://github.com/ajimae)! - release latest sdk
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- Updated dependencies [[`facc47b`](https://github.com/commercetools/commercetools-sdk-typescript/commit/facc47ba50b00056adc232d7c75a2849cdcc6689), [`7512c3f`](https://github.com/commercetools/commercetools-sdk-typescript/commit/7512c3f1f488645da3952f296d4f4fe3149b7fba)]:
|
|
24
|
+
- @commercetools/sdk-client-v2@1.4.0
|
|
25
|
+
|
|
26
|
+
## 2.4.0
|
|
27
|
+
|
|
28
|
+
### Minor Changes
|
|
29
|
+
|
|
30
|
+
- [#241](https://github.com/commercetools/commercetools-sdk-typescript/pull/241) [`85f5be3`](https://github.com/commercetools/commercetools-sdk-typescript/commit/85f5be349a9b0fa46539259981bfd8d5fc2ffdc6) Thanks [@ajimae](https://github.com/ajimae)! - Releasing the TS SDK with the following changelogs
|
|
31
|
+
|
|
32
|
+
- added functionalities to extend client user agent
|
|
33
|
+
- custom field added to OrderFromCardDraft
|
|
34
|
+
|
|
35
|
+
### Patch Changes
|
|
36
|
+
|
|
37
|
+
- Updated dependencies [[`85f5be3`](https://github.com/commercetools/commercetools-sdk-typescript/commit/85f5be349a9b0fa46539259981bfd8d5fc2ffdc6)]:
|
|
38
|
+
- @commercetools/sdk-client-v2@1.3.0
|
|
39
|
+
|
|
3
40
|
## 2.3.0
|
|
4
41
|
|
|
5
42
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
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
|
-
import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/
|
|
6
|
+
import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/change-history';
|
|
7
7
|
import { executeRequest, QueryParam } from '../shared/utils/common-types';
|
|
8
8
|
import { ApiRequest } from '../shared/utils/requests-utils';
|
|
9
9
|
export declare class ByProjectKeyByResourceTypeByIDRequestBuilder {
|
|
@@ -36,6 +36,7 @@ export declare class ByProjectKeyByResourceTypeByIDRequestBuilder {
|
|
|
36
36
|
clientId?: string;
|
|
37
37
|
source?: string;
|
|
38
38
|
changes?: string | string[];
|
|
39
|
+
stores?: string | string[];
|
|
39
40
|
customerId?: string;
|
|
40
41
|
excludePlatformInitiatedChanges?: PlatformInitiatedChange | PlatformInitiatedChange[];
|
|
41
42
|
expand?: boolean;
|
package/dist/declarations/src/generated/client/by-project-key-by-resource-type-request-builder.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
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
|
-
import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/
|
|
6
|
+
import { PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/change-history';
|
|
7
7
|
import { executeRequest, QueryParam } from '../shared/utils/common-types';
|
|
8
8
|
import { ApiRequest } from '../shared/utils/requests-utils';
|
|
9
9
|
import { ByProjectKeyByResourceTypeByIDRequestBuilder } from './by-project-key-by-resource-type-by-id-request-builder';
|
|
@@ -39,6 +39,7 @@ export declare class ByProjectKeyByResourceTypeRequestBuilder {
|
|
|
39
39
|
resourceId?: string;
|
|
40
40
|
source?: string;
|
|
41
41
|
changes?: string | string[];
|
|
42
|
+
stores?: string | string[];
|
|
42
43
|
customerId?: string;
|
|
43
44
|
excludePlatformInitiatedChanges?: PlatformInitiatedChange | PlatformInitiatedChange[];
|
|
44
45
|
expand?: boolean;
|
|
@@ -3,7 +3,7 @@
|
|
|
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
|
-
import { ChangeHistoryResourceType, PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/
|
|
6
|
+
import { ChangeHistoryResourceType, PlatformInitiatedChange, RecordPagedQueryResponse } from '../models/change-history';
|
|
7
7
|
import { executeRequest, QueryParam } from '../shared/utils/common-types';
|
|
8
8
|
import { ApiRequest } from '../shared/utils/requests-utils';
|
|
9
9
|
import { ByProjectKeyByResourceTypeRequestBuilder } from './by-project-key-by-resource-type-request-builder';
|
|
@@ -38,6 +38,7 @@ export declare class ByProjectKeyRequestBuilder {
|
|
|
38
38
|
resourceId?: string;
|
|
39
39
|
source?: string;
|
|
40
40
|
changes?: string | string[];
|
|
41
|
+
stores?: string | string[];
|
|
41
42
|
customerId?: string;
|
|
42
43
|
excludePlatformInitiatedChanges?: PlatformInitiatedChange | PlatformInitiatedChange[];
|
|
43
44
|
expand?: boolean;
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
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
|
+
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
5
|
+
*/
|
|
6
|
+
import { Change } from './change';
|
|
7
|
+
import { KeyReference, Reference } from './common';
|
|
8
|
+
import { Label } from './label';
|
|
9
|
+
/**
|
|
10
|
+
* A Record captures the differences in a resource between one version and the next.
|
|
11
|
+
* (Recall that the version number is not always incremented by one; see [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control).)
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
export interface Record {
|
|
15
|
+
/**
|
|
16
|
+
* Version of the resource after the change.
|
|
17
|
+
*
|
|
18
|
+
*/
|
|
19
|
+
readonly version: number;
|
|
20
|
+
/**
|
|
21
|
+
* Version of the resource before the change.
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
readonly previousVersion: number;
|
|
25
|
+
/**
|
|
26
|
+
* Type of the change (creation, update or deletion).
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
readonly type: string;
|
|
30
|
+
/**
|
|
31
|
+
* Information about the user or the API client who performed the change.
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
readonly modifiedBy: ModifiedBy;
|
|
35
|
+
/**
|
|
36
|
+
* Date and time when the change was made.
|
|
37
|
+
*
|
|
38
|
+
*/
|
|
39
|
+
readonly modifiedAt: string;
|
|
40
|
+
/**
|
|
41
|
+
* Information that describes the resource after the change.
|
|
42
|
+
*
|
|
43
|
+
*/
|
|
44
|
+
readonly label: Label;
|
|
45
|
+
/**
|
|
46
|
+
* Information that describes the resource before the change.
|
|
47
|
+
*
|
|
48
|
+
*/
|
|
49
|
+
readonly previousLabel: Label;
|
|
50
|
+
/**
|
|
51
|
+
* Shows the differences in the resource between `previousVersion` and `version`.
|
|
52
|
+
* The value is not identical to the actual array of update actions sent and is not limited to update actions (see, for example, [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control)).
|
|
53
|
+
*
|
|
54
|
+
*
|
|
55
|
+
*/
|
|
56
|
+
readonly changes: Change[];
|
|
57
|
+
/**
|
|
58
|
+
* Reference to the changed resource.
|
|
59
|
+
*
|
|
60
|
+
*
|
|
61
|
+
*/
|
|
62
|
+
readonly resource: Reference;
|
|
63
|
+
/**
|
|
64
|
+
* References to the [Stores](ctp:api:type:Store) attached to the [Change](ctp:history:type:Change).
|
|
65
|
+
*
|
|
66
|
+
*
|
|
67
|
+
*/
|
|
68
|
+
readonly stores: KeyReference[];
|
|
69
|
+
/**
|
|
70
|
+
* `true` if no change was detected.
|
|
71
|
+
* The version number of the resource can be increased even without any change in the resource.
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
*/
|
|
75
|
+
readonly withoutChanges: boolean;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Response to a query request for [Record](#record).
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
81
|
+
export interface RecordPagedQueryResponse {
|
|
82
|
+
/**
|
|
83
|
+
* Number of [results requested](/../api/general-concepts#limit).
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
*/
|
|
87
|
+
readonly limit: number;
|
|
88
|
+
/**
|
|
89
|
+
* Actual number of results returned.
|
|
90
|
+
*
|
|
91
|
+
*
|
|
92
|
+
*/
|
|
93
|
+
readonly count: number;
|
|
94
|
+
/**
|
|
95
|
+
* Total number of results matching the query.
|
|
96
|
+
* This number is an estimation and not [strongly consistent](/general-concepts#strong-consistency).
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
*/
|
|
100
|
+
readonly total: number;
|
|
101
|
+
/**
|
|
102
|
+
* Number of [elements skipped](/../api/general-concepts#offset).
|
|
103
|
+
*
|
|
104
|
+
*
|
|
105
|
+
*/
|
|
106
|
+
readonly offset: number;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
*/
|
|
110
|
+
readonly results: Record[];
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* This data type represents the supported resource types.
|
|
114
|
+
* The value must be one of the following:
|
|
115
|
+
*
|
|
116
|
+
*/
|
|
117
|
+
export declare type ChangeHistoryResourceType = 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'key-value-document' | 'order' | 'payment' | 'product' | 'product-discount' | 'product-type' | 'review' | 'shopping-list' | 'state' | 'store' | 'tax-category' | 'type' | 'zone';
|
|
118
|
+
/**
|
|
119
|
+
* This type consists of one enum value:
|
|
120
|
+
*
|
|
121
|
+
*/
|
|
122
|
+
export declare type DateStringFilter = 'now';
|
|
123
|
+
export interface ErrorObject {
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
*/
|
|
127
|
+
readonly code: string;
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
*/
|
|
131
|
+
readonly message: string;
|
|
132
|
+
}
|
|
133
|
+
export interface ErrorResponse {
|
|
134
|
+
/**
|
|
135
|
+
*
|
|
136
|
+
*/
|
|
137
|
+
readonly statusCode: number;
|
|
138
|
+
/**
|
|
139
|
+
*
|
|
140
|
+
*/
|
|
141
|
+
readonly message: string;
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
*/
|
|
145
|
+
readonly error?: string;
|
|
146
|
+
/**
|
|
147
|
+
*
|
|
148
|
+
*/
|
|
149
|
+
readonly error_description?: string;
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
*/
|
|
153
|
+
readonly errors?: ErrorObject[];
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Information about the user or the API client who performed the change. This is a variant of
|
|
157
|
+
* [LastModifiedBy](/types#lastmodifiedby).
|
|
158
|
+
*
|
|
159
|
+
*/
|
|
160
|
+
export interface ModifiedBy {
|
|
161
|
+
/**
|
|
162
|
+
* [ID](/general-concepts#identifier) of the Merchant Center user who made the change.
|
|
163
|
+
* Present only if the change was made in the Merchant Center.
|
|
164
|
+
*
|
|
165
|
+
*
|
|
166
|
+
*/
|
|
167
|
+
readonly id: string;
|
|
168
|
+
/**
|
|
169
|
+
* Indicates whether the change was made by a user or the API client with or without an
|
|
170
|
+
* [External user ID](/client-logging#external-user-ids).
|
|
171
|
+
*
|
|
172
|
+
*
|
|
173
|
+
*/
|
|
174
|
+
readonly type: string;
|
|
175
|
+
/**
|
|
176
|
+
* [Reference](/types#reference) to the
|
|
177
|
+
* [Customer](/projects/customers#customer) who made the change. Present only if
|
|
178
|
+
* the change was made using a token from the [Password
|
|
179
|
+
* Flow](/authorization#password-flow).
|
|
180
|
+
*
|
|
181
|
+
*
|
|
182
|
+
*/
|
|
183
|
+
readonly customer?: Reference;
|
|
184
|
+
/**
|
|
185
|
+
* Present only if the change was made using a token from an [Anonymous
|
|
186
|
+
* Session](/authorization#tokens-for-anonymous-sessions).
|
|
187
|
+
*
|
|
188
|
+
*
|
|
189
|
+
*/
|
|
190
|
+
readonly anonymousId?: string;
|
|
191
|
+
/**
|
|
192
|
+
* [ID](/general-concepts#identifier) of the [API
|
|
193
|
+
* Client](/projects/api-clients#apiclient) that made the change. Present only if
|
|
194
|
+
* the change was made using an API Client.
|
|
195
|
+
*
|
|
196
|
+
*
|
|
197
|
+
*/
|
|
198
|
+
readonly clientId?: string;
|
|
199
|
+
/**
|
|
200
|
+
* `true` if the change was made via Merchant Center or [ImpEx](https://impex.europe-west1.gcp.commercetools.com/).
|
|
201
|
+
*
|
|
202
|
+
*
|
|
203
|
+
*/
|
|
204
|
+
readonly isPlatformClient: boolean;
|
|
205
|
+
}
|
|
206
|
+
export declare type PlatformInitiatedChange = 'changeLineItemName' | 'changeReviewRatingStatistics' | 'excludeAll' | 'setApplicationVersion' | 'setIsValid' | 'setVariantAvailability';
|
|
207
|
+
/**
|
|
208
|
+
* Values for the Source enumeration.
|
|
209
|
+
*/
|
|
210
|
+
export declare type Source = 'ApiClient' | 'ImpEx' | 'MerchantCenter';
|
|
211
|
+
export declare 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';
|
|
@@ -3,7 +3,7 @@
|
|
|
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
|
-
import { Address, DeliveryItem, LocalizedString, Money, Parcel, Reference, SelectionMode } from './common';
|
|
6
|
+
import { Address, DeliveryItem, LocalizedString, Money, Parcel, Reference, SelectionMode, TaxedPrice, TaxRate } from './common';
|
|
7
7
|
export declare type ChangeTargetChangeValue = ChangeTargetCustomLineItemsChangeValue | ChangeTargetLineItemsChangeValue | ChangeTargetMultiBuyCustomLineItemsChangeValue | ChangeTargetMultiBuyLineItemsChangeValue | ChangeTargetShippingChangeValue;
|
|
8
8
|
export declare type ChangeValueChangeValue = ChangeValueAbsoluteChangeValue | ChangeValueExternalChangeValue | ChangeValueGiftLineItemChangeValue | ChangeValueRelativeChangeValue;
|
|
9
9
|
export interface AssetChangeValue {
|
|
@@ -16,6 +16,16 @@ export interface AssetChangeValue {
|
|
|
16
16
|
*/
|
|
17
17
|
readonly name: LocalizedString;
|
|
18
18
|
}
|
|
19
|
+
export interface AttributeValue {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
readonly name: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
readonly value: any;
|
|
28
|
+
}
|
|
19
29
|
/**
|
|
20
30
|
* Shape of the value for cart discounts line item and custom line items target.
|
|
21
31
|
*/
|
|
@@ -279,6 +289,17 @@ export interface ShippingMethodChangeValue {
|
|
|
279
289
|
*/
|
|
280
290
|
readonly name: string;
|
|
281
291
|
}
|
|
292
|
+
export interface ShippingMethodTaxAmountChangeValue {
|
|
293
|
+
/**
|
|
294
|
+
*
|
|
295
|
+
*/
|
|
296
|
+
readonly taxedPrice: TaxedPrice;
|
|
297
|
+
/**
|
|
298
|
+
* Shape of the value for `addTaxRate` and `removeTaxRate` actions
|
|
299
|
+
*
|
|
300
|
+
*/
|
|
301
|
+
readonly taxRate: TaxRate;
|
|
302
|
+
}
|
|
282
303
|
export interface ShoppingListLineItemValue {
|
|
283
304
|
/**
|
|
284
305
|
*
|
|
@@ -3,7 +3,7 @@
|
|
|
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
|
-
import { AssetChangeValue, ChangeTargetChangeValue, ChangeValueChangeValue, CustomFieldExpandedValue, CustomShippingMethodChangeValue, DeliveryChangeValue, EnumValue, FieldDefinitionOrderValue, InventoryQuantityValue, LocalizedEnumValue, ParcelChangeValue, SetCartClassificationShippingRateInputValue, SetCartScoreShippingRateInputValue, ShippingMethodChangeValue, ShoppingListLineItemValue, TextLineItemValue, TransactionChangeValue, ValidFromAndUntilValue } from './change-value';
|
|
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, CategoryOrderHints, ChannelRole, CustomFields, CustomLineItem, Delivery, DeliveryItem, DiscountCodeInfo, DiscountedLineItemPrice, DiscountedLineItemPriceForQuantity, FieldDefinition, GeoLocation, Image, ItemShippingDetails, ItemState, LineItem, LocalizedString, Location, Money, OrderState, Parcel, ParcelMeasurements, PaymentInfo, PaymentState, Price, ProductVariantAvailability, Reference, Reservation, ReturnInfo, ReturnPaymentState, ReturnShipmentState, ReviewRatingStatistics, RoundingMode, SearchKeywords, ShipmentState, StackingMode, StateRole, StateType, SyncInfo, TaxCalculationMode, TaxedItemPrice, TaxedPrice, TaxMode, TaxRate, TextInputHint, TextLineItem, TrackingData, Transaction, TransactionState, Variant } from './common';
|
|
8
8
|
export declare type Change = AddAddressChange | AddAssetChange | AddAttributeDefinitionChange | AddBillingAddressIdChange | AddChannelRolesChange | AddCustomLineItemChange | AddDeliveryChange | AddDiscountCodeChange | AddEnumValueChange | AddExternalImageChange | AddFieldDefinitionChange | AddInterfaceInteractionChange | AddItemShippingAddressesChange | AddLocalizedEnumValueChange | AddLocationChange | AddOrderLineItemChange | AddParcelToDeliveryChange | AddPaymentChange | AddPlainEnumValueChange | AddPriceChange | 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 | ChangeRequiresDiscountCodeChange | ChangeReviewRatingStatisticsChange | ChangeShipmentStateChange | ChangeShoppingListLineItemQuantityChange | ChangeShoppingListLineItemsOrderChange | ChangeSlugChange | ChangeSortOrderChange | ChangeStackingModeChange | 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 | RemovePropertyChange | RemoveShippingAddressIdChange | RemoveShoppingListLineItemChange | RemoveStateRolesChange | RemoveTaxRateChange | RemoveTextLineItemChange | RemoveVariantChange | SetAddressChange | SetAnonymousIdChange | SetApplicationVersionChange | SetAssetCustomFieldChange | SetAssetCustomTypeChange | SetAssetDescriptionChange | SetAssetKeyChange | SetAssetSourcesChange | SetAssetTagsChange | SetAttributeChange | 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 | SetLineItemDiscountedPriceChange | SetLineItemDiscountedPricePerQuantityChange | SetLineItemDistributionChannelChange | SetLineItemPriceChange | 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 | SetProductPriceCustomFieldChange | SetProductPriceCustomTypeChange | SetProductVariantKeyChange | SetPropertyChange | SetRatingChange | SetReservationsChange | SetRestockableInDaysChange | SetReturnPaymentStateChange | SetReturnShipmentStateChange | SetSalutationChange | SetSearchKeywordsChange | 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 | SetValidUntilChange | SetValueChange | SetVariantAvailabilityChange | SetVatIdChange | TransitionCustomLineItemStateChange | TransitionLineItemStateChange | TransitionStateChange | UnknownChange | UnpublishChange | UpdateSyncInfoChange | VerifyEmailChange;
|
|
9
9
|
export interface AddAddressChange {
|
|
@@ -2191,11 +2191,11 @@ export interface SetAttributeChange {
|
|
|
2191
2191
|
/**
|
|
2192
2192
|
*
|
|
2193
2193
|
*/
|
|
2194
|
-
readonly previousValue:
|
|
2194
|
+
readonly previousValue: AttributeValue;
|
|
2195
2195
|
/**
|
|
2196
2196
|
*
|
|
2197
2197
|
*/
|
|
2198
|
-
readonly nextValue:
|
|
2198
|
+
readonly nextValue: AttributeValue;
|
|
2199
2199
|
}
|
|
2200
2200
|
export interface SetAuthorNameChange {
|
|
2201
2201
|
readonly type: 'SetAuthorNameChange';
|
|
@@ -2308,12 +2308,14 @@ export interface SetCountryChange {
|
|
|
2308
2308
|
*/
|
|
2309
2309
|
readonly change: string;
|
|
2310
2310
|
/**
|
|
2311
|
-
*
|
|
2311
|
+
* Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
2312
|
+
*
|
|
2312
2313
|
*
|
|
2313
2314
|
*/
|
|
2314
2315
|
readonly previousValue: string;
|
|
2315
2316
|
/**
|
|
2316
|
-
*
|
|
2317
|
+
* Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
2318
|
+
*
|
|
2317
2319
|
*
|
|
2318
2320
|
*/
|
|
2319
2321
|
readonly nextValue: string;
|
|
@@ -3953,11 +3955,11 @@ export interface SetShippingMethodTaxAmountChange {
|
|
|
3953
3955
|
/**
|
|
3954
3956
|
*
|
|
3955
3957
|
*/
|
|
3956
|
-
readonly nextValue:
|
|
3958
|
+
readonly nextValue: ShippingMethodTaxAmountChangeValue;
|
|
3957
3959
|
/**
|
|
3958
3960
|
*
|
|
3959
3961
|
*/
|
|
3960
|
-
readonly previousValue:
|
|
3962
|
+
readonly previousValue: ShippingMethodTaxAmountChangeValue;
|
|
3961
3963
|
}
|
|
3962
3964
|
export interface SetShippingMethodTaxRateChange {
|
|
3963
3965
|
readonly type: 'SetShippingMethodTaxRateChange';
|
|
@@ -3,209 +3,12 @@
|
|
|
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
|
-
import { Change } from './change';
|
|
7
|
-
import { Label } from './label';
|
|
8
|
-
/**
|
|
9
|
-
* A Record captures the differences in a resource between one version and the next.
|
|
10
|
-
* (Recall that the version number is not always incremented by one; see [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control).)
|
|
11
|
-
*
|
|
12
|
-
*/
|
|
13
|
-
export interface Record {
|
|
14
|
-
/**
|
|
15
|
-
* Version of the resource after the change.
|
|
16
|
-
*
|
|
17
|
-
*/
|
|
18
|
-
readonly version: number;
|
|
19
|
-
/**
|
|
20
|
-
* Version of the resource before the change.
|
|
21
|
-
*
|
|
22
|
-
*/
|
|
23
|
-
readonly previousVersion: number;
|
|
24
|
-
/**
|
|
25
|
-
* Type of the change (creation, update or deletion).
|
|
26
|
-
*
|
|
27
|
-
*/
|
|
28
|
-
readonly type: string;
|
|
29
|
-
/**
|
|
30
|
-
* Information about the user or the API client who performed the change.
|
|
31
|
-
*
|
|
32
|
-
*/
|
|
33
|
-
readonly modifiedBy: ModifiedBy;
|
|
34
|
-
/**
|
|
35
|
-
* Date and time when the change was made.
|
|
36
|
-
*
|
|
37
|
-
*/
|
|
38
|
-
readonly modifiedAt: string;
|
|
39
|
-
/**
|
|
40
|
-
* Information that describes the resource after the change.
|
|
41
|
-
*
|
|
42
|
-
*/
|
|
43
|
-
readonly label: Label;
|
|
44
|
-
/**
|
|
45
|
-
* Information that describes the resource before the change.
|
|
46
|
-
*
|
|
47
|
-
*/
|
|
48
|
-
readonly previousLabel: Label;
|
|
49
|
-
/**
|
|
50
|
-
* Shows the differences in the resource between `previousVersion` and `version`.
|
|
51
|
-
* The value is not identical to the actual array of update actions that was sent to the platform and is not limited to update actions (see, for example, [Optimistic Concurrency Control](/general-concepts#optimistic-concurrency-control)).
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*/
|
|
55
|
-
readonly changes: Change[];
|
|
56
|
-
/**
|
|
57
|
-
* [Reference](/types#reference) to the changed resource.
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*/
|
|
61
|
-
readonly resource: Reference;
|
|
62
|
-
/**
|
|
63
|
-
* `true` if no change was detected.
|
|
64
|
-
* The version number of the resource can be increased even without any change in the resource.
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*/
|
|
68
|
-
readonly withoutChanges: boolean;
|
|
69
|
-
}
|
|
70
|
-
/**
|
|
71
|
-
* Response to a query request for [Record](#record).
|
|
72
|
-
*
|
|
73
|
-
*/
|
|
74
|
-
export interface RecordPagedQueryResponse {
|
|
75
|
-
/**
|
|
76
|
-
* Maximum number of results requested in the query request.
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*/
|
|
80
|
-
readonly limit: number;
|
|
81
|
-
/**
|
|
82
|
-
* Actual number of results returned.
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*/
|
|
86
|
-
readonly count: number;
|
|
87
|
-
/**
|
|
88
|
-
* Total number of results matching the query.
|
|
89
|
-
* This number is an estimation and not [strongly consistent](/general-concepts#strong-consistency).
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*/
|
|
93
|
-
readonly total: number;
|
|
94
|
-
/**
|
|
95
|
-
* The number of elements skipped, not a page number. Supplied by the client or the server default.
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*/
|
|
99
|
-
readonly offset: number;
|
|
100
|
-
/**
|
|
101
|
-
*
|
|
102
|
-
*/
|
|
103
|
-
readonly results: Record[];
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* This data type represents the supported resource types.
|
|
107
|
-
* The value must be one of the following:
|
|
108
|
-
*
|
|
109
|
-
*/
|
|
110
|
-
export declare type ChangeHistoryResourceType = 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'key-value-document' | 'order' | 'payment' | 'product' | 'product-discount' | 'product-type' | 'review' | 'shopping-list' | 'state' | 'store' | 'tax-category' | 'type' | 'zone';
|
|
111
|
-
/**
|
|
112
|
-
* This type consists of one enum value:
|
|
113
|
-
*
|
|
114
|
-
*/
|
|
115
|
-
export declare type DateStringFilter = 'now';
|
|
116
|
-
export interface ErrorObject {
|
|
117
|
-
/**
|
|
118
|
-
*
|
|
119
|
-
*/
|
|
120
|
-
readonly code: string;
|
|
121
|
-
/**
|
|
122
|
-
*
|
|
123
|
-
*/
|
|
124
|
-
readonly message: string;
|
|
125
|
-
}
|
|
126
|
-
export interface ErrorResponse {
|
|
127
|
-
/**
|
|
128
|
-
*
|
|
129
|
-
*/
|
|
130
|
-
readonly statusCode: number;
|
|
131
|
-
/**
|
|
132
|
-
*
|
|
133
|
-
*/
|
|
134
|
-
readonly message: string;
|
|
135
|
-
/**
|
|
136
|
-
*
|
|
137
|
-
*/
|
|
138
|
-
readonly error?: string;
|
|
139
|
-
/**
|
|
140
|
-
*
|
|
141
|
-
*/
|
|
142
|
-
readonly error_description?: string;
|
|
143
|
-
/**
|
|
144
|
-
*
|
|
145
|
-
*/
|
|
146
|
-
readonly errors?: ErrorObject[];
|
|
147
|
-
}
|
|
148
|
-
/**
|
|
149
|
-
* Information about the user or the API client who performed the change. This is a variant of
|
|
150
|
-
* [LastModifiedBy](/types#lastmodifiedby).
|
|
151
|
-
*
|
|
152
|
-
*/
|
|
153
|
-
export interface ModifiedBy {
|
|
154
|
-
/**
|
|
155
|
-
* [ID](/general-concepts#identifier) of the Merchant Center user who made the change.
|
|
156
|
-
* Present only if the change was made in the Merchant Center.
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*/
|
|
160
|
-
readonly id: string;
|
|
161
|
-
/**
|
|
162
|
-
* Indicates whether the change was made by a user or the API client with or without an
|
|
163
|
-
* [External user ID](/client-logging#external-user-ids).
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*/
|
|
167
|
-
readonly type: string;
|
|
168
|
-
/**
|
|
169
|
-
* [Reference](/types#reference) to the
|
|
170
|
-
* [Customer](/projects/customers#customer) who made the change. Present only if
|
|
171
|
-
* the change was made using a token from the [Password
|
|
172
|
-
* Flow](/authorization#password-flow).
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*/
|
|
176
|
-
readonly customer?: Reference;
|
|
177
|
-
/**
|
|
178
|
-
* Present only if the change was made using a token from an [Anonymous
|
|
179
|
-
* Session](/authorization#tokens-for-anonymous-sessions).
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*/
|
|
183
|
-
readonly anonymousId?: string;
|
|
184
|
-
/**
|
|
185
|
-
* [ID](/general-concepts#identifier) of the [API
|
|
186
|
-
* Client](/projects/api-clients#apiclient) that made the change. Present only if
|
|
187
|
-
* the change was made using an API Client.
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*/
|
|
191
|
-
readonly clientId?: string;
|
|
192
|
-
/**
|
|
193
|
-
* `true` if the change was made via Merchant Center or [ImpEx](https://impex.europe-west1.gcp.commercetools.com/).
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*/
|
|
197
|
-
readonly isPlatformClient: boolean;
|
|
198
|
-
}
|
|
199
|
-
/**
|
|
200
|
-
* Values for the Source enumeration.
|
|
201
|
-
*/
|
|
202
|
-
export declare type Source = 'ApiClient' | 'ImpEx' | 'MerchantCenter';
|
|
203
|
-
export declare 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';
|
|
204
6
|
export interface LocalizedString {
|
|
205
7
|
[key: string]: string;
|
|
206
8
|
}
|
|
207
9
|
export interface Address {
|
|
208
10
|
/**
|
|
11
|
+
* Unique ID of the Address.
|
|
209
12
|
*
|
|
210
13
|
*/
|
|
211
14
|
readonly id: string;
|
|
@@ -258,7 +61,8 @@ export interface Address {
|
|
|
258
61
|
*/
|
|
259
62
|
readonly state: string;
|
|
260
63
|
/**
|
|
261
|
-
*
|
|
64
|
+
* Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
65
|
+
*
|
|
262
66
|
*
|
|
263
67
|
*/
|
|
264
68
|
readonly country: string;
|
|
@@ -362,7 +166,7 @@ export interface AttributeDefinition {
|
|
|
362
166
|
/**
|
|
363
167
|
*
|
|
364
168
|
*/
|
|
365
|
-
readonly type:
|
|
169
|
+
readonly type: AttributeType;
|
|
366
170
|
/**
|
|
367
171
|
* The unique name of the attribute used in the API. The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (`_`) and the hyphen-minus (`-`). When using the same `name` for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types, otherwise an AttributeDefinitionAlreadyExists error code will be returned. An exception to this are the values of an `enum` or `lenum` type and sets thereof.
|
|
368
172
|
*
|
|
@@ -395,6 +199,12 @@ export interface AttributeDefinition {
|
|
|
395
199
|
*/
|
|
396
200
|
readonly isSearchable: boolean;
|
|
397
201
|
}
|
|
202
|
+
export interface AttributeType {
|
|
203
|
+
/**
|
|
204
|
+
*
|
|
205
|
+
*/
|
|
206
|
+
readonly name: string;
|
|
207
|
+
}
|
|
398
208
|
export interface CategoryOrderHints {
|
|
399
209
|
[key: string]: string;
|
|
400
210
|
}
|
|
@@ -523,10 +333,9 @@ export interface DiscountedLineItemPriceForQuantity {
|
|
|
523
333
|
}
|
|
524
334
|
export interface FieldDefinition {
|
|
525
335
|
/**
|
|
526
|
-
* Describes the type of the field.
|
|
527
336
|
*
|
|
528
337
|
*/
|
|
529
|
-
readonly type:
|
|
338
|
+
readonly type: FieldType;
|
|
530
339
|
/**
|
|
531
340
|
* The name of the field. The name must be between two and 36 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (`_`) and the hyphen-minus (`-`). The name must be unique for a given resource type ID. In case there is a field with the same name in another type it has to have the same FieldType also.
|
|
532
341
|
*
|
|
@@ -541,6 +350,12 @@ export interface FieldDefinition {
|
|
|
541
350
|
*/
|
|
542
351
|
readonly inputHint: TextInputHint;
|
|
543
352
|
}
|
|
353
|
+
export interface FieldType {
|
|
354
|
+
/**
|
|
355
|
+
*
|
|
356
|
+
*/
|
|
357
|
+
readonly name: string;
|
|
358
|
+
}
|
|
544
359
|
export interface GeoLocation {
|
|
545
360
|
/**
|
|
546
361
|
*
|
|
@@ -608,6 +423,16 @@ export interface ItemState {
|
|
|
608
423
|
*/
|
|
609
424
|
readonly state: Reference;
|
|
610
425
|
}
|
|
426
|
+
export interface KeyReference {
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
*/
|
|
430
|
+
readonly key: string;
|
|
431
|
+
/**
|
|
432
|
+
*
|
|
433
|
+
*/
|
|
434
|
+
readonly typeId: ReferenceTypeId;
|
|
435
|
+
}
|
|
611
436
|
export interface LineItem {
|
|
612
437
|
/**
|
|
613
438
|
*
|
|
@@ -655,7 +480,8 @@ export interface LineItem {
|
|
|
655
480
|
*/
|
|
656
481
|
export interface Location {
|
|
657
482
|
/**
|
|
658
|
-
*
|
|
483
|
+
* Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
484
|
+
*
|
|
659
485
|
*
|
|
660
486
|
*/
|
|
661
487
|
readonly country: string;
|
|
@@ -666,7 +492,7 @@ export interface Location {
|
|
|
666
492
|
}
|
|
667
493
|
export interface Money {
|
|
668
494
|
/**
|
|
669
|
-
*
|
|
495
|
+
* Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
|
|
670
496
|
*
|
|
671
497
|
*
|
|
672
498
|
*/
|
|
@@ -733,7 +559,6 @@ export interface PaymentInfo {
|
|
|
733
559
|
readonly payments: Reference[];
|
|
734
560
|
}
|
|
735
561
|
export declare type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending';
|
|
736
|
-
export declare type PlatformInitiatedChange = 'changeLineItemName' | 'changeReviewRatingStatistics' | 'excludeAll' | 'setApplicationVersion' | 'setIsValid' | 'setVariantAvailability';
|
|
737
562
|
export interface Price {
|
|
738
563
|
/**
|
|
739
564
|
*
|
|
@@ -987,7 +812,8 @@ export interface TaxRate {
|
|
|
987
812
|
*/
|
|
988
813
|
readonly includedInPrice: boolean;
|
|
989
814
|
/**
|
|
990
|
-
*
|
|
815
|
+
* Two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
816
|
+
*
|
|
991
817
|
*
|
|
992
818
|
*/
|
|
993
819
|
readonly country: string;
|
package/package.json
CHANGED
|
@@ -4,9 +4,15 @@
|
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
6
|
"name": "@commercetools/history-sdk",
|
|
7
|
-
"version": "2.
|
|
8
|
-
"description": "
|
|
9
|
-
"keywords": [
|
|
7
|
+
"version": "2.5.1",
|
|
8
|
+
"description": "Typescript SDK for Composable Commerce Audit Log features",
|
|
9
|
+
"keywords": [
|
|
10
|
+
"commercetools",
|
|
11
|
+
"composable commerce",
|
|
12
|
+
"typescript",
|
|
13
|
+
"sdk",
|
|
14
|
+
"history"
|
|
15
|
+
],
|
|
10
16
|
"homepage": "https://github.com/commercetools/commercetools-typescript-sdks/packages/history-sdk",
|
|
11
17
|
"bugs": "https://github.com/commercetools/commercetools-typescript-sdks/issues",
|
|
12
18
|
"repository": {
|
|
@@ -23,14 +29,14 @@
|
|
|
23
29
|
"./dist/commercetools-history-sdk.esm.js": "./dist/commercetools-history-sdk.browser.esm.js"
|
|
24
30
|
},
|
|
25
31
|
"dependencies": {
|
|
26
|
-
"@commercetools/sdk-client-v2": "^1.
|
|
32
|
+
"@commercetools/sdk-client-v2": "^1.4.0",
|
|
27
33
|
"@commercetools/sdk-middleware-auth": "^6.0.4",
|
|
28
34
|
"@commercetools/sdk-middleware-http": "^6.0.4",
|
|
29
35
|
"@commercetools/sdk-middleware-logger": "^2.1.1",
|
|
30
36
|
"querystring": "^0.2.1"
|
|
31
37
|
},
|
|
32
38
|
"devDependencies": {
|
|
33
|
-
"@commercetools/platform-sdk": "2.
|
|
39
|
+
"@commercetools/platform-sdk": "2.8.0",
|
|
34
40
|
"@types/uuid": "8.3.4",
|
|
35
41
|
"organize-imports-cli": "0.9.0",
|
|
36
42
|
"tsconfig-replace-paths": "0.0.11",
|