@emilgroup/migration-sdk 0.1.1-beta.5 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/api/migration-api.ts +253 -52
- package/dist/api/migration-api.d.ts +171 -52
- package/dist/api/migration-api.js +180 -46
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/ingest-run-record-class.d.ts +102 -0
- package/dist/models/ingest-run-record-class.js +15 -0
- package/dist/models/list-ingest-run-records-response-class.d.ts +43 -0
- package/dist/models/list-ingest-run-records-response-class.js +15 -0
- package/models/index.ts +2 -0
- package/models/ingest-run-record-class.ts +108 -0
- package/models/list-ingest-run-records-response-class.ts +49 -0
- package/package.json +1 -1
package/api/migration-api.ts
CHANGED
|
@@ -47,6 +47,8 @@ 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
|
|
50
52
|
import { ListIngestRunsResponseClass } from '../models';
|
|
51
53
|
// @ts-ignore
|
|
52
54
|
import { StopIngestFlushRequestDto } from '../models';
|
|
@@ -261,7 +263,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
261
263
|
};
|
|
262
264
|
},
|
|
263
265
|
/**
|
|
264
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
266
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
265
267
|
* @summary Create the Sync ingest flush
|
|
266
268
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
267
269
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -308,7 +310,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
308
310
|
};
|
|
309
311
|
},
|
|
310
312
|
/**
|
|
311
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
313
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
312
314
|
* @summary Create the Sync ingest flush
|
|
313
315
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
314
316
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -355,7 +357,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
355
357
|
};
|
|
356
358
|
},
|
|
357
359
|
/**
|
|
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-
|
|
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-flushes.view\"
|
|
359
361
|
* @summary Retrieve the ingest flush
|
|
360
362
|
* @param {string} code
|
|
361
363
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -490,16 +492,16 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
490
492
|
};
|
|
491
493
|
},
|
|
492
494
|
/**
|
|
493
|
-
* Returns a list of entity mappings you have previously created.
|
|
495
|
+
* 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\"
|
|
494
496
|
* @summary List entity mappings
|
|
495
497
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
496
498
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
497
499
|
* @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.
|
|
498
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
500
|
+
* @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>
|
|
499
501
|
* @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>
|
|
500
502
|
* @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>
|
|
501
503
|
* @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/>
|
|
502
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
504
|
+
* @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>
|
|
503
505
|
* @param {*} [options] Override http request option.
|
|
504
506
|
* @throws {RequiredError}
|
|
505
507
|
*/
|
|
@@ -566,16 +568,16 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
566
568
|
};
|
|
567
569
|
},
|
|
568
570
|
/**
|
|
569
|
-
* Returns a list of ingest flushes you have previously created.
|
|
571
|
+
* 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\"
|
|
570
572
|
* @summary List ingest flushes
|
|
571
573
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
572
574
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
573
575
|
* @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.
|
|
574
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
576
|
+
* @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>
|
|
575
577
|
* @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>
|
|
576
578
|
* @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>
|
|
577
579
|
* @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>
|
|
578
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
580
|
+
* @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>
|
|
579
581
|
* @param {*} [options] Override http request option.
|
|
580
582
|
* @throws {RequiredError}
|
|
581
583
|
*/
|
|
@@ -642,16 +644,96 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
642
644
|
};
|
|
643
645
|
},
|
|
644
646
|
/**
|
|
645
|
-
* Returns a list of ingest
|
|
647
|
+
* 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\"
|
|
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\"
|
|
646
728
|
* @summary List ingest runs
|
|
647
729
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
648
730
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
649
731
|
* @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.
|
|
650
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
732
|
+
* @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>
|
|
651
733
|
* @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>
|
|
652
734
|
* @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>
|
|
653
735
|
* @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>
|
|
654
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
736
|
+
* @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>
|
|
655
737
|
* @param {*} [options] Override http request option.
|
|
656
738
|
* @throws {RequiredError}
|
|
657
739
|
*/
|
|
@@ -718,7 +800,7 @@ export const MigrationApiAxiosParamCreator = function (configuration?: Configura
|
|
|
718
800
|
};
|
|
719
801
|
},
|
|
720
802
|
/**
|
|
721
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
803
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
722
804
|
* @summary Stops the ingest flush
|
|
723
805
|
* @param {string} code
|
|
724
806
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -931,7 +1013,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
931
1013
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
932
1014
|
},
|
|
933
1015
|
/**
|
|
934
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1016
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
935
1017
|
* @summary Create the Sync ingest flush
|
|
936
1018
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
937
1019
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -943,7 +1025,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
943
1025
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
944
1026
|
},
|
|
945
1027
|
/**
|
|
946
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1028
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
947
1029
|
* @summary Create the Sync ingest flush
|
|
948
1030
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
949
1031
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -955,7 +1037,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
955
1037
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
956
1038
|
},
|
|
957
1039
|
/**
|
|
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-
|
|
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-flushes.view\"
|
|
959
1041
|
* @summary Retrieve the ingest flush
|
|
960
1042
|
* @param {string} code
|
|
961
1043
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -991,16 +1073,16 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
991
1073
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
992
1074
|
},
|
|
993
1075
|
/**
|
|
994
|
-
* Returns a list of entity mappings you have previously created.
|
|
1076
|
+
* 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\"
|
|
995
1077
|
* @summary List entity mappings
|
|
996
1078
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
997
1079
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
998
1080
|
* @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.
|
|
999
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1081
|
+
* @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>
|
|
1000
1082
|
* @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>
|
|
1001
1083
|
* @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>
|
|
1002
1084
|
* @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/>
|
|
1003
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1085
|
+
* @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>
|
|
1004
1086
|
* @param {*} [options] Override http request option.
|
|
1005
1087
|
* @throws {RequiredError}
|
|
1006
1088
|
*/
|
|
@@ -1009,16 +1091,16 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1009
1091
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1010
1092
|
},
|
|
1011
1093
|
/**
|
|
1012
|
-
* Returns a list of ingest flushes you have previously created.
|
|
1094
|
+
* 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\"
|
|
1013
1095
|
* @summary List ingest flushes
|
|
1014
1096
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1015
1097
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1016
1098
|
* @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.
|
|
1017
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1099
|
+
* @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>
|
|
1018
1100
|
* @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>
|
|
1019
1101
|
* @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>
|
|
1020
1102
|
* @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>
|
|
1021
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1103
|
+
* @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>
|
|
1022
1104
|
* @param {*} [options] Override http request option.
|
|
1023
1105
|
* @throws {RequiredError}
|
|
1024
1106
|
*/
|
|
@@ -1027,16 +1109,35 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1027
1109
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1028
1110
|
},
|
|
1029
1111
|
/**
|
|
1030
|
-
* Returns a list of ingest
|
|
1112
|
+
* 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\"
|
|
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\"
|
|
1031
1132
|
* @summary List ingest runs
|
|
1032
1133
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1033
1134
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1034
1135
|
* @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.
|
|
1035
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1136
|
+
* @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>
|
|
1036
1137
|
* @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>
|
|
1037
1138
|
* @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>
|
|
1038
1139
|
* @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>
|
|
1039
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1140
|
+
* @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>
|
|
1040
1141
|
* @param {*} [options] Override http request option.
|
|
1041
1142
|
* @throws {RequiredError}
|
|
1042
1143
|
*/
|
|
@@ -1045,7 +1146,7 @@ export const MigrationApiFp = function(configuration?: Configuration) {
|
|
|
1045
1146
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1046
1147
|
},
|
|
1047
1148
|
/**
|
|
1048
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
1149
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1049
1150
|
* @summary Stops the ingest flush
|
|
1050
1151
|
* @param {string} code
|
|
1051
1152
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -1140,7 +1241,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1140
1241
|
return localVarFp.createIngestRunSync(createIngestRunSyncRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1141
1242
|
},
|
|
1142
1243
|
/**
|
|
1143
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1244
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1144
1245
|
* @summary Create the Sync ingest flush
|
|
1145
1246
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
1146
1247
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1151,7 +1252,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1151
1252
|
return localVarFp.flushIngestedDataAsync(flushIngestedDataRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1152
1253
|
},
|
|
1153
1254
|
/**
|
|
1154
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
1255
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1155
1256
|
* @summary Create the Sync ingest flush
|
|
1156
1257
|
* @param {FlushIngestedDataRequestDto} flushIngestedDataRequestDto
|
|
1157
1258
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1162,7 +1263,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1162
1263
|
return localVarFp.flushIngestedDataSync(flushIngestedDataRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1163
1264
|
},
|
|
1164
1265
|
/**
|
|
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-
|
|
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-flushes.view\"
|
|
1166
1267
|
* @summary Retrieve the ingest flush
|
|
1167
1268
|
* @param {string} code
|
|
1168
1269
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -1195,16 +1296,16 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1195
1296
|
return localVarFp.getJsonSchemas(sourceEntity, authorization, options).then((request) => request(axios, basePath));
|
|
1196
1297
|
},
|
|
1197
1298
|
/**
|
|
1198
|
-
* Returns a list of entity mappings you have previously created.
|
|
1299
|
+
* 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\"
|
|
1199
1300
|
* @summary List entity mappings
|
|
1200
1301
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1201
1302
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1202
1303
|
* @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.
|
|
1203
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1304
|
+
* @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>
|
|
1204
1305
|
* @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>
|
|
1205
1306
|
* @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>
|
|
1206
1307
|
* @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/>
|
|
1207
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1308
|
+
* @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>
|
|
1208
1309
|
* @param {*} [options] Override http request option.
|
|
1209
1310
|
* @throws {RequiredError}
|
|
1210
1311
|
*/
|
|
@@ -1212,16 +1313,16 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1212
1313
|
return localVarFp.listEntityMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1213
1314
|
},
|
|
1214
1315
|
/**
|
|
1215
|
-
* Returns a list of ingest flushes you have previously created.
|
|
1316
|
+
* 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\"
|
|
1216
1317
|
* @summary List ingest flushes
|
|
1217
1318
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1218
1319
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1219
1320
|
* @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.
|
|
1220
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1321
|
+
* @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>
|
|
1221
1322
|
* @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>
|
|
1222
1323
|
* @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>
|
|
1223
1324
|
* @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>
|
|
1224
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1325
|
+
* @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>
|
|
1225
1326
|
* @param {*} [options] Override http request option.
|
|
1226
1327
|
* @throws {RequiredError}
|
|
1227
1328
|
*/
|
|
@@ -1229,16 +1330,34 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1229
1330
|
return localVarFp.listIngestFlushes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1230
1331
|
},
|
|
1231
1332
|
/**
|
|
1232
|
-
* Returns a list of ingest
|
|
1333
|
+
* 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\"
|
|
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\"
|
|
1233
1352
|
* @summary List ingest runs
|
|
1234
1353
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1235
1354
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1236
1355
|
* @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.
|
|
1237
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
1356
|
+
* @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>
|
|
1238
1357
|
* @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>
|
|
1239
1358
|
* @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>
|
|
1240
1359
|
* @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>
|
|
1241
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
1360
|
+
* @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>
|
|
1242
1361
|
* @param {*} [options] Override http request option.
|
|
1243
1362
|
* @throws {RequiredError}
|
|
1244
1363
|
*/
|
|
@@ -1246,7 +1365,7 @@ export const MigrationApiFactory = function (configuration?: Configuration, base
|
|
|
1246
1365
|
return localVarFp.listIngestRuns(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
1247
1366
|
},
|
|
1248
1367
|
/**
|
|
1249
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
1368
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1250
1369
|
* @summary Stops the ingest flush
|
|
1251
1370
|
* @param {string} code
|
|
1252
1371
|
* @param {StopIngestFlushRequestDto} stopIngestFlushRequestDto
|
|
@@ -1515,7 +1634,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
1515
1634
|
readonly pageToken?: string
|
|
1516
1635
|
|
|
1517
1636
|
/**
|
|
1518
|
-
* Filter the response by one or multiple fields.
|
|
1637
|
+
* 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>
|
|
1519
1638
|
* @type {string}
|
|
1520
1639
|
* @memberof MigrationApiListEntityMappings
|
|
1521
1640
|
*/
|
|
@@ -1543,7 +1662,7 @@ export interface MigrationApiListEntityMappingsRequest {
|
|
|
1543
1662
|
readonly expand?: string
|
|
1544
1663
|
|
|
1545
1664
|
/**
|
|
1546
|
-
* Filters the response by one or multiple fields.
|
|
1665
|
+
* 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>
|
|
1547
1666
|
* @type {string}
|
|
1548
1667
|
* @memberof MigrationApiListEntityMappings
|
|
1549
1668
|
*/
|
|
@@ -1578,7 +1697,7 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
1578
1697
|
readonly pageToken?: string
|
|
1579
1698
|
|
|
1580
1699
|
/**
|
|
1581
|
-
* Filter the response by one or multiple fields.
|
|
1700
|
+
* 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>
|
|
1582
1701
|
* @type {string}
|
|
1583
1702
|
* @memberof MigrationApiListIngestFlushes
|
|
1584
1703
|
*/
|
|
@@ -1606,13 +1725,83 @@ export interface MigrationApiListIngestFlushesRequest {
|
|
|
1606
1725
|
readonly expand?: string
|
|
1607
1726
|
|
|
1608
1727
|
/**
|
|
1609
|
-
* Filters the response by one or multiple fields.
|
|
1728
|
+
* 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>
|
|
1610
1729
|
* @type {string}
|
|
1611
1730
|
* @memberof MigrationApiListIngestFlushes
|
|
1612
1731
|
*/
|
|
1613
1732
|
readonly filters?: string
|
|
1614
1733
|
}
|
|
1615
1734
|
|
|
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
|
+
|
|
1616
1805
|
/**
|
|
1617
1806
|
* Request parameters for listIngestRuns operation in MigrationApi.
|
|
1618
1807
|
* @export
|
|
@@ -1641,7 +1830,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
1641
1830
|
readonly pageToken?: string
|
|
1642
1831
|
|
|
1643
1832
|
/**
|
|
1644
|
-
* Filter the response by one or multiple fields.
|
|
1833
|
+
* 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>
|
|
1645
1834
|
* @type {string}
|
|
1646
1835
|
* @memberof MigrationApiListIngestRuns
|
|
1647
1836
|
*/
|
|
@@ -1669,7 +1858,7 @@ export interface MigrationApiListIngestRunsRequest {
|
|
|
1669
1858
|
readonly expand?: string
|
|
1670
1859
|
|
|
1671
1860
|
/**
|
|
1672
|
-
* Filters the response by one or multiple fields.
|
|
1861
|
+
* 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>
|
|
1673
1862
|
* @type {string}
|
|
1674
1863
|
* @memberof MigrationApiListIngestRuns
|
|
1675
1864
|
*/
|
|
@@ -1816,7 +2005,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
1816
2005
|
}
|
|
1817
2006
|
|
|
1818
2007
|
/**
|
|
1819
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
2008
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1820
2009
|
* @summary Create the Sync ingest flush
|
|
1821
2010
|
* @param {MigrationApiFlushIngestedDataAsyncRequest} requestParameters Request parameters.
|
|
1822
2011
|
* @param {*} [options] Override http request option.
|
|
@@ -1828,7 +2017,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
1828
2017
|
}
|
|
1829
2018
|
|
|
1830
2019
|
/**
|
|
1831
|
-
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-
|
|
2020
|
+
* This will start synchronous ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1832
2021
|
* @summary Create the Sync ingest flush
|
|
1833
2022
|
* @param {MigrationApiFlushIngestedDataSyncRequest} requestParameters Request parameters.
|
|
1834
2023
|
* @param {*} [options] Override http request option.
|
|
@@ -1840,7 +2029,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
1840
2029
|
}
|
|
1841
2030
|
|
|
1842
2031
|
/**
|
|
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-
|
|
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-flushes.view\"
|
|
1844
2033
|
* @summary Retrieve the ingest flush
|
|
1845
2034
|
* @param {MigrationApiGetIngestFlushRequest} requestParameters Request parameters.
|
|
1846
2035
|
* @param {*} [options] Override http request option.
|
|
@@ -1876,7 +2065,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
1876
2065
|
}
|
|
1877
2066
|
|
|
1878
2067
|
/**
|
|
1879
|
-
* Returns a list of entity mappings you have previously created.
|
|
2068
|
+
* 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\"
|
|
1880
2069
|
* @summary List entity mappings
|
|
1881
2070
|
* @param {MigrationApiListEntityMappingsRequest} requestParameters Request parameters.
|
|
1882
2071
|
* @param {*} [options] Override http request option.
|
|
@@ -1888,7 +2077,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
1888
2077
|
}
|
|
1889
2078
|
|
|
1890
2079
|
/**
|
|
1891
|
-
* Returns a list of ingest flushes you have previously created.
|
|
2080
|
+
* 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\"
|
|
1892
2081
|
* @summary List ingest flushes
|
|
1893
2082
|
* @param {MigrationApiListIngestFlushesRequest} requestParameters Request parameters.
|
|
1894
2083
|
* @param {*} [options] Override http request option.
|
|
@@ -1900,7 +2089,19 @@ export class MigrationApi extends BaseAPI {
|
|
|
1900
2089
|
}
|
|
1901
2090
|
|
|
1902
2091
|
/**
|
|
1903
|
-
* Returns a list of ingest
|
|
2092
|
+
* 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\"
|
|
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\"
|
|
1904
2105
|
* @summary List ingest runs
|
|
1905
2106
|
* @param {MigrationApiListIngestRunsRequest} requestParameters Request parameters.
|
|
1906
2107
|
* @param {*} [options] Override http request option.
|
|
@@ -1912,7 +2113,7 @@ export class MigrationApi extends BaseAPI {
|
|
|
1912
2113
|
}
|
|
1913
2114
|
|
|
1914
2115
|
/**
|
|
1915
|
-
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-
|
|
2116
|
+
* This will stop the running ingest flush. **Required Permissions** \"migration.ingest-flushes.*\"
|
|
1916
2117
|
* @summary Stops the ingest flush
|
|
1917
2118
|
* @param {MigrationApiStopIngestFlushRequest} requestParameters Request parameters.
|
|
1918
2119
|
* @param {*} [options] Override http request option.
|