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