@emilgroup/migration-sdk 0.1.1-beta.2 → 0.1.1-beta.6
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.
- package/.openapi-generator/FILES +8 -0
- package/README.md +2 -2
- package/api/migration-api.ts +640 -19
- package/dist/api/migration-api.d.ts +360 -16
- package/dist/api/migration-api.js +514 -8
- package/dist/models/flush-ingested-data-request-dto.d.ts +24 -0
- package/dist/models/flush-ingested-data-request-dto.js +15 -0
- package/dist/models/flush-ingested-data-response-class.d.ts +25 -0
- package/dist/models/flush-ingested-data-response-class.js +15 -0
- package/dist/models/get-ingest-flush-response-class.d.ts +25 -0
- package/dist/models/get-ingest-flush-response-class.js +15 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/dist/models/ingest-flush-class.d.ts +85 -0
- package/dist/models/ingest-flush-class.js +15 -0
- package/dist/models/ingest-flush-entity-class.d.ts +84 -0
- package/dist/models/ingest-flush-entity-class.js +15 -0
- package/dist/models/list-ingest-flushes-response-class.d.ts +43 -0
- package/dist/models/list-ingest-flushes-response-class.js +15 -0
- package/dist/models/stop-ingest-flush-request-dto.d.ts +24 -0
- package/dist/models/stop-ingest-flush-request-dto.js +15 -0
- package/dist/models/stop-ingest-flush-response-class.d.ts +25 -0
- package/dist/models/stop-ingest-flush-response-class.js +15 -0
- package/models/flush-ingested-data-request-dto.ts +30 -0
- package/models/flush-ingested-data-response-class.ts +31 -0
- package/models/get-ingest-flush-response-class.ts +31 -0
- package/models/index.ts +8 -0
- package/models/ingest-flush-class.ts +91 -0
- package/models/ingest-flush-entity-class.ts +90 -0
- package/models/list-ingest-flushes-response-class.ts +49 -0
- package/models/stop-ingest-flush-request-dto.ts +30 -0
- package/models/stop-ingest-flush-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -18,10 +18,16 @@ import { CreateIngestRunAsyncRequestDto } from '../models';
|
|
|
18
18
|
import { CreateIngestRunAsyncResponseClass } from '../models';
|
|
19
19
|
import { CreateIngestRunSyncRequestDto } from '../models';
|
|
20
20
|
import { CreateIngestRunSyncResponseClass } from '../models';
|
|
21
|
+
import { FlushIngestedDataRequestDto } from '../models';
|
|
22
|
+
import { FlushIngestedDataResponseClass } from '../models';
|
|
23
|
+
import { GetIngestFlushResponseClass } from '../models';
|
|
21
24
|
import { GetIngestRunResponseClass } from '../models';
|
|
22
25
|
import { GetJsonSchemasResponseClass } from '../models';
|
|
23
26
|
import { ListEntityMappingsResponseClass } from '../models';
|
|
27
|
+
import { ListIngestFlushesResponseClass } from '../models';
|
|
24
28
|
import { ListIngestRunsResponseClass } from '../models';
|
|
29
|
+
import { StopIngestFlushRequestDto } from '../models';
|
|
30
|
+
import { StopIngestFlushResponseClass } from '../models';
|
|
25
31
|
import { StopIngestRunCleanupRequestDto } from '../models';
|
|
26
32
|
import { StopIngestRunRequestDto } from '../models';
|
|
27
33
|
import { StopIngestRunResponseClass } from '../models';
|
|
@@ -68,6 +74,33 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
68
74
|
* @throws {RequiredError}
|
|
69
75
|
*/
|
|
70
76
|
createIngestRunSync: (createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
+
/**
|
|
78
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
79
|
+
* @summary Create the Sync ingest flush
|
|
80
|
+
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
81
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
flushIngestedDataAsync: (flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
86
|
+
/**
|
|
87
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
88
|
+
* @summary Create the Sync ingest flush
|
|
89
|
+
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
90
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
flushIngestedDataSync: (flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
|
+
/**
|
|
96
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
97
|
+
* @summary Retrieve the ingest flush
|
|
98
|
+
* @param {string} code
|
|
99
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
getIngestFlush: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
104
|
/**
|
|
72
105
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
73
106
|
* @summary Retrieve the ingest run
|
|
@@ -101,6 +134,21 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
101
134
|
* @throws {RequiredError}
|
|
102
135
|
*/
|
|
103
136
|
listEntityMappings: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
137
|
+
/**
|
|
138
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
139
|
+
* @summary List ingest flushes
|
|
140
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
141
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
142
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
143
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
144
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, errorMessage, code</i>
|
|
145
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
146
|
+
* @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.<br/> <br/> <i>Allowed values: entities<i>
|
|
147
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
listIngestFlushes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
152
|
/**
|
|
105
153
|
* Returns a list of ingest runs you have previously created. The ingest runs are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
106
154
|
* @summary List ingest runs
|
|
@@ -115,7 +163,17 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
115
163
|
* @param {*} [options] Override http request option.
|
|
116
164
|
* @throws {RequiredError}
|
|
117
165
|
*/
|
|
118
|
-
|
|
166
|
+
listIngestRuns: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
167
|
+
/**
|
|
168
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
169
|
+
* @summary Stops the ingest flush
|
|
170
|
+
* @param {string} code
|
|
171
|
+
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
172
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
173
|
+
* @param {*} [options] Override http request option.
|
|
174
|
+
* @throws {RequiredError}
|
|
175
|
+
*/
|
|
176
|
+
stopIngestFlush: (code: string, stopIngestFlushRequestDto: StopIngestFlushRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
119
177
|
/**
|
|
120
178
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
121
179
|
* @summary Stops the ingest run
|
|
@@ -180,6 +238,33 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
180
238
|
* @throws {RequiredError}
|
|
181
239
|
*/
|
|
182
240
|
createIngestRunSync(createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateIngestRunSyncResponseClass>>;
|
|
241
|
+
/**
|
|
242
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
243
|
+
* @summary Create the Sync ingest flush
|
|
244
|
+
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
245
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
*/
|
|
249
|
+
flushIngestedDataAsync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlushIngestedDataResponseClass>>;
|
|
250
|
+
/**
|
|
251
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
252
|
+
* @summary Create the Sync ingest flush
|
|
253
|
+
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
254
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
|
+
* @param {*} [options] Override http request option.
|
|
256
|
+
* @throws {RequiredError}
|
|
257
|
+
*/
|
|
258
|
+
flushIngestedDataSync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlushIngestedDataResponseClass>>;
|
|
259
|
+
/**
|
|
260
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
261
|
+
* @summary Retrieve the ingest flush
|
|
262
|
+
* @param {string} code
|
|
263
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
*/
|
|
267
|
+
getIngestFlush(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIngestFlushResponseClass>>;
|
|
183
268
|
/**
|
|
184
269
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
185
270
|
* @summary Retrieve the ingest run
|
|
@@ -213,6 +298,21 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
213
298
|
* @throws {RequiredError}
|
|
214
299
|
*/
|
|
215
300
|
listEntityMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEntityMappingsResponseClass>>;
|
|
301
|
+
/**
|
|
302
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
303
|
+
* @summary List ingest flushes
|
|
304
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
306
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
307
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
308
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, errorMessage, code</i>
|
|
309
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
310
|
+
* @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.<br/> <br/> <i>Allowed values: entities<i>
|
|
311
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
listIngestFlushes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIngestFlushesResponseClass>>;
|
|
216
316
|
/**
|
|
217
317
|
* Returns a list of ingest runs you have previously created. The ingest runs are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
218
318
|
* @summary List ingest runs
|
|
@@ -227,7 +327,17 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
227
327
|
* @param {*} [options] Override http request option.
|
|
228
328
|
* @throws {RequiredError}
|
|
229
329
|
*/
|
|
230
|
-
|
|
330
|
+
listIngestRuns(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIngestRunsResponseClass>>;
|
|
331
|
+
/**
|
|
332
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
333
|
+
* @summary Stops the ingest flush
|
|
334
|
+
* @param {string} code
|
|
335
|
+
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
336
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
337
|
+
* @param {*} [options] Override http request option.
|
|
338
|
+
* @throws {RequiredError}
|
|
339
|
+
*/
|
|
340
|
+
stopIngestFlush(code: string, stopIngestFlushRequestDto: StopIngestFlushRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StopIngestFlushResponseClass>>;
|
|
231
341
|
/**
|
|
232
342
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
233
343
|
* @summary Stops the ingest run
|
|
@@ -292,6 +402,33 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
292
402
|
* @throws {RequiredError}
|
|
293
403
|
*/
|
|
294
404
|
createIngestRunSync(createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: any): AxiosPromise<CreateIngestRunSyncResponseClass>;
|
|
405
|
+
/**
|
|
406
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
407
|
+
* @summary Create the Sync ingest flush
|
|
408
|
+
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
409
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
410
|
+
* @param {*} [options] Override http request option.
|
|
411
|
+
* @throws {RequiredError}
|
|
412
|
+
*/
|
|
413
|
+
flushIngestedDataAsync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: any): AxiosPromise<FlushIngestedDataResponseClass>;
|
|
414
|
+
/**
|
|
415
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
416
|
+
* @summary Create the Sync ingest flush
|
|
417
|
+
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
418
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
419
|
+
* @param {*} [options] Override http request option.
|
|
420
|
+
* @throws {RequiredError}
|
|
421
|
+
*/
|
|
422
|
+
flushIngestedDataSync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: any): AxiosPromise<FlushIngestedDataResponseClass>;
|
|
423
|
+
/**
|
|
424
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
425
|
+
* @summary Retrieve the ingest flush
|
|
426
|
+
* @param {string} code
|
|
427
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
428
|
+
* @param {*} [options] Override http request option.
|
|
429
|
+
* @throws {RequiredError}
|
|
430
|
+
*/
|
|
431
|
+
getIngestFlush(code: string, authorization?: string, options?: any): AxiosPromise<GetIngestFlushResponseClass>;
|
|
295
432
|
/**
|
|
296
433
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
297
434
|
* @summary Retrieve the ingest run
|
|
@@ -325,6 +462,21 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
325
462
|
* @throws {RequiredError}
|
|
326
463
|
*/
|
|
327
464
|
listEntityMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEntityMappingsResponseClass>;
|
|
465
|
+
/**
|
|
466
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
467
|
+
* @summary List ingest flushes
|
|
468
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
469
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
470
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
471
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
472
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, errorMessage, code</i>
|
|
473
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
474
|
+
* @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.<br/> <br/> <i>Allowed values: entities<i>
|
|
475
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
476
|
+
* @param {*} [options] Override http request option.
|
|
477
|
+
* @throws {RequiredError}
|
|
478
|
+
*/
|
|
479
|
+
listIngestFlushes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestFlushesResponseClass>;
|
|
328
480
|
/**
|
|
329
481
|
* Returns a list of ingest runs you have previously created. The ingest runs are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
330
482
|
* @summary List ingest runs
|
|
@@ -339,7 +491,17 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
339
491
|
* @param {*} [options] Override http request option.
|
|
340
492
|
* @throws {RequiredError}
|
|
341
493
|
*/
|
|
342
|
-
|
|
494
|
+
listIngestRuns(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestRunsResponseClass>;
|
|
495
|
+
/**
|
|
496
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
497
|
+
* @summary Stops the ingest flush
|
|
498
|
+
* @param {string} code
|
|
499
|
+
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
500
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
501
|
+
* @param {*} [options] Override http request option.
|
|
502
|
+
* @throws {RequiredError}
|
|
503
|
+
*/
|
|
504
|
+
stopIngestFlush(code: string, stopIngestFlushRequestDto: StopIngestFlushRequestDto, authorization?: string, options?: any): AxiosPromise<StopIngestFlushResponseClass>;
|
|
343
505
|
/**
|
|
344
506
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
345
507
|
* @summary Stops the ingest run
|
|
@@ -449,6 +611,63 @@ export interface MigrationApiCreateIngestRunSyncRequest {
|
|
|
449
611
|
*/
|
|
450
612
|
readonly authorization?: string;
|
|
451
613
|
}
|
|
614
|
+
/**
|
|
615
|
+
* Request parameters for flushIngestedDataAsync operation in MigrationApi.
|
|
616
|
+
* @export
|
|
617
|
+
* @interface MigrationApiFlushIngestedDataAsyncRequest
|
|
618
|
+
*/
|
|
619
|
+
export interface MigrationApiFlushIngestedDataAsyncRequest {
|
|
620
|
+
/**
|
|
621
|
+
*
|
|
622
|
+
* @type {FlushIngestedDataRequestDto}
|
|
623
|
+
* @memberof MigrationApiFlushIngestedDataAsync
|
|
624
|
+
*/
|
|
625
|
+
readonly flushIngestedDataRequestDto: FlushIngestedDataRequestDto;
|
|
626
|
+
/**
|
|
627
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
628
|
+
* @type {string}
|
|
629
|
+
* @memberof MigrationApiFlushIngestedDataAsync
|
|
630
|
+
*/
|
|
631
|
+
readonly authorization?: string;
|
|
632
|
+
}
|
|
633
|
+
/**
|
|
634
|
+
* Request parameters for flushIngestedDataSync operation in MigrationApi.
|
|
635
|
+
* @export
|
|
636
|
+
* @interface MigrationApiFlushIngestedDataSyncRequest
|
|
637
|
+
*/
|
|
638
|
+
export interface MigrationApiFlushIngestedDataSyncRequest {
|
|
639
|
+
/**
|
|
640
|
+
*
|
|
641
|
+
* @type {FlushIngestedDataRequestDto}
|
|
642
|
+
* @memberof MigrationApiFlushIngestedDataSync
|
|
643
|
+
*/
|
|
644
|
+
readonly flushIngestedDataRequestDto: FlushIngestedDataRequestDto;
|
|
645
|
+
/**
|
|
646
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
647
|
+
* @type {string}
|
|
648
|
+
* @memberof MigrationApiFlushIngestedDataSync
|
|
649
|
+
*/
|
|
650
|
+
readonly authorization?: string;
|
|
651
|
+
}
|
|
652
|
+
/**
|
|
653
|
+
* Request parameters for getIngestFlush operation in MigrationApi.
|
|
654
|
+
* @export
|
|
655
|
+
* @interface MigrationApiGetIngestFlushRequest
|
|
656
|
+
*/
|
|
657
|
+
export interface MigrationApiGetIngestFlushRequest {
|
|
658
|
+
/**
|
|
659
|
+
*
|
|
660
|
+
* @type {string}
|
|
661
|
+
* @memberof MigrationApiGetIngestFlush
|
|
662
|
+
*/
|
|
663
|
+
readonly code: string;
|
|
664
|
+
/**
|
|
665
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
666
|
+
* @type {string}
|
|
667
|
+
* @memberof MigrationApiGetIngestFlush
|
|
668
|
+
*/
|
|
669
|
+
readonly authorization?: string;
|
|
670
|
+
}
|
|
452
671
|
/**
|
|
453
672
|
* Request parameters for getIngestRun operation in MigrationApi.
|
|
454
673
|
* @export
|
|
@@ -543,60 +762,140 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
543
762
|
readonly filters?: string;
|
|
544
763
|
}
|
|
545
764
|
/**
|
|
546
|
-
* Request parameters for
|
|
765
|
+
* Request parameters for listIngestFlushes operation in MigrationApi.
|
|
547
766
|
* @export
|
|
548
|
-
* @interface
|
|
767
|
+
* @interface MigrationApiListIngestFlushesRequest
|
|
549
768
|
*/
|
|
550
|
-
export interface
|
|
769
|
+
export interface MigrationApiListIngestFlushesRequest {
|
|
551
770
|
/**
|
|
552
771
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
553
772
|
* @type {string}
|
|
554
|
-
* @memberof
|
|
773
|
+
* @memberof MigrationApiListIngestFlushes
|
|
555
774
|
*/
|
|
556
775
|
readonly authorization?: string;
|
|
557
776
|
/**
|
|
558
777
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
559
778
|
* @type {number}
|
|
560
|
-
* @memberof
|
|
779
|
+
* @memberof MigrationApiListIngestFlushes
|
|
561
780
|
*/
|
|
562
781
|
readonly pageSize?: number;
|
|
563
782
|
/**
|
|
564
783
|
* 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
565
784
|
* @type {string}
|
|
566
|
-
* @memberof
|
|
785
|
+
* @memberof MigrationApiListIngestFlushes
|
|
786
|
+
*/
|
|
787
|
+
readonly pageToken?: string;
|
|
788
|
+
/**
|
|
789
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
790
|
+
* @type {string}
|
|
791
|
+
* @memberof MigrationApiListIngestFlushes
|
|
792
|
+
*/
|
|
793
|
+
readonly filter?: string;
|
|
794
|
+
/**
|
|
795
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, errorMessage, code</i>
|
|
796
|
+
* @type {string}
|
|
797
|
+
* @memberof MigrationApiListIngestFlushes
|
|
798
|
+
*/
|
|
799
|
+
readonly search?: string;
|
|
800
|
+
/**
|
|
801
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
802
|
+
* @type {string}
|
|
803
|
+
* @memberof MigrationApiListIngestFlushes
|
|
804
|
+
*/
|
|
805
|
+
readonly order?: string;
|
|
806
|
+
/**
|
|
807
|
+
* 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.<br/> <br/> <i>Allowed values: entities<i>
|
|
808
|
+
* @type {string}
|
|
809
|
+
* @memberof MigrationApiListIngestFlushes
|
|
810
|
+
*/
|
|
811
|
+
readonly expand?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
814
|
+
* @type {string}
|
|
815
|
+
* @memberof MigrationApiListIngestFlushes
|
|
816
|
+
*/
|
|
817
|
+
readonly filters?: string;
|
|
818
|
+
}
|
|
819
|
+
/**
|
|
820
|
+
* Request parameters for listIngestRuns operation in MigrationApi.
|
|
821
|
+
* @export
|
|
822
|
+
* @interface MigrationApiListIngestRunsRequest
|
|
823
|
+
*/
|
|
824
|
+
export interface MigrationApiListIngestRunsRequest {
|
|
825
|
+
/**
|
|
826
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
827
|
+
* @type {string}
|
|
828
|
+
* @memberof MigrationApiListIngestRuns
|
|
829
|
+
*/
|
|
830
|
+
readonly authorization?: string;
|
|
831
|
+
/**
|
|
832
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
833
|
+
* @type {number}
|
|
834
|
+
* @memberof MigrationApiListIngestRuns
|
|
835
|
+
*/
|
|
836
|
+
readonly pageSize?: number;
|
|
837
|
+
/**
|
|
838
|
+
* 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
839
|
+
* @type {string}
|
|
840
|
+
* @memberof MigrationApiListIngestRuns
|
|
567
841
|
*/
|
|
568
842
|
readonly pageToken?: string;
|
|
569
843
|
/**
|
|
570
844
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
571
845
|
* @type {string}
|
|
572
|
-
* @memberof
|
|
846
|
+
* @memberof MigrationApiListIngestRuns
|
|
573
847
|
*/
|
|
574
848
|
readonly filter?: string;
|
|
575
849
|
/**
|
|
576
850
|
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, sourceEntity, payload, fileUrl, errorMessage, code</i>
|
|
577
851
|
* @type {string}
|
|
578
|
-
* @memberof
|
|
852
|
+
* @memberof MigrationApiListIngestRuns
|
|
579
853
|
*/
|
|
580
854
|
readonly search?: string;
|
|
581
855
|
/**
|
|
582
856
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
583
857
|
* @type {string}
|
|
584
|
-
* @memberof
|
|
858
|
+
* @memberof MigrationApiListIngestRuns
|
|
585
859
|
*/
|
|
586
860
|
readonly order?: string;
|
|
587
861
|
/**
|
|
588
862
|
* 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.<br/> <br/> <i>Allowed values: batches<i>
|
|
589
863
|
* @type {string}
|
|
590
|
-
* @memberof
|
|
864
|
+
* @memberof MigrationApiListIngestRuns
|
|
591
865
|
*/
|
|
592
866
|
readonly expand?: string;
|
|
593
867
|
/**
|
|
594
868
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
595
869
|
* @type {string}
|
|
596
|
-
* @memberof
|
|
870
|
+
* @memberof MigrationApiListIngestRuns
|
|
597
871
|
*/
|
|
598
872
|
readonly filters?: string;
|
|
599
873
|
}
|
|
874
|
+
/**
|
|
875
|
+
* Request parameters for stopIngestFlush operation in MigrationApi.
|
|
876
|
+
* @export
|
|
877
|
+
* @interface MigrationApiStopIngestFlushRequest
|
|
878
|
+
*/
|
|
879
|
+
export interface MigrationApiStopIngestFlushRequest {
|
|
880
|
+
/**
|
|
881
|
+
*
|
|
882
|
+
* @type {string}
|
|
883
|
+
* @memberof MigrationApiStopIngestFlush
|
|
884
|
+
*/
|
|
885
|
+
readonly code: string;
|
|
886
|
+
/**
|
|
887
|
+
*
|
|
888
|
+
* @type {StopIngestFlushRequestDto}
|
|
889
|
+
* @memberof MigrationApiStopIngestFlush
|
|
890
|
+
*/
|
|
891
|
+
readonly stopIngestFlushRequestDto: StopIngestFlushRequestDto;
|
|
892
|
+
/**
|
|
893
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
894
|
+
* @type {string}
|
|
895
|
+
* @memberof MigrationApiStopIngestFlush
|
|
896
|
+
*/
|
|
897
|
+
readonly authorization?: string;
|
|
898
|
+
}
|
|
600
899
|
/**
|
|
601
900
|
* Request parameters for stopIngestRun operation in MigrationApi.
|
|
602
901
|
* @export
|
|
@@ -690,6 +989,33 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
690
989
|
* @memberof MigrationApi
|
|
691
990
|
*/
|
|
692
991
|
createIngestRunSync(requestParameters: MigrationApiCreateIngestRunSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateIngestRunSyncResponseClass, any, {}>>;
|
|
992
|
+
/**
|
|
993
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
994
|
+
* @summary Create the Sync ingest flush
|
|
995
|
+
* @param {MigrationApiFlushIngestedDataAsyncRequest} requestParameters Request parameters.
|
|
996
|
+
* @param {*} [options] Override http request option.
|
|
997
|
+
* @throws {RequiredError}
|
|
998
|
+
* @memberof MigrationApi
|
|
999
|
+
*/
|
|
1000
|
+
flushIngestedDataAsync(requestParameters: MigrationApiFlushIngestedDataAsyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FlushIngestedDataResponseClass, any, {}>>;
|
|
1001
|
+
/**
|
|
1002
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1003
|
+
* @summary Create the Sync ingest flush
|
|
1004
|
+
* @param {MigrationApiFlushIngestedDataSyncRequest} requestParameters Request parameters.
|
|
1005
|
+
* @param {*} [options] Override http request option.
|
|
1006
|
+
* @throws {RequiredError}
|
|
1007
|
+
* @memberof MigrationApi
|
|
1008
|
+
*/
|
|
1009
|
+
flushIngestedDataSync(requestParameters: MigrationApiFlushIngestedDataSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FlushIngestedDataResponseClass, any, {}>>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
1012
|
+
* @summary Retrieve the ingest flush
|
|
1013
|
+
* @param {MigrationApiGetIngestFlushRequest} requestParameters Request parameters.
|
|
1014
|
+
* @param {*} [options] Override http request option.
|
|
1015
|
+
* @throws {RequiredError}
|
|
1016
|
+
* @memberof MigrationApi
|
|
1017
|
+
*/
|
|
1018
|
+
getIngestFlush(requestParameters: MigrationApiGetIngestFlushRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIngestFlushResponseClass, any, {}>>;
|
|
693
1019
|
/**
|
|
694
1020
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
695
1021
|
* @summary Retrieve the ingest run
|
|
@@ -717,15 +1043,33 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
717
1043
|
* @memberof MigrationApi
|
|
718
1044
|
*/
|
|
719
1045
|
listEntityMappings(requestParameters?: MigrationApiListEntityMappingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEntityMappingsResponseClass, any, {}>>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
1048
|
+
* @summary List ingest flushes
|
|
1049
|
+
* @param {MigrationApiListIngestFlushesRequest} requestParameters Request parameters.
|
|
1050
|
+
* @param {*} [options] Override http request option.
|
|
1051
|
+
* @throws {RequiredError}
|
|
1052
|
+
* @memberof MigrationApi
|
|
1053
|
+
*/
|
|
1054
|
+
listIngestFlushes(requestParameters?: MigrationApiListIngestFlushesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestFlushesResponseClass, any, {}>>;
|
|
720
1055
|
/**
|
|
721
1056
|
* Returns a list of ingest runs you have previously created. The ingest runs are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
722
1057
|
* @summary List ingest runs
|
|
723
|
-
* @param {
|
|
1058
|
+
* @param {MigrationApiListIngestRunsRequest} requestParameters Request parameters.
|
|
1059
|
+
* @param {*} [options] Override http request option.
|
|
1060
|
+
* @throws {RequiredError}
|
|
1061
|
+
* @memberof MigrationApi
|
|
1062
|
+
*/
|
|
1063
|
+
listIngestRuns(requestParameters?: MigrationApiListIngestRunsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestRunsResponseClass, any, {}>>;
|
|
1064
|
+
/**
|
|
1065
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1066
|
+
* @summary Stops the ingest flush
|
|
1067
|
+
* @param {MigrationApiStopIngestFlushRequest} requestParameters Request parameters.
|
|
724
1068
|
* @param {*} [options] Override http request option.
|
|
725
1069
|
* @throws {RequiredError}
|
|
726
1070
|
* @memberof MigrationApi
|
|
727
1071
|
*/
|
|
728
|
-
|
|
1072
|
+
stopIngestFlush(requestParameters: MigrationApiStopIngestFlushRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StopIngestFlushResponseClass, any, {}>>;
|
|
729
1073
|
/**
|
|
730
1074
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
731
1075
|
* @summary Stops the ingest run
|