@commercetools/importapi-sdk 4.2.0 → 4.3.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 CHANGED
@@ -1,5 +1,28 @@
1
1
  # @commercetools/importapi-sdk
2
2
 
3
+ ## 4.3.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#432](https://github.com/commercetools/commercetools-sdk-typescript/pull/432) [`d06e0c5`](https://github.com/commercetools/commercetools-sdk-typescript/commit/d06e0c58f4b9a8f69bbde63f906cc905c878aa2d) Thanks [@ajimae](https://github.com/ajimae)! - ### Required Properties
8
+
9
+ - changed property `password` of type `CustomerImport` to be optional
10
+
11
+ ### Added Properties
12
+
13
+ - added property `authenticationMode` to type `CustomerImport`
14
+ - added property `state` to type `OrderImport`
15
+ - added property `custom` to type `Address`
16
+
17
+ ### Added Type
18
+
19
+ - added type `AuthenticationMode`
20
+
21
+ ### Patch Changes
22
+
23
+ - Updated dependencies [[`8b4ad04`](https://github.com/commercetools/commercetools-sdk-typescript/commit/8b4ad04e9a43a8b399fa946ab6693500a4af3fb5)]:
24
+ - @commercetools/sdk-client-v2@2.1.4
25
+
3
26
  ## 4.2.0
4
27
 
5
28
  ### Minor Changes
@@ -647,7 +647,7 @@ class ByProjectKeyOrdersImportContainersByImportContainerKeyRequestBuilder {
647
647
  this.args = args;
648
648
  }
649
649
  /**
650
- * Creates a request for creating new Orders or updating existing ones.
650
+ * Creates a request for creating new Orders.
651
651
  */
652
652
  post(methodArgs) {
653
653
  return new ApiRequest({
@@ -643,7 +643,7 @@ class ByProjectKeyOrdersImportContainersByImportContainerKeyRequestBuilder {
643
643
  this.args = args;
644
644
  }
645
645
  /**
646
- * Creates a request for creating new Orders or updating existing ones.
646
+ * Creates a request for creating new Orders.
647
647
  */
648
648
  post(methodArgs) {
649
649
  return new ApiRequest({
@@ -647,7 +647,7 @@ class ByProjectKeyOrdersImportContainersByImportContainerKeyRequestBuilder {
647
647
  this.args = args;
648
648
  }
649
649
  /**
650
- * Creates a request for creating new Orders or updating existing ones.
650
+ * Creates a request for creating new Orders.
651
651
  */
652
652
  post(methodArgs) {
653
653
  return new ApiRequest({
@@ -647,7 +647,7 @@ class ByProjectKeyOrdersImportContainersByImportContainerKeyRequestBuilder {
647
647
  this.args = args;
648
648
  }
649
649
  /**
650
- * Creates a request for creating new Orders or updating existing ones.
650
+ * Creates a request for creating new Orders.
651
651
  */
652
652
  post(methodArgs) {
653
653
  return new ApiRequest({
@@ -643,7 +643,7 @@ class ByProjectKeyOrdersImportContainersByImportContainerKeyRequestBuilder {
643
643
  this.args = args;
644
644
  }
645
645
  /**
646
- * Creates a request for creating new Orders or updating existing ones.
646
+ * Creates a request for creating new Orders.
647
647
  */
648
648
  post(methodArgs) {
649
649
  return new ApiRequest({
@@ -26,7 +26,7 @@ export declare class ByProjectKeyOrdersImportContainersByImportContainerKeyReque
26
26
  baseUri?: string;
27
27
  });
28
28
  /**
29
- * Creates a request for creating new Orders or updating existing ones.
29
+ * Creates a request for creating new Orders.
30
30
  */
31
31
  post(methodArgs: {
32
32
  body: OrderImportRequest;
@@ -579,5 +579,10 @@ export interface Address {
579
579
  *
580
580
  */
581
581
  readonly externalId?: string;
582
+ /**
583
+ * Custom Fields for the address.
584
+ *
585
+ */
586
+ readonly custom?: Custom;
582
587
  }
583
588
  export type ProductPriceModeEnum = 'Embedded' | 'Standalone' | string;
@@ -5,6 +5,7 @@
5
5
  */
6
6
  import { CustomerGroupKeyReference, ImportResource, StoreKeyReference } from './common';
7
7
  import { Custom } from './customfields';
8
+ export type AuthenticationMode = 'ExternalAuth' | 'Password' | string;
8
9
  /**
9
10
  * Different from Address in that `key` is required and `id` is not supported.
10
11
  *
@@ -139,7 +140,7 @@ export interface CustomerImport extends ImportResource {
139
140
  *
140
141
  *
141
142
  */
142
- readonly password: string;
143
+ readonly password?: string;
143
144
  /**
144
145
  * The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Stores are created.
145
146
  *
@@ -250,8 +251,16 @@ export interface CustomerImport extends ImportResource {
250
251
  */
251
252
  readonly locale?: string;
252
253
  /**
253
- * The custom fields for this Customer.
254
+ * The Custom Fields for this Customer.
255
+ *
254
256
  *
255
257
  */
256
258
  readonly custom?: Custom;
259
+ /**
260
+ * - Set to `Password` to make the `password` field required for the Customer.
261
+ * - Set to `ExternalAuth` when the password is not required for the Customer.
262
+ *
263
+ *
264
+ */
265
+ readonly authenticationMode?: AuthenticationMode;
257
266
  }
@@ -123,7 +123,7 @@ export interface StandalonePriceImportRequest {
123
123
  readonly resources: StandalonePriceImport[];
124
124
  }
125
125
  /**
126
- * The request body to [import Orders](#import-orders). Contains data for [Orders](/../api/projects/orders#order) to be created or updated in a Project.
126
+ * The request body to [import Orders](#import-orders). Contains data for [Orders](/../api/projects/orders#order) to be created in a Project.
127
127
  *
128
128
  */
129
129
  export interface OrderImportRequest {
@@ -631,7 +631,7 @@ export interface ScoreShippingRateInput {
631
631
  * The data representation for an Order to be imported that is persisted as an [Order](/../api/projects/orders#top) in the Project.
632
632
  *
633
633
  * In commercetools, you can import an Order using the
634
- * [Create Order by Import](https://docs.commercetools.com/http-api-projects-orders-import.html#create-an-order-by-import)
634
+ * [Create Order by Import](/../api/projects/orders-import#create-an-order-by-import)
635
635
  * endpoint method instead of creating it from a Cart.
636
636
  *
637
637
  * An OrderImport is a snapshot of an order at the time it was imported.
@@ -774,4 +774,10 @@ export interface OrderImport {
774
774
  *
775
775
  */
776
776
  readonly store?: StoreKeyReference;
777
+ /**
778
+ * Reference to a State in a custom workflow.
779
+ *
780
+ *
781
+ */
782
+ readonly state?: StateKeyReference;
777
783
  }
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "name": "@commercetools/importapi-sdk",
7
- "version": "4.2.0",
7
+ "version": "4.3.0",
8
8
  "engines": {
9
9
  "node": ">=14"
10
10
  },
@@ -32,7 +32,7 @@
32
32
  "./dist/commercetools-importapi-sdk.esm.js": "./dist/commercetools-importapi-sdk.browser.esm.js"
33
33
  },
34
34
  "dependencies": {
35
- "@commercetools/sdk-client-v2": "^2.1.2",
35
+ "@commercetools/sdk-client-v2": "^2.1.4",
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",