@contrail/entity-types 1.5.1-alpha.0 → 1.5.2

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 (191) hide show
  1. package/.npmrc.bak +1 -0
  2. package/docs/.nojekyll +1 -0
  3. package/docs/assets/highlight.css +64 -0
  4. package/docs/assets/icons.js +15 -0
  5. package/docs/assets/icons.svg +1 -0
  6. package/docs/assets/main.js +59 -0
  7. package/docs/assets/navigation.js +1 -0
  8. package/docs/assets/search.js +1 -0
  9. package/docs/assets/style.css +1414 -0
  10. package/docs/classes/ApiError.html +14 -0
  11. package/docs/classes/AssortmentSplit.html +7 -0
  12. package/docs/classes/ColumnDefinition.html +7 -0
  13. package/docs/classes/ConditionalValues.html +5 -0
  14. package/docs/classes/EntitiesClient.html +26 -0
  15. package/docs/classes/EntitiesClientBatchCreateOptions.html +12 -0
  16. package/docs/classes/EntitiesClientBatchDeleteOptions.html +13 -0
  17. package/docs/classes/EntitiesClientBatchUpdateOptions.html +12 -0
  18. package/docs/classes/EntitiesClientCreateOptions.html +20 -0
  19. package/docs/classes/EntitiesClientDeleteOptions.html +17 -0
  20. package/docs/classes/EntitiesClientGetOptions.html +39 -0
  21. package/docs/classes/EntitiesClientUpdateOptions.html +25 -0
  22. package/docs/classes/EntityReference.html +7 -0
  23. package/docs/classes/InvalidPolicyError.html +13 -0
  24. package/docs/classes/LoaderProcess.html +44 -0
  25. package/docs/classes/TimeoutError.html +13 -0
  26. package/docs/classes/ValueToAssortment.html +6 -0
  27. package/docs/enums/API_VERSION.html +7 -0
  28. package/docs/enums/AppAccessGrantScope.html +3 -0
  29. package/docs/enums/AppExtensionType.html +6 -0
  30. package/docs/enums/AppExtensionUserApps.html +7 -0
  31. package/docs/enums/AppOrgStatus.html +7 -0
  32. package/docs/enums/AppVersionStatus.html +8 -0
  33. package/docs/enums/AssortmentType.html +7 -0
  34. package/docs/enums/EntityType.html +7 -0
  35. package/docs/enums/IssueType.html +11 -0
  36. package/docs/enums/LoadStatus.html +7 -0
  37. package/docs/enums/LoadType.html +9 -0
  38. package/docs/enums/LoaderFailureArea.html +7 -0
  39. package/docs/enums/LogLevel.html +8 -0
  40. package/docs/enums/NodeRuntime.html +4 -0
  41. package/docs/enums/PropertyType.html +27 -0
  42. package/docs/enums/SharedLinkAccessLevel.html +7 -0
  43. package/docs/enums/SortOrderOptions.html +5 -0
  44. package/docs/enums/SubscriptionChannel.html +5 -0
  45. package/docs/enums/SubscriptionType.html +9 -0
  46. package/docs/enums/UserOrgRole.html +5 -0
  47. package/docs/enums/WorkspacePrincipalRole.html +5 -0
  48. package/docs/enums/WorkspaceType.html +5 -0
  49. package/docs/functions/isValidNodeRuntime.html +2 -0
  50. package/docs/home-hero.svg +11 -0
  51. package/docs/index.html +5 -0
  52. package/docs/interfaces/App.html +26 -0
  53. package/docs/interfaces/AppAccessGrant.html +15 -0
  54. package/docs/interfaces/AppApiKey.html +15 -0
  55. package/docs/interfaces/AppCodePackage.html +16 -0
  56. package/docs/interfaces/AppExtension.html +20 -0
  57. package/docs/interfaces/AppExtensionDefinition.html +19 -0
  58. package/docs/interfaces/AppOrg.html +17 -0
  59. package/docs/interfaces/AppVersion.html +22 -0
  60. package/docs/interfaces/Asset.html +25 -0
  61. package/docs/interfaces/Assortment.html +32 -0
  62. package/docs/interfaces/AssortmentItem.html +27 -0
  63. package/docs/interfaces/AssortmentSummary.html +16 -0
  64. package/docs/interfaces/Color.html +19 -0
  65. package/docs/interfaces/ColumnIssueDetails.html +6 -0
  66. package/docs/interfaces/CompositePlansSummary.html +16 -0
  67. package/docs/interfaces/ConfigProperty.html +6 -0
  68. package/docs/interfaces/Content.html +29 -0
  69. package/docs/interfaces/ContentHolderContent.html +12 -0
  70. package/docs/interfaces/EntityLoadResult.html +10 -0
  71. package/docs/interfaces/ExternalLink.html +7 -0
  72. package/docs/interfaces/ExternalLinkExtraAttribute.html +4 -0
  73. package/docs/interfaces/File.html +20 -0
  74. package/docs/interfaces/GeneralIssueDetails.html +4 -0
  75. package/docs/interfaces/Group.html +14 -0
  76. package/docs/interfaces/GroupPrincipal.html +16 -0
  77. package/docs/interfaces/Item.html +25 -0
  78. package/docs/interfaces/LoadResult.html +13 -0
  79. package/docs/interfaces/LoaderConfiguration.html +16 -0
  80. package/docs/interfaces/LoaderNumbersSummary.html +14 -0
  81. package/docs/interfaces/Org.html +13 -0
  82. package/docs/interfaces/PreprocessingStepStoredResultSummary.html +6 -0
  83. package/docs/interfaces/ProcessedData.html +9 -0
  84. package/docs/interfaces/ProcessingIssues.html +4 -0
  85. package/docs/interfaces/Project.html +11 -0
  86. package/docs/interfaces/ProjectItem.html +18 -0
  87. package/docs/interfaces/PropertyTypeMetaData.html +5 -0
  88. package/docs/interfaces/RowLoadError.html +4 -0
  89. package/docs/interfaces/SharedLink.html +22 -0
  90. package/docs/interfaces/SharedLinkPrincipal.html +18 -0
  91. package/docs/interfaces/SortOption.html +4 -0
  92. package/docs/interfaces/Subscription.html +18 -0
  93. package/docs/interfaces/TriggerKeyDefinition.html +6 -0
  94. package/docs/interfaces/User.html +14 -0
  95. package/docs/interfaces/UserOrg.html +19 -0
  96. package/docs/interfaces/Workspace.html +29 -0
  97. package/docs/interfaces/WorkspacePrincipal.html +21 -0
  98. package/docs/modules.html +94 -0
  99. package/docs/types/BatchFetchResponse.html +2 -0
  100. package/docs/types/SubscriptionMatrix.html +2 -0
  101. package/docs/variables/BOARD_APP_SUBSCRIBED_TO_CONST.html +2 -0
  102. package/docs/variables/DEFAULT_API_VERSION.html +2 -0
  103. package/docs/variables/PLAN_APP_SUBSCRIBED_TO_CONST.html +2 -0
  104. package/docs/variables/SHOWCASE_APP_SUBSCRIBED_TO_CONST.html +2 -0
  105. package/lib/action-definition-config.d.ts +6 -6
  106. package/lib/action-definition-config.js +2 -2
  107. package/lib/app-access-grant.d.ts +15 -15
  108. package/lib/app-access-grant.js +7 -7
  109. package/lib/app-api-key.d.ts +15 -15
  110. package/lib/app-api-key.js +2 -2
  111. package/lib/app-code-package.d.ts +17 -17
  112. package/lib/app-code-package.js +2 -2
  113. package/lib/app-extension-definition.d.ts +53 -34
  114. package/lib/app-extension-definition.js +18 -18
  115. package/lib/app-extension.d.ts +24 -23
  116. package/lib/app-extension.js +2 -2
  117. package/lib/app-org.d.ts +20 -20
  118. package/lib/app-org.js +11 -11
  119. package/lib/app-version.d.ts +57 -57
  120. package/lib/app-version.js +21 -21
  121. package/lib/app.d.ts +25 -25
  122. package/lib/app.js +2 -2
  123. package/lib/asset.d.ts +16 -16
  124. package/lib/asset.js +2 -2
  125. package/lib/assortment-item.d.ts +27 -27
  126. package/lib/assortment-item.js +2 -2
  127. package/lib/assortment-publish-change.d.ts +48 -0
  128. package/lib/assortment-publish-change.js +2 -0
  129. package/lib/assortment-summary.d.ts +15 -15
  130. package/lib/assortment-summary.js +2 -2
  131. package/lib/assortment.d.ts +39 -39
  132. package/lib/assortment.js +11 -11
  133. package/lib/base-managed-entity.d.ts +8 -8
  134. package/lib/base-managed-entity.js +2 -2
  135. package/lib/batch-fetch-response.d.ts +11 -11
  136. package/lib/batch-fetch-response.js +2 -2
  137. package/lib/client.d.ts +107 -107
  138. package/lib/client.js +114 -114
  139. package/lib/color.d.ts +14 -14
  140. package/lib/color.js +2 -2
  141. package/lib/composite-plans-summary.d.ts +15 -15
  142. package/lib/composite-plans-summary.js +2 -2
  143. package/lib/content-custom-size.d.ts +14 -14
  144. package/lib/content-custom-size.js +2 -2
  145. package/lib/content.d.ts +25 -25
  146. package/lib/content.js +2 -2
  147. package/lib/contentholder-content.d.ts +5 -5
  148. package/lib/contentholder-content.js +2 -2
  149. package/lib/event-workflow-action-definition.d.ts +21 -21
  150. package/lib/event-workflow-action-definition.js +2 -2
  151. package/lib/event-workflow-process.d.ts +27 -27
  152. package/lib/event-workflow-process.js +11 -11
  153. package/lib/event-workflow-task.d.ts +30 -30
  154. package/lib/event-workflow-task.js +2 -2
  155. package/lib/file.d.ts +13 -13
  156. package/lib/file.js +2 -2
  157. package/lib/index.d.ts +40 -39
  158. package/lib/index.js +56 -55
  159. package/lib/item.d.ts +20 -20
  160. package/lib/item.js +2 -2
  161. package/lib/loader.d.ts +182 -183
  162. package/lib/loader.js +115 -116
  163. package/lib/log-level.d.ts +8 -8
  164. package/lib/log-level.js +12 -12
  165. package/lib/org-managed-entity.d.ts +5 -5
  166. package/lib/org-managed-entity.js +2 -2
  167. package/lib/org.d.ts +11 -11
  168. package/lib/org.js +2 -2
  169. package/lib/project-configuration.d.ts +39 -39
  170. package/lib/project-configuration.js +9 -9
  171. package/lib/project-item.d.ts +9 -9
  172. package/lib/project-item.js +2 -2
  173. package/lib/project.d.ts +4 -4
  174. package/lib/project.js +2 -2
  175. package/lib/property-type.d.ts +32 -32
  176. package/lib/property-type.js +31 -31
  177. package/lib/shared-links.d.ts +46 -46
  178. package/lib/shared-links.js +11 -11
  179. package/lib/subscription.d.ts +38 -38
  180. package/lib/subscription.js +22 -22
  181. package/lib/type-managed-entity.d.ts +8 -8
  182. package/lib/type-managed-entity.js +2 -2
  183. package/lib/user.d.ts +79 -79
  184. package/lib/user.js +20 -20
  185. package/lib/workspace-managed-entity.d.ts +5 -5
  186. package/lib/workspace-managed-entity.js +2 -2
  187. package/lib/workspace-principal.d.ts +24 -24
  188. package/lib/workspace-principal.js +9 -9
  189. package/lib/workspace.d.ts +32 -32
  190. package/lib/workspace.js +9 -9
  191. package/package.json +1 -1
package/lib/index.d.ts CHANGED
@@ -1,39 +1,40 @@
1
- export * from './action-definition-config';
2
- export * from './app';
3
- export * from './app-access-grant';
4
- export * from './app-api-key';
5
- export * from './app-code-package';
6
- export * from './app-extension';
7
- export * from './app-extension-definition';
8
- export * from './app-org';
9
- export * from './app-version';
10
- export * from './asset';
11
- export * from './assortment';
12
- export * from './assortment-item';
13
- export * from './assortment-summary';
14
- export * from './base-managed-entity';
15
- export * from './batch-fetch-response';
16
- export * from './client';
17
- export * from './color';
18
- export * from './composite-plans-summary';
19
- export * from './content';
20
- export * from './contentholder-content';
21
- export * from './event-workflow-action-definition';
22
- export * from './event-workflow-process';
23
- export * from './event-workflow-task';
24
- export * from './file';
25
- export * from './item';
26
- export * from './loader';
27
- export * from './log-level';
28
- export * from './org';
29
- export * from './org-managed-entity';
30
- export * from './project';
31
- export * from './project-item';
32
- export * from './property-type';
33
- export * from './shared-links';
34
- export * from './subscription';
35
- export * from './type-managed-entity';
36
- export * from './user';
37
- export * from './workspace';
38
- export * from './workspace-managed-entity';
39
- export * from './workspace-principal';
1
+ export * from './action-definition-config';
2
+ export * from './app';
3
+ export * from './app-access-grant';
4
+ export * from './app-api-key';
5
+ export * from './app-code-package';
6
+ export * from './app-extension';
7
+ export * from './app-extension-definition';
8
+ export * from './app-org';
9
+ export * from './app-version';
10
+ export * from './asset';
11
+ export * from './assortment';
12
+ export * from './assortment-item';
13
+ export * from './assortment-publish-change';
14
+ export * from './assortment-summary';
15
+ export * from './base-managed-entity';
16
+ export * from './batch-fetch-response';
17
+ export * from './client';
18
+ export * from './color';
19
+ export * from './composite-plans-summary';
20
+ export * from './content';
21
+ export * from './contentholder-content';
22
+ export * from './event-workflow-action-definition';
23
+ export * from './event-workflow-process';
24
+ export * from './event-workflow-task';
25
+ export * from './file';
26
+ export * from './item';
27
+ export * from './loader';
28
+ export * from './log-level';
29
+ export * from './org';
30
+ export * from './org-managed-entity';
31
+ export * from './project';
32
+ export * from './project-item';
33
+ export * from './property-type';
34
+ export * from './shared-links';
35
+ export * from './subscription';
36
+ export * from './type-managed-entity';
37
+ export * from './user';
38
+ export * from './workspace';
39
+ export * from './workspace-managed-entity';
40
+ export * from './workspace-principal';
package/lib/index.js CHANGED
@@ -1,55 +1,56 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./action-definition-config"), exports);
18
- __exportStar(require("./app"), exports);
19
- __exportStar(require("./app-access-grant"), exports);
20
- __exportStar(require("./app-api-key"), exports);
21
- __exportStar(require("./app-code-package"), exports);
22
- __exportStar(require("./app-extension"), exports);
23
- __exportStar(require("./app-extension-definition"), exports);
24
- __exportStar(require("./app-org"), exports);
25
- __exportStar(require("./app-version"), exports);
26
- __exportStar(require("./asset"), exports);
27
- __exportStar(require("./assortment"), exports);
28
- __exportStar(require("./assortment-item"), exports);
29
- __exportStar(require("./assortment-summary"), exports);
30
- __exportStar(require("./base-managed-entity"), exports);
31
- __exportStar(require("./batch-fetch-response"), exports);
32
- __exportStar(require("./client"), exports);
33
- __exportStar(require("./color"), exports);
34
- __exportStar(require("./composite-plans-summary"), exports);
35
- __exportStar(require("./content"), exports);
36
- __exportStar(require("./contentholder-content"), exports);
37
- __exportStar(require("./event-workflow-action-definition"), exports);
38
- __exportStar(require("./event-workflow-process"), exports);
39
- __exportStar(require("./event-workflow-task"), exports);
40
- __exportStar(require("./file"), exports);
41
- __exportStar(require("./item"), exports);
42
- __exportStar(require("./loader"), exports);
43
- __exportStar(require("./log-level"), exports);
44
- __exportStar(require("./org"), exports);
45
- __exportStar(require("./org-managed-entity"), exports);
46
- __exportStar(require("./project"), exports);
47
- __exportStar(require("./project-item"), exports);
48
- __exportStar(require("./property-type"), exports);
49
- __exportStar(require("./shared-links"), exports);
50
- __exportStar(require("./subscription"), exports);
51
- __exportStar(require("./type-managed-entity"), exports);
52
- __exportStar(require("./user"), exports);
53
- __exportStar(require("./workspace"), exports);
54
- __exportStar(require("./workspace-managed-entity"), exports);
55
- __exportStar(require("./workspace-principal"), exports);
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./action-definition-config"), exports);
18
+ __exportStar(require("./app"), exports);
19
+ __exportStar(require("./app-access-grant"), exports);
20
+ __exportStar(require("./app-api-key"), exports);
21
+ __exportStar(require("./app-code-package"), exports);
22
+ __exportStar(require("./app-extension"), exports);
23
+ __exportStar(require("./app-extension-definition"), exports);
24
+ __exportStar(require("./app-org"), exports);
25
+ __exportStar(require("./app-version"), exports);
26
+ __exportStar(require("./asset"), exports);
27
+ __exportStar(require("./assortment"), exports);
28
+ __exportStar(require("./assortment-item"), exports);
29
+ __exportStar(require("./assortment-publish-change"), exports);
30
+ __exportStar(require("./assortment-summary"), exports);
31
+ __exportStar(require("./base-managed-entity"), exports);
32
+ __exportStar(require("./batch-fetch-response"), exports);
33
+ __exportStar(require("./client"), exports);
34
+ __exportStar(require("./color"), exports);
35
+ __exportStar(require("./composite-plans-summary"), exports);
36
+ __exportStar(require("./content"), exports);
37
+ __exportStar(require("./contentholder-content"), exports);
38
+ __exportStar(require("./event-workflow-action-definition"), exports);
39
+ __exportStar(require("./event-workflow-process"), exports);
40
+ __exportStar(require("./event-workflow-task"), exports);
41
+ __exportStar(require("./file"), exports);
42
+ __exportStar(require("./item"), exports);
43
+ __exportStar(require("./loader"), exports);
44
+ __exportStar(require("./log-level"), exports);
45
+ __exportStar(require("./org"), exports);
46
+ __exportStar(require("./org-managed-entity"), exports);
47
+ __exportStar(require("./project"), exports);
48
+ __exportStar(require("./project-item"), exports);
49
+ __exportStar(require("./property-type"), exports);
50
+ __exportStar(require("./shared-links"), exports);
51
+ __exportStar(require("./subscription"), exports);
52
+ __exportStar(require("./type-managed-entity"), exports);
53
+ __exportStar(require("./user"), exports);
54
+ __exportStar(require("./workspace"), exports);
55
+ __exportStar(require("./workspace-managed-entity"), exports);
56
+ __exportStar(require("./workspace-principal"), exports);
package/lib/item.d.ts CHANGED
@@ -1,20 +1,20 @@
1
- import { TypeManagedEntity } from './type-managed-entity';
2
- export interface Item extends TypeManagedEntity {
3
- itemFamilyId?: string;
4
- itemFamily?: Item;
5
- itemOptions?: {
6
- [key: string]: Array<Item>;
7
- };
8
- name: string;
9
- primaryViewableId?: string;
10
- federatedId?: string;
11
- assortmentItems?: any[];
12
- assortmentAtts?: {
13
- [key: string]: any;
14
- };
15
- optionGroup?: string;
16
- optionName?: string;
17
- isPrimary?: boolean;
18
- roles?: Array<string>;
19
- [key: string]: any;
20
- }
1
+ import { TypeManagedEntity } from './type-managed-entity';
2
+ export interface Item extends TypeManagedEntity {
3
+ itemFamilyId?: string;
4
+ itemFamily?: Item;
5
+ itemOptions?: {
6
+ [key: string]: Array<Item>;
7
+ };
8
+ name: string;
9
+ primaryViewableId?: string;
10
+ federatedId?: string;
11
+ assortmentItems?: any[];
12
+ assortmentAtts?: {
13
+ [key: string]: any;
14
+ };
15
+ optionGroup?: string;
16
+ optionName?: string;
17
+ isPrimary?: boolean;
18
+ roles?: Array<string>;
19
+ [key: string]: any;
20
+ }
package/lib/item.js CHANGED
@@ -1,2 +1,2 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/lib/loader.d.ts CHANGED
@@ -1,183 +1,182 @@
1
- import { LogLevel } from './log-level';
2
- import { OrgManagedEntity } from './org-managed-entity';
3
- export declare class ColumnDefinition {
4
- fromProperty?: string;
5
- toProperty: string;
6
- conditions?: ConditionalValues[];
7
- default?: any;
8
- }
9
- export declare class ConditionalValues {
10
- conditional: string;
11
- value: string;
12
- }
13
- export declare class AssortmentSplit {
14
- partialAssortmentUpdate?: boolean;
15
- dropField?: string;
16
- fieldToSplitOn: string;
17
- values: ValueToAssortment[];
18
- }
19
- export declare class ValueToAssortment {
20
- value: string;
21
- assortmentId?: string;
22
- assortmentIdentifier?: string;
23
- }
24
- export interface LoaderConfiguration extends OrgManagedEntity {
25
- name?: string;
26
- federatedMappings?: any;
27
- conditionalColumns?: ColumnDefinition[];
28
- assortmentSplit?: AssortmentSplit;
29
- workspaceIdentifier?: string;
30
- propertiesToRemove?: string[];
31
- }
32
- export declare enum LoadStatus {
33
- ACTIVE = "ACTIVE",
34
- PENDING = "PENDING",
35
- FAILED = "FAILED",
36
- COMPLETE = "COMPLETE",
37
- CANCELED = "CANCELED"
38
- }
39
- export declare enum LoadType {
40
- ITEM = "ITEM",
41
- PROJECT_ITEM = "PROJECT_ITEM",
42
- ASSORTMENT = "ASSORTMENT",
43
- COLOR = "COLOR",
44
- CUSTOM_ENTITY = "CUSTOM_ENTITY",
45
- SIZE_RANGE_TEMPLATE = "SIZE_RANGE_TEMPLATE",
46
- PROJECT = "PROJECT"
47
- }
48
- export interface LoadResult {
49
- colorsLoadResult?: EntityLoadResult;
50
- customEntitiesLoadResult?: EntityLoadResult;
51
- itemsLoadResult?: EntityLoadResult;
52
- projectItemsLoadResult?: EntityLoadResult;
53
- assortmentItemsLoadResult?: EntityLoadResult;
54
- transformErrors: any[];
55
- transformWarnings?: any[];
56
- generalErrors?: GeneralIssueDetails[];
57
- generalWarnings?: GeneralIssueDetails[];
58
- systemErrors?: GeneralIssueDetails[];
59
- failureArea?: LoaderFailureArea;
60
- }
61
- export interface RowLoadError {
62
- data: any;
63
- error: any;
64
- }
65
- export interface LoaderNumbersSummary {
66
- numberFamiliesLoaded: number;
67
- numberOptionsLoaded: number;
68
- numberProjectItemsLoaded: number;
69
- numberAssortmentItemsLoaded: number;
70
- numberColorsLoaded: number;
71
- numberImagesLoaded: number;
72
- numberFamiliesFailed: number;
73
- numberOptionsFailed: number;
74
- numberProjectItemsFailed: number;
75
- numberAssortmentItemsFailed: number;
76
- numberColorsFailed: number;
77
- numberImagesFailed: number;
78
- }
79
- export interface ProcessingIssues {
80
- rowNumber: number;
81
- columnIssues: ColumnIssueDetails[];
82
- }
83
- export interface ColumnIssueDetails {
84
- columnName: string;
85
- message: string;
86
- issueType: IssueType;
87
- data: string;
88
- }
89
- export interface GeneralIssueDetails {
90
- message: string;
91
- issueType: IssueType;
92
- }
93
- export interface EntityLoadResult {
94
- created: any[];
95
- updated: any[];
96
- unchanged: any[];
97
- deleted: any[];
98
- failedCreate: RowLoadError[];
99
- failedUpdate: RowLoadError[];
100
- failedDelete: RowLoadError[];
101
- failed: boolean;
102
- }
103
- export interface PreprocessingStepStoredResultSummary {
104
- preprocessingStepName: string;
105
- fileId: string;
106
- numberOfWarnings: number;
107
- numberOfErrors: number;
108
- }
109
- export interface ProcessedData {
110
- csvRows: any[];
111
- transformationErrors: ProcessingIssues[];
112
- transformationWarnings: ProcessingIssues[];
113
- generalErrors: GeneralIssueDetails[];
114
- generalWarnings: GeneralIssueDetails[];
115
- systemErrors: GeneralIssueDetails[];
116
- failureArea: LoaderFailureArea;
117
- }
118
- export declare class LoaderProcess implements OrgManagedEntity {
119
- id: string;
120
- createdOn?: Date;
121
- updatedOn?: Date;
122
- createdById?: string;
123
- updatedById?: string;
124
- createdBy?: any;
125
- updatedBy?: any;
126
- orgId?: string;
127
- loaderConfigurationId?: string;
128
- name?: string;
129
- endedOn?: Date;
130
- status: LoadStatus;
131
- logLevel?: LogLevel;
132
- processLogs?: string;
133
- processLogS3File?: string;
134
- processLogS3FileDownloadLink?: string;
135
- logsFileId?: string;
136
- logFileDownloadLink?: string;
137
- loadProcessResult?: LoadResult;
138
- loadProcessResultFileId?: string;
139
- loadProcessResultDownloadLink?: string;
140
- preprocessingStepResults?: PreprocessingStepStoredResultSummary[];
141
- processDurationSeconds?: number;
142
- loadFileId: string;
143
- loadType: LoadType[];
144
- federatedMappings?: any;
145
- conditionalColumns?: ColumnDefinition[];
146
- assortmentSplit?: AssortmentSplit;
147
- partialAssortmentUpdate?: boolean;
148
- assortmentItemDropField?: string;
149
- directAssortmentItemLoad?: boolean;
150
- workspaceIdentifier?: string;
151
- propertiesToRemove?: string[];
152
- badRowsCount?: number;
153
- uploadErrorCount?: number;
154
- hasErrors?: boolean;
155
- parallelWorkerCount?: number;
156
- messageGroupId?: string;
157
- isPartialFailure?: boolean;
158
- }
159
- export declare enum IssueType {
160
- CONFIG = "CONFIG",
161
- INVALID_DATA = "INVALID_DATA",
162
- MISSING_DATA = "MISSING_DATA",
163
- DUPLICATE_FEDERATED_ID = "DUPLICATE_FEDERATED_ID",
164
- SYSTEM_ERROR = "SYSTEM_ERROR",
165
- HEADER_MISMATCH = "HEADER_MISMATCH",
166
- VALIDATION_ERROR = "VALIDATION_ERROR",
167
- PERMISSION_DENIED = "PERMISSION_DENIED",
168
- UNKNOWN_ERROR = "UNKNOWN_ERROR"
169
- }
170
- export declare enum LoaderFailureArea {
171
- PARSING_CSV = "PARSING_CSV",
172
- TRANSFORMING_DATA = "TRANSFORMING_DATA",
173
- UPLOADING_DATA = "UPLOADING_DATA",
174
- VALIDATING_DATA = "VALIDATING_DATA",
175
- NONE = "NONE"
176
- }
177
- export declare enum EntityType {
178
- COLOR = "color",
179
- CUSTOM_ENTITY = "custom-entity",
180
- ITEM = "item",
181
- PROJECT_ITEM = "project-item",
182
- ASSORTMENT = "assortment-item"
183
- }
1
+ import { LogLevel } from './log-level';
2
+ import { OrgManagedEntity } from './org-managed-entity';
3
+ export declare class ColumnDefinition {
4
+ fromProperty?: string;
5
+ toProperty: string;
6
+ conditions?: ConditionalValues[];
7
+ default?: any;
8
+ }
9
+ export declare class ConditionalValues {
10
+ conditional: string;
11
+ value: string;
12
+ }
13
+ export declare class AssortmentSplit {
14
+ partialAssortmentUpdate?: boolean;
15
+ dropField?: string;
16
+ fieldToSplitOn: string;
17
+ values: ValueToAssortment[];
18
+ }
19
+ export declare class ValueToAssortment {
20
+ value: string;
21
+ assortmentId?: string;
22
+ assortmentIdentifier?: string;
23
+ }
24
+ export interface LoaderConfiguration extends OrgManagedEntity {
25
+ name?: string;
26
+ federatedMappings?: any;
27
+ conditionalColumns?: ColumnDefinition[];
28
+ assortmentSplit?: AssortmentSplit;
29
+ workspaceIdentifier?: string;
30
+ propertiesToRemove?: string[];
31
+ }
32
+ export declare enum LoadStatus {
33
+ ACTIVE = "ACTIVE",
34
+ PENDING = "PENDING",
35
+ FAILED = "FAILED",
36
+ COMPLETE = "COMPLETE",
37
+ CANCELED = "CANCELED"
38
+ }
39
+ export declare enum LoadType {
40
+ ITEM = "ITEM",
41
+ PROJECT_ITEM = "PROJECT_ITEM",
42
+ ASSORTMENT = "ASSORTMENT",
43
+ COLOR = "COLOR",
44
+ CUSTOM_ENTITY = "CUSTOM_ENTITY",
45
+ SIZE_RANGE_TEMPLATE = "SIZE_RANGE_TEMPLATE",
46
+ PROJECT = "PROJECT"
47
+ }
48
+ export interface LoadResult {
49
+ colorsLoadResult?: EntityLoadResult;
50
+ customEntitiesLoadResult?: EntityLoadResult;
51
+ itemsLoadResult?: EntityLoadResult;
52
+ projectItemsLoadResult?: EntityLoadResult;
53
+ assortmentItemsLoadResult?: EntityLoadResult;
54
+ transformErrors: any[];
55
+ transformWarnings?: any[];
56
+ generalErrors?: GeneralIssueDetails[];
57
+ generalWarnings?: GeneralIssueDetails[];
58
+ systemErrors?: GeneralIssueDetails[];
59
+ failureArea?: LoaderFailureArea;
60
+ }
61
+ export interface RowLoadError {
62
+ data: any;
63
+ error: any;
64
+ }
65
+ export interface LoaderNumbersSummary {
66
+ numberFamiliesLoaded: number;
67
+ numberOptionsLoaded: number;
68
+ numberProjectItemsLoaded: number;
69
+ numberAssortmentItemsLoaded: number;
70
+ numberColorsLoaded: number;
71
+ numberImagesLoaded: number;
72
+ numberFamiliesFailed: number;
73
+ numberOptionsFailed: number;
74
+ numberProjectItemsFailed: number;
75
+ numberAssortmentItemsFailed: number;
76
+ numberColorsFailed: number;
77
+ numberImagesFailed: number;
78
+ }
79
+ export interface ProcessingIssues {
80
+ rowNumber: number;
81
+ columnIssues: ColumnIssueDetails[];
82
+ }
83
+ export interface ColumnIssueDetails {
84
+ columnName: string;
85
+ message: string;
86
+ issueType: IssueType;
87
+ data: string;
88
+ }
89
+ export interface GeneralIssueDetails {
90
+ message: string;
91
+ issueType: IssueType;
92
+ }
93
+ export interface EntityLoadResult {
94
+ created: any[];
95
+ updated: any[];
96
+ unchanged: any[];
97
+ deleted: any[];
98
+ failedCreate: RowLoadError[];
99
+ failedUpdate: RowLoadError[];
100
+ failedDelete: RowLoadError[];
101
+ failed: boolean;
102
+ }
103
+ export interface PreprocessingStepStoredResultSummary {
104
+ preprocessingStepName: string;
105
+ fileId: string;
106
+ numberOfWarnings: number;
107
+ numberOfErrors: number;
108
+ }
109
+ export interface ProcessedData {
110
+ csvRows: any[];
111
+ transformationErrors: ProcessingIssues[];
112
+ transformationWarnings: ProcessingIssues[];
113
+ generalErrors: GeneralIssueDetails[];
114
+ generalWarnings: GeneralIssueDetails[];
115
+ systemErrors: GeneralIssueDetails[];
116
+ failureArea: LoaderFailureArea;
117
+ }
118
+ export declare class LoaderProcess implements OrgManagedEntity {
119
+ id: string;
120
+ createdOn?: Date;
121
+ updatedOn?: Date;
122
+ createdById?: string;
123
+ updatedById?: string;
124
+ createdBy?: any;
125
+ updatedBy?: any;
126
+ orgId?: string;
127
+ loaderConfigurationId?: string;
128
+ name?: string;
129
+ endedOn?: Date;
130
+ status: LoadStatus;
131
+ logLevel?: LogLevel;
132
+ processLogs?: string;
133
+ processLogS3File?: string;
134
+ processLogS3FileDownloadLink?: string;
135
+ logsFileId?: string;
136
+ logFileDownloadLink?: string;
137
+ loadProcessResult?: LoadResult;
138
+ loadProcessResultFileId?: string;
139
+ loadProcessResultDownloadLink?: string;
140
+ preprocessingStepResults?: PreprocessingStepStoredResultSummary[];
141
+ processDurationSeconds?: number;
142
+ loadFileId: string;
143
+ loadType: LoadType[];
144
+ federatedMappings?: any;
145
+ conditionalColumns?: ColumnDefinition[];
146
+ assortmentSplit?: AssortmentSplit;
147
+ partialAssortmentUpdate?: boolean;
148
+ assortmentItemDropField?: string;
149
+ workspaceIdentifier?: string;
150
+ propertiesToRemove?: string[];
151
+ badRowsCount?: number;
152
+ uploadErrorCount?: number;
153
+ hasErrors?: boolean;
154
+ parallelWorkerCount?: number;
155
+ messageGroupId?: string;
156
+ isPartialFailure?: boolean;
157
+ }
158
+ export declare enum IssueType {
159
+ CONFIG = "CONFIG",
160
+ INVALID_DATA = "INVALID_DATA",
161
+ MISSING_DATA = "MISSING_DATA",
162
+ DUPLICATE_FEDERATED_ID = "DUPLICATE_FEDERATED_ID",
163
+ SYSTEM_ERROR = "SYSTEM_ERROR",
164
+ HEADER_MISMATCH = "HEADER_MISMATCH",
165
+ VALIDATION_ERROR = "VALIDATION_ERROR",
166
+ PERMISSION_DENIED = "PERMISSION_DENIED",
167
+ UNKNOWN_ERROR = "UNKNOWN_ERROR"
168
+ }
169
+ export declare enum LoaderFailureArea {
170
+ PARSING_CSV = "PARSING_CSV",
171
+ TRANSFORMING_DATA = "TRANSFORMING_DATA",
172
+ UPLOADING_DATA = "UPLOADING_DATA",
173
+ VALIDATING_DATA = "VALIDATING_DATA",
174
+ NONE = "NONE"
175
+ }
176
+ export declare enum EntityType {
177
+ COLOR = "color",
178
+ CUSTOM_ENTITY = "custom-entity",
179
+ ITEM = "item",
180
+ PROJECT_ITEM = "project-item",
181
+ ASSORTMENT = "assortment-item"
182
+ }