@ibm-cloud/ibm_dph_services 0.3.0 → 0.4.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/dph/v1.d.ts CHANGED
@@ -15,6 +15,8 @@
15
15
  */
16
16
  /// <reference types="node" />
17
17
  /// <reference types="node" />
18
+ /// <reference types="node" />
19
+ /// <reference types="node" />
18
20
  import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
19
21
  import { BaseService, UserOptions } from 'ibm-cloud-sdk-core';
20
22
  /**
@@ -257,6 +259,8 @@ declare class DphV1 extends BaseService {
257
259
  * version creation or retiring.
258
260
  * @param {AssetListAccessControl} [params.accessControl] - Access control object.
259
261
  * @param {string} [params.lastUpdatedAt] - Timestamp of last asset update.
262
+ * @param {ContainerIdentity} [params.subContainer] - The identity schema for a IBM knowledge catalog container
263
+ * (catalog/project/space).
260
264
  * @param {boolean} [params.isRestricted] - Indicates whether the data product is restricted or not. A restricted data
261
265
  * product indicates that orders of the data product requires explicit approval before data is delivered.
262
266
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
@@ -399,13 +403,16 @@ declare class DphV1 extends BaseService {
399
403
  * @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
400
404
  * @param {string} params.draftId - Data product draft id.
401
405
  * @param {string} params.contractTermsId - Contract terms id.
402
- * @param {string} [params.accept] - The type of the response: application/odcs+yaml or application/json.
406
+ * @param {string} [params.accept] - The type of the response: application/json or application/odcs+yaml.
403
407
  * @param {boolean} [params.includeContractDocuments] - Set to false to exclude external contract documents (e.g.,
404
408
  * Terms and Conditions URLs) from the response. By default, these are included.
409
+ * @param {boolean} [params.autopopulateServerInformation] - Set to true to autopopulate server information from
410
+ * connection details. Default is false.
411
+ * @param {string} [params.serverAssetId] - Asset ID of the server used for autopopulating connection details.
405
412
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
406
- * @returns {Promise<DphV1.Response<NodeJS.ReadableStream>>}
413
+ * @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
407
414
  */
408
- getDataProductDraftContractTerms(params: DphV1.GetDataProductDraftContractTermsParams): Promise<DphV1.Response<NodeJS.ReadableStream>>;
415
+ getDataProductDraftContractTerms(params: DphV1.GetDataProductDraftContractTermsParams): Promise<DphV1.Response<DphV1.ContractTerms>>;
409
416
  /**
410
417
  * Update a data product contract terms identified by id.
411
418
  *
@@ -430,6 +437,7 @@ declare class DphV1 extends BaseService {
430
437
  * @param {ContractTemplateCustomProperty[]} [params.customProperties] - Custom properties that are not part of the
431
438
  * standard contract.
432
439
  * @param {ContractTest} [params.contractTest] - Contains the contract test status and related metadata.
440
+ * @param {ContractServer[]} [params.servers] - List of server definitions.
433
441
  * @param {ContractSchema[]} [params.schema] - Schema details of the data asset.
434
442
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
435
443
  * @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
@@ -456,6 +464,22 @@ declare class DphV1 extends BaseService {
456
464
  * @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
457
465
  */
458
466
  updateDataProductDraftContractTerms(params: DphV1.UpdateDataProductDraftContractTermsParams): Promise<DphV1.Response<DphV1.ContractTerms>>;
467
+ /**
468
+ * Retrieve a data product contract terms identified by id in specified format.
469
+ *
470
+ * Retrieve a data product contract terms identified by id in specified format.
471
+ *
472
+ * @param {Object} params - The parameters to send to the service.
473
+ * @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
474
+ * @param {string} params.draftId - Data product draft id.
475
+ * @param {string} params.contractTermsId - Contract terms id.
476
+ * @param {string} params.format - The format for returning contract terms. For example: odcs.
477
+ * @param {string} params.formatVersion - The version of the format for returning contract terms. For example: 3.
478
+ * @param {string} [params.accept] - The type of the response: application/odcs+yaml or application/json.
479
+ * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
480
+ * @returns {Promise<DphV1.Response<NodeJS.ReadableStream>>}
481
+ */
482
+ getContractTermsInSpecifiedFormat(params: DphV1.GetContractTermsInSpecifiedFormatParams): Promise<DphV1.Response<NodeJS.ReadableStream>>;
459
483
  /**
460
484
  * Publish a draft of an existing data product.
461
485
  *
@@ -523,6 +547,22 @@ declare class DphV1 extends BaseService {
523
547
  * @returns {Promise<DphV1.Response<DphV1.ContractTermsDocument>>}
524
548
  */
525
549
  getReleaseContractTermsDocument(params: DphV1.GetReleaseContractTermsDocumentParams): Promise<DphV1.Response<DphV1.ContractTermsDocument>>;
550
+ /**
551
+ * Retrieve a published data product contract terms identified by id.
552
+ *
553
+ * Retrieve a published data product contract terms identified by id.
554
+ *
555
+ * @param {Object} params - The parameters to send to the service.
556
+ * @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
557
+ * @param {string} params.releaseId - Data product release id.
558
+ * @param {string} params.contractTermsId - Contract terms id.
559
+ * @param {string} [params.accept] - The type of the response: application/odcs+yaml or application/json.
560
+ * @param {boolean} [params.includeContractDocuments] - Set to false to exclude external contract documents (e.g.,
561
+ * Terms and Conditions URLs) from the response. By default, these are included.
562
+ * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
563
+ * @returns {Promise<DphV1.Response<NodeJS.ReadableStream>>}
564
+ */
565
+ getPublishedDataProductDraftContractTerms(params: DphV1.GetPublishedDataProductDraftContractTermsParams): Promise<DphV1.Response<NodeJS.ReadableStream>>;
526
566
  /**
527
567
  * Retrieve a list of data product releases.
528
568
  *
@@ -552,10 +592,29 @@ declare class DphV1 extends BaseService {
552
592
  * @param {string} params.releaseId - Data product release id.
553
593
  * @param {boolean} [params.revokeAccess] - Revoke's Access from all the Subscriptions of the Data Product. No user's
554
594
  * can able to see the subscribed assets anymore.
595
+ * @param {string} [params.startAt] - The date and time when the revoke access operation should start (ISO 8601
596
+ * format, e.g., 2025-09-24T06:55:29Z). If not provided, the operation starts immediately.
555
597
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
556
598
  * @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
557
599
  */
558
600
  retireDataProductRelease(params: DphV1.RetireDataProductReleaseParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
601
+ /**
602
+ * Revoke access from Data Product subscriptions.
603
+ *
604
+ * Revoke's access from Subscriptions of the data product id passed in the path parameter. Optionally specify a future
605
+ * date-time when the revoke access operation should start using the start_at field in ISO 8601 format (e.g.,
606
+ * 2025-09-24T06:55:29Z). If start_at is not provided, the revoke access operation starts immediately.
607
+ *
608
+ * @param {Object} params - The parameters to send to the service.
609
+ * @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
610
+ * @param {string} params.releaseId - The unique identifier of the data product release.
611
+ * @param {NodeJS.ReadableStream | Buffer} [params.body] - Request parameters to handle revoke access from
612
+ * subscriptions. The start_at field can be used to schedule the revoke access operation for a future date-time.
613
+ * @param {string} [params.contentType] - The type of the input.
614
+ * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
615
+ * @returns {Promise<DphV1.Response<DphV1.RevokeAccessResponse>>}
616
+ */
617
+ createRevokeAccessProcess(params: DphV1.CreateRevokeAccessProcessParams): Promise<DphV1.Response<DphV1.RevokeAccessResponse>>;
559
618
  /*************************
560
619
  * dataProductContractTemplates
561
620
  ************************/
@@ -569,6 +628,8 @@ declare class DphV1 extends BaseService {
569
628
  * catalog is looked up by using the uid of the default data product catalog.
570
629
  * @param {string} [params.contractTemplateName] - Name of the data product contract template. If not supplied, the
571
630
  * data product templates within the catalog will returned.
631
+ * @param {string} [params.domainIds] - Comma-separated domain IDs to filter data product contract templates. If not
632
+ * supplied, the data product templates within the catalog will returned.
572
633
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
573
634
  * @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplateCollection>>}
574
635
  */
@@ -581,6 +642,8 @@ declare class DphV1 extends BaseService {
581
642
  * @param {Object} params - The parameters to send to the service.
582
643
  * @param {ContainerReference} params.container - Container reference.
583
644
  * @param {string} [params.id] - The identifier of the data product contract template.
645
+ * @param {string} [params.creatorId] - The identifier of the user who created the data product contract template.
646
+ * @param {string} [params.createdAt] - The timestamp when the data product contract template was created.
584
647
  * @param {string} [params.name] - The name of the contract template.
585
648
  * @param {ErrorMessage} [params.error] - Contains the code and details.
586
649
  * @param {ContractTerms} [params.contractTerms] - Defines the complete structure of a contract terms.
@@ -588,6 +651,8 @@ declare class DphV1 extends BaseService {
588
651
  * catalog is looked up by using the uid of the default data product catalog.
589
652
  * @param {string} [params.contractTemplateName] - Name of the data product contract template. If not supplied, the
590
653
  * data product templates within the catalog will returned.
654
+ * @param {string} [params.domainIds] - Comma-separated domain IDs to filter data product contract templates. If not
655
+ * supplied, the data product templates within the catalog will returned.
591
656
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
592
657
  * @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplate>>}
593
658
  */
@@ -644,6 +709,7 @@ declare class DphV1 extends BaseService {
644
709
  * @param {Object} [params] - The parameters to send to the service.
645
710
  * @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
646
711
  * catalog is looked up by using the uid of the default data product catalog.
712
+ * @param {boolean} [params.includeSubdomains] - Include subdomains in the response.
647
713
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
648
714
  * @returns {Promise<DphV1.Response<DphV1.DataProductDomainCollection>>}
649
715
  */
@@ -660,11 +726,13 @@ declare class DphV1 extends BaseService {
660
726
  * @param {string} [params.name] - The name of the data product domain.
661
727
  * @param {string} [params.description] - The description of the data product domain.
662
728
  * @param {string} [params.id] - The identifier of the data product domain.
729
+ * @param {string} [params.createdBy] - The identifier of the creator of the data product domain.
663
730
  * @param {MemberRolesSchema} [params.memberRoles] - Member roles of a corresponding asset.
664
731
  * @param {PropertiesSchema} [params.properties] - Properties of the corresponding asset.
665
732
  * @param {InitializeSubDomain[]} [params.subDomains] - List of sub domains to be added within a domain.
666
- * @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
667
- * catalog is looked up by using the uid of the default data product catalog.
733
+ * @param {ContainerIdentity} [params.subContainer] - The identity schema for a IBM knowledge catalog container
734
+ * (catalog/project/space).
735
+ * @param {boolean} [params.linkToSubcontainers] - Link domains to subcontainers.
668
736
  * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
669
737
  * @returns {Promise<DphV1.Response<DphV1.DataProductDomain>>}
670
738
  */
@@ -760,6 +828,23 @@ declare class DphV1 extends BaseService {
760
828
  * @returns {Promise<DphV1.Response<DphV1.BucketValidationResponse>>}
761
829
  */
762
830
  getS3BucketValidation(params: DphV1.GetS3BucketValidationParams): Promise<DphV1.Response<DphV1.BucketValidationResponse>>;
831
+ /*************************
832
+ * dataProductRevokeAccessJobRuns
833
+ ************************/
834
+ /**
835
+ * Access revoke status of the subscriptions against the data product release id.
836
+ *
837
+ * Retrieves the status of revoke access requests.
838
+ *
839
+ * @param {Object} params - The parameters to send to the service.
840
+ * @param {string} params.releaseId - Pass the data product release version id to retrieve job runs state for that
841
+ * specific DPV ID.
842
+ * @param {number} [params.limit] - Limit the number of tracking assets in the results. The maximum is 200.
843
+ * @param {string} [params.start] - Start token for pagination.
844
+ * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
845
+ * @returns {Promise<DphV1.Response<DphV1.RevokeAccessStateResponse>>}
846
+ */
847
+ getRevokeAccessProcessState(params: DphV1.GetRevokeAccessProcessStateParams): Promise<DphV1.Response<DphV1.RevokeAccessStateResponse>>;
763
848
  }
764
849
  /*************************
765
850
  * interfaces
@@ -935,6 +1020,8 @@ declare namespace DphV1 {
935
1020
  accessControl?: AssetListAccessControl;
936
1021
  /** Timestamp of last asset update. */
937
1022
  lastUpdatedAt?: string;
1023
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
1024
+ subContainer?: ContainerIdentity;
938
1025
  /** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
939
1026
  * the data product requires explicit approval before data is delivered.
940
1027
  */
@@ -1051,20 +1138,24 @@ declare namespace DphV1 {
1051
1138
  draftId: string;
1052
1139
  /** Contract terms id. */
1053
1140
  contractTermsId: string;
1054
- /** The type of the response: application/odcs+yaml or application/json. */
1141
+ /** The type of the response: application/json or application/odcs+yaml. */
1055
1142
  accept?: GetDataProductDraftContractTermsConstants.Accept | string;
1056
1143
  /** Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By
1057
1144
  * default, these are included.
1058
1145
  */
1059
1146
  includeContractDocuments?: boolean;
1147
+ /** Set to true to autopopulate server information from connection details. Default is false. */
1148
+ autopopulateServerInformation?: boolean;
1149
+ /** Asset ID of the server used for autopopulating connection details. */
1150
+ serverAssetId?: string;
1060
1151
  headers?: OutgoingHttpHeaders;
1061
1152
  }
1062
1153
  /** Constants for the `getDataProductDraftContractTerms` operation. */
1063
1154
  namespace GetDataProductDraftContractTermsConstants {
1064
- /** The type of the response: application/odcs+yaml or application/json. */
1155
+ /** The type of the response: application/json or application/odcs+yaml. */
1065
1156
  enum Accept {
1066
- APPLICATION_ODCS_YAML = "application/odcs+yaml",
1067
- APPLICATION_JSON = "application/json"
1157
+ APPLICATION_JSON = "application/json",
1158
+ APPLICATION_ODCS_YAML = "application/odcs+yaml"
1068
1159
  }
1069
1160
  }
1070
1161
  /** Parameters for the `replaceDataProductDraftContractTerms` operation. */
@@ -1101,6 +1192,8 @@ declare namespace DphV1 {
1101
1192
  customProperties?: ContractTemplateCustomProperty[];
1102
1193
  /** Contains the contract test status and related metadata. */
1103
1194
  contractTest?: ContractTest;
1195
+ /** List of server definitions. */
1196
+ servers?: ContractServer[];
1104
1197
  /** Schema details of the data asset. */
1105
1198
  schema?: ContractSchema[];
1106
1199
  headers?: OutgoingHttpHeaders;
@@ -1117,6 +1210,30 @@ declare namespace DphV1 {
1117
1210
  jsonPatchInstructions: JsonPatchOperation[];
1118
1211
  headers?: OutgoingHttpHeaders;
1119
1212
  }
1213
+ /** Parameters for the `getContractTermsInSpecifiedFormat` operation. */
1214
+ interface GetContractTermsInSpecifiedFormatParams {
1215
+ /** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
1216
+ dataProductId: string;
1217
+ /** Data product draft id. */
1218
+ draftId: string;
1219
+ /** Contract terms id. */
1220
+ contractTermsId: string;
1221
+ /** The format for returning contract terms. For example: odcs. */
1222
+ format: string;
1223
+ /** The version of the format for returning contract terms. For example: 3. */
1224
+ formatVersion: string;
1225
+ /** The type of the response: application/odcs+yaml or application/json. */
1226
+ accept?: GetContractTermsInSpecifiedFormatConstants.Accept | string;
1227
+ headers?: OutgoingHttpHeaders;
1228
+ }
1229
+ /** Constants for the `getContractTermsInSpecifiedFormat` operation. */
1230
+ namespace GetContractTermsInSpecifiedFormatConstants {
1231
+ /** The type of the response: application/odcs+yaml or application/json. */
1232
+ enum Accept {
1233
+ APPLICATION_ODCS_YAML = "application/odcs+yaml",
1234
+ APPLICATION_JSON = "application/json"
1235
+ }
1236
+ }
1120
1237
  /** Parameters for the `publishDataProductDraft` operation. */
1121
1238
  interface PublishDataProductDraftParams {
1122
1239
  /** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
@@ -1159,6 +1276,30 @@ declare namespace DphV1 {
1159
1276
  documentId: string;
1160
1277
  headers?: OutgoingHttpHeaders;
1161
1278
  }
1279
+ /** Parameters for the `getPublishedDataProductDraftContractTerms` operation. */
1280
+ interface GetPublishedDataProductDraftContractTermsParams {
1281
+ /** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
1282
+ dataProductId: string;
1283
+ /** Data product release id. */
1284
+ releaseId: string;
1285
+ /** Contract terms id. */
1286
+ contractTermsId: string;
1287
+ /** The type of the response: application/odcs+yaml or application/json. */
1288
+ accept?: GetPublishedDataProductDraftContractTermsConstants.Accept | string;
1289
+ /** Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By
1290
+ * default, these are included.
1291
+ */
1292
+ includeContractDocuments?: boolean;
1293
+ headers?: OutgoingHttpHeaders;
1294
+ }
1295
+ /** Constants for the `getPublishedDataProductDraftContractTerms` operation. */
1296
+ namespace GetPublishedDataProductDraftContractTermsConstants {
1297
+ /** The type of the response: application/odcs+yaml or application/json. */
1298
+ enum Accept {
1299
+ APPLICATION_ODCS_YAML = "application/odcs+yaml",
1300
+ APPLICATION_JSON = "application/json"
1301
+ }
1302
+ }
1162
1303
  /** Parameters for the `listDataProductReleases` operation. */
1163
1304
  interface ListDataProductReleasesParams {
1164
1305
  /** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
@@ -1195,6 +1336,24 @@ declare namespace DphV1 {
1195
1336
  * assets anymore.
1196
1337
  */
1197
1338
  revokeAccess?: boolean;
1339
+ /** The date and time when the revoke access operation should start (ISO 8601 format, e.g.,
1340
+ * 2025-09-24T06:55:29Z). If not provided, the operation starts immediately.
1341
+ */
1342
+ startAt?: string;
1343
+ headers?: OutgoingHttpHeaders;
1344
+ }
1345
+ /** Parameters for the `createRevokeAccessProcess` operation. */
1346
+ interface CreateRevokeAccessProcessParams {
1347
+ /** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
1348
+ dataProductId: string;
1349
+ /** The unique identifier of the data product release. */
1350
+ releaseId: string;
1351
+ /** Request parameters to handle revoke access from subscriptions. The start_at field can be used to schedule
1352
+ * the revoke access operation for a future date-time.
1353
+ */
1354
+ body?: NodeJS.ReadableStream | Buffer;
1355
+ /** The type of the input. */
1356
+ contentType?: string;
1198
1357
  headers?: OutgoingHttpHeaders;
1199
1358
  }
1200
1359
  /** Parameters for the `listDataProductContractTemplate` operation. */
@@ -1207,6 +1366,10 @@ declare namespace DphV1 {
1207
1366
  * will returned.
1208
1367
  */
1209
1368
  contractTemplateName?: string;
1369
+ /** Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product
1370
+ * templates within the catalog will returned.
1371
+ */
1372
+ domainIds?: string;
1210
1373
  headers?: OutgoingHttpHeaders;
1211
1374
  }
1212
1375
  /** Parameters for the `createContractTemplate` operation. */
@@ -1215,6 +1378,10 @@ declare namespace DphV1 {
1215
1378
  container: ContainerReference;
1216
1379
  /** The identifier of the data product contract template. */
1217
1380
  id?: string;
1381
+ /** The identifier of the user who created the data product contract template. */
1382
+ creatorId?: string;
1383
+ /** The timestamp when the data product contract template was created. */
1384
+ createdAt?: string;
1218
1385
  /** The name of the contract template. */
1219
1386
  name?: string;
1220
1387
  /** Contains the code and details. */
@@ -1229,6 +1396,10 @@ declare namespace DphV1 {
1229
1396
  * will returned.
1230
1397
  */
1231
1398
  contractTemplateName?: string;
1399
+ /** Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product
1400
+ * templates within the catalog will returned.
1401
+ */
1402
+ domainIds?: string;
1232
1403
  headers?: OutgoingHttpHeaders;
1233
1404
  }
1234
1405
  /** Parameters for the `getContractTemplate` operation. */
@@ -1263,6 +1434,8 @@ declare namespace DphV1 {
1263
1434
  * the uid of the default data product catalog.
1264
1435
  */
1265
1436
  containerId?: string;
1437
+ /** Include subdomains in the response. */
1438
+ includeSubdomains?: boolean;
1266
1439
  headers?: OutgoingHttpHeaders;
1267
1440
  }
1268
1441
  /** Parameters for the `createDataProductDomain` operation. */
@@ -1279,16 +1452,18 @@ declare namespace DphV1 {
1279
1452
  description?: string;
1280
1453
  /** The identifier of the data product domain. */
1281
1454
  id?: string;
1455
+ /** The identifier of the creator of the data product domain. */
1456
+ createdBy?: string;
1282
1457
  /** Member roles of a corresponding asset. */
1283
1458
  memberRoles?: MemberRolesSchema;
1284
1459
  /** Properties of the corresponding asset. */
1285
1460
  properties?: PropertiesSchema;
1286
1461
  /** List of sub domains to be added within a domain. */
1287
1462
  subDomains?: InitializeSubDomain[];
1288
- /** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
1289
- * the uid of the default data product catalog.
1290
- */
1291
- containerId?: string;
1463
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
1464
+ subContainer?: ContainerIdentity;
1465
+ /** Link domains to subcontainers. */
1466
+ linkToSubcontainers?: boolean;
1292
1467
  headers?: OutgoingHttpHeaders;
1293
1468
  }
1294
1469
  /** Parameters for the `createDataProductSubdomain` operation. */
@@ -1347,9 +1522,26 @@ declare namespace DphV1 {
1347
1522
  bucketName: string;
1348
1523
  headers?: OutgoingHttpHeaders;
1349
1524
  }
1525
+ /** Parameters for the `getRevokeAccessProcessState` operation. */
1526
+ interface GetRevokeAccessProcessStateParams {
1527
+ /** Pass the data product release version id to retrieve job runs state for that specific DPV ID. */
1528
+ releaseId: string;
1529
+ /** Limit the number of tracking assets in the results. The maximum is 200. */
1530
+ limit?: number;
1531
+ /** Start token for pagination. */
1532
+ start?: string;
1533
+ headers?: OutgoingHttpHeaders;
1534
+ }
1350
1535
  /*************************
1351
1536
  * model interfaces
1352
1537
  ************************/
1538
+ /**
1539
+ * Asset.
1540
+ */
1541
+ interface Asset {
1542
+ metadata?: JsonObject;
1543
+ entity?: JsonObject;
1544
+ }
1353
1545
  /**
1354
1546
  * Access control object.
1355
1547
  */
@@ -1437,18 +1629,74 @@ declare namespace DphV1 {
1437
1629
  }
1438
1630
  }
1439
1631
  }
1632
+ /**
1633
+ * Defines a data asset name and id.
1634
+ */
1635
+ interface ContractAsset {
1636
+ /** ID of the data asset. */
1637
+ id?: string;
1638
+ /** Name of the data asset. */
1639
+ name?: string;
1640
+ }
1641
+ /**
1642
+ * Defines a quality rule for validating data assets.
1643
+ */
1644
+ interface ContractQualityRule {
1645
+ /** The type of the quality rule: 'text', 'library', or 'sql'. */
1646
+ type: string;
1647
+ /** A descriptive explanation of the quality rule. */
1648
+ description?: string;
1649
+ /** The name or identifier of the library-based quality rule to be applied. */
1650
+ rule?: string;
1651
+ /** A text (non-parsed) block of code required for the third-party DQ engine to run. */
1652
+ implementation?: string;
1653
+ /** Required for custom DQ rule: name of the third-party engine being used. Common values include soda,
1654
+ * greatExpectations, montecarlo, etc.
1655
+ */
1656
+ engine?: string;
1657
+ /** The threshold value that the quality check result must be less than. */
1658
+ must_be_less_than?: string;
1659
+ /** The threshold value that the quality check result must be less than or equal to. */
1660
+ must_be_less_or_equal_to?: string;
1661
+ /** The threshold value that the quality check result must be greater than. */
1662
+ must_be_greater_than?: string;
1663
+ /** The threshold value that the quality check result must be greater than or equal to. */
1664
+ must_be_greater_or_equal_to?: string;
1665
+ /** Inclusive range (min and max) for the quality check result. */
1666
+ must_be_between?: string[];
1667
+ /** Inclusive range (min and max) the quality check must not fall within. */
1668
+ must_not_be_between?: string[];
1669
+ /** The exact value(s) the quality check result must match. */
1670
+ must_be?: string;
1671
+ /** The exact value(s) the quality check result must not match. */
1672
+ must_not_be?: string;
1673
+ /** User-friendly name for the quality rule. */
1674
+ name?: string;
1675
+ /** Unit used for evaluating the quality rule (e.g., rows, records). */
1676
+ unit?: string;
1677
+ /** The SQL query to execute for validating quality in case of a 'sql' rule type. */
1678
+ query?: string;
1679
+ }
1440
1680
  /**
1441
1681
  * Schema definition of the data asset.
1442
1682
  */
1443
1683
  interface ContractSchema {
1684
+ /** Id of the data asset whose schema information is stored. */
1685
+ asset_id: string;
1686
+ /** Connection Id of the data asset whose schema information is stored. */
1687
+ connection_id: string;
1444
1688
  /** Name of the schema or data asset part. */
1445
1689
  name?: string;
1446
1690
  /** Description of the schema. */
1447
1691
  description?: string;
1692
+ /** Connection path of the asset. */
1693
+ connection_path?: string;
1448
1694
  /** MIME type or physical type. */
1449
1695
  physical_type?: string;
1450
1696
  /** List of properties. */
1451
1697
  properties?: ContractSchemaProperty[];
1698
+ /** List of quality rules defined for the asset. */
1699
+ quality?: ContractQualityRule[];
1452
1700
  }
1453
1701
  /**
1454
1702
  * Defines a property inside the schema.
@@ -1458,6 +1706,8 @@ declare namespace DphV1 {
1458
1706
  name: string;
1459
1707
  /** Detailed type definition of a schema property. */
1460
1708
  type?: ContractSchemaPropertyType;
1709
+ /** List of quality rules defined for the column. */
1710
+ quality?: ContractQualityRule[];
1461
1711
  }
1462
1712
  /**
1463
1713
  * Detailed type definition of a schema property.
@@ -1476,6 +1726,65 @@ declare namespace DphV1 {
1476
1726
  /** Native type of the field. */
1477
1727
  native_type?: string;
1478
1728
  }
1729
+ /**
1730
+ * Schema definition of a server configuration for the asset.
1731
+ */
1732
+ interface ContractServer {
1733
+ /** Name of the server. */
1734
+ server: string;
1735
+ /** Defines a data asset name and id. */
1736
+ asset?: ContractAsset;
1737
+ /** ID of the data source associated with data asset. */
1738
+ connection_id?: string;
1739
+ /** Type of the server. */
1740
+ type?: string;
1741
+ /** Description of the server. */
1742
+ description?: string;
1743
+ /** Environment in which the server operates. */
1744
+ environment?: string;
1745
+ /** Account used by the server. */
1746
+ account?: string;
1747
+ /** Catalog name. */
1748
+ catalog?: string;
1749
+ /** Database name. */
1750
+ database?: string;
1751
+ /** Dataset name. */
1752
+ dataset?: string;
1753
+ /** Delimiter. */
1754
+ delimiter?: string;
1755
+ /** Server endpoint URL. */
1756
+ endpoint_url?: string;
1757
+ /** File format. */
1758
+ format?: string;
1759
+ /** Host name or IP address. */
1760
+ host?: string;
1761
+ /** Location URL. */
1762
+ location?: string;
1763
+ /** Relative or absolute path to the data. */
1764
+ path?: string;
1765
+ /** Port to the server. */
1766
+ port?: string;
1767
+ /** Project name. */
1768
+ project?: string;
1769
+ /** Cloud region. */
1770
+ region?: string;
1771
+ /** Region name. */
1772
+ region_name?: string;
1773
+ /** Schema name. */
1774
+ schema?: string;
1775
+ /** Service name. */
1776
+ service_name?: string;
1777
+ /** Staging directory. */
1778
+ staging_dir?: string;
1779
+ /** Data stream name. */
1780
+ stream?: string;
1781
+ /** Warehouse or cluster name. */
1782
+ warehouse?: string;
1783
+ /** List of roles for the server. */
1784
+ roles?: string[];
1785
+ /** List of custom properties for the server. */
1786
+ custom_properties?: ContractTemplateCustomProperty[];
1787
+ }
1479
1788
  /**
1480
1789
  * Represents a custom property within the contract.
1481
1790
  */
@@ -1553,6 +1862,8 @@ declare namespace DphV1 {
1553
1862
  custom_properties?: ContractTemplateCustomProperty[];
1554
1863
  /** Contains the contract test status and related metadata. */
1555
1864
  contract_test?: ContractTest;
1865
+ /** List of server definitions. */
1866
+ servers?: ContractServer[];
1556
1867
  /** Schema details of the data asset. */
1557
1868
  schema?: ContractSchema[];
1558
1869
  }
@@ -1678,6 +1989,10 @@ declare namespace DphV1 {
1678
1989
  container: ContainerReference;
1679
1990
  /** The identifier of the data product contract template. */
1680
1991
  id?: string;
1992
+ /** The identifier of the user who created the data product contract template. */
1993
+ creator_id?: string;
1994
+ /** The timestamp when the data product contract template was created. */
1995
+ created_at?: string;
1681
1996
  /** The name of the contract template. */
1682
1997
  name?: string;
1683
1998
  /** Contains the code and details. */
@@ -1715,12 +2030,16 @@ declare namespace DphV1 {
1715
2030
  description?: string;
1716
2031
  /** The identifier of the data product domain. */
1717
2032
  id?: string;
2033
+ /** The identifier of the creator of the data product domain. */
2034
+ created_by?: string;
1718
2035
  /** Member roles of a corresponding asset. */
1719
2036
  member_roles?: MemberRolesSchema;
1720
2037
  /** Properties of the corresponding asset. */
1721
2038
  properties?: PropertiesSchema;
1722
2039
  /** List of sub domains to be added within a domain. */
1723
2040
  sub_domains?: InitializeSubDomain[];
2041
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
2042
+ sub_container?: ContainerIdentity;
1724
2043
  }
1725
2044
  /**
1726
2045
  * A collection of data product domains.
@@ -1773,6 +2092,8 @@ declare namespace DphV1 {
1773
2092
  access_control?: AssetListAccessControl;
1774
2093
  /** Timestamp of last asset update. */
1775
2094
  last_updated_at?: string;
2095
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
2096
+ sub_container?: ContainerIdentity;
1776
2097
  /** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
1777
2098
  * the data product requires explicit approval before data is delivered.
1778
2099
  */
@@ -1885,6 +2206,8 @@ declare namespace DphV1 {
1885
2206
  access_control?: AssetListAccessControl;
1886
2207
  /** Timestamp of last asset update. */
1887
2208
  last_updated_at?: string;
2209
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
2210
+ sub_container?: ContainerIdentity;
1888
2211
  /** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
1889
2212
  * the data product requires explicit approval before data is delivered.
1890
2213
  */
@@ -1951,6 +2274,8 @@ declare namespace DphV1 {
1951
2274
  access_control?: AssetListAccessControl;
1952
2275
  /** Timestamp of last asset update. */
1953
2276
  last_updated_at?: string;
2277
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
2278
+ sub_container?: ContainerIdentity;
1954
2279
  /** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
1955
2280
  * the data product requires explicit approval before data is delivered.
1956
2281
  */
@@ -2066,6 +2391,8 @@ declare namespace DphV1 {
2066
2391
  access_control?: AssetListAccessControl;
2067
2392
  /** Timestamp of last asset update. */
2068
2393
  last_updated_at?: string;
2394
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
2395
+ sub_container?: ContainerIdentity;
2069
2396
  /** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
2070
2397
  * the data product requires explicit approval before data is delivered.
2071
2398
  */
@@ -2172,6 +2499,8 @@ declare namespace DphV1 {
2172
2499
  access_control?: AssetListAccessControl;
2173
2500
  /** Timestamp of last asset update. */
2174
2501
  last_updated_at?: string;
2502
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
2503
+ sub_container?: ContainerIdentity;
2175
2504
  /** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
2176
2505
  * the data product requires explicit approval before data is delivered.
2177
2506
  */
@@ -2279,6 +2608,8 @@ declare namespace DphV1 {
2279
2608
  access_control?: AssetListAccessControl;
2280
2609
  /** Timestamp of last asset update. */
2281
2610
  last_updated_at?: string;
2611
+ /** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
2612
+ sub_container?: ContainerIdentity;
2282
2613
  /** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
2283
2614
  * the data product requires explicit approval before data is delivered.
2284
2615
  */
@@ -2379,9 +2710,20 @@ declare namespace DphV1 {
2379
2710
  engine_port?: string;
2380
2711
  /** The host of the engine defined by the data product producer. */
2381
2712
  engine_host?: string;
2713
+ /** The type of the engine (eg: Presto/Spark). */
2714
+ engine_type: EngineDetailsModel.Constants.EngineType | string;
2382
2715
  /** The list of associated catalogs. */
2383
2716
  associated_catalogs?: string[];
2384
2717
  }
2718
+ namespace EngineDetailsModel {
2719
+ namespace Constants {
2720
+ /** The type of the engine (eg: Presto/Spark). */
2721
+ enum EngineType {
2722
+ SPARK = "spark",
2723
+ PRESTO = "presto"
2724
+ }
2725
+ }
2726
+ }
2385
2727
  /**
2386
2728
  * Detailed error information.
2387
2729
  */
@@ -2603,6 +2945,8 @@ declare namespace DphV1 {
2603
2945
  interface ProducerInputModel {
2604
2946
  /** Engine details as defined by the data product producer. */
2605
2947
  engine_details?: EngineDetailsModel;
2948
+ /** List of engines defined by the data product producer. */
2949
+ engines?: EngineDetailsModel[];
2606
2950
  }
2607
2951
  /**
2608
2952
  * Properties of the corresponding asset.
@@ -2627,6 +2971,24 @@ declare namespace DphV1 {
2627
2971
  /** Reference to a workflow definition. */
2628
2972
  definition?: WorkflowDefinitionReference;
2629
2973
  }
2974
+ /**
2975
+ * This class holds the response message from the revoke access operation.
2976
+ */
2977
+ interface RevokeAccessResponse {
2978
+ /** Response message of revoke access. */
2979
+ message?: string;
2980
+ }
2981
+ /**
2982
+ * Revoke access states with pagination support.
2983
+ */
2984
+ interface RevokeAccessStateResponse {
2985
+ /** Holds revoke access state. */
2986
+ results?: Asset[];
2987
+ /** Total number of rows available. */
2988
+ total_count?: number;
2989
+ /** Pagination information for the next page of results. */
2990
+ next?: SearchAssetPaginationInfo;
2991
+ }
2630
2992
  /**
2631
2993
  * Represents a role associated with the contract.
2632
2994
  */
@@ -2634,6 +2996,21 @@ declare namespace DphV1 {
2634
2996
  /** The role associated with the contract. */
2635
2997
  role?: string;
2636
2998
  }
2999
+ /**
3000
+ * Pagination information for the next page of results.
3001
+ */
3002
+ interface SearchAssetPaginationInfo {
3003
+ /** Search query for filtering results. */
3004
+ query?: string;
3005
+ /** Number of items per page. */
3006
+ limit?: number;
3007
+ /** Bookmark for pagination. */
3008
+ bookmark?: string;
3009
+ /** What to include in the results. */
3010
+ include?: string;
3011
+ /** Number of items to skip. */
3012
+ skip?: number;
3013
+ }
2637
3014
  /**
2638
3015
  * Service id credentials.
2639
3016
  */