@emilgroup/migration-sdk 0.1.1-beta.13 → 0.1.1-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -10
- package/README.md +2 -2
- package/api/migration-api.ts +48 -870
- package/dist/api/migration-api.d.ts +40 -503
- package/dist/api/migration-api.js +28 -668
- package/dist/models/index.d.ts +0 -10
- package/dist/models/index.js +0 -10
- package/models/index.ts +0 -10
- package/package.json +1 -1
- package/dist/models/flush-ingested-data-request-dto.d.ts +0 -24
- package/dist/models/flush-ingested-data-request-dto.js +0 -15
- package/dist/models/flush-ingested-data-response-class.d.ts +0 -25
- package/dist/models/flush-ingested-data-response-class.js +0 -15
- package/dist/models/get-ingest-flush-response-class.d.ts +0 -25
- package/dist/models/get-ingest-flush-response-class.js +0 -15
- package/dist/models/ingest-flush-class.d.ts +0 -85
- package/dist/models/ingest-flush-class.js +0 -15
- package/dist/models/ingest-flush-entity-class.d.ts +0 -84
- package/dist/models/ingest-flush-entity-class.js +0 -15
- 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-flushes-response-class.d.ts +0 -43
- package/dist/models/list-ingest-flushes-response-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/dist/models/stop-ingest-flush-request-dto.d.ts +0 -24
- package/dist/models/stop-ingest-flush-request-dto.js +0 -15
- package/dist/models/stop-ingest-flush-response-class.d.ts +0 -25
- package/dist/models/stop-ingest-flush-response-class.js +0 -15
- package/models/flush-ingested-data-request-dto.ts +0 -30
- package/models/flush-ingested-data-response-class.ts +0 -31
- package/models/get-ingest-flush-response-class.ts +0 -31
- package/models/ingest-flush-class.ts +0 -91
- package/models/ingest-flush-entity-class.ts +0 -90
- package/models/ingest-run-record-class.ts +0 -108
- package/models/list-ingest-flushes-response-class.ts +0 -49
- package/models/list-ingest-run-records-response-class.ts +0 -49
- package/models/stop-ingest-flush-request-dto.ts +0 -30
- package/models/stop-ingest-flush-response-class.ts +0 -31
|
@@ -18,17 +18,10 @@ import { CreateIngestRunAsyncRequestDto } from '../models';
|
|
|
18
18
|
import { CreateIngestRunAsyncResponseClass } from '../models';
|
|
19
19
|
import { CreateIngestRunSyncRequestDto } from '../models';
|
|
20
20
|
import { CreateIngestRunSyncResponseClass } from '../models';
|
|
21
|
-
import { FlushIngestedDataRequestDto } from '../models';
|
|
22
|
-
import { FlushIngestedDataResponseClass } from '../models';
|
|
23
|
-
import { GetIngestFlushResponseClass } from '../models';
|
|
24
21
|
import { GetIngestRunResponseClass } from '../models';
|
|
25
22
|
import { GetJsonSchemasResponseClass } from '../models';
|
|
26
23
|
import { ListEntityMappingsResponseClass } from '../models';
|
|
27
|
-
import { ListIngestFlushesResponseClass } from '../models';
|
|
28
|
-
import { ListIngestRunRecordsResponseClass } from '../models';
|
|
29
24
|
import { ListIngestRunsResponseClass } from '../models';
|
|
30
|
-
import { StopIngestFlushRequestDto } from '../models';
|
|
31
|
-
import { StopIngestFlushResponseClass } from '../models';
|
|
32
25
|
import { StopIngestRunCleanupRequestDto } from '../models';
|
|
33
26
|
import { StopIngestRunRequestDto } from '../models';
|
|
34
27
|
import { StopIngestRunResponseClass } from '../models';
|
|
@@ -75,33 +68,6 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
75
68
|
* @throws {RequiredError}
|
|
76
69
|
*/
|
|
77
70
|
createIngestRunSync: (createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
-
/**
|
|
79
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
80
|
-
* @summary Create the Sync ingest flush
|
|
81
|
-
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
82
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
-
* @param {*} [options] Override http request option.
|
|
84
|
-
* @throws {RequiredError}
|
|
85
|
-
*/
|
|
86
|
-
flushIngestedDataAsync: (flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
|
-
/**
|
|
88
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
89
|
-
* @summary Create the Sync ingest flush
|
|
90
|
-
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
91
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
92
|
-
* @param {*} [options] Override http request option.
|
|
93
|
-
* @throws {RequiredError}
|
|
94
|
-
*/
|
|
95
|
-
flushIngestedDataSync: (flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
|
-
/**
|
|
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\"
|
|
98
|
-
* @summary Retrieve the ingest flush
|
|
99
|
-
* @param {string} code
|
|
100
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
101
|
-
* @param {*} [options] Override http request option.
|
|
102
|
-
* @throws {RequiredError}
|
|
103
|
-
*/
|
|
104
|
-
getIngestFlush: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
105
71
|
/**
|
|
106
72
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
107
73
|
* @summary Retrieve the ingest run
|
|
@@ -121,76 +87,35 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
121
87
|
*/
|
|
122
88
|
getJsonSchemas: (sourceEntity: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
123
89
|
/**
|
|
124
|
-
* Returns a list of entity mappings you have previously created.
|
|
90
|
+
* 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
91
|
* @summary List entity mappings
|
|
126
92
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
127
93
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
128
94
|
* @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.
|
|
95
|
+
* @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
96
|
* @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
97
|
* @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
98
|
* @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.
|
|
99
|
+
* @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
100
|
* @param {*} [options] Override http request option.
|
|
135
101
|
* @throws {RequiredError}
|
|
136
102
|
*/
|
|
137
103
|
listEntityMappings: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
138
104
|
/**
|
|
139
|
-
* Returns a list of ingest
|
|
140
|
-
* @summary List ingest flushes
|
|
141
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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.
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
149
|
-
* @param {*} [options] Override http request option.
|
|
150
|
-
* @throws {RequiredError}
|
|
151
|
-
*/
|
|
152
|
-
listIngestFlushes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
153
|
-
/**
|
|
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\"
|
|
105
|
+
* 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
106
|
* @summary List ingest runs
|
|
172
107
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
173
108
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
174
109
|
* @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.
|
|
110
|
+
* @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
111
|
* @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
112
|
* @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
113
|
* @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.
|
|
114
|
+
* @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
115
|
* @param {*} [options] Override http request option.
|
|
181
116
|
* @throws {RequiredError}
|
|
182
117
|
*/
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
186
|
-
* @summary Stops the ingest flush
|
|
187
|
-
* @param {string} code
|
|
188
|
-
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
189
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
|
-
* @param {*} [options] Override http request option.
|
|
191
|
-
* @throws {RequiredError}
|
|
192
|
-
*/
|
|
193
|
-
stopIngestFlush: (code: string, stopIngestFlushRequestDto: StopIngestFlushRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
118
|
+
listTasks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
194
119
|
/**
|
|
195
120
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
196
121
|
* @summary Stops the ingest run
|
|
@@ -255,33 +180,6 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
255
180
|
* @throws {RequiredError}
|
|
256
181
|
*/
|
|
257
182
|
createIngestRunSync(createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateIngestRunSyncResponseClass>>;
|
|
258
|
-
/**
|
|
259
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
260
|
-
* @summary Create the Sync ingest flush
|
|
261
|
-
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
262
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
263
|
-
* @param {*} [options] Override http request option.
|
|
264
|
-
* @throws {RequiredError}
|
|
265
|
-
*/
|
|
266
|
-
flushIngestedDataAsync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlushIngestedDataResponseClass>>;
|
|
267
|
-
/**
|
|
268
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
269
|
-
* @summary Create the Sync ingest flush
|
|
270
|
-
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
271
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
272
|
-
* @param {*} [options] Override http request option.
|
|
273
|
-
* @throws {RequiredError}
|
|
274
|
-
*/
|
|
275
|
-
flushIngestedDataSync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FlushIngestedDataResponseClass>>;
|
|
276
|
-
/**
|
|
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\"
|
|
278
|
-
* @summary Retrieve the ingest flush
|
|
279
|
-
* @param {string} code
|
|
280
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
281
|
-
* @param {*} [options] Override http request option.
|
|
282
|
-
* @throws {RequiredError}
|
|
283
|
-
*/
|
|
284
|
-
getIngestFlush(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIngestFlushResponseClass>>;
|
|
285
183
|
/**
|
|
286
184
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
287
185
|
* @summary Retrieve the ingest run
|
|
@@ -301,76 +199,35 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
301
199
|
*/
|
|
302
200
|
getJsonSchemas(sourceEntity: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJsonSchemasResponseClass>>;
|
|
303
201
|
/**
|
|
304
|
-
* Returns a list of entity mappings you have previously created.
|
|
202
|
+
* 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
203
|
* @summary List entity mappings
|
|
306
204
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
205
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
308
206
|
* @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.
|
|
207
|
+
* @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
208
|
* @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
209
|
* @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
210
|
* @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.
|
|
211
|
+
* @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
212
|
* @param {*} [options] Override http request option.
|
|
315
213
|
* @throws {RequiredError}
|
|
316
214
|
*/
|
|
317
215
|
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
216
|
/**
|
|
319
|
-
* Returns a list of ingest
|
|
320
|
-
* @summary List ingest flushes
|
|
321
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
322
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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.
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
329
|
-
* @param {*} [options] Override http request option.
|
|
330
|
-
* @throws {RequiredError}
|
|
331
|
-
*/
|
|
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>>;
|
|
333
|
-
/**
|
|
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\"
|
|
217
|
+
* 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
218
|
* @summary List ingest runs
|
|
352
219
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
220
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
354
221
|
* @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.
|
|
222
|
+
* @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
223
|
* @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
224
|
* @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
225
|
* @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.
|
|
360
|
-
* @param {*} [options] Override http request option.
|
|
361
|
-
* @throws {RequiredError}
|
|
362
|
-
*/
|
|
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>>;
|
|
364
|
-
/**
|
|
365
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
366
|
-
* @summary Stops the ingest flush
|
|
367
|
-
* @param {string} code
|
|
368
|
-
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
369
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
226
|
+
* @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>
|
|
370
227
|
* @param {*} [options] Override http request option.
|
|
371
228
|
* @throws {RequiredError}
|
|
372
229
|
*/
|
|
373
|
-
|
|
230
|
+
listTasks(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>>;
|
|
374
231
|
/**
|
|
375
232
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
376
233
|
* @summary Stops the ingest run
|
|
@@ -435,33 +292,6 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
435
292
|
* @throws {RequiredError}
|
|
436
293
|
*/
|
|
437
294
|
createIngestRunSync(createIngestRunSyncRequestDto: CreateIngestRunSyncRequestDto, authorization?: string, options?: any): AxiosPromise<CreateIngestRunSyncResponseClass>;
|
|
438
|
-
/**
|
|
439
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
440
|
-
* @summary Create the Sync ingest flush
|
|
441
|
-
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
442
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
443
|
-
* @param {*} [options] Override http request option.
|
|
444
|
-
* @throws {RequiredError}
|
|
445
|
-
*/
|
|
446
|
-
flushIngestedDataAsync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: any): AxiosPromise<FlushIngestedDataResponseClass>;
|
|
447
|
-
/**
|
|
448
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
449
|
-
* @summary Create the Sync ingest flush
|
|
450
|
-
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
451
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
452
|
-
* @param {*} [options] Override http request option.
|
|
453
|
-
* @throws {RequiredError}
|
|
454
|
-
*/
|
|
455
|
-
flushIngestedDataSync(flushIngestedDataRequestDto: FlushIngestedDataRequestDto, authorization?: string, options?: any): AxiosPromise<FlushIngestedDataResponseClass>;
|
|
456
|
-
/**
|
|
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\"
|
|
458
|
-
* @summary Retrieve the ingest flush
|
|
459
|
-
* @param {string} code
|
|
460
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
461
|
-
* @param {*} [options] Override http request option.
|
|
462
|
-
* @throws {RequiredError}
|
|
463
|
-
*/
|
|
464
|
-
getIngestFlush(code: string, authorization?: string, options?: any): AxiosPromise<GetIngestFlushResponseClass>;
|
|
465
295
|
/**
|
|
466
296
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
467
297
|
* @summary Retrieve the ingest run
|
|
@@ -481,76 +311,35 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
481
311
|
*/
|
|
482
312
|
getJsonSchemas(sourceEntity: string, authorization?: string, options?: any): AxiosPromise<GetJsonSchemasResponseClass>;
|
|
483
313
|
/**
|
|
484
|
-
* Returns a list of entity mappings you have previously created.
|
|
314
|
+
* 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
315
|
* @summary List entity mappings
|
|
486
316
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
487
317
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
488
318
|
* @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.
|
|
319
|
+
* @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
320
|
* @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
321
|
* @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
322
|
* @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.
|
|
323
|
+
* @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
324
|
* @param {*} [options] Override http request option.
|
|
495
325
|
* @throws {RequiredError}
|
|
496
326
|
*/
|
|
497
327
|
listEntityMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEntityMappingsResponseClass>;
|
|
498
328
|
/**
|
|
499
|
-
* Returns a list of ingest
|
|
500
|
-
* @summary List ingest flushes
|
|
501
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
502
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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.
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
509
|
-
* @param {*} [options] Override http request option.
|
|
510
|
-
* @throws {RequiredError}
|
|
511
|
-
*/
|
|
512
|
-
listIngestFlushes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestFlushesResponseClass>;
|
|
513
|
-
/**
|
|
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\"
|
|
329
|
+
* 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
330
|
* @summary List ingest runs
|
|
532
331
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
533
332
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
534
333
|
* @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.
|
|
334
|
+
* @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
335
|
* @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
336
|
* @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
337
|
* @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.
|
|
338
|
+
* @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
339
|
* @param {*} [options] Override http request option.
|
|
541
340
|
* @throws {RequiredError}
|
|
542
341
|
*/
|
|
543
|
-
|
|
544
|
-
/**
|
|
545
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
546
|
-
* @summary Stops the ingest flush
|
|
547
|
-
* @param {string} code
|
|
548
|
-
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
549
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
550
|
-
* @param {*} [options] Override http request option.
|
|
551
|
-
* @throws {RequiredError}
|
|
552
|
-
*/
|
|
553
|
-
stopIngestFlush(code: string, stopIngestFlushRequestDto: StopIngestFlushRequestDto, authorization?: string, options?: any): AxiosPromise<StopIngestFlushResponseClass>;
|
|
342
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestRunsResponseClass>;
|
|
554
343
|
/**
|
|
555
344
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
556
345
|
* @summary Stops the ingest run
|
|
@@ -660,63 +449,6 @@ export interface MigrationApiCreateIngestRunSyncRequest {
|
|
|
660
449
|
*/
|
|
661
450
|
readonly authorization?: string;
|
|
662
451
|
}
|
|
663
|
-
/**
|
|
664
|
-
* Request parameters for flushIngestedDataAsync operation in MigrationApi.
|
|
665
|
-
* @export
|
|
666
|
-
* @interface MigrationApiFlushIngestedDataAsyncRequest
|
|
667
|
-
*/
|
|
668
|
-
export interface MigrationApiFlushIngestedDataAsyncRequest {
|
|
669
|
-
/**
|
|
670
|
-
*
|
|
671
|
-
* @type {FlushIngestedDataRequestDto}
|
|
672
|
-
* @memberof MigrationApiFlushIngestedDataAsync
|
|
673
|
-
*/
|
|
674
|
-
readonly flushIngestedDataRequestDto: FlushIngestedDataRequestDto;
|
|
675
|
-
/**
|
|
676
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
677
|
-
* @type {string}
|
|
678
|
-
* @memberof MigrationApiFlushIngestedDataAsync
|
|
679
|
-
*/
|
|
680
|
-
readonly authorization?: string;
|
|
681
|
-
}
|
|
682
|
-
/**
|
|
683
|
-
* Request parameters for flushIngestedDataSync operation in MigrationApi.
|
|
684
|
-
* @export
|
|
685
|
-
* @interface MigrationApiFlushIngestedDataSyncRequest
|
|
686
|
-
*/
|
|
687
|
-
export interface MigrationApiFlushIngestedDataSyncRequest {
|
|
688
|
-
/**
|
|
689
|
-
*
|
|
690
|
-
* @type {FlushIngestedDataRequestDto}
|
|
691
|
-
* @memberof MigrationApiFlushIngestedDataSync
|
|
692
|
-
*/
|
|
693
|
-
readonly flushIngestedDataRequestDto: FlushIngestedDataRequestDto;
|
|
694
|
-
/**
|
|
695
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
696
|
-
* @type {string}
|
|
697
|
-
* @memberof MigrationApiFlushIngestedDataSync
|
|
698
|
-
*/
|
|
699
|
-
readonly authorization?: string;
|
|
700
|
-
}
|
|
701
|
-
/**
|
|
702
|
-
* Request parameters for getIngestFlush operation in MigrationApi.
|
|
703
|
-
* @export
|
|
704
|
-
* @interface MigrationApiGetIngestFlushRequest
|
|
705
|
-
*/
|
|
706
|
-
export interface MigrationApiGetIngestFlushRequest {
|
|
707
|
-
/**
|
|
708
|
-
*
|
|
709
|
-
* @type {string}
|
|
710
|
-
* @memberof MigrationApiGetIngestFlush
|
|
711
|
-
*/
|
|
712
|
-
readonly code: string;
|
|
713
|
-
/**
|
|
714
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
715
|
-
* @type {string}
|
|
716
|
-
* @memberof MigrationApiGetIngestFlush
|
|
717
|
-
*/
|
|
718
|
-
readonly authorization?: string;
|
|
719
|
-
}
|
|
720
452
|
/**
|
|
721
453
|
* Request parameters for getIngestRun operation in MigrationApi.
|
|
722
454
|
* @export
|
|
@@ -780,7 +512,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
780
512
|
*/
|
|
781
513
|
readonly pageToken?: string;
|
|
782
514
|
/**
|
|
783
|
-
* Filter the response by one or multiple fields.
|
|
515
|
+
* 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
516
|
* @type {string}
|
|
785
517
|
* @memberof MigrationApiListEntityMappings
|
|
786
518
|
*/
|
|
@@ -804,208 +536,67 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
804
536
|
*/
|
|
805
537
|
readonly expand?: string;
|
|
806
538
|
/**
|
|
807
|
-
* Filters the response by one or multiple fields.
|
|
539
|
+
* 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
540
|
* @type {string}
|
|
809
541
|
* @memberof MigrationApiListEntityMappings
|
|
810
542
|
*/
|
|
811
543
|
readonly filters?: string;
|
|
812
544
|
}
|
|
813
545
|
/**
|
|
814
|
-
* Request parameters for
|
|
546
|
+
* Request parameters for listTasks operation in MigrationApi.
|
|
815
547
|
* @export
|
|
816
|
-
* @interface
|
|
548
|
+
* @interface MigrationApiListTasksRequest
|
|
817
549
|
*/
|
|
818
|
-
export interface
|
|
550
|
+
export interface MigrationApiListTasksRequest {
|
|
819
551
|
/**
|
|
820
552
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
821
553
|
* @type {string}
|
|
822
|
-
* @memberof
|
|
554
|
+
* @memberof MigrationApiListTasks
|
|
823
555
|
*/
|
|
824
556
|
readonly authorization?: string;
|
|
825
557
|
/**
|
|
826
558
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
827
559
|
* @type {number}
|
|
828
|
-
* @memberof
|
|
560
|
+
* @memberof MigrationApiListTasks
|
|
829
561
|
*/
|
|
830
562
|
readonly pageSize?: number;
|
|
831
563
|
/**
|
|
832
564
|
* 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.
|
|
833
565
|
* @type {string}
|
|
834
|
-
* @memberof
|
|
566
|
+
* @memberof MigrationApiListTasks
|
|
835
567
|
*/
|
|
836
568
|
readonly pageToken?: string;
|
|
837
569
|
/**
|
|
838
|
-
* Filter the response by one or multiple fields.
|
|
570
|
+
* 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>
|
|
839
571
|
* @type {string}
|
|
840
|
-
* @memberof
|
|
841
|
-
*/
|
|
842
|
-
readonly filter?: string;
|
|
843
|
-
/**
|
|
844
|
-
* 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>
|
|
845
|
-
* @type {string}
|
|
846
|
-
* @memberof MigrationApiListIngestFlushes
|
|
847
|
-
*/
|
|
848
|
-
readonly search?: string;
|
|
849
|
-
/**
|
|
850
|
-
* 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>
|
|
851
|
-
* @type {string}
|
|
852
|
-
* @memberof MigrationApiListIngestFlushes
|
|
853
|
-
*/
|
|
854
|
-
readonly order?: string;
|
|
855
|
-
/**
|
|
856
|
-
* 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>
|
|
857
|
-
* @type {string}
|
|
858
|
-
* @memberof MigrationApiListIngestFlushes
|
|
859
|
-
*/
|
|
860
|
-
readonly expand?: string;
|
|
861
|
-
/**
|
|
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>
|
|
863
|
-
* @type {string}
|
|
864
|
-
* @memberof MigrationApiListIngestFlushes
|
|
865
|
-
*/
|
|
866
|
-
readonly filters?: string;
|
|
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
|
-
}
|
|
929
|
-
/**
|
|
930
|
-
* Request parameters for listIngestRuns operation in MigrationApi.
|
|
931
|
-
* @export
|
|
932
|
-
* @interface MigrationApiListIngestRunsRequest
|
|
933
|
-
*/
|
|
934
|
-
export interface MigrationApiListIngestRunsRequest {
|
|
935
|
-
/**
|
|
936
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
937
|
-
* @type {string}
|
|
938
|
-
* @memberof MigrationApiListIngestRuns
|
|
939
|
-
*/
|
|
940
|
-
readonly authorization?: string;
|
|
941
|
-
/**
|
|
942
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
943
|
-
* @type {number}
|
|
944
|
-
* @memberof MigrationApiListIngestRuns
|
|
945
|
-
*/
|
|
946
|
-
readonly pageSize?: number;
|
|
947
|
-
/**
|
|
948
|
-
* 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.
|
|
949
|
-
* @type {string}
|
|
950
|
-
* @memberof MigrationApiListIngestRuns
|
|
951
|
-
*/
|
|
952
|
-
readonly pageToken?: string;
|
|
953
|
-
/**
|
|
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>
|
|
955
|
-
* @type {string}
|
|
956
|
-
* @memberof MigrationApiListIngestRuns
|
|
572
|
+
* @memberof MigrationApiListTasks
|
|
957
573
|
*/
|
|
958
574
|
readonly filter?: string;
|
|
959
575
|
/**
|
|
960
576
|
* 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>
|
|
961
577
|
* @type {string}
|
|
962
|
-
* @memberof
|
|
578
|
+
* @memberof MigrationApiListTasks
|
|
963
579
|
*/
|
|
964
580
|
readonly search?: string;
|
|
965
581
|
/**
|
|
966
582
|
* 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>
|
|
967
583
|
* @type {string}
|
|
968
|
-
* @memberof
|
|
584
|
+
* @memberof MigrationApiListTasks
|
|
969
585
|
*/
|
|
970
586
|
readonly order?: string;
|
|
971
587
|
/**
|
|
972
588
|
* 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>
|
|
973
589
|
* @type {string}
|
|
974
|
-
* @memberof
|
|
590
|
+
* @memberof MigrationApiListTasks
|
|
975
591
|
*/
|
|
976
592
|
readonly expand?: string;
|
|
977
593
|
/**
|
|
978
|
-
* Filters the response by one or multiple fields.
|
|
594
|
+
* 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
595
|
* @type {string}
|
|
980
|
-
* @memberof
|
|
596
|
+
* @memberof MigrationApiListTasks
|
|
981
597
|
*/
|
|
982
598
|
readonly filters?: string;
|
|
983
599
|
}
|
|
984
|
-
/**
|
|
985
|
-
* Request parameters for stopIngestFlush operation in MigrationApi.
|
|
986
|
-
* @export
|
|
987
|
-
* @interface MigrationApiStopIngestFlushRequest
|
|
988
|
-
*/
|
|
989
|
-
export interface MigrationApiStopIngestFlushRequest {
|
|
990
|
-
/**
|
|
991
|
-
*
|
|
992
|
-
* @type {string}
|
|
993
|
-
* @memberof MigrationApiStopIngestFlush
|
|
994
|
-
*/
|
|
995
|
-
readonly code: string;
|
|
996
|
-
/**
|
|
997
|
-
*
|
|
998
|
-
* @type {StopIngestFlushRequestDto}
|
|
999
|
-
* @memberof MigrationApiStopIngestFlush
|
|
1000
|
-
*/
|
|
1001
|
-
readonly stopIngestFlushRequestDto: StopIngestFlushRequestDto;
|
|
1002
|
-
/**
|
|
1003
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1004
|
-
* @type {string}
|
|
1005
|
-
* @memberof MigrationApiStopIngestFlush
|
|
1006
|
-
*/
|
|
1007
|
-
readonly authorization?: string;
|
|
1008
|
-
}
|
|
1009
600
|
/**
|
|
1010
601
|
* Request parameters for stopIngestRun operation in MigrationApi.
|
|
1011
602
|
* @export
|
|
@@ -1099,33 +690,6 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1099
690
|
* @memberof MigrationApi
|
|
1100
691
|
*/
|
|
1101
692
|
createIngestRunSync(requestParameters: MigrationApiCreateIngestRunSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateIngestRunSyncResponseClass, any, {}>>;
|
|
1102
|
-
/**
|
|
1103
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1104
|
-
* @summary Create the Sync ingest flush
|
|
1105
|
-
* @param {MigrationApiFlushIngestedDataAsyncRequest} requestParameters Request parameters.
|
|
1106
|
-
* @param {*} [options] Override http request option.
|
|
1107
|
-
* @throws {RequiredError}
|
|
1108
|
-
* @memberof MigrationApi
|
|
1109
|
-
*/
|
|
1110
|
-
flushIngestedDataAsync(requestParameters: MigrationApiFlushIngestedDataAsyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FlushIngestedDataResponseClass, any, {}>>;
|
|
1111
|
-
/**
|
|
1112
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1113
|
-
* @summary Create the Sync ingest flush
|
|
1114
|
-
* @param {MigrationApiFlushIngestedDataSyncRequest} requestParameters Request parameters.
|
|
1115
|
-
* @param {*} [options] Override http request option.
|
|
1116
|
-
* @throws {RequiredError}
|
|
1117
|
-
* @memberof MigrationApi
|
|
1118
|
-
*/
|
|
1119
|
-
flushIngestedDataSync(requestParameters: MigrationApiFlushIngestedDataSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FlushIngestedDataResponseClass, any, {}>>;
|
|
1120
|
-
/**
|
|
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\"
|
|
1122
|
-
* @summary Retrieve the ingest flush
|
|
1123
|
-
* @param {MigrationApiGetIngestFlushRequest} requestParameters Request parameters.
|
|
1124
|
-
* @param {*} [options] Override http request option.
|
|
1125
|
-
* @throws {RequiredError}
|
|
1126
|
-
* @memberof MigrationApi
|
|
1127
|
-
*/
|
|
1128
|
-
getIngestFlush(requestParameters: MigrationApiGetIngestFlushRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIngestFlushResponseClass, any, {}>>;
|
|
1129
693
|
/**
|
|
1130
694
|
* Retrieves the details of the ingest run that was previously created. Supply the unique ingest run code that was returned when you created it and Emil Api will return the corresponding ingest run information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
1131
695
|
* @summary Retrieve the ingest run
|
|
@@ -1145,7 +709,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1145
709
|
*/
|
|
1146
710
|
getJsonSchemas(requestParameters: MigrationApiGetJsonSchemasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJsonSchemasResponseClass, any, {}>>;
|
|
1147
711
|
/**
|
|
1148
|
-
* Returns a list of entity mappings you have previously created.
|
|
712
|
+
* 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
713
|
* @summary List entity mappings
|
|
1150
714
|
* @param {MigrationApiListEntityMappingsRequest} requestParameters Request parameters.
|
|
1151
715
|
* @param {*} [options] Override http request option.
|
|
@@ -1154,41 +718,14 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1154
718
|
*/
|
|
1155
719
|
listEntityMappings(requestParameters?: MigrationApiListEntityMappingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEntityMappingsResponseClass, any, {}>>;
|
|
1156
720
|
/**
|
|
1157
|
-
* Returns a list of ingest
|
|
1158
|
-
* @summary List ingest flushes
|
|
1159
|
-
* @param {MigrationApiListIngestFlushesRequest} requestParameters Request parameters.
|
|
1160
|
-
* @param {*} [options] Override http request option.
|
|
1161
|
-
* @throws {RequiredError}
|
|
1162
|
-
* @memberof MigrationApi
|
|
1163
|
-
*/
|
|
1164
|
-
listIngestFlushes(requestParameters?: MigrationApiListIngestFlushesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestFlushesResponseClass, any, {}>>;
|
|
1165
|
-
/**
|
|
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\"
|
|
721
|
+
* 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
722
|
* @summary List ingest runs
|
|
1177
|
-
* @param {
|
|
1178
|
-
* @param {*} [options] Override http request option.
|
|
1179
|
-
* @throws {RequiredError}
|
|
1180
|
-
* @memberof MigrationApi
|
|
1181
|
-
*/
|
|
1182
|
-
listIngestRuns(requestParameters?: MigrationApiListIngestRunsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestRunsResponseClass, any, {}>>;
|
|
1183
|
-
/**
|
|
1184
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1185
|
-
* @summary Stops the ingest flush
|
|
1186
|
-
* @param {MigrationApiStopIngestFlushRequest} requestParameters Request parameters.
|
|
723
|
+
* @param {MigrationApiListTasksRequest} requestParameters Request parameters.
|
|
1187
724
|
* @param {*} [options] Override http request option.
|
|
1188
725
|
* @throws {RequiredError}
|
|
1189
726
|
* @memberof MigrationApi
|
|
1190
727
|
*/
|
|
1191
|
-
|
|
728
|
+
listTasks(requestParameters?: MigrationApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestRunsResponseClass, any, {}>>;
|
|
1192
729
|
/**
|
|
1193
730
|
* This will stop the running ingest run. **Required Permissions** \"migration.ingest-runs.*\"
|
|
1194
731
|
* @summary Stops the ingest run
|