@commercetools/importapi-sdk 1.19.0 → 2.0.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.
Files changed (111) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/README.md +100 -18
  3. package/dist/commercetools-importapi-sdk.browser.cjs.js +2160 -2189
  4. package/dist/commercetools-importapi-sdk.browser.esm.js +2160 -2189
  5. package/dist/commercetools-importapi-sdk.cjs.dev.js +2160 -2189
  6. package/dist/commercetools-importapi-sdk.cjs.prod.js +2160 -2189
  7. package/dist/commercetools-importapi-sdk.esm.js +2160 -2189
  8. package/dist/declarations/src/ctp/ctp-client.d.ts +2 -2
  9. package/dist/declarations/src/generated/client/api-root.d.ts +18 -18
  10. package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts +52 -52
  11. package/dist/declarations/src/generated/client/categories/by-project-key-categories-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  12. package/dist/declarations/src/generated/client/categories/by-project-key-categories-request-builder.d.ts +28 -28
  13. package/dist/declarations/src/generated/client/customers/by-project-key-customers-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  14. package/dist/declarations/src/generated/client/customers/by-project-key-customers-request-builder.d.ts +28 -28
  15. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  16. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-request-builder.d.ts +26 -26
  17. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  18. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-request-builder.d.ts +26 -26
  19. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-by-import-container-key-request-builder.d.ts +55 -55
  20. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-request-builder.d.ts +51 -51
  21. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  22. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-request-builder.d.ts +26 -26
  23. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  24. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-request-builder.d.ts +26 -26
  25. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  26. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-request-builder.d.ts +26 -26
  27. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  28. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-request-builder.d.ts +26 -26
  29. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-by-import-container-key-request-builder.d.ts +36 -36
  30. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-request-builder.d.ts +26 -26
  31. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  32. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-request-builder.d.ts +26 -26
  33. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  34. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-request-builder.d.ts +26 -26
  35. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  36. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-request-builder.d.ts +26 -26
  37. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  38. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-request-builder.d.ts +26 -26
  39. package/dist/declarations/src/generated/client/import-operations/by-project-key-categories-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  40. package/dist/declarations/src/generated/client/import-operations/by-project-key-categories-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +49 -49
  41. package/dist/declarations/src/generated/client/import-operations/by-project-key-customers-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  42. package/dist/declarations/src/generated/client/import-operations/by-project-key-customers-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  43. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-containers-by-import-container-key-import-operations-request-builder.d.ts +45 -45
  44. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-by-id-request-builder.d.ts +35 -35
  45. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-request-builder.d.ts +26 -26
  46. package/dist/declarations/src/generated/client/import-operations/by-project-key-inventories-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  47. package/dist/declarations/src/generated/client/import-operations/by-project-key-inventories-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  48. package/dist/declarations/src/generated/client/import-operations/by-project-key-order-patches-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  49. package/dist/declarations/src/generated/client/import-operations/by-project-key-order-patches-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  50. package/dist/declarations/src/generated/client/import-operations/by-project-key-orders-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  51. package/dist/declarations/src/generated/client/import-operations/by-project-key-orders-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  52. package/dist/declarations/src/generated/client/import-operations/by-project-key-prices-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  53. package/dist/declarations/src/generated/client/import-operations/by-project-key-prices-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  54. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-drafts-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  55. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-drafts-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  56. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-types-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  57. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-types-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  58. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  59. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  60. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variants-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  61. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variants-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  62. package/dist/declarations/src/generated/client/import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  63. package/dist/declarations/src/generated/client/import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  64. package/dist/declarations/src/generated/client/import-sinks/by-project-key-import-sinks-by-import-sink-key-request-builder.d.ts +51 -51
  65. package/dist/declarations/src/generated/client/import-sinks/by-project-key-import-sinks-request-builder.d.ts +51 -51
  66. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-containers-by-import-container-key-import-summaries-request-builder.d.ts +35 -35
  67. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-summaries-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  68. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-summaries-request-builder.d.ts +26 -26
  69. package/dist/declarations/src/generated/client/inventories/by-project-key-inventories-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  70. package/dist/declarations/src/generated/client/inventories/by-project-key-inventories-request-builder.d.ts +28 -28
  71. package/dist/declarations/src/generated/client/order-patches/by-project-key-order-patches-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  72. package/dist/declarations/src/generated/client/order-patches/by-project-key-order-patches-request-builder.d.ts +28 -28
  73. package/dist/declarations/src/generated/client/orders/by-project-key-orders-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  74. package/dist/declarations/src/generated/client/orders/by-project-key-orders-request-builder.d.ts +28 -28
  75. package/dist/declarations/src/generated/client/prices/by-project-key-prices-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  76. package/dist/declarations/src/generated/client/prices/by-project-key-prices-request-builder.d.ts +28 -28
  77. package/dist/declarations/src/generated/client/product-drafts/by-project-key-product-drafts-import-sink-key-by-import-sink-key-request-builder.d.ts +38 -38
  78. package/dist/declarations/src/generated/client/product-drafts/by-project-key-product-drafts-request-builder.d.ts +28 -28
  79. package/dist/declarations/src/generated/client/product-types/by-project-key-product-types-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  80. package/dist/declarations/src/generated/client/product-types/by-project-key-product-types-request-builder.d.ts +28 -28
  81. package/dist/declarations/src/generated/client/product-variant-patches/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  82. package/dist/declarations/src/generated/client/product-variant-patches/by-project-key-product-variant-patches-request-builder.d.ts +28 -28
  83. package/dist/declarations/src/generated/client/product-variants/by-project-key-product-variants-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  84. package/dist/declarations/src/generated/client/product-variants/by-project-key-product-variants-request-builder.d.ts +28 -28
  85. package/dist/declarations/src/generated/client/products/by-project-key-products-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  86. package/dist/declarations/src/generated/client/products/by-project-key-products-request-builder.d.ts +28 -28
  87. package/dist/declarations/src/generated/index.d.ts +26 -26
  88. package/dist/declarations/src/generated/models/categories.d.ts +79 -79
  89. package/dist/declarations/src/generated/models/common.d.ts +570 -544
  90. package/dist/declarations/src/generated/models/customers.d.ts +252 -252
  91. package/dist/declarations/src/generated/models/customfields.d.ts +260 -260
  92. package/dist/declarations/src/generated/models/errors.d.ts +356 -352
  93. package/dist/declarations/src/generated/models/importcontainers.d.ts +114 -114
  94. package/dist/declarations/src/generated/models/importoperations.d.ts +128 -128
  95. package/dist/declarations/src/generated/models/importrequests.d.ts +175 -175
  96. package/dist/declarations/src/generated/models/importsinks.d.ts +113 -113
  97. package/dist/declarations/src/generated/models/importsummaries.d.ts +55 -55
  98. package/dist/declarations/src/generated/models/inventories.d.ts +44 -44
  99. package/dist/declarations/src/generated/models/order-patches.d.ts +227 -227
  100. package/dist/declarations/src/generated/models/orders.d.ts +778 -778
  101. package/dist/declarations/src/generated/models/prices.d.ts +130 -130
  102. package/dist/declarations/src/generated/models/productdrafts.d.ts +226 -224
  103. package/dist/declarations/src/generated/models/products.d.ts +181 -179
  104. package/dist/declarations/src/generated/models/producttypes.d.ts +173 -173
  105. package/dist/declarations/src/generated/models/productvariants.d.ts +529 -527
  106. package/dist/declarations/src/generated/shared/utils/common-types.d.ts +26 -26
  107. package/dist/declarations/src/generated/shared/utils/middleware.d.ts +8 -8
  108. package/dist/declarations/src/generated/shared/utils/requests-utils.d.ts +13 -13
  109. package/dist/declarations/src/generated/shared/utils/uri-utils.d.ts +7 -7
  110. package/dist/declarations/src/index.d.ts +2 -2
  111. package/package.json +5 -6
@@ -1,37 +1,37 @@
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 { ImportResponse, ProductImportRequest } from '../../models/importrequests';
7
- import { executeRequest } from '../../shared/utils/common-types';
8
- import { ApiRequest } from '../../shared/utils/requests-utils';
9
- import { ByProjectKeyProductsImportSinkKeyByImportSinkKeyImportOperationsRequestBuilder } from '../import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-request-builder';
10
- export declare class ByProjectKeyProductsImportSinkKeyByImportSinkKeyRequestBuilder {
11
- protected readonly args: {
12
- pathArgs: {
13
- projectKey: string;
14
- importSinkKey: string;
15
- };
16
- executeRequest: executeRequest;
17
- baseUri?: string;
18
- };
19
- constructor(args: {
20
- pathArgs: {
21
- projectKey: string;
22
- importSinkKey: string;
23
- };
24
- executeRequest: executeRequest;
25
- baseUri?: string;
26
- });
27
- importOperations(): ByProjectKeyProductsImportSinkKeyByImportSinkKeyImportOperationsRequestBuilder;
28
- /**
29
- * Creates import request for creating new products or updating existing ones.
30
- */
31
- post(methodArgs: {
32
- body: ProductImportRequest;
33
- headers?: {
34
- [key: string]: string | string[];
35
- };
36
- }): ApiRequest<ImportResponse>;
37
- }
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 { ImportResponse, ProductImportRequest } from '../../models/importrequests';
7
+ import { executeRequest } from '../../shared/utils/common-types';
8
+ import { ApiRequest } from '../../shared/utils/requests-utils';
9
+ import { ByProjectKeyProductsImportSinkKeyByImportSinkKeyImportOperationsRequestBuilder } from '../import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-request-builder';
10
+ export declare class ByProjectKeyProductsImportSinkKeyByImportSinkKeyRequestBuilder {
11
+ protected readonly args: {
12
+ pathArgs: {
13
+ projectKey: string;
14
+ importSinkKey: string;
15
+ };
16
+ executeRequest: executeRequest;
17
+ baseUri?: string;
18
+ };
19
+ constructor(args: {
20
+ pathArgs: {
21
+ projectKey: string;
22
+ importSinkKey: string;
23
+ };
24
+ executeRequest: executeRequest;
25
+ baseUri?: string;
26
+ });
27
+ importOperations(): ByProjectKeyProductsImportSinkKeyByImportSinkKeyImportOperationsRequestBuilder;
28
+ /**
29
+ * Creates import request for creating new products or updating existing ones.
30
+ */
31
+ post(methodArgs: {
32
+ body: ProductImportRequest;
33
+ headers?: {
34
+ [key: string]: string | string[];
35
+ };
36
+ }): ApiRequest<ImportResponse>;
37
+ }
@@ -1,28 +1,28 @@
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 { executeRequest } from '../../shared/utils/common-types';
7
- import { ByProjectKeyProductsImportContainersRequestBuilder } from '../import-containers/by-project-key-products-import-containers-request-builder';
8
- import { ByProjectKeyProductsImportSinkKeyByImportSinkKeyRequestBuilder } from './by-project-key-products-import-sink-key-by-import-sink-key-request-builder';
9
- export declare class ByProjectKeyProductsRequestBuilder {
10
- protected readonly args: {
11
- pathArgs: {
12
- projectKey: string;
13
- };
14
- executeRequest: executeRequest;
15
- baseUri?: string;
16
- };
17
- constructor(args: {
18
- pathArgs: {
19
- projectKey: string;
20
- };
21
- executeRequest: executeRequest;
22
- baseUri?: string;
23
- });
24
- importContainers(): ByProjectKeyProductsImportContainersRequestBuilder;
25
- importSinkKeyWithImportSinkKeyValue(childPathArgs: {
26
- importSinkKey: string;
27
- }): ByProjectKeyProductsImportSinkKeyByImportSinkKeyRequestBuilder;
28
- }
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 { executeRequest } from '../../shared/utils/common-types';
7
+ import { ByProjectKeyProductsImportContainersRequestBuilder } from '../import-containers/by-project-key-products-import-containers-request-builder';
8
+ import { ByProjectKeyProductsImportSinkKeyByImportSinkKeyRequestBuilder } from './by-project-key-products-import-sink-key-by-import-sink-key-request-builder';
9
+ export declare class ByProjectKeyProductsRequestBuilder {
10
+ protected readonly args: {
11
+ pathArgs: {
12
+ projectKey: string;
13
+ };
14
+ executeRequest: executeRequest;
15
+ baseUri?: string;
16
+ };
17
+ constructor(args: {
18
+ pathArgs: {
19
+ projectKey: string;
20
+ };
21
+ executeRequest: executeRequest;
22
+ baseUri?: string;
23
+ });
24
+ importContainers(): ByProjectKeyProductsImportContainersRequestBuilder;
25
+ importSinkKeyWithImportSinkKeyValue(childPathArgs: {
26
+ importSinkKey: string;
27
+ }): ByProjectKeyProductsImportSinkKeyByImportSinkKeyRequestBuilder;
28
+ }
@@ -1,26 +1,26 @@
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
- export * from './client/api-root';
7
- export * from './models/categories';
8
- export * from './models/common';
9
- export * from './models/customers';
10
- export * from './models/customfields';
11
- export * from './models/errors';
12
- export * from './models/importcontainers';
13
- export * from './models/importoperations';
14
- export * from './models/importrequests';
15
- export * from './models/importsinks';
16
- export * from './models/importsummaries';
17
- export * from './models/inventories';
18
- export * from './models/order-patches';
19
- export * from './models/orders';
20
- export * from './models/prices';
21
- export * from './models/productdrafts';
22
- export * from './models/products';
23
- export * from './models/producttypes';
24
- export * from './models/productvariants';
25
- export * from './shared/utils/common-types';
26
- export * from './shared/utils/middleware';
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
+ export * from './client/api-root';
7
+ export * from './models/categories';
8
+ export * from './models/common';
9
+ export * from './models/customers';
10
+ export * from './models/customfields';
11
+ export * from './models/errors';
12
+ export * from './models/importcontainers';
13
+ export * from './models/importoperations';
14
+ export * from './models/importrequests';
15
+ export * from './models/importsinks';
16
+ export * from './models/importsummaries';
17
+ export * from './models/inventories';
18
+ export * from './models/order-patches';
19
+ export * from './models/orders';
20
+ export * from './models/prices';
21
+ export * from './models/productdrafts';
22
+ export * from './models/products';
23
+ export * from './models/producttypes';
24
+ export * from './models/productvariants';
25
+ export * from './shared/utils/common-types';
26
+ export * from './shared/utils/middleware';
@@ -1,79 +1,79 @@
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 { Asset, CategoryKeyReference, ImportResource, LocalizedString } from './common';
7
- import { Custom } from './customfields';
8
- /**
9
- * The data representation for a Category to be imported that is persisted as a [Category](/../api/projects/categories#category) in the Project.
10
- *
11
- */
12
- export interface CategoryImport extends ImportResource {
13
- /**
14
- * Maps to `Category.name`.
15
- *
16
- *
17
- */
18
- readonly name: LocalizedString;
19
- /**
20
- * Maps to `Category.slug`.
21
- * Must match the pattern `[-a-zA-Z0-9_]{2,256}`.
22
- *
23
- *
24
- */
25
- readonly slug: LocalizedString;
26
- /**
27
- * Maps to `Category.description`.
28
- *
29
- *
30
- */
31
- readonly description?: LocalizedString;
32
- /**
33
- * Maps to `Category.parent`.
34
- * The Reference to the parent [Category](/../api/projects/categories#category) with which the Category is associated.
35
- * If referenced Category does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Category is created.
36
- *
37
- *
38
- */
39
- readonly parent?: CategoryKeyReference;
40
- /**
41
- * Maps to `Category.orderHint`.
42
- *
43
- *
44
- */
45
- readonly orderHint?: string;
46
- /**
47
- * Maps to `Category.externalId`.
48
- *
49
- *
50
- */
51
- readonly externalId?: string;
52
- /**
53
- * Maps to `Category.metaTitle`.
54
- *
55
- *
56
- */
57
- readonly metaTitle?: LocalizedString;
58
- /**
59
- * Maps to `Category.metaDescription`.
60
- *
61
- *
62
- */
63
- readonly metaDescription?: LocalizedString;
64
- /**
65
- * Maps to `Category.metaKeywords`.
66
- *
67
- *
68
- */
69
- readonly metaKeywords?: LocalizedString;
70
- /**
71
- *
72
- */
73
- readonly assets?: Asset[];
74
- /**
75
- * The custom fields for this Category.
76
- *
77
- */
78
- readonly custom?: Custom;
79
- }
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 { Asset, CategoryKeyReference, ImportResource, LocalizedString } from './common';
7
+ import { Custom } from './customfields';
8
+ /**
9
+ * The data representation for a Category to be imported that is persisted as a [Category](/../api/projects/categories#category) in the Project.
10
+ *
11
+ */
12
+ export interface CategoryImport extends ImportResource {
13
+ /**
14
+ * Maps to `Category.name`.
15
+ *
16
+ *
17
+ */
18
+ readonly name: LocalizedString;
19
+ /**
20
+ * Maps to `Category.slug`.
21
+ * Must match the pattern `[-a-zA-Z0-9_]{2,256}`.
22
+ *
23
+ *
24
+ */
25
+ readonly slug: LocalizedString;
26
+ /**
27
+ * Maps to `Category.description`.
28
+ *
29
+ *
30
+ */
31
+ readonly description?: LocalizedString;
32
+ /**
33
+ * Maps to `Category.parent`.
34
+ * The Reference to the parent [Category](/../api/projects/categories#category) with which the Category is associated.
35
+ * If referenced Category does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Category is created.
36
+ *
37
+ *
38
+ */
39
+ readonly parent?: CategoryKeyReference;
40
+ /**
41
+ * Maps to `Category.orderHint`.
42
+ *
43
+ *
44
+ */
45
+ readonly orderHint?: string;
46
+ /**
47
+ * Maps to `Category.externalId`.
48
+ *
49
+ *
50
+ */
51
+ readonly externalId?: string;
52
+ /**
53
+ * Maps to `Category.metaTitle`.
54
+ *
55
+ *
56
+ */
57
+ readonly metaTitle?: LocalizedString;
58
+ /**
59
+ * Maps to `Category.metaDescription`.
60
+ *
61
+ *
62
+ */
63
+ readonly metaDescription?: LocalizedString;
64
+ /**
65
+ * Maps to `Category.metaKeywords`.
66
+ *
67
+ *
68
+ */
69
+ readonly metaKeywords?: LocalizedString;
70
+ /**
71
+ *
72
+ */
73
+ readonly assets?: Asset[];
74
+ /**
75
+ * The custom fields for this Category.
76
+ *
77
+ */
78
+ readonly custom?: Custom;
79
+ }