@commercetools/importapi-sdk 5.16.0 → 5.18.0

package/dist/declarations/src/generated/models/productdrafts.d.ts

@@ -13,15 +13,15 @@ import { Attribute } from "./productvariants.js";
  */
 export interface ProductDraftImport extends ImportResource {
     /**
-     *	User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
+     *	User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it will be updated with the imported data.
      *
      */
     readonly key: string;
     /**
-     *	The `productType` of a [Product](/../api/projects/products#product).
+     *	The `productType` of a [Product](ctp:api:type:Product).
      *	Maps to `Product.productType`.
-     *	The Reference to the [ProductType](/../api/projects/productTypes#producttype) with which the ProductDraft is associated.
-     *	If referenced ProductType does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductType is created.
+     *	The Reference to the [ProductType](ctp:api:type:ProductType) with which the ProductDraft is associated.
+     *	If referenced ProductType does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductType is created.
      *
      *
      */
@@ -44,8 +44,8 @@ export interface ProductDraftImport extends ImportResource {
      */
     readonly description?: LocalizedString;
     /**
-     *	The Reference to the [Categories](/../api/projects/categories#category) with which the ProductDraft is associated.
-     *	If referenced Categories do not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Categories are created.
+     *	The Reference to the [Categories](ctp:api:type:Category) with which the ProductDraft is associated.
+     *	If referenced Categories do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Categories are created.
      *
      *
      */
@@ -99,8 +99,8 @@ export interface ProductDraftImport extends ImportResource {
      */
     readonly variants?: ProductVariantDraftImport[];
     /**
-     *	The Reference to the [TaxCategory](/../api/projects/taxCategories#taxcategory) with which the ProductDraft is associated.
-     *	If referenced TaxCategory does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary TaxCategory is created.
+     *	The Reference to the [TaxCategory](/projects/taxCategories#taxcategory) with which the ProductDraft is associated.
+     *	If referenced TaxCategory does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary TaxCategory is created.
      *
      *
      */
@@ -129,20 +129,20 @@ export interface ProductDraftImport extends ImportResource {
      */
     readonly searchKeywords?: SearchKeywords;
     /**
-     *	The Reference to the [State](/../api/projects/states#state) with which the ProductDraft is associated.
-     *	If referenced State does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary State is created.
+     *	The Reference to the [State](/projects/states#state) with which the ProductDraft is associated.
+     *	If referenced State does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary State is created.
      *
      *
      */
     readonly state?: StateKeyReference;
     /**
-     *	Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/best-practices#managing-the-published-state-of-products).
+     *	Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/import-export/best-practices#managing-the-published-state-of-products).
      *
      *
      */
     readonly publish?: boolean;
     /**
-     *	Determines the type of Prices the API uses. See [ProductPriceMode](/../api/projects/products#productpricemode) for more details. If not provided, the existing `Product.priceMode` is not changed.
+     *	Determines the type of Prices the API uses. If not provided, the existing `Product.priceMode` is not changed.
      *
      *
      */

package/dist/declarations/src/generated/models/products.d.ts

@@ -55,14 +55,14 @@ export interface WhitespaceTokenizer {
     readonly type: 'whitespace';
 }
 /**
- *	The data representation for a Product to be imported that is persisted as a [Product](/../api/projects/products#product) in the Project.
+ *	The data representation for a Product to be imported that is persisted as a [Product](ctp:api:type:Product) in the Project.
  *
- *	This is the minimal representation required for creating a [Product](/../api/projects/products#product) in commercetools.
+ *	This is the minimal representation required for creating a [Product](ctp:api:type:Product) in commercetools.
  *
  */
 export interface ProductImport extends ImportResource {
     /**
-     *	User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
+     *	User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it will be updated with the imported data.
      *
      */
     readonly key: string;
@@ -73,10 +73,10 @@ export interface ProductImport extends ImportResource {
      */
     readonly name: LocalizedString;
     /**
-     *	The `productType` of a [Product](/../api/projects/products#product).
+     *	The `productType` of a [Product](ctp:api:type:Product).
      *	Maps to `Product.productType`.
-     *	The Reference to the [ProductType](/../api/projects/productTypes#producttype) with which the Product is associated.
-     *	If referenced ProductType does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductType is created.
+     *	The Reference to the [ProductType](ctp:api:type:ProductType) with which the Product is associated.
+     *	If referenced ProductType does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductType is created.
      *
      *
      */
@@ -96,8 +96,8 @@ export interface ProductImport extends ImportResource {
     readonly description?: LocalizedString;
     /**
      *	Maps to `Product.categories`.
-     *	The References to the [Categories](/../api/projects/categories#category) with which the Product is associated.
-     *	If referenced Categories do not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Categories are created.
+     *	The References to the [Categories](ctp:api:type:Category) with which the Product is associated.
+     *	If referenced Categories do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Categories are created.
      *
      *
      */
@@ -139,8 +139,8 @@ export interface ProductImport extends ImportResource {
      */
     readonly metaKeywords?: LocalizedString;
     /**
-     *	The Reference to the [TaxCategory](/../api/projects/taxCategories#taxcategory) with which the Product is associated.
-     *	If referenced TaxCategory does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary TaxCategory is created.
+     *	The Reference to the [TaxCategory](/projects/taxCategories#taxcategory) with which the Product is associated.
+     *	If referenced TaxCategory does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary TaxCategory is created.
      *
      *
      */
@@ -169,20 +169,20 @@ export interface ProductImport extends ImportResource {
      */
     readonly searchKeywords?: SearchKeywords;
     /**
-     *	The Reference to the [State](/../api/projects/states#state) with which the Product is associated.
-     *	If referenced State does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary State is created.
+     *	The Reference to the [State](/projects/states#state) with which the Product is associated.
+     *	If referenced State does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary State is created.
      *
      *
      */
     readonly state?: StateKeyReference;
     /**
-     *	Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/best-practices#managing-the-published-state-of-products).
+     *	Determines the published status and current/staged projection of the Product. For more information, see [Managing the published state of Products](/import-export/best-practices#managing-the-published-state-of-products).
      *
      *
      */
     readonly publish?: boolean;
     /**
-     *	Determines the type of Prices the API uses. See [ProductPriceMode](/../api/projects/products#productpricemode) for more details. If not provided, the existing `Product.priceMode` is not changed.
+     *	Determines the type of Prices the API uses. If not provided, the existing `Product.priceMode` is not changed.
      *
      *
      */

package/dist/declarations/src/generated/models/producttypes.d.ts

@@ -148,12 +148,12 @@ export interface AttributeTimeType {
 export type AttributeConstraintEnum = 'CombinationUnique' | 'None' | 'SameForAll' | 'Unique' | string;
 export type TextInputHint = 'MultiLine' | 'SingleLine' | string;
 /**
- *	The data representation for a ProductType to be imported that is persisted as a [ProductType](/../api/projects/productTypes#producttype) in the Project.
+ *	The data representation for a ProductType to be imported that is persisted as a [ProductType](ctp:api:type:ProductType) in the Project.
  *
  */
 export interface ProductTypeImport extends ImportResource {
     /**
-     *	User-defined unique identifier. If a [ProductType](/../api/projects/productTypes#producttype) with this `key` exists, it will be updated with the imported data.
+     *	User-defined unique identifier. If a [ProductType](ctp:api:type:ProductType) with this `key` exists, it will be updated with the imported data.
      *
      */
     readonly key: string;
@@ -170,7 +170,7 @@ export interface ProductTypeImport extends ImportResource {
      */
     readonly description: string;
     /**
-     *	The `attributes` of [ProductType](/../api/projects/productTypes#producttype).
+     *	The `attributes` of [ProductType](ctp:api:type:ProductType).
      *
      *
      */

package/dist/declarations/src/generated/models/productvariants.d.ts

@@ -442,12 +442,12 @@ export interface TimeSetAttribute {
     readonly value: string[];
 }
 /**
- *	The data representation for a ProductVariant to be imported that is persisted as a [ProductVariant](/../api/projects/products#productvariant) in the Project.
+ *	The data representation for a ProductVariant to be imported that is persisted as a [ProductVariant](ctp:api:type:ProductVariant) in the Project.
  *
  */
 export interface ProductVariantImport extends ImportResource {
     /**
-     *	User-defined unique identifier. If a [ProductVariant](/../api/projects/products#productvariant) with this `key` exists on the specified `product`, it will be updated with the imported data.
+     *	User-defined unique identifier. If a [ProductVariant](ctp:api:type:ProductVariant) with this `key` exists on the specified `product`, it will be updated with the imported data.
      *
      */
     readonly key: string;
@@ -458,7 +458,7 @@ export interface ProductVariantImport extends ImportResource {
      */
     readonly sku?: string;
     /**
-     *	- When creating a new ProductVariant, set to `false`; otherwise, the import operation will fail with a [NewMasterVariantAdditionNotAllowed](/error#newmastervariantadditionnotallowederror) error.
+     *	- When creating a new ProductVariant, set to `false`; otherwise, the import operation will fail with a [NewMasterVariantAdditionNotAllowed](ctp:import:type:NewMasterVariantAdditionNotAllowedError) error.
      *	- Set to `true` if the ProductVariant exists and you want to set this ProductVariant as the Master Variant.
      *
      *
@@ -466,7 +466,7 @@ export interface ProductVariantImport extends ImportResource {
     readonly isMasterVariant: boolean;
     /**
      *	Maps to `ProductVariant.attributes`.
-     *	The referenced attribute must be defined in an already existing ProductType in the project, or the `state` of the [ImportOperation](/import-operation#importoperation) will be `unresolved`.
+     *	The referenced attribute must be defined in an already existing ProductType in the project, or the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be `unresolved`.
      *
      *
      */
@@ -491,39 +491,39 @@ export interface ProductVariantImport extends ImportResource {
      */
     readonly staged?: boolean;
     /**
-     *	The [Product](/../api/projects/products#productvariant) to which this Product Variant belongs. Maps to `ProductVariant.product`.
-     *	The Reference to the [Product](/../api/projects/products#product) with which the ProductVariant is associated.
-     *	If referenced Product does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Product is created.
+     *	The [Product](ctp:api:type:ProductVariant) to which this Product Variant belongs. Maps to `ProductVariant.product`.
+     *	The Reference to the [Product](ctp:api:type:Product) with which the ProductVariant is associated.
+     *	If referenced Product does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Product is created.
      *
      *
      */
     readonly product: ProductKeyReference;
 }
 /**
- *	Representation for an update of a [ProductVariant](/../api/projects/products#productvariant). Use this type to import updates for existing
- *	[ProductVariants](/../api/projects/products#productvariant) in a Project.
+ *	Representation for an update of a [ProductVariant](ctp:api:type:ProductVariant). Use this type to import updates for existing
+ *	[ProductVariants](ctp:api:type:ProductVariant) in a Project.
  *
  */
 export interface ProductVariantPatch {
     /**
-     *	Reference to the [ProductVariant](/../api/projects/products#productvariant) to update.
-     *	If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductVariant is created.
+     *	Reference to the [ProductVariant](ctp:api:type:ProductVariant) to update.
+     *	If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductVariant is created.
      *
      *
      */
     readonly productVariant: ProductVariantKeyReference;
     /**
      *	Maps to `ProductVariant.attributes`.
-     *	- The referenced Attribute must be defined in an existing [ProductType](/../api/projects/productTypes#producttype), or the `state` of the [ImportOperation](/import-operation#importoperation) will be `validationFailed`.
+     *	- The referenced Attribute must be defined in an existing [ProductType](ctp:api:type:ProductType), or the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be `validationFailed`.
      *	- Setting the value of a non-required Attribute to `null` will remove the Attribute.
-     *	- Attempting to set a `null` value to a required Attribute will make the import operation fail with an [InvalidOperation](/error#invalidoperation) error.
-     *	- Importing [LocalizableTextAttributes](/product-variant#localizabletextattribute) or [LocalizableTextSetAttributes](/product-variant#localizabletextsetattribute) follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to `null`.
+     *	- Attempting to set a `null` value to a required Attribute will make the import operation fail with an [InvalidOperation](ctp:import:type:InvalidOperation) error.
+     *	- Importing [LocalizableTextAttributes](ctp:import:type:LocalizableTextAttribute) or [LocalizableTextSetAttributes](ctp:import:type:LocalizableTextSetAttribute) follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to `null`.
      *
      *
      */
     readonly attributes?: Attributes;
     /**
-     *	If `false`, the attribute changes are applied to both [current and staged projected representations](/../api/projects/productProjections#current--staged) of the [Product](/../api/projects/products#product).
+     *	If `false`, the attribute changes are applied to both [current and staged projected representations](/projects/productProjections#current--staged) of the [Product](ctp:api:type:Product).
      *
      *
      */

package/dist/declarations/src/generated/models/standalone-prices.d.ts

@@ -6,12 +6,12 @@
 import { ChannelKeyReference, CustomerGroupKeyReference, DiscountedPrice, ImportResource, PriceTier, TypedMoney } from "./common.js";
 import { Custom } from "./customfields.js";
 /**
- *	The data representation for a Standalone Price to be imported that is persisted as a [Standalone Price](/../api/projects/standalone-prices#standaloneprice) in the Project.
+ *	The data representation for a Standalone Price to be imported that is persisted as a [Standalone Price](ctp:api:type:StandalonePrice)) in the Project.
  *
  */
 export interface StandalonePriceImport extends ImportResource {
     /**
-     *	User-defined unique identifier for the Standalone Price. If a [StandalonePrice](/../api/projects/standalone-prices#standaloneprice) with this `key` exists, it will be updated with the imported data.
+     *	User-defined unique identifier for the Standalone Price. If a [StandalonePrice](ctp:api:type:StandalonePrice)) with this `key` exists, it will be updated with the imported data.
      *
      *
      */
@@ -29,25 +29,25 @@ export interface StandalonePriceImport extends ImportResource {
      */
     readonly value: TypedMoney;
     /**
-     *	Sets the country for which this Price is valid.
+     *	Sets the country for this Price, if the Price does not yet have a country.
      *
-     *	The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error.
+     *	The country cannot be updated. Attempting to update the an existing country will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error.
      *
      *
      */
     readonly country?: string;
     /**
-     *	Sets the CustomerGroup for which this Price is valid.
+     *	Sets the CustomerGroup for this Price, if the Price does not yet have a CustomerGroup.
      *
-     *	The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error.
+     *	The CustomerGroup cannot be updated. Attempting to update an existing CustomerGroup will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error.
      *
      *
      */
     readonly customerGroup?: CustomerGroupKeyReference;
     /**
-     *	Sets the product distribution Channel for which this Price is valid.
+     *	Sets the product distribution Channel for this Price, if the Price does not yet have a Channel.
      *
-     *	The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error.
+     *	The Channel cannot be updated. Attempting to update an existing Channel will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error.
      *
      *
      */

package/dist/declarations/src/generated/models/types.d.ts

@@ -10,7 +10,7 @@ import { ImportResource, LocalizedString } from "./common.js";
  */
 export type TypeTextInputHint = 'MultiLine' | 'SingleLine' | string;
 /**
- *	With Types, you can model your own Custom Fields on the following resources and data types. Maps to `Type.resourceTypeId`.
+ *	IDs indicating the [type of resource](ctp:api:type:ResourceTypeId). Maps to `Type.resourceTypeIds`.
  *
  */
 export type ResourceTypeId = 'address' | 'asset' | 'business-unit' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'quote' | 'review' | 'shipping' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'standalone-price' | 'store' | 'transaction' | string;
@@ -22,13 +22,13 @@ export interface CustomFieldBooleanType {
     readonly name: 'Boolean';
 }
 /**
- *	Field type for [DateTime](ctp:import:type:DateTime) values.
+ *	Field type for [DateTime](ctp:api:type:DateTime) values.
  */
 export interface CustomFieldDateTimeType {
     readonly name: 'DateTime';
 }
 /**
- *	Field type for [Date](ctp:import:type:Date) values.
+ *	Field type for [Date](ctp:api:type:Date) values.
  */
 export interface CustomFieldDateType {
     readonly name: 'Date';
@@ -86,13 +86,13 @@ export interface CustomFieldLocalizedEnumValue {
     readonly label: LocalizedString;
 }
 /**
- *	Field type for [LocalizedString](ctp:import:type:LocalizedString) values.
+ *	Field type for [LocalizedString](ctp:api:type:LocalizedString) values.
  */
 export interface CustomFieldLocalizedStringType {
     readonly name: 'LocalizedString';
 }
 /**
- *	Field type for [CentPrecisionMoney](ctp:import:type:CentPrecisionMoney) values.
+ *	Field type for [CentPrecisionMoney](ctp:api:type:CentPrecisionMoney) values.
  */
 export interface CustomFieldMoneyType {
     readonly name: 'Money';
@@ -104,7 +104,7 @@ export interface CustomFieldNumberType {
     readonly name: 'Number';
 }
 /**
- *	Field type for [Reference](ctp:import:type:Reference) values.
+ *	Field type for [Reference](ctp:api:type:Reference) values.
  */
 export interface CustomFieldReferenceType {
     readonly name: 'Reference';
@@ -136,13 +136,13 @@ export interface CustomFieldStringType {
     readonly name: 'String';
 }
 /**
- *	Field type for [Time](ctp:import:type:Time) values.
+ *	Field type for [Time](ctp:api:type:Time) values.
  */
 export interface CustomFieldTimeType {
     readonly name: 'Time';
 }
 /**
- *	Defines a [Custom Field](/../api/projects/custom-fields) and its meta-information. Maps to `Type.FieldDefinition`.
+ *	Defines a [Custom Field](/projects/custom-fields) and its meta-information. Maps to `Type.FieldDefinition`.
  *
  */
 export interface FieldDefinition {
@@ -175,12 +175,12 @@ export interface FieldDefinition {
     readonly inputHint?: TypeTextInputHint;
 }
 /**
- *	The data representation for a Type to be imported that is persisted as a [Type](/../api/projects/types#type) in the Project.
+ *	The data representation for a Type to be imported that is persisted as a [Type](ctp:api:type:Type) in the Project.
  *
  */
 export interface TypeImport extends ImportResource {
     /**
-     *	User-defined unique identifier for the Type. If a [Type](/../api/projects/types#type) with this `key` exists, it will be updated with the imported data.
+     *	User-defined unique identifier for the Type. If a [Type](ctp:api:type:Type) with this `key` exists, it will be updated with the imported data.
      *
      *
      */

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "name": "@commercetools/importapi-sdk",
-  "version": "5.16.0",
+  "version": "5.18.0",
   "engines": {
     "node": ">=14"
   },