@emilgroup/migration-sdk 0.1.1-beta.11 → 0.1.1-beta.13
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/README.md +2 -2
- package/api/migration-api.ts +48 -48
- package/dist/api/migration-api.d.ts +48 -48
- package/dist/api/migration-api.js +40 -40
- package/package.json +1 -1
|
@@ -121,62 +121,62 @@ export declare const MigrationApiAxiosParamCreator: (configuration?: Configurati
|
|
|
121
121
|
*/
|
|
122
122
|
getJsonSchemas: (sourceEntity: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
123
123
|
/**
|
|
124
|
-
* Returns a list of entity mappings you have previously created.
|
|
124
|
+
* Returns a list of entity mappings you have previously created. The entity mappings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
125
125
|
* @summary List entity mappings
|
|
126
126
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
127
127
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
128
128
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
129
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
129
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
130
130
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, sourceEntity, sourceId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3</i>
|
|
131
131
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
132
132
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
133
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
133
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
134
134
|
* @param {*} [options] Override http request option.
|
|
135
135
|
* @throws {RequiredError}
|
|
136
136
|
*/
|
|
137
137
|
listEntityMappings: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
138
138
|
/**
|
|
139
|
-
* Returns a list of ingest flushes you have previously created.
|
|
139
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
140
140
|
* @summary List ingest flushes
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
142
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
143
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.
|
|
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
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
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
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.
|
|
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
149
|
* @param {*} [options] Override http request option.
|
|
150
150
|
* @throws {RequiredError}
|
|
151
151
|
*/
|
|
152
152
|
listIngestFlushes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
153
153
|
/**
|
|
154
|
-
* Returns a list of ingest run records you have previously created.
|
|
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
155
|
* @summary List ingest run records
|
|
156
156
|
* @param {string} code
|
|
157
157
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
158
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
159
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.
|
|
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
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
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
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.
|
|
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
165
|
* @param {*} [options] Override http request option.
|
|
166
166
|
* @throws {RequiredError}
|
|
167
167
|
*/
|
|
168
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
169
|
/**
|
|
170
|
-
* Returns a list of ingest runs you have previously created.
|
|
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\"
|
|
171
171
|
* @summary List ingest runs
|
|
172
172
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
173
173
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
174
174
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
175
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
175
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
176
176
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, sourceEntity, payload, fileUrl, errorMessage, code</i>
|
|
177
177
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
178
178
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: batches<i>
|
|
179
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
179
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
180
180
|
* @param {*} [options] Override http request option.
|
|
181
181
|
* @throws {RequiredError}
|
|
182
182
|
*/
|
|
@@ -301,62 +301,62 @@ export declare const MigrationApiFp: (configuration?: Configuration) => {
|
|
|
301
301
|
*/
|
|
302
302
|
getJsonSchemas(sourceEntity: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJsonSchemasResponseClass>>;
|
|
303
303
|
/**
|
|
304
|
-
* Returns a list of entity mappings you have previously created.
|
|
304
|
+
* Returns a list of entity mappings you have previously created. The entity mappings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
305
305
|
* @summary List entity mappings
|
|
306
306
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
307
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
308
308
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
309
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
309
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
310
310
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, sourceEntity, sourceId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3</i>
|
|
311
311
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
312
312
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
313
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
313
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
314
314
|
* @param {*} [options] Override http request option.
|
|
315
315
|
* @throws {RequiredError}
|
|
316
316
|
*/
|
|
317
317
|
listEntityMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEntityMappingsResponseClass>>;
|
|
318
318
|
/**
|
|
319
|
-
* Returns a list of ingest flushes you have previously created.
|
|
319
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
320
320
|
* @summary List ingest flushes
|
|
321
321
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
322
322
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
323
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.
|
|
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
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
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
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.
|
|
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
329
|
* @param {*} [options] Override http request option.
|
|
330
330
|
* @throws {RequiredError}
|
|
331
331
|
*/
|
|
332
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
333
|
/**
|
|
334
|
-
* Returns a list of ingest run records you have previously created.
|
|
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
335
|
* @summary List ingest run records
|
|
336
336
|
* @param {string} code
|
|
337
337
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
338
338
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
339
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.
|
|
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
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
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
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.
|
|
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
345
|
* @param {*} [options] Override http request option.
|
|
346
346
|
* @throws {RequiredError}
|
|
347
347
|
*/
|
|
348
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
349
|
/**
|
|
350
|
-
* Returns a list of ingest runs you have previously created.
|
|
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\"
|
|
351
351
|
* @summary List ingest runs
|
|
352
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
353
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
354
354
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
355
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
355
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
356
356
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, sourceEntity, payload, fileUrl, errorMessage, code</i>
|
|
357
357
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
358
358
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: batches<i>
|
|
359
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
359
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
361
361
|
* @throws {RequiredError}
|
|
362
362
|
*/
|
|
@@ -481,62 +481,62 @@ export declare const MigrationApiFactory: (configuration?: Configuration, basePa
|
|
|
481
481
|
*/
|
|
482
482
|
getJsonSchemas(sourceEntity: string, authorization?: string, options?: any): AxiosPromise<GetJsonSchemasResponseClass>;
|
|
483
483
|
/**
|
|
484
|
-
* Returns a list of entity mappings you have previously created.
|
|
484
|
+
* Returns a list of entity mappings you have previously created. The entity mappings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
485
485
|
* @summary List entity mappings
|
|
486
486
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
487
487
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
488
488
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
489
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
489
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
490
490
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, sourceEntity, sourceId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3</i>
|
|
491
491
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
492
492
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
493
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
493
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
494
494
|
* @param {*} [options] Override http request option.
|
|
495
495
|
* @throws {RequiredError}
|
|
496
496
|
*/
|
|
497
497
|
listEntityMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEntityMappingsResponseClass>;
|
|
498
498
|
/**
|
|
499
|
-
* Returns a list of ingest flushes you have previously created.
|
|
499
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
500
500
|
* @summary List ingest flushes
|
|
501
501
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
502
502
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
503
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.
|
|
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
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
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
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.
|
|
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
509
|
* @param {*} [options] Override http request option.
|
|
510
510
|
* @throws {RequiredError}
|
|
511
511
|
*/
|
|
512
512
|
listIngestFlushes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestFlushesResponseClass>;
|
|
513
513
|
/**
|
|
514
|
-
* Returns a list of ingest run records you have previously created.
|
|
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
515
|
* @summary List ingest run records
|
|
516
516
|
* @param {string} code
|
|
517
517
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
518
518
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
519
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.
|
|
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
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
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
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.
|
|
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
525
|
* @param {*} [options] Override http request option.
|
|
526
526
|
* @throws {RequiredError}
|
|
527
527
|
*/
|
|
528
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
529
|
/**
|
|
530
|
-
* Returns a list of ingest runs you have previously created.
|
|
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\"
|
|
531
531
|
* @summary List ingest runs
|
|
532
532
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
533
533
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
534
534
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
535
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
535
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
536
536
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: sourceSystem, sourceEntity, payload, fileUrl, errorMessage, code</i>
|
|
537
537
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, code, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
538
538
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: batches<i>
|
|
539
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
539
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
540
540
|
* @param {*} [options] Override http request option.
|
|
541
541
|
* @throws {RequiredError}
|
|
542
542
|
*/
|
|
@@ -780,7 +780,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
780
780
|
*/
|
|
781
781
|
readonly pageToken?: string;
|
|
782
782
|
/**
|
|
783
|
-
* Filter the response by one or multiple fields.
|
|
783
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
784
784
|
* @type {string}
|
|
785
785
|
* @memberof MigrationApiListEntityMappings
|
|
786
786
|
*/
|
|
@@ -804,7 +804,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
804
804
|
*/
|
|
805
805
|
readonly expand?: string;
|
|
806
806
|
/**
|
|
807
|
-
* Filters the response by one or multiple fields.
|
|
807
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, ern, sourceSystem, sourceEntity, sourceId, targetEntity, targetId, targetCode, targetSlug, targetOtherId1, targetOtherId2, targetOtherId3, ingestBatchId</i>
|
|
808
808
|
* @type {string}
|
|
809
809
|
* @memberof MigrationApiListEntityMappings
|
|
810
810
|
*/
|
|
@@ -835,7 +835,7 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
835
835
|
*/
|
|
836
836
|
readonly pageToken?: string;
|
|
837
837
|
/**
|
|
838
|
-
* Filter the response by one or multiple fields.
|
|
838
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
839
839
|
* @type {string}
|
|
840
840
|
* @memberof MigrationApiListIngestFlushes
|
|
841
841
|
*/
|
|
@@ -859,7 +859,7 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
859
859
|
*/
|
|
860
860
|
readonly expand?: string;
|
|
861
861
|
/**
|
|
862
|
-
* Filters the response by one or multiple fields.
|
|
862
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, totalDeletedRowCount, isSuccess, errorMessage</i>
|
|
863
863
|
* @type {string}
|
|
864
864
|
* @memberof MigrationApiListIngestFlushes
|
|
865
865
|
*/
|
|
@@ -896,7 +896,7 @@ export interface MigrationApiListIngestRunRecordsRequest {
|
|
|
896
896
|
*/
|
|
897
897
|
readonly pageToken?: string;
|
|
898
898
|
/**
|
|
899
|
-
* Filter the response by one or multiple fields.
|
|
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
900
|
* @type {string}
|
|
901
901
|
* @memberof MigrationApiListIngestRunRecords
|
|
902
902
|
*/
|
|
@@ -920,7 +920,7 @@ export interface MigrationApiListIngestRunRecordsRequest {
|
|
|
920
920
|
*/
|
|
921
921
|
readonly expand?: string;
|
|
922
922
|
/**
|
|
923
|
-
* Filters the response by one or multiple fields.
|
|
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
924
|
* @type {string}
|
|
925
925
|
* @memberof MigrationApiListIngestRunRecords
|
|
926
926
|
*/
|
|
@@ -951,7 +951,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
951
951
|
*/
|
|
952
952
|
readonly pageToken?: string;
|
|
953
953
|
/**
|
|
954
|
-
* Filter the response by one or multiple fields.
|
|
954
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
955
955
|
* @type {string}
|
|
956
956
|
* @memberof MigrationApiListIngestRuns
|
|
957
957
|
*/
|
|
@@ -975,7 +975,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
975
975
|
*/
|
|
976
976
|
readonly expand?: string;
|
|
977
977
|
/**
|
|
978
|
-
* Filters the response by one or multiple fields.
|
|
978
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, updatedAt, ern, sourceSystem, sourceEntity, fileUrl, recordCount, isSuccess, errorMessage</i>
|
|
979
979
|
* @type {string}
|
|
980
980
|
* @memberof MigrationApiListIngestRuns
|
|
981
981
|
*/
|
|
@@ -1145,7 +1145,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1145
1145
|
*/
|
|
1146
1146
|
getJsonSchemas(requestParameters: MigrationApiGetJsonSchemasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJsonSchemasResponseClass, any, {}>>;
|
|
1147
1147
|
/**
|
|
1148
|
-
* Returns a list of entity mappings you have previously created.
|
|
1148
|
+
* Returns a list of entity mappings you have previously created. The entity mappings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
1149
1149
|
* @summary List entity mappings
|
|
1150
1150
|
* @param {MigrationApiListEntityMappingsRequest} requestParameters Request parameters.
|
|
1151
1151
|
* @param {*} [options] Override http request option.
|
|
@@ -1154,7 +1154,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1154
1154
|
*/
|
|
1155
1155
|
listEntityMappings(requestParameters?: MigrationApiListEntityMappingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEntityMappingsResponseClass, any, {}>>;
|
|
1156
1156
|
/**
|
|
1157
|
-
* Returns a list of ingest flushes you have previously created.
|
|
1157
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-flushes.view\"
|
|
1158
1158
|
* @summary List ingest flushes
|
|
1159
1159
|
* @param {MigrationApiListIngestFlushesRequest} requestParameters Request parameters.
|
|
1160
1160
|
* @param {*} [options] Override http request option.
|
|
@@ -1163,7 +1163,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1163
1163
|
*/
|
|
1164
1164
|
listIngestFlushes(requestParameters?: MigrationApiListIngestFlushesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestFlushesResponseClass, any, {}>>;
|
|
1165
1165
|
/**
|
|
1166
|
-
* Returns a list of ingest run records you have previously created.
|
|
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
1167
|
* @summary List ingest run records
|
|
1168
1168
|
* @param {MigrationApiListIngestRunRecordsRequest} requestParameters Request parameters.
|
|
1169
1169
|
* @param {*} [options] Override http request option.
|
|
@@ -1172,7 +1172,7 @@ export declare class MigrationApi extends BaseAPI {
|
|
|
1172
1172
|
*/
|
|
1173
1173
|
listIngestRunRecords(requestParameters: MigrationApiListIngestRunRecordsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListIngestRunRecordsResponseClass, any, {}>>;
|
|
1174
1174
|
/**
|
|
1175
|
-
* Returns a list of ingest runs you have previously created.
|
|
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\"
|
|
1176
1176
|
* @summary List ingest runs
|
|
1177
1177
|
* @param {MigrationApiListIngestRunsRequest} requestParameters Request parameters.
|
|
1178
1178
|
* @param {*} [options] Override http request option.
|