@salesforce/lds-adapters-cdp-data-clean-room 1.391.0 → 1.393.0

package/src/raml/api.raml

@@ -95,21 +95,21 @@ types:
       description:
         description: description
         type: string
-        required: true
+        required: false
       templateNames:
         description: List of usecase templates that the provider supports
         type: array
         items:
           type: string
-        required: true
+        required: false
       dataCloudOrgId:
         description: Unique ID representing Data Cloud org
         type: string
-        required: true
+        required: false
       domainUrl:
         description: Domain URL of the provider
         type: string
-        required: true
+        required: false
       dataspaceName:
         description: dataspaceName
         type: string
@@ -125,7 +125,31 @@ types:
       offCoreTenantId:
         description: Off Core Tenant Id of the provider
         type: string
-        required: true
+        required: false
+      source:
+        description: provider source like DataCloud, AWS, GCP
+        type: string
+        required: false
+      templateJson:
+        description: extensible template uploaded by user
+        type: CustomUseCaseTemplateInputRepresentation
+        required: false
+      templateType:
+        description: Dictates whether template provided is of type SALESFORCE/CUSTOM
+        type: string
+        required: false
+      useCaseTypeConfig:
+        description: Dictates whether useCase provided is of type Overlap/Activation/Custom
+        type: DataCleanRoomUseCaseTypeInputRepresentation
+        required: false
+      providerName:
+        description: Name of the Provider provided by user
+        type: string
+        required: false
+      sourceConfiguration:
+        description: Other source related configuration DC/AWS
+        type: any
+        required: false
   DataCleanRoomProviderRepresentation:
     description: Represents Cdp Data Clean Room Provider
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -161,12 +185,15 @@ types:
       dataCloudOrgId:
         description: Data Cloud Provider Org Id
         type: string
+        required: false
       description:
         description: Data Clean Room Provider Description
         type: string
+        required: false
       domainUrl:
         description: Data Clean Room Provider Domain Url
         type: string
+        required: false
       logoUrl:
         description: Data Clean Room Provider Logo Url
         type: string
@@ -174,11 +201,33 @@ types:
       offCoreTenantId:
         description: Data Clean Room Provider Off Core Tenant Id
         type: string
+        required: false
       templateNames:
         description: Data Clean Room Provider Template Names
         type: array
+        required: false
         items:
           type: string
+      creationType:
+        description: Defines how provider package is created in an org
+        type: string
+        required: false
+      source:
+        description: provider source like DataCloud, AWS, GCP
+        type: string
+        required: false
+      providerName:
+        description: Name of the Provider provided by user
+        type: string
+        required: false
+      sourceConfiguration:
+        description: Other source related configuration DC/AWS
+        type: any
+        required: false
+      useCaseTypeConfig:
+        description: Dictates whether useCase provided is of type Overlap/Activation/Custom
+        type: DataCleanRoomUseCaseTypeRepresentation
+        required: false
   UseCaseTemplateMappingAttributeRepresentation:
     description: Represents Cdp Data Clean Room Mapping details
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -316,6 +365,7 @@ types:
       templateName:
         description: Name of the use case template for which mapping is provided
         type: string
+        required: false
       name:
         description: name
         type: string
@@ -324,13 +374,26 @@ types:
         description: label
         type: string
         required: true
-      description?:
+      description:
         description: description
         type: string
+        required: false
       dataspaceName:
         description: dataspaceName
         type: string
         required: false
+      templateVersionId:
+        description: Record Id from DataCleanRoomTemplateVersion entity
+        type: string
+        required: false
+      templateType:
+        description: Dictates whether template provided is of type SALESFORCE/CUSTOM
+        type: string
+        required: false
+      useCaseType:
+        description: Dictates whether useCase provided is of type Overlap/Activation/Custom
+        type: string
+        required: false
   DataCleanRoomDataSpecificationRepresentation:
     description: Represents Cdp Data Clean Room Specification
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -390,6 +453,10 @@ types:
       templateVersion?:
         description: Template Version Info for which data clean room is created
         type: DataCleanRoomTemplateRepresentation
+      providerId:
+        description: Reference key to DataCleanRoomProvider record
+        type: string
+        required: false
   DataCleanRoomMemberRepresentation:
     description: Represents Cdp Data Clean Room Members
     type: object
@@ -412,6 +479,7 @@ types:
       memberOrgId:
         description: Id of the member org
         type: string
+        required: false
       memberStatus:
         description: Status of the collaboration member
         type: string
@@ -483,12 +551,17 @@ types:
         description: Developer name of use case template that the collaboration will
           support
         type: string
+        required: false
       label:
         description: Label of the asset
         type: string
       description?:
         description: Description of data clean room
         type: string
+      templateVersionId:
+        description: Id of the template version
+        type: string
+        required: false
   DataCleanRoomCollaborationRepresentation:
     description: Represents Cdp Data Clean Room Collaboration
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -585,6 +658,22 @@ types:
       queryTemplate:
         description: Defined Query template for use case template
         type: any
+      useCaseType:
+        description: Type identifying whether its OOTB template or custom template
+        type: string
+        required: false
+      templateVersion:
+        description: version of the template
+        type: string
+        required: false
+      templateType:
+        description: Type identifying whether its OOTB template or custom template
+        type: string
+        required: false
+      providerId:
+        description: Reference key to DataCleanRoomProvider record
+        type: string
+        required: false
   DataCleanRoomCollaborationCollectionRepresentation:
     description: Represents Data Clean Room Collaboration Collection
     # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
@@ -680,9 +769,14 @@ types:
         type: string
       segmentIds:
         description: Segment IDs on which the query would be executed
+        required: false
         type: array
         items:
           type: string
+      queryParameters:
+        description: Map of query parameters along-with their values, required for the query to be executed
+        type: any
+        required: false
 
   DataCleanRoomQueryJobRepresentation:
     description: Represents Cdp Data Clean Room Query Job
@@ -719,9 +813,6 @@ types:
       errorMessage?:
         description: Error message specifying the query failure reason, if any
         type: string
-      result?:
-        description: Number of records obtained as part of query run
-        type: integer
       status:
         description: Query Status of Query Job
         type: string
@@ -738,6 +829,26 @@ types:
         type: array
         items:
           type: string
+      queryParam:
+        description: Date time at which query was triggered
+        type: any
+        required: false
+      outputDMOName:
+        description: Result DMO developer name in case of Activation usecase; result report name in case of other usecases.
+        type: string
+        required: false
+      reportId:
+        description: Id of the report associated with output DMO
+        type: string
+        required: false
+      reportName:
+        description: Name of the report associated with output DMO
+        type: string
+        required: false
+      executedBy:
+        description: Name of the user who executed the query job
+        type: string
+        required: false
 
   DataCleanRoomQueryJobHistoryCollectionRepresentation:
     description: Represents Data Clean Room Job History Collection
@@ -765,6 +876,184 @@ types:
         items:
           type: DataCleanRoomQueryJobRepresentation
 
+  CustomUseCaseTemplateInputRepresentation:
+    description: Represents data clean room custom template
+    properties:
+      name:
+        description: Name of the custom template
+        type: string
+        required: true
+      description:
+        description: Description of the custom template
+        type: string
+        required: true
+      version:
+        description: version of the custom template
+        type: string
+        required: true
+      tables:
+        description: List of tables referenced in template queries
+        type: CustomUseCaseTemplateTableInputRepresentation
+        required: true
+      queries:
+        description: List of queries defined in the template
+        type: CustomUseCaseTemplateQueryInputRepresentation
+        required: true
+
+  CustomUseCaseTemplateTableInputRepresentation:
+    description: Represents data clean room custom template table input
+    properties:
+      tableConfigs:
+        description: List of table configs
+        type: array
+        items:
+          type: CustomUseCaseTemplateTableConfig
+        required: true
+
+  CustomUseCaseTemplateTableConfig:
+    description: Represents data clean room custom template table
+    properties:
+      name:
+        description: Name of the custom template table
+        type: string
+        required: true
+      description:
+        description: Description of the custom template table
+        type: string
+        required: true
+      role:
+        description: Role of the custom template
+        type: string
+        required: true
+      columns:
+        description: List of columns in the table
+        type: array
+        items:
+          type: CustomUseCaseTemplateColumnRepresentation
+        required: true
+
+  CustomUseCaseTemplateColumnRepresentation:
+    description: Represents data clean room custom template column
+    properties:
+      name:
+        description: Name of the custom template column
+        type: string
+        required: true
+      description:
+        description: Description of the custom template column
+        type: string
+        required: true
+      type:
+        description: type of the custom template column
+        type: string
+        required: true
+      defaultValue:
+        description: defaultValue of the custom template column
+        type: string
+        required: false
+
+  CustomUseCaseTemplateQueryInputRepresentation:
+    description: Represents data clean room custom template query input
+    properties:
+      queryConfigs:
+        description: List of query configs
+        type: array
+        items:
+          type: CustomUseCaseTemplateQueryConfig
+        required: true
+
+  CustomUseCaseTemplateQueryConfig:
+    description: Represents data clean room custom template query
+    properties:
+      name:
+        description: Name of the custom template query
+        type: string
+        required: true
+      description:
+        description: Description of the custom template query
+        type: string
+        required: true
+      usecase:
+        description: Name of the associated use case
+        type: string
+        required: false
+      type:
+        description: type of the custom template query
+        type: string
+        required: true
+      source:
+        description: Actual Query to be executed
+        type: string
+        required: true
+      queryParameters:
+        description: query parameters
+        type: CustomUseCaseTemplateQueryParamRepresentation
+        required: false
+      referencedTables:
+        description: List of tables referenced by the query
+        type: array
+        items:
+          type: string
+        required: true
+      analysisConfigs:
+        description: Additional configurations for the query
+        type: CustomUseCaseTemplateAnalysisConfigRepresentation
+        required: false
+
+  CustomUseCaseTemplateQueryParamRepresentation:
+    description: Represents data clean room custom template query parameter
+    properties:
+      queryParamConfigs:
+        description: List of queries parameters defined in the template.
+        type: array
+        items:
+          type: CustomUseCaseTemplateQueryParamConfig
+        required: true
+
+  CustomUseCaseTemplateQueryParamConfig:
+    description: Represents data clean room custom template query parameter
+    properties:
+      name:
+        description: Name of the custom template query parameter
+        type: string
+        required: true
+      description:
+        description: Description of the custom template query parameter
+        type: string
+        required: true
+      type:
+        description: type of the custom template query parameter
+        type: string
+        required: true
+
+  CustomUseCaseTemplateAnalysisConfigRepresentation:
+    description: Represents data clean room custom template analysis config
+    properties:
+      outputPath:
+        description: output path for saving the result of the query
+        type: string
+        required: false
+
+  DataCleanRoomUseCaseTypeInputRepresentation:
+    description: Represents Data Clean Room Use Case Type Input
+    properties:
+      useCaseTypes:
+        description: Dictates whether useCase provided is of type Overlap/Activation/Custom
+        type: array
+        required: false
+        items:
+          type: string
+
+  DataCleanRoomUseCaseTypeRepresentation:
+    description: Represents Data Clean Room Use Case Type output
+    properties:
+      useCaseTypes:
+        description: Dictates whether useCase provided is of type Overlap/Activation/Custom
+        type: array
+        required: false
+        items:
+          type: string
+
 /ssot:
   /data-clean-room:
     /providers:
@@ -895,6 +1184,9 @@ types:
           orderBy:
             type: string
             required: false
+          filters:
+            type: string
+            required: false
     /collaborations/{collaborationIdOrApiName}/actions:
       /accept-invitation:
         put:
@@ -977,3 +1269,30 @@ types:
         collaborationIdOrApiName:
           type: string
           required: true
+    /providers/{providerIdOrName}/templates:
+      get:
+        displayName: getDataCleanRoomTemplatesByProviderIdPaginated
+        description: Gets the paginated list of all templates for a given provider ID
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomTemplateCollectionRepresentation
+        queryParameters:
+          filters:
+            type: string
+            required: false
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+      uriParameters:
+        providerIdOrName:
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -79,3 +79,7 @@ types:
       get:
         (luvio.adapter):
           name: getAllDataCleanRoomQueryPaginated
+    /providers/{providerIdOrName}/templates:
+      get:
+        (luvio.adapter):
+          name: getDataCleanRoomTemplatesByProviderIdPaginated