@salesforce/lds-adapters-cdp-data-clean-room 1.354.0-dev1 → 1.354.0-dev11

package/src/raml/api.raml

@@ -6,7 +6,7 @@ version: '63.0'
 mediaType: application/json
 protocols:
   - https
-baseUri: /services/data/v63.0
+baseUri: /services/data/v64.0
 securitySchemes:
   OAuth2:
     type: OAuth 2.0
@@ -29,7 +29,7 @@ types:
     description: Represents a user
     type: object
     properties:
-      id:
+      id?:
         description: The 18 character user ID
         type: string
       name?:
@@ -165,40 +165,800 @@ types:
         type: array
         items:
           type: string
+  UseCaseTemplateMappingAttributeRepresentation:
+    description: Represents Cdp Data Clean Room Mapping details
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
+    # type: CdpAssetBaseRepresentation
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string
+      dataMapping?:
+        description: Data Clean Room Data Mapping
+        type: UseCaseTemplateMappingRepresentation
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string
+      name?:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      url?:
+        description: Url
+        type: string
+      alias:
+        description: Attribute Alias
+        type: string
+      attributeId:
+        description: Attribute Id
+        type: string
+        required: false
+      path:
+        description: Attribute Path
+        type: array
+        items:
+          type: UseCaseTemplateMappingPathAttributeRepresentation
+      subjectAttribute:
+        description: Subject Attribute
+        type: UseCaseTemplateMappingSubjectAttributeRepresentation
+      filterOptions?:
+        description: Attribute Filter Option
+        type: UseCaseTemplateMappingAttributeFilterOptionRepresentation
+  UseCaseTemplateMappingPathAttributeRepresentation:
+    description: Data Clean Room UseCase Template Mapping Path Attribute Config
+    type: object
+    properties:
+      sourceAttribute:
+        description: Source attribute details in path component
+        type: any
+      targetAttribute:
+        description: Target attribute details in path component
+        type: any
+  UseCaseTemplateMappingRepresentation:
+    description: Represents Cdp Data Clean Room Mapping details
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
+    # type: CdpAssetBaseRepresentation
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string
+      name?:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      url?:
+        description: Url
+        type: string
+      attributes:
+        description: UseCase Template Mapping attributes
+        type: array
+        items:
+          type: UseCaseTemplateMappingAttributeRepresentation
+      collaborationEntity:
+        description: UseCase Template Collaboration Entity for Mapping
+        type: string
+  UseCaseTemplateMappingSubjectAttributeRepresentation:
+    description: Data Clean Room UseCase Template Mapping Subject Attribute Config
+    type: object
+    properties:
+      fieldLabel:
+        description: Label of mapping field
+        type: string
+      fieldName:
+        description: Name of mapping field
+        type: string
+      objectLabel:
+        description: Label of mapping object
+        type: string
+      objectName:
+        description: Name of mapping object
+        type: string
+  DataCleanRoomDataSpecificationInputRepresentation:
+    description: Represents Cdp Data clean room Specification input
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
+    # type: CdpObjectBaseInputRepresentation
+    type: object
+    properties:
+      dataMapping:
+        description: Data Mapping details for the data clean room member
+        type: any
+      memberType:
+        description: Type of the data clean room member
+        type: string
+      ownerOrgId:
+        description: Data cloud orgId where the mapping is created
+        type: string
+      templateName:
+        description: Name of the use case template for which mapping is provided
+        type: string
+      name:
+        description: name
+        type: string
+        required: false
+      label:
+        description: label
+        type: string
+        required: true
+      description?:
+        description: description
+        type: string
+      dataspaceName:
+        description: dataspaceName
+        type: string
+        required: false
+  DataCleanRoomDataSpecificationRepresentation:
+    description: Represents Cdp Data Clean Room Specification
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
+    # type: CdpAssetBaseRepresentation
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string
+      dataMapping:
+        description: Data Clean Room Data Mapping
+        type: UseCaseTemplateMappingRepresentation
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string
+      name?:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      url?:
+        description: Url
+        type: string
+      dataSpaceName:
+        description: Data Clean Room Specification DataSpace
+        type: string
+      description?:
+        description: Data Clean Room Specification Description
+        type: string
+      memberType:
+        description: Data Clean Room Member Type
+        type: string
+        enum:
+          - Consumer
+          - Provider
+      ownerOrgId?:
+        description: Data Clean Room Specification Owner Org ID
+        type: string
+      status:
+        description: Data Clean Room Data Specification Status
+        type: string
+        enum:
+          - Active
+          - Inactive
+      templateName:
+        description: Data Clean Room UseCase Template name
+        type: string
+  DataCleanRoomMemberRepresentation:
+    description: Represents Cdp Data Clean Room Members
+    type: object
+    properties:
+      invitationId:
+        description: Id of the invitation that enabled the member to be part of collaboration
+        type: string
+      invitationStatus:
+        description: Status of the invitation
+        type: string
+        enum:
+          - Accepted
+          - Pending
+          - Rejected
+          - Sent
+          - SentError
+      memberId:
+        description: Id of collaborating member
+        type: string
+      memberOrgId:
+        description: Id of the member org
+        type: string
+      memberStatus:
+        description: Status of the collaboration member
+        type: string
+        enum:
+          - Active
+          - Inactive
+          - Mapping_Incomplete
+      memberType:
+        description: Type of Member
+        type: string
+        enum:
+          - Consumer
+          - Provider
+      providerId:
+        description: Reference key to DataCleanRoomProvider record
+        type: string
+      specificationId?:
+        description: Reference key to DataCleanRoomDataSpecification
+        type: string
+  DataCleanRoomSpecificationCollectionRepresentation:
+    description: Represents Data Clean Room Specification Collection
+    # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
+    # type: CdpPaginatedResponseBaseRepresentation
+    properties:
+      currentPageUrl:
+        description: Current page url
+        type: string
+        required: false
+      nextPageUrl:
+        description: Next page url if it exists
+        type: string | nil
+        required: false
+      totalSize:
+        description: Total size of collection
+        type: integer
+        required: false
+      cleanroomSpecifications:
+        description: List of data clean room specifications
+        type: array
+        items:
+          type: DataCleanRoomDataSpecificationRepresentation
+      limit:
+        description: Number of records present in this response
+        type: integer
+      offset:
+        description: Start offset of the next batch
+        type: integer
+  DataCleanRoomCollaborationInputRepresentation:
+    description: Represents Cdp Data clean room collaboration input
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
+    # type: CdpObjectBaseInputRepresentation
+    properties:
+      apiKey?:
+        description: Api key for collaboration
+        type: string
+      dataCloudOrgId:
+        description: Core org ID where Data cloud clean room is enabled
+        type: string
+      dataSpaceName?:
+        description: Name of data space where data clean is created
+        type: string
+      providerDevName:
+        description: Developer name of provider definition
+        type: string
+      specificationDevName:
+        description: Developer Name of DataCleanRoomSpecification
+        type: string
+      templateName:
+        description: Developer name of use case template that the collaboration will
+          support
+        type: string
+      label:
+        description: Label of the asset
+        type: string
+      description?:
+        description: Description of data clean room
+        type: string
+  DataCleanRoomCollaborationRepresentation:
+    description: Represents Cdp Data Clean Room Collaboration
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
+    # type: CdpAssetBaseRepresentation
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string
+      name?:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      url?:
+        description: Url
+        type: string
+      dataSpaceName?:
+        description: DataSpace dev name of data clean room
+        type: string
+      description?:
+        description: Description of data clean room
+        type: string
+      members:
+        description: List of all members
+        type: array
+        items:
+          type: DataCleanRoomMemberRepresentation
+      status:
+        description: Enum for status of data clean room
+        type: string
+        enum:
+          - Active
+          - Inactive
+      templateVersion:
+        description: Template Version Info for which data clean room is created
+        type: DataCleanRoomTemplateRepresentation
+      apiKey?:
+        description: Api key for collaboration
+        type: string
+  DataCleanRoomTemplateRepresentation:
+    description: Represents Cdp Data Clean Room Template
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
+    # type: CdpAssetBaseRepresentation
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string
+      id?:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string
+      name?:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      url?:
+        description: Url
+        type: string
+      configuration:
+        description: Configuration for use case template
+        type: any
+      description:
+        description: Description of use case template
+        type: string
+      queryTemplate:
+        description: Defined Query template for use case template
+        type: any
+  DataCleanRoomCollaborationCollectionRepresentation:
+    description: Represents Data Clean Room Collaboration Collection
+    # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
+    # type: CdpPaginatedResponseBaseRepresentation
+    properties:
+      currentPageUrl?:
+        description: Current page url
+        type: string
+      nextPageUrl?:
+        description: Next page url if it exists
+        type: string | nil
+      totalSize?:
+        description: Total size of collection
+        type: integer
+      collaborations:
+        description: List of Data Clean Rooms Collaborations
+        type: array
+        items:
+          type: DataCleanRoomCollaborationRepresentation
+      limit:
+        description: Number of records present in this response
+        type: integer
+      offset:
+        description: Number of records to skip for the next request
+        type: integer
+  DataCleanRoomTemplateCollectionRepresentation:
+    description: Represents Cdp Data Clean Room Template Collection
+    # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
+    # type: CdpPaginatedResponseBaseRepresentation
+    properties:
+      currentPageUrl:
+        description: Current page url
+        type: string
+        required: false
+      nextPageUrl:
+        description: Next page url if it exists
+        type: string | nil
+        required: false
+      totalSize:
+        description: Total size of collection
+        type: integer
+        required: false
+      limit:
+        description: Number of records present in this response
+        type: integer
+      offset:
+        description: Number of records to skip for the next request
+        type: integer
+      templates:
+        description: List of Templates
+        type: array
+        items:
+          type: DataCleanRoomTemplateRepresentation
+
+  DataCleanRoomAcceptInvitationInputRepresentation:
+    description: Represents Cdp Data clean room Accept invitation input
+    type: object
+    properties:
+      invitationId:
+        description: Record Id of DataCleanRoomInvitation
+        type: string
+      specificationId:
+        description: Record Id of DataCleanRoomSpecification
+        type: string
+
+  DataCleanRoomRejectInvitationInputRepresentation:
+    description: Represents Cdp Data clean room Reject invitation input
+    type: object
+    properties:
+      invitationId:
+        description: Record Id of DataCleanRoomInvitation
+        type: string
+
+  UseCaseTemplateMappingAttributeFilterOptionRepresentation:
+    description: Data Clean Room UseCase Template Mapping Attribute Filter Config
+    type: object
+    properties:
+      operator:
+        description: Attribute Filter Operator
+        type: string
+      values:
+        description: Attribute Filter Values
+        type: array
+        items:
+          type: string
+
+  DataCleanRoomQueryJobInputRepresentation:
+    description: Represents Cdp Data clean room Query Job input
+    type: object
+    properties:
+      queryExecutionName:
+        description: Name of the Query that would be executed
+        type: string
+      segmentIds:
+        description: Segment IDs on which the query would be executed
+        type: array
+        items:
+          type: string
+
+  DataCleanRoomQueryJobRepresentation:
+    description: Represents Cdp Data Clean Room Query Job
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpAssetBaseRepresentation
+    # type: CdpAssetBaseRepresentation
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string
+      name?:
+        description: Name of the asset
+        type: string
+      completedDate?:
+        description: Date time at which query run was completed
+        type: string
+      errorCode?:
+        description: Error code due to query failure, if any
+        type: string
+      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
+        enum:
+          - Completed
+          - Created
+          - Failed
+          - Running
+      triggeredDate?:
+        description: Date time at which query was triggered
+        type: string
+      segmentNames?:
+        description: List of segment names
+        type: array
+        items:
+          type: string
+
+  DataCleanRoomQueryJobHistoryCollectionRepresentation:
+    description: Represents Data Clean Room Job History Collection
+    # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
+    # type: CdpPaginatedResponseBaseRepresentation
+    properties:
+      currentPageUrl?:
+        description: Current page url
+        type: string
+      nextPageUrl?:
+        description: Next page url if it exists
+        type: string | nil
+      totalSize?:
+        description: Total size of collection
+        type: integer
+      limit:
+        description: Number of records present in this response
+        type: integer
+      offset:
+        description: Start offset of the next batch
+        type: integer
+      queryJobs:
+        description: List of query jobs
+        type: array
+        items:
+          type: DataCleanRoomQueryJobRepresentation
+
 /ssot:
-  /data-clean-room/providers:
-    get:
-      displayName: getCdpDataCleanRoomProviderCollection
-      description: Gets the paginated list of all providers
-      responses:
-        '200':
-          description: Success
+  /data-clean-room:
+    /providers:
+      get:
+        displayName: getCdpDataCleanRoomProviderCollection
+        description: Gets the paginated list of all providers
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomProviderCollectionRepresentation
+        queryParameters:
+          filters:
+            type: string
+            required: false
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+      post:
+        displayName: postCdpDataCleanRoomProviderCollection
+        description: Creates a new Data Clean Room Provider
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomProviderRepresentation
+        body:
+          application/json:
+            type: DataCleanRoomProviderInputRepresentation
+            (oas-body-name): input
+    /specifications:
+      get:
+        displayName: getCdpDataCleanRoomDataSpecificationCollection
+        description: Gets the paginated list of all Data Clean Room Specifications
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomSpecificationCollectionRepresentation
+        queryParameters:
+          filters:
+            type: string
+            required: false
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+      post:
+        displayName: postCdpDataCleanRoomDataSpecificationCollection
+        description: Creates a new Data Clean Room Specification.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomDataSpecificationRepresentation
+        body:
+          application/json:
+            type: DataCleanRoomDataSpecificationInputRepresentation
+            (oas-body-name): input
+    /collaborations:
+      get:
+        displayName: getCdpDataCleanRoomCollaborationCollection
+        description: Gets a list of data clean rooms
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomCollaborationCollectionRepresentation
+        queryParameters:
+          filters:
+            type: string
+            required: false
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+      post:
+        displayName: postCdpDataCleanRoomCollaborationCollection
+        description: Creates a new data clean room collaboration
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomCollaborationRepresentation
+        body:
+          application/json:
+            type: DataCleanRoomCollaborationInputRepresentation
+            (oas-body-name): input
+    /templates:
+      get:
+        displayName: getCdpDataCleanRoomTemplateCollection
+        description: Gets the paginated list of all template
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomTemplateCollectionRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+    /collaborations/{collaborationIdOrApiName}/actions:
+      /accept-invitation:
+        put:
+          displayName: putCdpDataCleanRoomCollaboration
+          description: Handles invitation acceptance for a given Data Clean Room
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DataCleanRoomMemberRepresentation
           body:
             application/json:
-              type: DataCleanRoomProviderCollectionRepresentation
-      queryParameters:
-        batchSize:
-          type: integer
-          required: false
-        filters:
-          type: string
-          required: false
-        offset:
-          type: integer
-          required: false
-        orderBy:
-          type: string
-          required: false
-    post:
-      displayName: postCdpDataCleanRoomProviderCollection
-      description: Creates a new Data Clean Room Provider
-      responses:
-        '200':
-          description: Success
+              type: DataCleanRoomAcceptInvitationInputRepresentation
+              (oas-body-name): input
+        uriParameters:
+          collaborationIdOrApiName:
+            type: string
+      /reject-invitation:
+        put:
+          displayName: putCdpDataCleanRoomRejectInvitation
+          description: Handles invitation rejection for a given Data Clean Room
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DataCleanRoomMemberRepresentation
           body:
             application/json:
-              type: DataCleanRoomProviderRepresentation
-      body:
-        application/json:
-          type: DataCleanRoomProviderInputRepresentation
-          (oas-body-name): input
+              type: DataCleanRoomRejectInvitationInputRepresentation
+              (oas-body-name): input
+        uriParameters:
+          collaborationIdOrApiName:
+            type: string
+    /collaborations/{collaborationIdOrApiName}/actions/run:
+      post:
+        displayName: postCdpDataCleanRoomQueryJob
+        description: Triggers the Data clean room query job
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomQueryJobRepresentation
+        body:
+          application/json:
+            type: DataCleanRoomQueryJobInputRepresentation
+            (oas-body-name): input
+      uriParameters:
+        collaborationIdOrApiName:
+          type: string
+          required: true
+
+    /collaborations/{collaborationIdOrApiName}/jobs:
+      get:
+        displayName: getCdpDataCleanRoomQueryJobCollection
+        description: Gets a list of query job history for a given data clean room
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataCleanRoomQueryJobHistoryCollectionRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+          filters:
+            type: string
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+      uriParameters:
+        collaborationIdOrApiName:
+          type: string
+          required: true