@emilgroup/migration-sdk 0.1.1-beta.13 → 0.1.1-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -2
- package/README.md +2 -2
- package/api/migration-api.ts +52 -253
- package/dist/api/migration-api.d.ts +52 -171
- package/dist/api/migration-api.js +46 -180
- package/dist/models/index.d.ts +0 -2
- package/dist/models/index.js +0 -2
- package/models/index.ts +0 -2
- package/package.json +1 -1
- package/dist/models/ingest-run-record-class.d.ts +0 -102
- package/dist/models/ingest-run-record-class.js +0 -15
- package/dist/models/list-ingest-run-records-response-class.d.ts +0 -43
- package/dist/models/list-ingest-run-records-response-class.js +0 -15
- package/models/ingest-run-record-class.ts +0 -108
- package/models/list-ingest-run-records-response-class.ts +0 -49
package/api/migration-api.ts
CHANGED
|
@@ -47,8 +47,6 @@ import { ListEntityMappingsResponseClass } from '../models';
|
|
|
47
47
|
// @ts-ignore
|
|
48
48
|
import { ListIngestFlushesResponseClass } from '../models';
|
|
49
49
|
// @ts-ignore
|
|
50
|
-
import { ListIngestRunRecordsResponseClass } from '../models';
|
|
51
|
-
// @ts-ignore
|
|
52
50
|
import { ListIngestRunsResponseClass } from '../models';
|
|
53
51
|
// @ts-ignore
|
|
54
52
|
import { StopIngestFlushRequestDto } from '../models';
|
|
@@ -263,7 +261,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
263
261
|
};
|
|
264
262
|
},
|
|
265
263
|
/**
|
|
266
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
264
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
267
265
|
* @summary Create the Sync ingest flush
|
|
268
266
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
269
267
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -310,7 +308,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
310
308
|
};
|
|
311
309
|
},
|
|
312
310
|
/**
|
|
313
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
311
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
314
312
|
* @summary Create the Sync ingest flush
|
|
315
313
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
316
314
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -357,7 +355,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
357
355
|
};
|
|
358
356
|
},
|
|
359
357
|
/**
|
|
360
|
-
* 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-
|
|
358
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
361
359
|
* @summary Retrieve the ingest flush
|
|
362
360
|
* @param {string} code
|
|
363
361
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -492,16 +490,16 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
492
490
|
};
|
|
493
491
|
},
|
|
494
492
|
/**
|
|
495
|
-
* Returns a list of entity mappings you have previously created.
|
|
493
|
+
* 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\"
|
|
496
494
|
* @summary List entity mappings
|
|
497
495
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
498
496
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
499
497
|
* @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.
|
|
500
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
498
|
+
* @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>
|
|
501
499
|
* @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>
|
|
502
500
|
* @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>
|
|
503
501
|
* @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/>
|
|
504
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
502
|
+
* @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>
|
|
505
503
|
* @param {*} [options] Override http request option.
|
|
506
504
|
* @throws {RequiredError}
|
|
507
505
|
*/
|
|
@@ -568,16 +566,16 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
568
566
|
};
|
|
569
567
|
},
|
|
570
568
|
/**
|
|
571
|
-
* Returns a list of ingest flushes you have previously created.
|
|
569
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
572
570
|
* @summary List ingest flushes
|
|
573
571
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
574
572
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
575
573
|
* @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.
|
|
576
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
574
|
+
* @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>
|
|
577
575
|
* @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>
|
|
578
576
|
* @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>
|
|
579
577
|
* @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>
|
|
580
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
578
|
+
* @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>
|
|
581
579
|
* @param {*} [options] Override http request option.
|
|
582
580
|
* @throws {RequiredError}
|
|
583
581
|
*/
|
|
@@ -644,96 +642,16 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
644
642
|
};
|
|
645
643
|
},
|
|
646
644
|
/**
|
|
647
|
-
* Returns a list of ingest
|
|
648
|
-
* @summary List ingest run records
|
|
649
|
-
* @param {string} code
|
|
650
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
651
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
652
|
-
* @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.
|
|
653
|
-
* @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>
|
|
654
|
-
* @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>
|
|
655
|
-
* @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>
|
|
656
|
-
* @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/>
|
|
657
|
-
* @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>
|
|
658
|
-
* @param {*} [options] Override http request option.
|
|
659
|
-
* @throws {RequiredError}
|
|
660
|
-
*/
|
|
661
|
-
listIngestRunRecords: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
662
|
-
// verify required parameter 'code' is not null or undefined
|
|
663
|
-
assertParamExists('listIngestRunRecords', 'code', code)
|
|
664
|
-
const localVarPath = `/migrationservice/v1/ingest-runs/{code}/records`
|
|
665
|
-
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
666
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
667
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
668
|
-
let baseOptions;
|
|
669
|
-
let baseAccessToken;
|
|
670
|
-
if (configuration) {
|
|
671
|
-
baseOptions = configuration.baseOptions;
|
|
672
|
-
baseAccessToken = configuration.accessToken;
|
|
673
|
-
}
|
|
674
|
-
|
|
675
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
676
|
-
const localVarHeaderParameter = {} as any;
|
|
677
|
-
const localVarQueryParameter = {} as any;
|
|
678
|
-
|
|
679
|
-
// authentication bearer required
|
|
680
|
-
// http bearer authentication required
|
|
681
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
682
|
-
|
|
683
|
-
if (pageSize !== undefined) {
|
|
684
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
685
|
-
}
|
|
686
|
-
|
|
687
|
-
if (pageToken !== undefined) {
|
|
688
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
689
|
-
}
|
|
690
|
-
|
|
691
|
-
if (filter !== undefined) {
|
|
692
|
-
localVarQueryParameter['filter'] = filter;
|
|
693
|
-
}
|
|
694
|
-
|
|
695
|
-
if (search !== undefined) {
|
|
696
|
-
localVarQueryParameter['search'] = search;
|
|
697
|
-
}
|
|
698
|
-
|
|
699
|
-
if (order !== undefined) {
|
|
700
|
-
localVarQueryParameter['order'] = order;
|
|
701
|
-
}
|
|
702
|
-
|
|
703
|
-
if (expand !== undefined) {
|
|
704
|
-
localVarQueryParameter['expand'] = expand;
|
|
705
|
-
}
|
|
706
|
-
|
|
707
|
-
if (filters !== undefined) {
|
|
708
|
-
localVarQueryParameter['filters'] = filters;
|
|
709
|
-
}
|
|
710
|
-
|
|
711
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
712
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
713
|
-
}
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
718
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
719
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
720
|
-
|
|
721
|
-
return {
|
|
722
|
-
url: toPathString(localVarUrlObj),
|
|
723
|
-
options: localVarRequestOptions,
|
|
724
|
-
};
|
|
725
|
-
},
|
|
726
|
-
/**
|
|
727
|
-
* 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\"
|
|
645
|
+
* 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\"
|
|
728
646
|
* @summary List ingest runs
|
|
729
647
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
730
648
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
731
649
|
* @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.
|
|
732
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
650
|
+
* @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>
|
|
733
651
|
* @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>
|
|
734
652
|
* @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>
|
|
735
653
|
* @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>
|
|
736
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
654
|
+
* @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>
|
|
737
655
|
* @param {*} [options] Override http request option.
|
|
738
656
|
* @throws {RequiredError}
|
|
739
657
|
*/
|
|
@@ -800,7 +718,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
800
718
|
};
|
|
801
719
|
},
|
|
802
720
|
/**
|
|
803
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
721
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
804
722
|
* @summary Stops the ingest flush
|
|
805
723
|
* @param {string} code
|
|
806
724
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -1013,7 +931,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1013
931
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1014
932
|
},
|
|
1015
933
|
/**
|
|
1016
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
934
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
1017
935
|
* @summary Create the Sync ingest flush
|
|
1018
936
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
1019
937
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1025,7 +943,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1025
943
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1026
944
|
},
|
|
1027
945
|
/**
|
|
1028
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
946
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
1029
947
|
* @summary Create the Sync ingest flush
|
|
1030
948
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
1031
949
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1037,7 +955,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1037
955
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1038
956
|
},
|
|
1039
957
|
/**
|
|
1040
|
-
* 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-
|
|
958
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
1041
959
|
* @summary Retrieve the ingest flush
|
|
1042
960
|
* @param {string} code
|
|
1043
961
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1073,16 +991,16 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1073
991
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1074
992
|
},
|
|
1075
993
|
/**
|
|
1076
|
-
* Returns a list of entity mappings you have previously created.
|
|
994
|
+
* 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\"
|
|
1077
995
|
* @summary List entity mappings
|
|
1078
996
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1079
997
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1080
998
|
* @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.
|
|
1081
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
999
|
+
* @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>
|
|
1082
1000
|
* @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>
|
|
1083
1001
|
* @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>
|
|
1084
1002
|
* @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/>
|
|
1085
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1003
|
+
* @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>
|
|
1086
1004
|
* @param {*} [options] Override http request option.
|
|
1087
1005
|
* @throws {RequiredError}
|
|
1088
1006
|
*/
|
|
@@ -1091,16 +1009,16 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1091
1009
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1092
1010
|
},
|
|
1093
1011
|
/**
|
|
1094
|
-
* Returns a list of ingest flushes you have previously created.
|
|
1012
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
1095
1013
|
* @summary List ingest flushes
|
|
1096
1014
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1097
1015
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1098
1016
|
* @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.
|
|
1099
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1017
|
+
* @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>
|
|
1100
1018
|
* @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>
|
|
1101
1019
|
* @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>
|
|
1102
1020
|
* @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>
|
|
1103
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1021
|
+
* @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>
|
|
1104
1022
|
* @param {*} [options] Override http request option.
|
|
1105
1023
|
* @throws {RequiredError}
|
|
1106
1024
|
*/
|
|
@@ -1109,35 +1027,16 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1109
1027
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1110
1028
|
},
|
|
1111
1029
|
/**
|
|
1112
|
-
* Returns a list of ingest
|
|
1113
|
-
* @summary List ingest run records
|
|
1114
|
-
* @param {string} code
|
|
1115
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1116
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1117
|
-
* @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.
|
|
1118
|
-
* @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>
|
|
1119
|
-
* @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>
|
|
1120
|
-
* @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>
|
|
1121
|
-
* @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/>
|
|
1122
|
-
* @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>
|
|
1123
|
-
* @param {*} [options] Override http request option.
|
|
1124
|
-
* @throws {RequiredError}
|
|
1125
|
-
*/
|
|
1126
|
-
async 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>> {
|
|
1127
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listIngestRunRecords(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
1128
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1129
|
-
},
|
|
1130
|
-
/**
|
|
1131
|
-
* 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\"
|
|
1030
|
+
* 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\"
|
|
1132
1031
|
* @summary List ingest runs
|
|
1133
1032
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1134
1033
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1135
1034
|
* @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.
|
|
1136
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1035
|
+
* @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>
|
|
1137
1036
|
* @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>
|
|
1138
1037
|
* @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>
|
|
1139
1038
|
* @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>
|
|
1140
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1039
|
+
* @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>
|
|
1141
1040
|
* @param {*} [options] Override http request option.
|
|
1142
1041
|
* @throws {RequiredError}
|
|
1143
1042
|
*/
|
|
@@ -1146,7 +1045,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1146
1045
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1147
1046
|
},
|
|
1148
1047
|
/**
|
|
1149
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
1048
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
1150
1049
|
* @summary Stops the ingest flush
|
|
1151
1050
|
* @param {string} code
|
|
1152
1051
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -1241,7 +1140,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1241
1140
|
return localVarFp.createIngestRunSync(createIngestRunSyncRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1242
1141
|
},
|
|
1243
1142
|
/**
|
|
1244
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1143
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
1245
1144
|
* @summary Create the Sync ingest flush
|
|
1246
1145
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
1247
1146
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1252,7 +1151,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1252
1151
|
return localVarFp.flushIngestedDataAsync(flushIngestedDataRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1253
1152
|
},
|
|
1254
1153
|
/**
|
|
1255
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1154
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
1256
1155
|
* @summary Create the Sync ingest flush
|
|
1257
1156
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
1258
1157
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1263,7 +1162,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1263
1162
|
return localVarFp.flushIngestedDataSync(flushIngestedDataRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1264
1163
|
},
|
|
1265
1164
|
/**
|
|
1266
|
-
* 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-
|
|
1165
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
1267
1166
|
* @summary Retrieve the ingest flush
|
|
1268
1167
|
* @param {string} code
|
|
1269
1168
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1296,16 +1195,16 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1296
1195
|
return localVarFp.getJsonSchemas(sourceEntity, authorization, options).then((request) => request(axios, basePath));
|
|
1297
1196
|
},
|
|
1298
1197
|
/**
|
|
1299
|
-
* Returns a list of entity mappings you have previously created.
|
|
1198
|
+
* 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\"
|
|
1300
1199
|
* @summary List entity mappings
|
|
1301
1200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1302
1201
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1303
1202
|
* @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.
|
|
1304
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1203
|
+
* @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>
|
|
1305
1204
|
* @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>
|
|
1306
1205
|
* @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>
|
|
1307
1206
|
* @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/>
|
|
1308
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1207
|
+
* @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>
|
|
1309
1208
|
* @param {*} [options] Override http request option.
|
|
1310
1209
|
* @throws {RequiredError}
|
|
1311
1210
|
*/
|
|
@@ -1313,16 +1212,16 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1313
1212
|
return localVarFp.listEntityMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1314
1213
|
},
|
|
1315
1214
|
/**
|
|
1316
|
-
* Returns a list of ingest flushes you have previously created.
|
|
1215
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
1317
1216
|
* @summary List ingest flushes
|
|
1318
1217
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1319
1218
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1320
1219
|
* @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.
|
|
1321
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1220
|
+
* @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>
|
|
1322
1221
|
* @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>
|
|
1323
1222
|
* @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>
|
|
1324
1223
|
* @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>
|
|
1325
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1224
|
+
* @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>
|
|
1326
1225
|
* @param {*} [options] Override http request option.
|
|
1327
1226
|
* @throws {RequiredError}
|
|
1328
1227
|
*/
|
|
@@ -1330,34 +1229,16 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1330
1229
|
return localVarFp.listIngestFlushes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1331
1230
|
},
|
|
1332
1231
|
/**
|
|
1333
|
-
* Returns a list of ingest
|
|
1334
|
-
* @summary List ingest run records
|
|
1335
|
-
* @param {string} code
|
|
1336
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1337
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1338
|
-
* @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.
|
|
1339
|
-
* @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>
|
|
1340
|
-
* @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>
|
|
1341
|
-
* @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>
|
|
1342
|
-
* @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/>
|
|
1343
|
-
* @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>
|
|
1344
|
-
* @param {*} [options] Override http request option.
|
|
1345
|
-
* @throws {RequiredError}
|
|
1346
|
-
*/
|
|
1347
|
-
listIngestRunRecords(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListIngestRunRecordsResponseClass> {
|
|
1348
|
-
return localVarFp.listIngestRunRecords(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1349
|
-
},
|
|
1350
|
-
/**
|
|
1351
|
-
* 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\"
|
|
1232
|
+
* 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\"
|
|
1352
1233
|
* @summary List ingest runs
|
|
1353
1234
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1354
1235
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1355
1236
|
* @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.
|
|
1356
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1237
|
+
* @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>
|
|
1357
1238
|
* @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>
|
|
1358
1239
|
* @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>
|
|
1359
1240
|
* @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>
|
|
1360
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1241
|
+
* @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>
|
|
1361
1242
|
* @param {*} [options] Override http request option.
|
|
1362
1243
|
* @throws {RequiredError}
|
|
1363
1244
|
*/
|
|
@@ -1365,7 +1246,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1365
1246
|
return localVarFp.listIngestRuns(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1366
1247
|
},
|
|
1367
1248
|
/**
|
|
1368
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
1249
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
1369
1250
|
* @summary Stops the ingest flush
|
|
1370
1251
|
* @param {string} code
|
|
1371
1252
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -1634,7 +1515,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
1634
1515
|
readonly pageToken?: string
|
|
1635
1516
|
|
|
1636
1517
|
/**
|
|
1637
|
-
* Filter the response by one or multiple fields.
|
|
1518
|
+
* 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>
|
|
1638
1519
|
* @type {string}
|
|
1639
1520
|
* @memberof MigrationApiListEntityMappings
|
|
1640
1521
|
*/
|
|
@@ -1662,7 +1543,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
1662
1543
|
readonly expand?: string
|
|
1663
1544
|
|
|
1664
1545
|
/**
|
|
1665
|
-
* Filters the response by one or multiple fields.
|
|
1546
|
+
* 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>
|
|
1666
1547
|
* @type {string}
|
|
1667
1548
|
* @memberof MigrationApiListEntityMappings
|
|
1668
1549
|
*/
|
|
@@ -1697,7 +1578,7 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
1697
1578
|
readonly pageToken?: string
|
|
1698
1579
|
|
|
1699
1580
|
/**
|
|
1700
|
-
* Filter the response by one or multiple fields.
|
|
1581
|
+
* 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>
|
|
1701
1582
|
* @type {string}
|
|
1702
1583
|
* @memberof MigrationApiListIngestFlushes
|
|
1703
1584
|
*/
|
|
@@ -1725,83 +1606,13 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
1725
1606
|
readonly expand?: string
|
|
1726
1607
|
|
|
1727
1608
|
/**
|
|
1728
|
-
* Filters the response by one or multiple fields.
|
|
1609
|
+
* 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>
|
|
1729
1610
|
* @type {string}
|
|
1730
1611
|
* @memberof MigrationApiListIngestFlushes
|
|
1731
1612
|
*/
|
|
1732
1613
|
readonly filters?: string
|
|
1733
1614
|
}
|
|
1734
1615
|
|
|
1735
|
-
/**
|
|
1736
|
-
* Request parameters for listIngestRunRecords operation in MigrationApi.
|
|
1737
|
-
* @export
|
|
1738
|
-
* @interface MigrationApiListIngestRunRecordsRequest
|
|
1739
|
-
*/
|
|
1740
|
-
export interface MigrationApiListIngestRunRecordsRequest {
|
|
1741
|
-
/**
|
|
1742
|
-
*
|
|
1743
|
-
* @type {string}
|
|
1744
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1745
|
-
*/
|
|
1746
|
-
readonly code: string
|
|
1747
|
-
|
|
1748
|
-
/**
|
|
1749
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1750
|
-
* @type {string}
|
|
1751
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1752
|
-
*/
|
|
1753
|
-
readonly authorization?: string
|
|
1754
|
-
|
|
1755
|
-
/**
|
|
1756
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1757
|
-
* @type {number}
|
|
1758
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1759
|
-
*/
|
|
1760
|
-
readonly pageSize?: number
|
|
1761
|
-
|
|
1762
|
-
/**
|
|
1763
|
-
* 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.
|
|
1764
|
-
* @type {string}
|
|
1765
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1766
|
-
*/
|
|
1767
|
-
readonly pageToken?: string
|
|
1768
|
-
|
|
1769
|
-
/**
|
|
1770
|
-
* 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>
|
|
1771
|
-
* @type {string}
|
|
1772
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1773
|
-
*/
|
|
1774
|
-
readonly filter?: string
|
|
1775
|
-
|
|
1776
|
-
/**
|
|
1777
|
-
* 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>
|
|
1778
|
-
* @type {string}
|
|
1779
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1780
|
-
*/
|
|
1781
|
-
readonly search?: string
|
|
1782
|
-
|
|
1783
|
-
/**
|
|
1784
|
-
* 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>
|
|
1785
|
-
* @type {string}
|
|
1786
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1787
|
-
*/
|
|
1788
|
-
readonly order?: string
|
|
1789
|
-
|
|
1790
|
-
/**
|
|
1791
|
-
* 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/>
|
|
1792
|
-
* @type {string}
|
|
1793
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1794
|
-
*/
|
|
1795
|
-
readonly expand?: string
|
|
1796
|
-
|
|
1797
|
-
/**
|
|
1798
|
-
* 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>
|
|
1799
|
-
* @type {string}
|
|
1800
|
-
* @memberof MigrationApiListIngestRunRecords
|
|
1801
|
-
*/
|
|
1802
|
-
readonly filters?: string
|
|
1803
|
-
}
|
|
1804
|
-
|
|
1805
1616
|
/**
|
|
1806
1617
|
* Request parameters for listIngestRuns operation in MigrationApi.
|
|
1807
1618
|
* @export
|
|
@@ -1830,7 +1641,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
1830
1641
|
readonly pageToken?: string
|
|
1831
1642
|
|
|
1832
1643
|
/**
|
|
1833
|
-
* Filter the response by one or multiple fields.
|
|
1644
|
+
* 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>
|
|
1834
1645
|
* @type {string}
|
|
1835
1646
|
* @memberof MigrationApiListIngestRuns
|
|
1836
1647
|
*/
|
|
@@ -1858,7 +1669,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
1858
1669
|
readonly expand?: string
|
|
1859
1670
|
|
|
1860
1671
|
/**
|
|
1861
|
-
* Filters the response by one or multiple fields.
|
|
1672
|
+
* 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>
|
|
1862
1673
|
* @type {string}
|
|
1863
1674
|
* @memberof MigrationApiListIngestRuns
|
|
1864
1675
|
*/
|
|
@@ -2005,7 +1816,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
2005
1816
|
}
|
|
2006
1817
|
|
|
2007
1818
|
/**
|
|
2008
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1819
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
2009
1820
|
* @summary Create the Sync ingest flush
|
|
2010
1821
|
* @param {MigrationApiFlushIngestedDataAsyncRequest} requestParameters Request parameters.
|
|
2011
1822
|
* @param {*} [options] Override http request option.
|
|
@@ -2017,7 +1828,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
2017
1828
|
}
|
|
2018
1829
|
|
|
2019
1830
|
/**
|
|
2020
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1831
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
2021
1832
|
* @summary Create the Sync ingest flush
|
|
2022
1833
|
* @param {MigrationApiFlushIngestedDataSyncRequest} requestParameters Request parameters.
|
|
2023
1834
|
* @param {*} [options] Override http request option.
|
|
@@ -2029,7 +1840,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
2029
1840
|
}
|
|
2030
1841
|
|
|
2031
1842
|
/**
|
|
2032
|
-
* 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-
|
|
1843
|
+
* Retrieves the details of the ingest flush that was previously created. Supply the unique ingest flush code that was returned when you created it and Emil Api will return the corresponding ingest flush information. **Required Permissions** \"migration.ingest-runs.view\"
|
|
2033
1844
|
* @summary Retrieve the ingest flush
|
|
2034
1845
|
* @param {MigrationApiGetIngestFlushRequest} requestParameters Request parameters.
|
|
2035
1846
|
* @param {*} [options] Override http request option.
|
|
@@ -2065,7 +1876,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
2065
1876
|
}
|
|
2066
1877
|
|
|
2067
1878
|
/**
|
|
2068
|
-
* Returns a list of entity mappings you have previously created.
|
|
1879
|
+
* 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\"
|
|
2069
1880
|
* @summary List entity mappings
|
|
2070
1881
|
* @param {MigrationApiListEntityMappingsRequest} requestParameters Request parameters.
|
|
2071
1882
|
* @param {*} [options] Override http request option.
|
|
@@ -2077,7 +1888,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
2077
1888
|
}
|
|
2078
1889
|
|
|
2079
1890
|
/**
|
|
2080
|
-
* Returns a list of ingest flushes you have previously created.
|
|
1891
|
+
* Returns a list of ingest flushes you have previously created. The ingest flushes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"migration.ingest-runs.view\"
|
|
2081
1892
|
* @summary List ingest flushes
|
|
2082
1893
|
* @param {MigrationApiListIngestFlushesRequest} requestParameters Request parameters.
|
|
2083
1894
|
* @param {*} [options] Override http request option.
|
|
@@ -2089,19 +1900,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
2089
1900
|
}
|
|
2090
1901
|
|
|
2091
1902
|
/**
|
|
2092
|
-
* Returns a list of ingest
|
|
2093
|
-
* @summary List ingest run records
|
|
2094
|
-
* @param {MigrationApiListIngestRunRecordsRequest} requestParameters Request parameters.
|
|
2095
|
-
* @param {*} [options] Override http request option.
|
|
2096
|
-
* @throws {RequiredError}
|
|
2097
|
-
* @memberof MigrationApi
|
|
2098
|
-
*/
|
|
2099
|
-
public listIngestRunRecords(requestParameters: MigrationApiListIngestRunRecordsRequest, options?: AxiosRequestConfig) {
|
|
2100
|
-
return MigrationApiFp(this.configuration).listIngestRunRecords(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
2101
|
-
}
|
|
2102
|
-
|
|
2103
|
-
/**
|
|
2104
|
-
* 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\"
|
|
1903
|
+
* 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\"
|
|
2105
1904
|
* @summary List ingest runs
|
|
2106
1905
|
* @param {MigrationApiListIngestRunsRequest} requestParameters Request parameters.
|
|
2107
1906
|
* @param {*} [options] Override http request option.
|
|
@@ -2113,7 +1912,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
2113
1912
|
}
|
|
2114
1913
|
|
|
2115
1914
|
/**
|
|
2116
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
1915
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-runs.*\"
|
|
2117
1916
|
* @summary Stops the ingest flush
|
|
2118
1917
|
* @param {MigrationApiStopIngestFlushRequest} requestParameters Request parameters.
|
|
2119
1918
|
* @param {*} [options] Override http request option.
|