@emilgroup/partner-sdk 1.23.1-beta.1 → 1.23.1-beta.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.
@@ -0,0 +1,358 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL PartnerService
6
+ * The EMIL PartnerService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.PartnerHierarchyOperationsApi = exports.PartnerHierarchyOperationsApiFactory = exports.PartnerHierarchyOperationsApiFp = exports.PartnerHierarchyOperationsApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ /**
89
+ * PartnerHierarchyOperationsApi - axios parameter creator
90
+ * @export
91
+ */
92
+ var PartnerHierarchyOperationsApiAxiosParamCreator = function (configuration) {
93
+ var _this = this;
94
+ return {
95
+ /**
96
+ * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
97
+ * @summary Get a partner hierarchy operation
98
+ * @param {string} code
99
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
100
+ * @param {string} [expand]
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ getPartnerHierarchyOperation: function (code, authorization, expand, options) {
105
+ if (options === void 0) { options = {}; }
106
+ return __awaiter(_this, void 0, void 0, function () {
107
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
108
+ return __generator(this, function (_a) {
109
+ switch (_a.label) {
110
+ case 0:
111
+ // verify required parameter 'code' is not null or undefined
112
+ (0, common_1.assertParamExists)('getPartnerHierarchyOperation', 'code', code);
113
+ localVarPath = "/partnerservice/v1/partner-hierarchy-operations/{code}"
114
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
115
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
116
+ if (configuration) {
117
+ baseOptions = configuration.baseOptions;
118
+ baseAccessToken = configuration.accessToken;
119
+ }
120
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
121
+ localVarHeaderParameter = {};
122
+ localVarQueryParameter = {};
123
+ // authentication bearer required
124
+ // http bearer authentication required
125
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
126
+ case 1:
127
+ // authentication bearer required
128
+ // http bearer authentication required
129
+ _a.sent();
130
+ if (expand !== undefined) {
131
+ localVarQueryParameter['expand'] = expand;
132
+ }
133
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
134
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
135
+ }
136
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
137
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
138
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
139
+ return [2 /*return*/, {
140
+ url: (0, common_1.toPathString)(localVarUrlObj),
141
+ options: localVarRequestOptions,
142
+ }];
143
+ }
144
+ });
145
+ });
146
+ },
147
+ /**
148
+ * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
149
+ * @summary List partner hierarchy operations
150
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
151
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
152
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
153
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
154
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
155
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, type, status, createdAt, updatedAt&lt;/i&gt;
156
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
157
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ listPartnerHierarchyOperations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
162
+ if (options === void 0) { options = {}; }
163
+ return __awaiter(_this, void 0, void 0, function () {
164
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
165
+ return __generator(this, function (_a) {
166
+ switch (_a.label) {
167
+ case 0:
168
+ localVarPath = "/partnerservice/v1/partner-hierarchy-operations";
169
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
170
+ if (configuration) {
171
+ baseOptions = configuration.baseOptions;
172
+ baseAccessToken = configuration.accessToken;
173
+ }
174
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
175
+ localVarHeaderParameter = {};
176
+ localVarQueryParameter = {};
177
+ // authentication bearer required
178
+ // http bearer authentication required
179
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
180
+ case 1:
181
+ // authentication bearer required
182
+ // http bearer authentication required
183
+ _a.sent();
184
+ if (pageSize !== undefined) {
185
+ localVarQueryParameter['pageSize'] = pageSize;
186
+ }
187
+ if (pageToken !== undefined) {
188
+ localVarQueryParameter['pageToken'] = pageToken;
189
+ }
190
+ if (filter !== undefined) {
191
+ localVarQueryParameter['filter'] = filter;
192
+ }
193
+ if (search !== undefined) {
194
+ localVarQueryParameter['search'] = search;
195
+ }
196
+ if (order !== undefined) {
197
+ localVarQueryParameter['order'] = order;
198
+ }
199
+ if (expand !== undefined) {
200
+ localVarQueryParameter['expand'] = expand;
201
+ }
202
+ if (filters !== undefined) {
203
+ localVarQueryParameter['filters'] = filters;
204
+ }
205
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
206
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
207
+ }
208
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
209
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
210
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
211
+ return [2 /*return*/, {
212
+ url: (0, common_1.toPathString)(localVarUrlObj),
213
+ options: localVarRequestOptions,
214
+ }];
215
+ }
216
+ });
217
+ });
218
+ },
219
+ };
220
+ };
221
+ exports.PartnerHierarchyOperationsApiAxiosParamCreator = PartnerHierarchyOperationsApiAxiosParamCreator;
222
+ /**
223
+ * PartnerHierarchyOperationsApi - functional programming interface
224
+ * @export
225
+ */
226
+ var PartnerHierarchyOperationsApiFp = function (configuration) {
227
+ var localVarAxiosParamCreator = (0, exports.PartnerHierarchyOperationsApiAxiosParamCreator)(configuration);
228
+ return {
229
+ /**
230
+ * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
231
+ * @summary Get a partner hierarchy operation
232
+ * @param {string} code
233
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
234
+ * @param {string} [expand]
235
+ * @param {*} [options] Override http request option.
236
+ * @throws {RequiredError}
237
+ */
238
+ getPartnerHierarchyOperation: function (code, authorization, expand, options) {
239
+ return __awaiter(this, void 0, void 0, function () {
240
+ var localVarAxiosArgs;
241
+ return __generator(this, function (_a) {
242
+ switch (_a.label) {
243
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPartnerHierarchyOperation(code, authorization, expand, options)];
244
+ case 1:
245
+ localVarAxiosArgs = _a.sent();
246
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
247
+ }
248
+ });
249
+ });
250
+ },
251
+ /**
252
+ * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
253
+ * @summary List partner hierarchy operations
254
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
255
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
256
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
257
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
258
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
259
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, type, status, createdAt, updatedAt&lt;/i&gt;
260
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
261
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ */
265
+ listPartnerHierarchyOperations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
266
+ return __awaiter(this, void 0, void 0, function () {
267
+ var localVarAxiosArgs;
268
+ return __generator(this, function (_a) {
269
+ switch (_a.label) {
270
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPartnerHierarchyOperations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
271
+ case 1:
272
+ localVarAxiosArgs = _a.sent();
273
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
274
+ }
275
+ });
276
+ });
277
+ },
278
+ };
279
+ };
280
+ exports.PartnerHierarchyOperationsApiFp = PartnerHierarchyOperationsApiFp;
281
+ /**
282
+ * PartnerHierarchyOperationsApi - factory interface
283
+ * @export
284
+ */
285
+ var PartnerHierarchyOperationsApiFactory = function (configuration, basePath, axios) {
286
+ var localVarFp = (0, exports.PartnerHierarchyOperationsApiFp)(configuration);
287
+ return {
288
+ /**
289
+ * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
290
+ * @summary Get a partner hierarchy operation
291
+ * @param {string} code
292
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
293
+ * @param {string} [expand]
294
+ * @param {*} [options] Override http request option.
295
+ * @throws {RequiredError}
296
+ */
297
+ getPartnerHierarchyOperation: function (code, authorization, expand, options) {
298
+ return localVarFp.getPartnerHierarchyOperation(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
299
+ },
300
+ /**
301
+ * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
302
+ * @summary List partner hierarchy operations
303
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
304
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
305
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
306
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
307
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
308
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, type, status, createdAt, updatedAt&lt;/i&gt;
309
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
310
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, partnerHierarchyCode, type, status, createdAt&lt;/i&gt;
311
+ * @param {*} [options] Override http request option.
312
+ * @throws {RequiredError}
313
+ */
314
+ listPartnerHierarchyOperations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
315
+ return localVarFp.listPartnerHierarchyOperations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
316
+ },
317
+ };
318
+ };
319
+ exports.PartnerHierarchyOperationsApiFactory = PartnerHierarchyOperationsApiFactory;
320
+ /**
321
+ * PartnerHierarchyOperationsApi - object-oriented interface
322
+ * @export
323
+ * @class PartnerHierarchyOperationsApi
324
+ * @extends {BaseAPI}
325
+ */
326
+ var PartnerHierarchyOperationsApi = /** @class */ (function (_super) {
327
+ __extends(PartnerHierarchyOperationsApi, _super);
328
+ function PartnerHierarchyOperationsApi() {
329
+ return _super !== null && _super.apply(this, arguments) || this;
330
+ }
331
+ /**
332
+ * Returns one partner hierarchy background operation by code. Use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
333
+ * @summary Get a partner hierarchy operation
334
+ * @param {PartnerHierarchyOperationsApiGetPartnerHierarchyOperationRequest} requestParameters Request parameters.
335
+ * @param {*} [options] Override http request option.
336
+ * @throws {RequiredError}
337
+ * @memberof PartnerHierarchyOperationsApi
338
+ */
339
+ PartnerHierarchyOperationsApi.prototype.getPartnerHierarchyOperation = function (requestParameters, options) {
340
+ var _this = this;
341
+ return (0, exports.PartnerHierarchyOperationsApiFp)(this.configuration).getPartnerHierarchyOperation(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
342
+ };
343
+ /**
344
+ * Returns a paginated list of partner hierarchy background operations. Filter by partnerHierarchyCode, type, or status, and use expand=partnerHierarchy to include the hierarchy. **Required Permissions** \"partner-management.partners.view\"
345
+ * @summary List partner hierarchy operations
346
+ * @param {PartnerHierarchyOperationsApiListPartnerHierarchyOperationsRequest} requestParameters Request parameters.
347
+ * @param {*} [options] Override http request option.
348
+ * @throws {RequiredError}
349
+ * @memberof PartnerHierarchyOperationsApi
350
+ */
351
+ PartnerHierarchyOperationsApi.prototype.listPartnerHierarchyOperations = function (requestParameters, options) {
352
+ var _this = this;
353
+ if (requestParameters === void 0) { requestParameters = {}; }
354
+ return (0, exports.PartnerHierarchyOperationsApiFp)(this.configuration).listPartnerHierarchyOperations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
355
+ };
356
+ return PartnerHierarchyOperationsApi;
357
+ }(base_1.BaseAPI));
358
+ exports.PartnerHierarchyOperationsApi = PartnerHierarchyOperationsApi;
package/dist/api.d.ts CHANGED
@@ -14,6 +14,7 @@ export * from './api/blacklist-reasons-api';
14
14
  export * from './api/health-api';
15
15
  export * from './api/partner-hierarchies-api';
16
16
  export * from './api/partner-hierarchy-nodes-api';
17
+ export * from './api/partner-hierarchy-operations-api';
17
18
  export * from './api/partner-hierarchy-types-api';
18
19
  export * from './api/partner-invitations-api';
19
20
  export * from './api/partner-relations-api';
package/dist/api.js CHANGED
@@ -32,6 +32,7 @@ __exportStar(require("./api/blacklist-reasons-api"), exports);
32
32
  __exportStar(require("./api/health-api"), exports);
33
33
  __exportStar(require("./api/partner-hierarchies-api"), exports);
34
34
  __exportStar(require("./api/partner-hierarchy-nodes-api"), exports);
35
+ __exportStar(require("./api/partner-hierarchy-operations-api"), exports);
35
36
  __exportStar(require("./api/partner-hierarchy-types-api"), exports);
36
37
  __exportStar(require("./api/partner-invitations-api"), exports);
37
38
  __exportStar(require("./api/partner-relations-api"), exports);
@@ -0,0 +1,25 @@
1
+ /**
2
+ * EMIL PartnerService
3
+ * The EMIL PartnerService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { PartnerHierarchyOperationClass } from './partner-hierarchy-operation-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetPartnerHierarchyOperationResponseClass
17
+ */
18
+ export interface GetPartnerHierarchyOperationResponseClass {
19
+ /**
20
+ * The partner hierarchy operation response.
21
+ * @type {PartnerHierarchyOperationClass}
22
+ * @memberof GetPartnerHierarchyOperationResponseClass
23
+ */
24
+ 'operation': PartnerHierarchyOperationClass;
25
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL PartnerService
6
+ * The EMIL PartnerService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface GetPartnerHierarchyTreeFileResponseClass {
18
18
  /**
19
- * Download URL for the hierarchy tree file. Empty while the file is still being built.
19
+ * Download URL for the latest available hierarchy tree file.
20
20
  * @type {string}
21
21
  * @memberof GetPartnerHierarchyTreeFileResponseClass
22
22
  */
@@ -28,15 +28,33 @@ export interface GetPartnerHierarchyTreeFileResponseClass {
28
28
  */
29
29
  'expiresAt'?: string;
30
30
  /**
31
- * Operation code returned when the tree file is being built instead of immediately available.
31
+ * Operation code returned when a data operation is active or a tree-file build is pending or processing.
32
32
  * @type {string}
33
33
  * @memberof GetPartnerHierarchyTreeFileResponseClass
34
34
  */
35
35
  'operationCode'?: string;
36
36
  /**
37
- * Current tree file build status when a download URL is not ready yet.
37
+ * Status of operationCode when a data operation or tree-file build is in progress.
38
38
  * @type {string}
39
39
  * @memberof GetPartnerHierarchyTreeFileResponseClass
40
40
  */
41
- 'status'?: string;
41
+ 'operationStatus'?: string;
42
+ /**
43
+ * Type of operationCode.
44
+ * @type {string}
45
+ * @memberof GetPartnerHierarchyTreeFileResponseClass
46
+ */
47
+ 'operationType'?: string;
48
+ /**
49
+ * Hierarchy version represented by the returned tree file.
50
+ * @type {number}
51
+ * @memberof GetPartnerHierarchyTreeFileResponseClass
52
+ */
53
+ 'treeFileVersion'?: number;
54
+ /**
55
+ * True only when the returned file is older than the current hierarchy version.
56
+ * @type {boolean}
57
+ * @memberof GetPartnerHierarchyTreeFileResponseClass
58
+ */
59
+ 'isTreeFileOutdated'?: boolean;
42
60
  }
@@ -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';
@@ -43,6 +43,7 @@ __exportStar(require("./generate-upload-url-response-class"), exports);
43
43
  __exportStar(require("./get-blacklist-item-response-class"), exports);
44
44
  __exportStar(require("./get-blacklist-reason-response-class"), exports);
45
45
  __exportStar(require("./get-partner-hierarchy-node-response-class"), exports);
46
+ __exportStar(require("./get-partner-hierarchy-operation-response-class"), exports);
46
47
  __exportStar(require("./get-partner-hierarchy-response-class"), exports);
47
48
  __exportStar(require("./get-partner-hierarchy-tree-file-response-class"), exports);
48
49
  __exportStar(require("./get-partner-hierarchy-tree-response-class"), exports);
@@ -39,12 +39,6 @@ export interface PartnerHierarchyClass {
39
39
  * @memberof PartnerHierarchyClass
40
40
  */
41
41
  'partnerHierarchyTypeCode': string;
42
- /**
43
- * Whether the cached hierarchy tree needs a refresh.
44
- * @type {boolean}
45
- * @memberof PartnerHierarchyClass
46
- */
47
- 'isTreeStale': boolean;
48
42
  /**
49
43
  * Processing reference, if the hierarchy is currently locked.
50
44
  * @type {string}
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { PartnerHierarchyClass } from './partner-hierarchy-class';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -32,37 +33,37 @@ export interface PartnerHierarchyOperationClass {
32
33
  * @type {string}
33
34
  * @memberof PartnerHierarchyOperationClass
34
35
  */
35
- 'partnerHierarchyCode'?: string;
36
+ 'partnerHierarchyCode': string;
36
37
  /**
37
- * Operation type, such as CREATE_NODES, REPLACE_TREE, or CREATE_TREE_FILE.
38
+ * Operation type.
38
39
  * @type {string}
39
40
  * @memberof PartnerHierarchyOperationClass
40
41
  */
41
- 'type'?: string;
42
+ 'type': PartnerHierarchyOperationClassTypeEnum;
42
43
  /**
43
- * Current operation status, such as PENDING, PROCESSING, DONE, or FAILED.
44
+ * Operation status.
44
45
  * @type {string}
45
46
  * @memberof PartnerHierarchyOperationClass
46
47
  */
47
- 'status'?: string;
48
+ 'status': PartnerHierarchyOperationClassStatusEnum;
48
49
  /**
49
- * Uploaded file key used by this operation. Empty for operations that do not read an uploaded file.
50
+ * Uploaded file key used by this operation. Absent for tree file builds.
50
51
  * @type {string}
51
52
  * @memberof PartnerHierarchyOperationClass
52
53
  */
53
- 's3Key': string;
54
+ 's3Key'?: string;
54
55
  /**
55
56
  * Failure reason when the operation status is FAILED.
56
57
  * @type {string}
57
58
  * @memberof PartnerHierarchyOperationClass
58
59
  */
59
- 'error': string;
60
+ 'error'?: string;
60
61
  /**
61
62
  * Time when the operation finished.
62
63
  * @type {string}
63
64
  * @memberof PartnerHierarchyOperationClass
64
65
  */
65
- 'completedAt': string;
66
+ 'completedAt'?: string;
66
67
  /**
67
68
  * Time at which the object was created.
68
69
  * @type {string}
@@ -87,4 +88,23 @@ export interface PartnerHierarchyOperationClass {
87
88
  * @memberof PartnerHierarchyOperationClass
88
89
  */
89
90
  'updatedBy': string;
91
+ /**
92
+ * Included when expand=partnerHierarchy.
93
+ * @type {PartnerHierarchyClass}
94
+ * @memberof PartnerHierarchyOperationClass
95
+ */
96
+ 'partnerHierarchy'?: PartnerHierarchyClass;
90
97
  }
98
+ export declare const PartnerHierarchyOperationClassTypeEnum: {
99
+ readonly BatchCreateNodes: "BATCH_CREATE_NODES";
100
+ readonly ReplaceHierarchyTree: "REPLACE_HIERARCHY_TREE";
101
+ readonly BuildHierarchyTreeFile: "BUILD_HIERARCHY_TREE_FILE";
102
+ };
103
+ export type PartnerHierarchyOperationClassTypeEnum = typeof PartnerHierarchyOperationClassTypeEnum[keyof typeof PartnerHierarchyOperationClassTypeEnum];
104
+ export declare const PartnerHierarchyOperationClassStatusEnum: {
105
+ readonly Pending: "PENDING";
106
+ readonly Processing: "PROCESSING";
107
+ readonly Done: "DONE";
108
+ readonly Failed: "FAILED";
109
+ };
110
+ export type PartnerHierarchyOperationClassStatusEnum = typeof PartnerHierarchyOperationClassStatusEnum[keyof typeof PartnerHierarchyOperationClassStatusEnum];
@@ -13,3 +13,15 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.PartnerHierarchyOperationClassStatusEnum = exports.PartnerHierarchyOperationClassTypeEnum = void 0;
17
+ exports.PartnerHierarchyOperationClassTypeEnum = {
18
+ BatchCreateNodes: 'BATCH_CREATE_NODES',
19
+ ReplaceHierarchyTree: 'REPLACE_HIERARCHY_TREE',
20
+ BuildHierarchyTreeFile: 'BUILD_HIERARCHY_TREE_FILE'
21
+ };
22
+ exports.PartnerHierarchyOperationClassStatusEnum = {
23
+ Pending: 'PENDING',
24
+ Processing: 'PROCESSING',
25
+ Done: 'DONE',
26
+ Failed: 'FAILED'
27
+ };
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL PartnerService
5
+ * The EMIL PartnerService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { PartnerHierarchyOperationClass } from './partner-hierarchy-operation-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface GetPartnerHierarchyOperationResponseClass
22
+ */
23
+ export interface GetPartnerHierarchyOperationResponseClass {
24
+ /**
25
+ * The partner hierarchy operation response.
26
+ * @type {PartnerHierarchyOperationClass}
27
+ * @memberof GetPartnerHierarchyOperationResponseClass
28
+ */
29
+ 'operation': PartnerHierarchyOperationClass;
30
+ }
31
+