@salesforce/lds-adapters-cdp-data-clean-room 1.428.0-dev2 → 1.428.0-dev20

package/src/raml/api.raml

@@ -410,6 +410,10 @@ types:
         description: Dictates whether useCase provided is of type Overlap/Activation/Custom
         type: string
         required: false
+      providerName:
+        description: Provider package for which the mapping is associated to.
+        type: string
+        required: false
   DataCleanRoomDataSpecificationRepresentation:
     description: Represents Cdp Data Clean Room Specification
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -478,6 +482,12 @@ types:
         description: Reference key to DataCleanRoomProvider record
         type: string
         required: false
+      templateVersions:
+        description: List of template versions to which the collaboration is associated to
+        type: array
+        items:
+          type: DataCleanRoomTemplateRepresentation
+        required: false
   DataCleanRoomMemberRepresentation:
     description: Represents Cdp Data Clean Room Members
     type: object
@@ -530,6 +540,10 @@ types:
         items:
           type: DataCleanRoomMemberConfigRepresentation
         required: false
+      memberDataCloudRegion:
+        description: Consumer Datacloud region
+        type: string
+        required: false
   DataCleanRoomSpecificationCollectionRepresentation:
     description: Represents Data Clean Room Specification Collection
     # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
@@ -593,6 +607,10 @@ types:
         description: Id of the template version
         type: string
         required: false
+      useCaseType:
+        description: useCaseType for which the collaboration is getting created.
+        type: string
+        required: false
   DataCleanRoomCollaborationRepresentation:
     description: Represents Cdp Data Clean Room Collaboration
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -650,9 +668,16 @@ types:
       templateVersion:
         description: Template Version Info for which data clean room is created
         type: DataCleanRoomTemplateRepresentation
+        required: false
       apiKey?:
         description: Api key for collaboration
         type: string
+      templateVersions:
+        description: List of template versions to which the collaboration is associated to
+        type: array
+        items:
+          type: DataCleanRoomTemplateRepresentation
+        required: false
   DataCleanRoomTemplateRepresentation:
     description: Represents Cdp Data Clean Room Template
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -788,6 +813,10 @@ types:
         description: Name of data space to which the collaboration is associated
         type: string
         required: false
+      memberDataCloudRegion:
+        description: Consumer Datacloud region
+        type: string
+        required: false
 
   DataCleanRoomOutputConfigurationRepresentation:
     description: Represents data clean room output configuration representation
@@ -865,6 +894,65 @@ types:
         type: string
         required: true
 
+  DataCleanRoomOutputDestinationConfigRepresentation:
+    description: Output destination attributes based on the connector type. Base representation extended by connector-specific implementations (Connect API pattern). Structure varies by connectorType.
+    type: object
+    properties:
+      connectorType:
+        description: Type of the connector (MetadataConnectorTypeEnum)
+        type: string
+        required: true
+
+  DataCleanRoomAwsS3OutputDestinationConfigRepresentation:
+    description: AWS S3 output destination config for member config, extends DataCleanRoomOutputDestinationConfigRepresentation
+    # TODO Hand-rolled: discriminator fix, unrolling DataCleanRoomOutputDestinationConfigRepresentation
+    # type: DataCleanRoomOutputDestinationConfigRepresentation
+    type: object
+    properties:
+      connectorType:
+        description: Type of the connector
+        type: string
+        required: true
+      roleArn:
+        description: IAM role used to connect to the s3 url provided
+        type: string
+        required: true
+      s3Url:
+        description: Full path of the s3 bucket with folders where the user wants the data to be shared
+        type: string
+        required: true
+
+  DataCleanRoomSnowflakeOutputDestinationConfigRepresentation:
+    description: Snowflake output destination config for member config, extends DataCleanRoomOutputDestinationConfigRepresentation
+    # TODO Hand-rolled: discriminator fix, unrolling DataCleanRoomOutputDestinationConfigRepresentation
+    # type: DataCleanRoomOutputDestinationConfigRepresentation
+    type: object
+    properties:
+      connectorType:
+        description: Type of the connector
+        type: string
+        required: true
+      accountUrl:
+        description: Snowflake account url of the provider's account
+        type: string
+        required: true
+      schemaName:
+        description: Schema name of the provider's the final dataset
+        type: string
+        required: true
+      databaseName:
+        description: Database name of the provider's the final dataset
+        type: string
+        required: true
+      warehouseName:
+        description: Warehouse name of the provider's the final dataset
+        type: string
+        required: true
+      serviceUser:
+        description: Service user with the relevant access to the provided database and warehouse
+        type: string
+        required: true
+
   DataCleanRoomRejectInvitationInputRepresentation:
     description: Represents Cdp Data clean room Reject invitation input
     type: object
@@ -893,6 +981,10 @@ types:
       queryExecutionName:
         description: Name of the Query that would be executed
         type: string
+      templateVersionId:
+        description: Id of the template version to run the query with
+        type: string
+        required: false
       segmentIds:
         description: Segment IDs on which the query would be executed
         required: false
@@ -956,9 +1048,17 @@ types:
         items:
           type: string
       queryParam:
-        description: Date time at which query was triggered
+        description: Map of query parameters along-with their values, required for the query to be executed
         type: any
         required: false
+      templateVersionId:
+        description: Reference key to DataCleanRoomTemplateVersion entity
+        type: string
+        required: false
+      queryName:
+        description: Name of the underlying query template version
+        type: string
+        required: false
       outputDMOName:
         description: Result DMO developer name in case of Activation usecase; result report name in case of other usecases.
         type: string
@@ -975,6 +1075,14 @@ types:
         description: Name of the user who executed the query job
         type: string
         required: false
+      type:
+        description: Determines the type of query run.
+        type: string
+        required: false
+      scheduleName:
+        description: Name of the schedule this run is part of, if the type is scheduled.
+        type: string
+        required: false
 
   DataCleanRoomQueryJobHistoryCollectionRepresentation:
     description: Represents Data Clean Room Job History Collection
@@ -1001,6 +1109,10 @@ types:
         type: array
         items:
           type: DataCleanRoomQueryJobRepresentation
+      queryConcurrencyLimit:
+        description: Maximum number of concurrent query jobs allowed
+        type: integer
+        required: false
 
   CustomUseCaseTemplateInputRepresentation:
     description: Represents data clean room custom template
@@ -1195,6 +1307,22 @@ types:
         description: Text displayed in the UI when the user interacts with the Info icon.
         type: string
         required: false
+      matchPolicy:
+        description: Match Policy to join multiple match fields.
+        type: CustomUseCaseTemplateMatchPolicyRepresentation
+        required: false
+
+  CustomUseCaseTemplateMatchPolicyRepresentation:
+    description: Represents data clean room custom template match policy
+    properties:
+      type:
+        description: Type of the column being matched.
+        type: string
+        required: true
+      alias:
+        description: The output column name the given column has to be projected/unioned as.
+        type: string
+        required: true
 
   CustomUseCaseTemplateQueryInputRepresentation:
     description: Represents data clean room custom template query input
@@ -1322,6 +1450,10 @@ types:
         description: Unique identifier for the output destination connection
         type: string
         required: false
+      outputDestinationConfig:
+        description: Output destination attributes for the connector type (260+)
+        type: DataCleanRoomOutputDestinationConfigRepresentation
+        required: false
 
   DataCleanRoomMetadataConfigurationRepresentation:
     description: Represents metadata configruation associated with template
@@ -1554,6 +1686,23 @@ types:
         description: Text displayed in the UI when the user interacts with the Info icon.
         type: string
         required: false
+      matchPolicy:
+        description: Match Policy to join multiple match fields.
+        type: UseCaseTemplateMatchPolicyRepresentation
+        required: false
+
+  UseCaseTemplateMatchPolicyRepresentation:
+    description: Represents usecase template match policy
+    type: object
+    properties:
+      type:
+        description: Type of the column being matched.
+        type: string
+        required: true
+      alias:
+        description: The output column name the given column has to be projected/unioned as.
+        type: string
+        required: true
 
 /ssot:
   /data-clean-room: