@salesforce/lds-adapters-cdp-data-clean-room 1.404.0-dev2 → 1.404.0-dev21

package/src/raml/api.raml

@@ -150,6 +150,14 @@ types:
         description: Other source related configuration DC/AWS
         type: any
         required: false
+      packageType:
+        description: Dictates the type of the package
+        type: string
+        required: false
+      providerDataSource:
+        description: The source of provider data
+        type: string
+        required: false
   DataCleanRoomProviderRepresentation:
     description: Represents Cdp Data Clean Room Provider
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -228,6 +236,14 @@ types:
         description: Dictates whether useCase provided is of type Overlap/Activation/Custom
         type: DataCleanRoomUseCaseTypeRepresentation
         required: false
+      packageType:
+        description: Dictates the type of the package
+        type: string
+        required: false
+      providerDataSource:
+        description: The source of provider data
+        type: string
+        required: false
   UseCaseTemplateMappingAttributeRepresentation:
     description: Represents Cdp Data Clean Room Mapping details
     # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
@@ -499,6 +515,16 @@ types:
       specificationId?:
         description: Reference key to DataCleanRoomDataSpecification
         type: string
+      memberDomainUrl:
+        description: Member org domain URL
+        type: string
+        required: false
+      memberConfigs:
+        description: Member configs assocaited with the template
+        type: array
+        items:
+          type: DataCleanRoomMemberConfigRepresentation
+        required: false
   DataCleanRoomSpecificationCollectionRepresentation:
     description: Represents Data Clean Room Specification Collection
     # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
@@ -651,7 +677,8 @@ types:
         type: string
       configuration:
         description: Configuration for use case template
-        type: any
+        type: UseCaseTemplateConfigRepresentation
+        required: false
       description:
         description: Description of use case template
         type: string
@@ -674,6 +701,10 @@ types:
         description: Reference key to DataCleanRoomProvider record
         type: string
         required: false
+      metadataConfiguration:
+        description: metadata configuration for the template
+        type: DataCleanRoomMetadataConfigurationRepresentation
+        required: false
   DataCleanRoomCollaborationCollectionRepresentation:
     description: Represents Data Clean Room Collaboration Collection
     # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
@@ -737,7 +768,92 @@ types:
         type: string
       specificationId:
         description: Record Id of DataCleanRoomSpecification
+        type: string | nil
+        required: false
+      outputConfiguration:
+        description: Output configuration for the collaboration involved
+        type: DataCleanRoomOutputConfigurationRepresentation
+        required: false
+      dataSpaceName:
+        description: Name of data space to which the collaboration is associated
         type: string
+        required: false
+
+  DataCleanRoomOutputConfigurationRepresentation:
+    description: Represents data clean room output configuration representation
+    type: object
+    properties:
+      outputDestinationType:
+        description: Output destination type
+        type: string
+        required: true
+      externalId:
+        description: unique Id for the output configuration
+        type: string
+        required: false
+      connectionAttributes:
+        description: Connection attributes for the output configuration
+        type: DataCleanRoomConnectionAttributesRepresentation
+        required: false
+
+  DataCleanRoomConnectionAttributesRepresentation:
+    description: Base representation for clean room connection attributes - extended by connector specific implementations. This is an abstract base class. Structure varies by connectorType. Concrete implementations (e.g., DataCleanRoomAwsS3ConnectionAttributesRepresentation) will extend this class.
+    type: object
+    properties:
+      connectorType:
+        description: Type of the connector
+        type: string
+        required: true
+
+  DataCleanRoomAwsS3ConnectionAttributesRepresentation:
+    description: Represents AWS S3 connection attributes for data clean room, extends DataCleanRoomConnectionAttributesRepresentation
+    # TODO Hand-rolled: discriminator fix, unrolling DataCleanRoomConnectionAttributesRepresentation
+    # type: DataCleanRoomConnectionAttributesRepresentation
+    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
+
+  DataCleanRoomSnowflakeConnectionAttributesRepresentation:
+    description: Represents Snowflake connection attributes for data clean room, extends DataCleanRoomConnectionAttributesRepresentation
+    # TODO Hand-rolled: discriminator fix, unrolling DataCleanRoomConnectionAttributesRepresentation
+    # type: DataCleanRoomConnectionAttributesRepresentation
+    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
@@ -899,6 +1015,120 @@ types:
         description: List of queries defined in the template
         type: CustomUseCaseTemplateQueryInputRepresentation
         required: true
+      useCaseConfigs:
+        description: Map of use case type to usecase specific configs
+        type: object
+        required: false
+        properties:
+          //:
+            type: DataCleanRoomUsecaseConfigInputRepresentation
+
+  DataCleanRoomUsecaseConfigInputRepresentation:
+    description: Represents data clean room use case config input representation.
+    properties:
+      useCaseType:
+        description: Type of the use case
+        type: string
+        required: true
+
+  MatchBoostUsecaseConfigInputRepresentation:
+    description: Represents match boost use case config input, extends DataCleanRoomUseCaseConfigInputRepresentation
+    # TODO Hand-rolled: discriminator fix, unrolling DataCleanRoomUseCaseConfigInputRepresentation
+    # type: DataCleanRoomUseCaseConfigInputRepresentation
+    type: object
+    properties:
+      useCaseType:
+        description: Type of the use case
+        type: string
+        required: true
+      supportedContactPoints:
+        description: List of contact points supported by the Provider
+        type: array
+        required: true
+        items:
+          type: any
+      outputObjects:
+        description: List of objects having output enriched dataset
+        type: MatchBoostOutputObjectInputRepresentation
+        required: true
+
+  MatchBoostOutputObjectInputRepresentation:
+    description: Represents match boost output object input
+    type: object
+    properties:
+      outputObjectConfigs:
+        description: List of output object configs
+        type: array
+        required: true
+        items:
+          type: MatchBoostOutputObjectConfigRepresentation
+
+  MatchBoostOutputObjectConfigRepresentation:
+    description: Represents match boost output object config
+    type: object
+    properties:
+      objectName:
+        description: Unique name of the entity
+        type: string
+        required: true
+      bridgeTable:
+        description: Details if this entity is a bridge table
+        type: MatchBoostOutputBridgeTableInputRepresentation
+        required: false
+      relatedTable:
+        description: Details for a non-bridge table entity
+        type: MatchBoostOutputRelatedTableInputRepresentation
+        required: false
+
+  MatchBoostOutputBridgeTableInputRepresentation:
+    description: Represents match boost output bridge table input
+    type: object
+    properties:
+      sourceIdFieldName:
+        description: Column name corresponding to the equivalent column in the shared data
+        type: string
+        required: false
+
+  MatchBoostOutputRelatedTableInputRepresentation:
+    description: Represents match boost output related table input
+    type: object
+    properties:
+      sourceObjectName:
+        description: Equivalent ssot object name
+        type: string
+        required: false
+      pathFromBridgeTable:
+        description: Path details identifying the relationship between bridge table and this entity
+        type: array
+        required: false
+        items:
+          type: MatchBoostOutputBridgeTablePathInputRepresentation
+
+  MatchBoostOutputBridgeTablePathInputRepresentation:
+    description: Represents match boost output bridge table path input
+    type: object
+    properties:
+      sourceAttribute:
+        description: Source attribute of the path
+        type: MatchBoostOutputBridgeTablePathAttributeInputRepresentation
+        required: false
+      targetAttribute:
+        description: Target attribute of the path
+        type: MatchBoostOutputBridgeTablePathAttributeInputRepresentation
+        required: false
+
+  MatchBoostOutputBridgeTablePathAttributeInputRepresentation:
+    description: Represents match boost output bridge table path attribute input
+    type: object
+    properties:
+      objectName:
+        description: Unique name of the entity
+        type: string
+        required: false
+      fieldName:
+        description: Unique field name of the entity
+        type: string
+        required: false
 
   CustomUseCaseTemplateTableInputRepresentation:
     description: Represents data clean room custom template table input
@@ -951,6 +1181,10 @@ types:
         description: defaultValue of the custom template column
         type: string
         required: false
+      tooltip:
+        description: Text displayed in the UI when the user interacts with the Info icon.
+        type: string
+        required: false
 
   CustomUseCaseTemplateQueryInputRepresentation:
     description: Represents data clean room custom template query input
@@ -979,15 +1213,15 @@ types:
         required: false
       type:
         description: type of the custom template query
-        type: string
-        required: true
+        type: string | nil
+        required: false
       source:
         description: Actual Query to be executed
-        type: string
-        required: true
+        type: string | nil
+        required: false
       queryParameters:
         description: query parameters
-        type: CustomUseCaseTemplateQueryParamRepresentation
+        type: CustomUseCaseTemplateQueryParamRepresentation | nil
         required: false
       referencedTables:
         description: List of tables referenced by the query
@@ -1054,6 +1288,263 @@ types:
         items:
           type: string
 
+  DataCleanRoomMemberConfigRepresentation:
+    description: Represents member configs associated with template
+    type: object
+    properties:
+      id:
+        description: Id of the member config
+        type: string
+        required: false
+      templateVersionId:
+        description: Reference key to DataCleanRoomTemplateVer
+        type: string
+        required: false
+      outputDestinationId:
+        description: Reference key to OutputDestination
+        type: string
+        required: false
+      outputDestinationType:
+        description: Output destination type
+        type: string
+        required: false
+      externalId:
+        description: Unique identifier for the output destination connection
+        type: string
+        required: false
+
+  DataCleanRoomMetadataConfigurationRepresentation:
+    description: Represents metadata configruation associated with template
+    type: object
+    properties:
+      memberConfig:
+        description: list of member-specific metadata configurations
+        type: array
+        required: false
+        items:
+          type: DataCleanRoomMetadataMemberConfigRepresentation
+      usecaseConfig:
+        description: Use case specific configuration
+        type: DataCleanRoomUsecaseConfigRepresentation
+        required: false
+
+  DataCleanRoomMetadataMemberConfigRepresentation:
+    description: Represents metadata member config associated with template
+    type: object
+    properties:
+      type:
+        description: Type of member (CONSUMER or PROVIDER)
+        type: string
+        required: false
+      canTriggerQuery:
+        description: Whether this member can trigger query execution
+        type: boolean
+        required: false
+      canReceiveResult:
+        description: Whether this member can receive query results
+        type: boolean
+        required: false
+      paysForQueries:
+        description: Whether this member pays for query execution
+        type: boolean
+        required: false
+      contributesData:
+        description: Whether this member contributes data to the clean room
+        type: boolean
+        required: false
+      outputConfig:
+        description: Output configuration for query results
+        type: DataCleanRoomMetadataOutputConfigRepresentation
+        required: false
+
+  DataCleanRoomMetadataOutputConfigRepresentation:
+    description: Represents metadata output config for query results
+    type: object
+    properties:
+      destinationType:
+        description: Type of output destination
+        type: any
+        required: false
+      connectorType:
+        description: Type of connector
+        type: any
+        required: false
+
+  DataCleanRoomUsecaseConfigRepresentation:
+    description: Base representation for use case specific configuration. This is an abstract base class. Structure varies by useCaseType.
+    type: object
+    properties:
+      useCaseType:
+        description: Type of the use case
+        type: any
+        required: false
+
+  DataCleanRoomMatchBoostUsecaseConfigRepresentation:
+    description: Represents match boost use case config, extends DataCleanRoomUsecaseConfigRepresentation
+    # TODO Hand-rolled: discriminator fix, unrolling DataCleanRoomUsecaseConfigRepresentation
+    # type: DataCleanRoomUsecaseConfigRepresentation
+    type: object
+    properties:
+      useCaseType:
+        description: Type of the use case
+        type: any
+        required: false
+      supportedContactPoints:
+        description: List of contact points supported by the Provider
+        type: array
+        required: false
+        items:
+          type: any
+      outputObjects:
+        description: List of objects having output enriched dataset
+        type: DataCleanRoomMatchBoostOutputObjectRepresentation
+        required: false
+
+  DataCleanRoomMatchBoostOutputObjectRepresentation:
+    description: Represents match boost output object
+    type: object
+    properties:
+      outputObjectConfigs:
+        description: List of output object configs
+        type: array
+        required: false
+        items:
+          type: DataCleanRoomMatchBoostOutputObjectConfigRepresentation
+
+  DataCleanRoomMatchBoostOutputObjectConfigRepresentation:
+    description: Represents match boost output object config
+    type: object
+    properties:
+      objectName:
+        description: Unique name of the entity
+        type: string
+        required: false
+      bridgeTable:
+        description: Details if this entity is a bridge table
+        type: DataCleanRoomMatchBoostOutputBridgeTableRepresentation
+        required: false
+      relatedTable:
+        description: Details for a non-bridge table entity
+        type: DataCleanRoomMatchBoostOutputRelatedTableRepresentation
+        required: false
+
+  DataCleanRoomMatchBoostOutputBridgeTableRepresentation:
+    description: Represents match boost output bridge table
+    type: object
+    properties:
+      sourceIdFieldName:
+        description: Column name corresponding to the equivalent column in the shared data
+        type: string
+        required: false
+
+  DataCleanRoomMatchBoostOutputRelatedTableRepresentation:
+    description: Represents match boost output related table
+    type: object
+    properties:
+      sourceObjectName:
+        description: Equivalent ssot object name
+        type: string
+        required: false
+      pathFromBridgeTable:
+        description: Path details identifying the relationship between bridge table and this entity
+        type: array
+        required: false
+        items:
+          type: DataCleanRoomMatchBoostOutputBridgeTablePathRepresentation
+
+  DataCleanRoomMatchBoostOutputBridgeTablePathRepresentation:
+    description: Represents match boost output bridge table path
+    type: object
+    properties:
+      sourceAttribute:
+        description: Source attribute of the path
+        type: DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation
+        required: false
+      targetAttribute:
+        description: Target attribute of the path
+        type: DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation
+        required: false
+
+  DataCleanRoomMatchBoostOutputBridgeTablePathAttributeRepresentation:
+    description: Represents match boost output bridge table path attribute
+    type: object
+    properties:
+      objectName:
+        description: Unique name of the entity
+        type: string
+        required: false
+      fieldName:
+        description: Unique field name of the entity
+        type: string
+        required: false
+
+  UseCaseTemplateConfigRepresentation:
+    description: Represents usecase template configuration output representation
+    type: object
+    properties:
+      memberConfigs:
+        description: Usecase template member configurations
+        type: array
+        required: false
+        items:
+          type: UseCaseTemplateMemberConfigRepresentation
+
+  UseCaseTemplateMemberConfigRepresentation:
+    description: Represents usecase template member configuration output representation
+    type: object
+    properties:
+      memberType:
+        description: Usecase member type
+        type: any
+        required: false
+      attributeConfigs:
+        description: Usecase template attribute configurations
+        type: array
+        required: false
+        items:
+          type: UseCaseTemplateAttributeConfigRepresentation
+
+  UseCaseTemplateAttributeConfigRepresentation:
+    description: Represents usecase template attribute configuration output representation
+    type: object
+    properties:
+      alias:
+        description: UseCase Template Attribute alias
+        type: string
+        required: false
+      description:
+        description: UseCase Template Attribute description
+        type: string
+        required: false
+      required:
+        description: Captures whether the attribute is mandatory to be mapped or not
+        type: boolean
+        required: false
+      id:
+        description: UseCase Template Attribute id
+        type: string
+        required: false
+      label:
+        description: UseCase Template Attribute label
+        type: string
+        required: false
+      tableName:
+        description: UseCase Template Attribute tableName
+        type: string
+        required: false
+      defaultValue:
+        description: UseCase Template Attribute defaultValue
+        type: string
+        required: false
+      queryOptions:
+        description: UseCase Template Attribute Query Configuration
+        type: any
+        required: false
+      tooltip:
+        description: Text displayed in the UI when the user interacts with the Info icon.
+        type: string
+        required: false
+
 /ssot:
   /data-clean-room:
     /providers: