@emilgroup/partner-sdk 1.23.1-beta.1 → 1.23.1-beta.3

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.
@@ -21,7 +21,7 @@
21
21
  */
22
22
  export interface GetPartnerHierarchyTreeFileResponseClass {
23
23
  /**
24
- * Download URL for the hierarchy tree file. Empty while the file is still being built.
24
+ * Download URL for the latest available hierarchy tree file.
25
25
  * @type {string}
26
26
  * @memberof GetPartnerHierarchyTreeFileResponseClass
27
27
  */
@@ -33,16 +33,34 @@ export interface GetPartnerHierarchyTreeFileResponseClass {
33
33
  */
34
34
  'expiresAt'?: string;
35
35
  /**
36
- * Operation code returned when the tree file is being built instead of immediately available.
36
+ * Operation code returned when a data operation is active or a tree-file build is pending or processing.
37
37
  * @type {string}
38
38
  * @memberof GetPartnerHierarchyTreeFileResponseClass
39
39
  */
40
40
  'operationCode'?: string;
41
41
  /**
42
- * Current tree file build status when a download URL is not ready yet.
42
+ * Status of operationCode when a data operation or tree-file build is in progress.
43
43
  * @type {string}
44
44
  * @memberof GetPartnerHierarchyTreeFileResponseClass
45
45
  */
46
- 'status'?: string;
46
+ 'operationStatus'?: string;
47
+ /**
48
+ * Type of operationCode.
49
+ * @type {string}
50
+ * @memberof GetPartnerHierarchyTreeFileResponseClass
51
+ */
52
+ 'operationType'?: string;
53
+ /**
54
+ * Hierarchy version represented by the returned tree file.
55
+ * @type {number}
56
+ * @memberof GetPartnerHierarchyTreeFileResponseClass
57
+ */
58
+ 'treeFileVersion'?: number;
59
+ /**
60
+ * True only when the returned file is older than the current hierarchy version.
61
+ * @type {boolean}
62
+ * @memberof GetPartnerHierarchyTreeFileResponseClass
63
+ */
64
+ 'isTreeFileOutdated'?: boolean;
47
65
  }
48
66
 
package/models/index.ts CHANGED
@@ -27,6 +27,7 @@ export * from './generate-upload-url-response-class';
27
27
  export * from './get-blacklist-item-response-class';
28
28
  export * from './get-blacklist-reason-response-class';
29
29
  export * from './get-partner-hierarchy-node-response-class';
30
+ export * from './get-partner-hierarchy-operation-response-class';
30
31
  export * from './get-partner-hierarchy-response-class';
31
32
  export * from './get-partner-hierarchy-tree-file-response-class';
32
33
  export * from './get-partner-hierarchy-tree-response-class';
@@ -44,12 +44,6 @@ export interface PartnerHierarchyClass {
44
44
  * @memberof PartnerHierarchyClass
45
45
  */
46
46
  'partnerHierarchyTypeCode': string;
47
- /**
48
- * Whether the cached hierarchy tree needs a refresh.
49
- * @type {boolean}
50
- * @memberof PartnerHierarchyClass
51
- */
52
- 'isTreeStale': boolean;
53
47
  /**
54
48
  * Processing reference, if the hierarchy is currently locked.
55
49
  * @type {string}
@@ -13,6 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
+ import { PartnerHierarchyClass } from './partner-hierarchy-class';
16
17
 
17
18
  /**
18
19
  *
@@ -37,37 +38,37 @@ export interface PartnerHierarchyOperationClass {
37
38
  * @type {string}
38
39
  * @memberof PartnerHierarchyOperationClass
39
40
  */
40
- 'partnerHierarchyCode'?: string;
41
+ 'partnerHierarchyCode': string;
41
42
  /**
42
- * Operation type, such as CREATE_NODES, REPLACE_TREE, or CREATE_TREE_FILE.
43
+ * Operation type.
43
44
  * @type {string}
44
45
  * @memberof PartnerHierarchyOperationClass
45
46
  */
46
- 'type'?: string;
47
+ 'type': PartnerHierarchyOperationClassTypeEnum;
47
48
  /**
48
- * Current operation status, such as PENDING, PROCESSING, DONE, or FAILED.
49
+ * Operation status.
49
50
  * @type {string}
50
51
  * @memberof PartnerHierarchyOperationClass
51
52
  */
52
- 'status'?: string;
53
+ 'status': PartnerHierarchyOperationClassStatusEnum;
53
54
  /**
54
- * Uploaded file key used by this operation. Empty for operations that do not read an uploaded file.
55
+ * Uploaded file key used by this operation. Absent for tree file builds.
55
56
  * @type {string}
56
57
  * @memberof PartnerHierarchyOperationClass
57
58
  */
58
- 's3Key': string;
59
+ 's3Key'?: string;
59
60
  /**
60
61
  * Failure reason when the operation status is FAILED.
61
62
  * @type {string}
62
63
  * @memberof PartnerHierarchyOperationClass
63
64
  */
64
- 'error': string;
65
+ 'error'?: string;
65
66
  /**
66
67
  * Time when the operation finished.
67
68
  * @type {string}
68
69
  * @memberof PartnerHierarchyOperationClass
69
70
  */
70
- 'completedAt': string;
71
+ 'completedAt'?: string;
71
72
  /**
72
73
  * Time at which the object was created.
73
74
  * @type {string}
@@ -92,5 +93,28 @@ export interface PartnerHierarchyOperationClass {
92
93
  * @memberof PartnerHierarchyOperationClass
93
94
  */
94
95
  'updatedBy': string;
96
+ /**
97
+ * Included when expand=partnerHierarchy.
98
+ * @type {PartnerHierarchyClass}
99
+ * @memberof PartnerHierarchyOperationClass
100
+ */
101
+ 'partnerHierarchy'?: PartnerHierarchyClass;
95
102
  }
96
103
 
104
+ export const PartnerHierarchyOperationClassTypeEnum = {
105
+ BatchCreateNodes: 'BATCH_CREATE_NODES',
106
+ ReplaceHierarchyTree: 'REPLACE_HIERARCHY_TREE',
107
+ BuildHierarchyTreeFile: 'BUILD_HIERARCHY_TREE_FILE'
108
+ } as const;
109
+
110
+ export type PartnerHierarchyOperationClassTypeEnum = typeof PartnerHierarchyOperationClassTypeEnum[keyof typeof PartnerHierarchyOperationClassTypeEnum];
111
+ export const PartnerHierarchyOperationClassStatusEnum = {
112
+ Pending: 'PENDING',
113
+ Processing: 'PROCESSING',
114
+ Done: 'DONE',
115
+ Failed: 'FAILED'
116
+ } as const;
117
+
118
+ export type PartnerHierarchyOperationClassStatusEnum = typeof PartnerHierarchyOperationClassStatusEnum[keyof typeof PartnerHierarchyOperationClassStatusEnum];
119
+
120
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/partner-sdk",
3
- "version": "1.23.1-beta.1",
3
+ "version": "1.23.1-beta.3",
4
4
  "description": "OpenAPI client for @emilgroup/partner-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [