@salesforce/lds-adapters-cdp-data-clean-room 1.332.0-dev19

package/src/raml/api.raml

@@ -0,0 +1,204 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v63.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  CdpUserRepresentation:
+    description: Represents a user
+    type: object
+    properties:
+      id:
+        description: The 18 character user ID
+        type: string
+      name?:
+        description: The name of the user
+        type: string
+      profilePhotoUrl?:
+        description: The Chatter profile photo of the user
+        type: string
+  CdpPaginatedResponseBaseRepresentation:
+    description: Base paginated response representation
+    type: object
+    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
+  DataCleanRoomProviderCollectionRepresentation:
+    description: Represents Data Clean Room Provider Collection
+    # TODO Hand-rolled: discriminator fix, flattening CdpPaginatedResponseBaseRepresentation
+    # type: CdpPaginatedResponseBaseRepresentation
+    type: object
+    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
+        required: false
+      offset:
+        description: Start offset of the next batch
+        type: integer
+        required: false
+      providers:
+        description: List of provider definitions
+        type: array
+        items:
+          type: DataCleanRoomProviderRepresentation
+  DataCleanRoomProviderInputRepresentation:
+    description: Represents Cdp Data clean room Provider input
+    # TODO Hand-rolled: mulitple inheritance fix, unrolling CdpObjectBaseInputRepresentation
+    # type: CdpObjectBaseInputRepresentation
+    type: object
+    properties:
+      label:
+        description: label
+        type: string
+        required: true
+      description:
+        description: description
+        type: string
+        required: true
+      templateNames:
+        description: List of usecase templates that the provider supports
+        type: array
+        items:
+          type: string
+        required: true
+      dataCloudOrgId:
+        description: Unique ID representing Data Cloud org
+        type: string
+        required: true
+      dataspaceName:
+        description: dataspaceName
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      logoUrl:
+        description: Path to logo for discoverability
+        type: string
+        required: false
+  DataCleanRoomProviderRepresentation:
+    description: Represents Cdp Data Clean Room Provider
+    # 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
+      dataCloudOrgId:
+        description: Data Cloud Provider Org Id
+        type: string
+      description:
+        description: Data Clean Room Provider Description
+        type: string
+      logoUrl:
+        description: Data Clean Room Provider Logo Url
+        type: string
+        required: false
+      templateNames:
+        description: Data Clean Room Provider Template Names
+        type: array
+        items:
+          type: string
+/ssot:
+  /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:
+        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
+          body:
+            application/json:
+              type: DataCleanRoomProviderRepresentation
+      body:
+        application/json:
+          type: DataCleanRoomProviderInputRepresentation
+          (oas-body-name): input

package/src/raml/luvio.raml

@@ -0,0 +1,23 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'data-clean-room'
+(luvio.ttl): 60000
+
+types:
+  DataCleanRoomProviderRepresentation:
+    (luvio.key):
+      id: id
+    (luvio.opaque): true
+
+/ssot:
+  /data-clean-room/providers:
+    post:
+      (luvio.adapter):
+        name: createProvider
+    get:
+      (luvio.adapter):
+        name: getDataCleanRoomProvidersPaginated