@emilgroup/migration-sdk 0.1.1-beta.5 → 0.2.0
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 +2 -0
- package/README.md +2 -2
- package/api/migration-api.ts +253 -52
- package/dist/api/migration-api.d.ts +171 -52
- package/dist/api/migration-api.js +180 -46
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/ingest-run-record-class.d.ts +102 -0
- package/dist/models/ingest-run-record-class.js +15 -0
- package/dist/models/list-ingest-run-records-response-class.d.ts +43 -0
- package/dist/models/list-ingest-run-records-response-class.js +15 -0
- package/models/index.ts +2 -0
- package/models/ingest-run-record-class.ts +108 -0
- package/models/list-ingest-run-records-response-class.ts +49 -0
- package/package.json +1 -1
|
@@ -25,6 +25,7 @@ import { GetIngestRunResponseClass } from '../models';
|
|
|
25
25
|
import { GetJsonSchemasResponseClass } from '../models';
|
|
26
26
|
import { ListEntityMappingsResponseClass } from '../models';
|
|
27
27
|
import { ListIngestFlushesResponseClass } from '../models';
|
|
28
|
+
import { ListIngestRunRecordsResponseClass } from '../models';
|
|
28
29
|
import { ListIngestRunsResponseClass } from '../models';
|
|
29
30
|
import { StopIngestFlushRequestDto } from '../models';
|
|
30
31
|
import { StopIngestFlushResponseClass } from '../models';
|
|
@@ -75,7 +76,7 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
75
76
|
*/
|
|
76
77
|
createIngestRunSync: (createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
78
|
/**
|
|
78
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
79
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
79
80
|
* @summary Create the Sync ingest flush
|
|
80
81
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
81
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -84,7 +85,7 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
84
85
|
*/
|
|
85
86
|
flushIngestedDataAsync: (flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
86
87
|
/**
|
|
87
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
88
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
88
89
|
* @summary Create the Sync ingest flush
|
|
89
90
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
90
91
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -93,7 +94,7 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
93
94
|
*/
|
|
94
95
|
flushIngestedDataSync: (flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
96
|
/**
|
|
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-
|
|
97
|
+
* 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
98
|
* @summary Retrieve the ingest flush
|
|
98
99
|
* @param {string} code
|
|
99
100
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -120,52 +121,68 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
120
121
|
*/
|
|
121
122
|
getJsonSchemas: (sourceEntity: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
122
123
|
/**
|
|
123
|
-
* Returns a list of entity mappings you have previously created.
|
|
124
|
+
* Returns a list of entity mappings you have previously created. The entity mappings 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\"
|
|
124
125
|
* @summary List entity mappings
|
|
125
126
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
126
127
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
127
128
|
* @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.
|
|
128
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
129
|
+
* @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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
129
130
|
* @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, sourceEntity, sourceId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3</i>
|
|
130
131
|
* @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, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
131
132
|
* @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/>
|
|
132
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
133
|
+
* @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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
133
134
|
* @param {*} [options] Override http request option.
|
|
134
135
|
* @throws {RequiredError}
|
|
135
136
|
*/
|
|
136
137
|
listEntityMappings: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
137
138
|
/**
|
|
138
|
-
* Returns a list of ingest flushes you have previously created.
|
|
139
|
+
* 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
140
|
* @summary List ingest flushes
|
|
140
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
141
142
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
142
143
|
* @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.
|
|
144
|
+
* @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
145
|
* @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
146
|
* @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
147
|
* @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.
|
|
148
|
+
* @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
149
|
* @param {*} [options] Override http request option.
|
|
149
150
|
* @throws {RequiredError}
|
|
150
151
|
*/
|
|
151
152
|
listIngestFlushes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
152
153
|
/**
|
|
153
|
-
* Returns a list of ingest
|
|
154
|
+
* Returns a list of ingest run records you have previously created. The ingest run records 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\"
|
|
155
|
+
* @summary List ingest run records
|
|
156
|
+
* @param {string} code
|
|
157
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
159
|
+
* @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.
|
|
160
|
+
* @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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
161
|
+
* @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: externalId, errorMessage</i>
|
|
162
|
+
* @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, ingestRunId, ingestBatchId, rowNo, externalId, status, stage, errorMessage</i>
|
|
163
|
+
* @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/>
|
|
164
|
+
* @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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
*/
|
|
168
|
+
listIngestRunRecords: (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
169
|
+
/**
|
|
170
|
+
* 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\"
|
|
154
171
|
* @summary List ingest runs
|
|
155
172
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
156
173
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
157
174
|
* @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.
|
|
158
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
175
|
+
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
159
176
|
* @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, sourceEntity, payload, fileUrl, errorMessage, code</i>
|
|
160
177
|
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
161
178
|
* @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: batches<i>
|
|
162
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
179
|
+
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
163
180
|
* @param {*} [options] Override http request option.
|
|
164
181
|
* @throws {RequiredError}
|
|
165
182
|
*/
|
|
166
183
|
listIngestRuns: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
167
184
|
/**
|
|
168
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
185
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
169
186
|
* @summary Stops the ingest flush
|
|
170
187
|
* @param {string} code
|
|
171
188
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -239,7 +256,7 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
239
256
|
*/
|
|
240
257
|
createIngestRunSync(createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateIngestRunSyncResponseClass>>;
|
|
241
258
|
/**
|
|
242
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
259
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
243
260
|
* @summary Create the Sync ingest flush
|
|
244
261
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
245
262
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -248,7 +265,7 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
248
265
|
*/
|
|
249
266
|
flushIngestedDataAsync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlushIngestedDataResponseClass>>;
|
|
250
267
|
/**
|
|
251
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
268
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
252
269
|
* @summary Create the Sync ingest flush
|
|
253
270
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
254
271
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -257,7 +274,7 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
257
274
|
*/
|
|
258
275
|
flushIngestedDataSync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlushIngestedDataResponseClass>>;
|
|
259
276
|
/**
|
|
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-
|
|
277
|
+
* 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
278
|
* @summary Retrieve the ingest flush
|
|
262
279
|
* @param {string} code
|
|
263
280
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -284,52 +301,68 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
284
301
|
*/
|
|
285
302
|
getJsonSchemas(sourceEntity: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJsonSchemasResponseClass>>;
|
|
286
303
|
/**
|
|
287
|
-
* Returns a list of entity mappings you have previously created.
|
|
304
|
+
* Returns a list of entity mappings you have previously created. The entity mappings 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\"
|
|
288
305
|
* @summary List entity mappings
|
|
289
306
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
290
307
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
291
308
|
* @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.
|
|
292
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
309
|
+
* @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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
293
310
|
* @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, sourceEntity, sourceId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3</i>
|
|
294
311
|
* @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, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
295
312
|
* @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/>
|
|
296
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
313
|
+
* @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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
297
314
|
* @param {*} [options] Override http request option.
|
|
298
315
|
* @throws {RequiredError}
|
|
299
316
|
*/
|
|
300
317
|
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
318
|
/**
|
|
302
|
-
* Returns a list of ingest flushes you have previously created.
|
|
319
|
+
* 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
320
|
* @summary List ingest flushes
|
|
304
321
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
322
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
306
323
|
* @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.
|
|
324
|
+
* @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
325
|
* @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
326
|
* @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
327
|
* @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.
|
|
328
|
+
* @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
329
|
* @param {*} [options] Override http request option.
|
|
313
330
|
* @throws {RequiredError}
|
|
314
331
|
*/
|
|
315
332
|
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>>;
|
|
316
333
|
/**
|
|
317
|
-
* Returns a list of ingest
|
|
334
|
+
* Returns a list of ingest run records you have previously created. The ingest run records 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\"
|
|
335
|
+
* @summary List ingest run records
|
|
336
|
+
* @param {string} code
|
|
337
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
338
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
339
|
+
* @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.
|
|
340
|
+
* @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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
341
|
+
* @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: externalId, errorMessage</i>
|
|
342
|
+
* @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, ingestRunId, ingestBatchId, rowNo, externalId, status, stage, errorMessage</i>
|
|
343
|
+
* @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/>
|
|
344
|
+
* @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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
*/
|
|
348
|
+
listIngestRunRecords(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListIngestRunRecordsResponseClass>>;
|
|
349
|
+
/**
|
|
350
|
+
* 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\"
|
|
318
351
|
* @summary List ingest runs
|
|
319
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
320
353
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
321
354
|
* @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.
|
|
322
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
355
|
+
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
323
356
|
* @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, sourceEntity, payload, fileUrl, errorMessage, code</i>
|
|
324
357
|
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
325
358
|
* @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: batches<i>
|
|
326
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
359
|
+
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
327
360
|
* @param {*} [options] Override http request option.
|
|
328
361
|
* @throws {RequiredError}
|
|
329
362
|
*/
|
|
330
363
|
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
364
|
/**
|
|
332
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
365
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
333
366
|
* @summary Stops the ingest flush
|
|
334
367
|
* @param {string} code
|
|
335
368
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -403,7 +436,7 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
403
436
|
*/
|
|
404
437
|
createIngestRunSync(createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: any): AxiosPromise<CreateIngestRunSyncResponseClass>;
|
|
405
438
|
/**
|
|
406
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
439
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
407
440
|
* @summary Create the Sync ingest flush
|
|
408
441
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
409
442
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -412,7 +445,7 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
412
445
|
*/
|
|
413
446
|
flushIngestedDataAsync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: any): AxiosPromise<FlushIngestedDataResponseClass>;
|
|
414
447
|
/**
|
|
415
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
448
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
416
449
|
* @summary Create the Sync ingest flush
|
|
417
450
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
418
451
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -421,7 +454,7 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
421
454
|
*/
|
|
422
455
|
flushIngestedDataSync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: any): AxiosPromise<FlushIngestedDataResponseClass>;
|
|
423
456
|
/**
|
|
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-
|
|
457
|
+
* 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
458
|
* @summary Retrieve the ingest flush
|
|
426
459
|
* @param {string} code
|
|
427
460
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -448,52 +481,68 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
448
481
|
*/
|
|
449
482
|
getJsonSchemas(sourceEntity: string, authorization?: string, options?: any): AxiosPromise<GetJsonSchemasResponseClass>;
|
|
450
483
|
/**
|
|
451
|
-
* Returns a list of entity mappings you have previously created.
|
|
484
|
+
* Returns a list of entity mappings you have previously created. The entity mappings 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\"
|
|
452
485
|
* @summary List entity mappings
|
|
453
486
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
454
487
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
455
488
|
* @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.
|
|
456
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
489
|
+
* @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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
457
490
|
* @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, sourceEntity, sourceId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3</i>
|
|
458
491
|
* @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, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
459
492
|
* @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/>
|
|
460
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
493
|
+
* @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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
461
494
|
* @param {*} [options] Override http request option.
|
|
462
495
|
* @throws {RequiredError}
|
|
463
496
|
*/
|
|
464
497
|
listEntityMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEntityMappingsResponseClass>;
|
|
465
498
|
/**
|
|
466
|
-
* Returns a list of ingest flushes you have previously created.
|
|
499
|
+
* 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
500
|
* @summary List ingest flushes
|
|
468
501
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
469
502
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
470
503
|
* @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.
|
|
504
|
+
* @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
505
|
* @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
506
|
* @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
507
|
* @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.
|
|
508
|
+
* @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
509
|
* @param {*} [options] Override http request option.
|
|
477
510
|
* @throws {RequiredError}
|
|
478
511
|
*/
|
|
479
512
|
listIngestFlushes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestFlushesResponseClass>;
|
|
480
513
|
/**
|
|
481
|
-
* Returns a list of ingest
|
|
514
|
+
* Returns a list of ingest run records you have previously created. The ingest run records 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\"
|
|
515
|
+
* @summary List ingest run records
|
|
516
|
+
* @param {string} code
|
|
517
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
518
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
519
|
+
* @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.
|
|
520
|
+
* @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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
521
|
+
* @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: externalId, errorMessage</i>
|
|
522
|
+
* @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, ingestRunId, ingestBatchId, rowNo, externalId, status, stage, errorMessage</i>
|
|
523
|
+
* @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/>
|
|
524
|
+
* @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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
525
|
+
* @param {*} [options] Override http request option.
|
|
526
|
+
* @throws {RequiredError}
|
|
527
|
+
*/
|
|
528
|
+
listIngestRunRecords(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestRunRecordsResponseClass>;
|
|
529
|
+
/**
|
|
530
|
+
* 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\"
|
|
482
531
|
* @summary List ingest runs
|
|
483
532
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
484
533
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
485
534
|
* @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.
|
|
486
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
535
|
+
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
487
536
|
* @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, sourceEntity, payload, fileUrl, errorMessage, code</i>
|
|
488
537
|
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
489
538
|
* @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: batches<i>
|
|
490
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
539
|
+
* @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, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
491
540
|
* @param {*} [options] Override http request option.
|
|
492
541
|
* @throws {RequiredError}
|
|
493
542
|
*/
|
|
494
543
|
listIngestRuns(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestRunsResponseClass>;
|
|
495
544
|
/**
|
|
496
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
545
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
497
546
|
* @summary Stops the ingest flush
|
|
498
547
|
* @param {string} code
|
|
499
548
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -731,7 +780,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
731
780
|
*/
|
|
732
781
|
readonly pageToken?: string;
|
|
733
782
|
/**
|
|
734
|
-
* Filter the response by one or multiple fields.
|
|
783
|
+
* 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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
735
784
|
* @type {string}
|
|
736
785
|
* @memberof MigrationApiListEntityMappings
|
|
737
786
|
*/
|
|
@@ -755,7 +804,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
755
804
|
*/
|
|
756
805
|
readonly expand?: string;
|
|
757
806
|
/**
|
|
758
|
-
* Filters the response by one or multiple fields.
|
|
807
|
+
* 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, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
759
808
|
* @type {string}
|
|
760
809
|
* @memberof MigrationApiListEntityMappings
|
|
761
810
|
*/
|
|
@@ -786,7 +835,7 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
786
835
|
*/
|
|
787
836
|
readonly pageToken?: string;
|
|
788
837
|
/**
|
|
789
|
-
* Filter the response by one or multiple fields.
|
|
838
|
+
* 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
839
|
* @type {string}
|
|
791
840
|
* @memberof MigrationApiListIngestFlushes
|
|
792
841
|
*/
|
|
@@ -810,12 +859,73 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
810
859
|
*/
|
|
811
860
|
readonly expand?: string;
|
|
812
861
|
/**
|
|
813
|
-
* Filters the response by one or multiple fields.
|
|
862
|
+
* 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
863
|
* @type {string}
|
|
815
864
|
* @memberof MigrationApiListIngestFlushes
|
|
816
865
|
*/
|
|
817
866
|
readonly filters?: string;
|
|
818
867
|
}
|
|
868
|
+
/**
|
|
869
|
+
* Request parameters for listIngestRunRecords operation in MigrationApi.
|
|
870
|
+
* @export
|
|
871
|
+
* @interface MigrationApiListIngestRunRecordsRequest
|
|
872
|
+
*/
|
|
873
|
+
export interface MigrationApiListIngestRunRecordsRequest {
|
|
874
|
+
/**
|
|
875
|
+
*
|
|
876
|
+
* @type {string}
|
|
877
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
878
|
+
*/
|
|
879
|
+
readonly code: string;
|
|
880
|
+
/**
|
|
881
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
882
|
+
* @type {string}
|
|
883
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
884
|
+
*/
|
|
885
|
+
readonly authorization?: string;
|
|
886
|
+
/**
|
|
887
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
888
|
+
* @type {number}
|
|
889
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
890
|
+
*/
|
|
891
|
+
readonly pageSize?: number;
|
|
892
|
+
/**
|
|
893
|
+
* 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.
|
|
894
|
+
* @type {string}
|
|
895
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
896
|
+
*/
|
|
897
|
+
readonly pageToken?: string;
|
|
898
|
+
/**
|
|
899
|
+
* 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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
900
|
+
* @type {string}
|
|
901
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
902
|
+
*/
|
|
903
|
+
readonly filter?: string;
|
|
904
|
+
/**
|
|
905
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: externalId, errorMessage</i>
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
908
|
+
*/
|
|
909
|
+
readonly search?: string;
|
|
910
|
+
/**
|
|
911
|
+
* 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, ingestRunId, ingestBatchId, rowNo, externalId, status, stage, errorMessage</i>
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
914
|
+
*/
|
|
915
|
+
readonly order?: string;
|
|
916
|
+
/**
|
|
917
|
+
* 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/>
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
920
|
+
*/
|
|
921
|
+
readonly expand?: string;
|
|
922
|
+
/**
|
|
923
|
+
* 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, ingestRunId, ingestBatchId, createdAt, updatedAt, ern, rowNo, externalId, errorMessage</i>
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof MigrationApiListIngestRunRecords
|
|
926
|
+
*/
|
|
927
|
+
readonly filters?: string;
|
|
928
|
+
}
|
|
819
929
|
/**
|
|
820
930
|
* Request parameters for listIngestRuns operation in MigrationApi.
|
|
821
931
|
* @export
|
|
@@ -841,7 +951,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
841
951
|
*/
|
|
842
952
|
readonly pageToken?: string;
|
|
843
953
|
/**
|
|
844
|
-
* Filter the response by one or multiple fields.
|
|
954
|
+
* 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>
|
|
845
955
|
* @type {string}
|
|
846
956
|
* @memberof MigrationApiListIngestRuns
|
|
847
957
|
*/
|
|
@@ -865,7 +975,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
865
975
|
*/
|
|
866
976
|
readonly expand?: string;
|
|
867
977
|
/**
|
|
868
|
-
* Filters the response by one or multiple fields.
|
|
978
|
+
* 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>
|
|
869
979
|
* @type {string}
|
|
870
980
|
* @memberof MigrationApiListIngestRuns
|
|
871
981
|
*/
|
|
@@ -990,7 +1100,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
990
1100
|
*/
|
|
991
1101
|
createIngestRunSync(requestParameters: MigrationApiCreateIngestRunSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateIngestRunSyncResponseClass, any, {}>>;
|
|
992
1102
|
/**
|
|
993
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1103
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
994
1104
|
* @summary Create the Sync ingest flush
|
|
995
1105
|
* @param {MigrationApiFlushIngestedDataAsyncRequest} requestParameters Request parameters.
|
|
996
1106
|
* @param {*} [options] Override http request option.
|
|
@@ -999,7 +1109,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
999
1109
|
*/
|
|
1000
1110
|
flushIngestedDataAsync(requestParameters: MigrationApiFlushIngestedDataAsyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FlushIngestedDataResponseClass, any, {}>>;
|
|
1001
1111
|
/**
|
|
1002
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1112
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1003
1113
|
* @summary Create the Sync ingest flush
|
|
1004
1114
|
* @param {MigrationApiFlushIngestedDataSyncRequest} requestParameters Request parameters.
|
|
1005
1115
|
* @param {*} [options] Override http request option.
|
|
@@ -1008,7 +1118,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1008
1118
|
*/
|
|
1009
1119
|
flushIngestedDataSync(requestParameters: MigrationApiFlushIngestedDataSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FlushIngestedDataResponseClass, any, {}>>;
|
|
1010
1120
|
/**
|
|
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-
|
|
1121
|
+
* 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
1122
|
* @summary Retrieve the ingest flush
|
|
1013
1123
|
* @param {MigrationApiGetIngestFlushRequest} requestParameters Request parameters.
|
|
1014
1124
|
* @param {*} [options] Override http request option.
|
|
@@ -1035,7 +1145,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1035
1145
|
*/
|
|
1036
1146
|
getJsonSchemas(requestParameters: MigrationApiGetJsonSchemasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJsonSchemasResponseClass, any, {}>>;
|
|
1037
1147
|
/**
|
|
1038
|
-
* Returns a list of entity mappings you have previously created.
|
|
1148
|
+
* Returns a list of entity mappings you have previously created. The entity mappings 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\"
|
|
1039
1149
|
* @summary List entity mappings
|
|
1040
1150
|
* @param {MigrationApiListEntityMappingsRequest} requestParameters Request parameters.
|
|
1041
1151
|
* @param {*} [options] Override http request option.
|
|
@@ -1044,7 +1154,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1044
1154
|
*/
|
|
1045
1155
|
listEntityMappings(requestParameters?: MigrationApiListEntityMappingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEntityMappingsResponseClass, any, {}>>;
|
|
1046
1156
|
/**
|
|
1047
|
-
* Returns a list of ingest flushes you have previously created.
|
|
1157
|
+
* 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
1158
|
* @summary List ingest flushes
|
|
1049
1159
|
* @param {MigrationApiListIngestFlushesRequest} requestParameters Request parameters.
|
|
1050
1160
|
* @param {*} [options] Override http request option.
|
|
@@ -1053,7 +1163,16 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1053
1163
|
*/
|
|
1054
1164
|
listIngestFlushes(requestParameters?: MigrationApiListIngestFlushesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestFlushesResponseClass, any, {}>>;
|
|
1055
1165
|
/**
|
|
1056
|
-
* Returns a list of ingest
|
|
1166
|
+
* Returns a list of ingest run records you have previously created. The ingest run records 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\"
|
|
1167
|
+
* @summary List ingest run records
|
|
1168
|
+
* @param {MigrationApiListIngestRunRecordsRequest} requestParameters Request parameters.
|
|
1169
|
+
* @param {*} [options] Override http request option.
|
|
1170
|
+
* @throws {RequiredError}
|
|
1171
|
+
* @memberof MigrationApi
|
|
1172
|
+
*/
|
|
1173
|
+
listIngestRunRecords(requestParameters: MigrationApiListIngestRunRecordsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestRunRecordsResponseClass, any, {}>>;
|
|
1174
|
+
/**
|
|
1175
|
+
* 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\"
|
|
1057
1176
|
* @summary List ingest runs
|
|
1058
1177
|
* @param {MigrationApiListIngestRunsRequest} requestParameters Request parameters.
|
|
1059
1178
|
* @param {*} [options] Override http request option.
|
|
@@ -1062,7 +1181,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1062
1181
|
*/
|
|
1063
1182
|
listIngestRuns(requestParameters?: MigrationApiListIngestRunsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestRunsResponseClass, any, {}>>;
|
|
1064
1183
|
/**
|
|
1065
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
1184
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1066
1185
|
* @summary Stops the ingest flush
|
|
1067
1186
|
* @param {MigrationApiStopIngestFlushRequest} requestParameters Request parameters.
|
|
1068
1187
|
* @param {*} [options] Override http request option.
|