@salesforce/lds-adapters-cdp-communication-capping 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,290 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  CdpErrorRepresentation:
+    description: Error response representation
+    type: object
+    properties:
+      errorCode?:
+        description: Error Code
+        type: string
+      message?:
+        description: Message stating the reason for error, if any
+        type: string
+  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
+  DataSpaceFilterConditionRepresentation:
+    description: Represents dataSpace filter condition
+    type: object
+    properties:
+      fieldName:
+        description: table field name on which filter is applied
+        type: string
+      filterValue:
+        description: value of the condition
+        type: string
+      operator:
+        description: operator of the filter condition
+        type: string
+        enum:
+          - EqualsOperator
+          - InOperator
+      tableName:
+        description: table name on which filter is applied
+        type: string
+  DataSpaceFilterRepresentation:
+    description: Represents dataSpace filter on a DLO
+    type: object
+    properties:
+      conditions:
+        description: list of conditions in the filter
+        type: array
+        items:
+          type: DataSpaceFilterConditionRepresentation
+      conjunctiveOperator:
+        description: enum of filter operator
+        type: string
+        enum:
+          - AndOperator
+          - NoneOperator
+          - OrOperator
+  DataSpaceRepresentation:
+    description: Represents Cdp DataSpace
+    type: object
+    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
+      filter?:
+        description: Data Space Filter
+        type: DataSpaceFilterRepresentation
+  CommunicationCappingActionResponseRepresentation:
+    description: Representation for the standard action response in communication
+      capping
+    type: object
+    properties:
+      errors:
+        description: Any errors that resulted from the action.
+        type: array
+        items:
+          type: CdpErrorRepresentation
+      success:
+        description: Indicates whether the call was successful.
+        type: boolean
+  DimensionRepresentation:
+    description: Represents Communication Capping Dimension
+    type: object
+    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
+      hierarchyOrder:
+        description: Hierarchy of Dimension
+        type: integer
+      type:
+        description: Dimension Type
+        type: string
+        enum:
+          - Functional
+          - NonFunctional
+      values?:
+        description: Dimension Value
+        type: array
+        items:
+          type: DimensionValueRepresentation
+  DimensionValueRepresentation:
+    description: Represents Communication Capping Dimension Value
+    type: object
+    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
+  CommunicationCappingRepresentation:
+    description: Representation for the communication capping configuration
+    type: object
+    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
+      dataspacesInfo:
+        description: Communication Capping config dataspaces information
+        type: array
+        items:
+          type: DataSpaceRepresentation
+      description?:
+        description: Communication Capping config description
+        type: string | nil
+      dimensions:
+        description: Communication Capping config dimensions
+        type: array
+        items:
+          type: DimensionRepresentation
+      status?:
+        description: Communication Capping config status
+        type: string
+        enum:
+          - Active
+          - Error
+          - Inactive
+          - Processing
+/ssot:
+  /communication-cappings:
+    /{idOrName}:
+      get:
+        displayName: getCdpCommunicationCapping
+        description: Gets the specific communication capping config
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CommunicationCappingRepresentation
+      uriParameters:
+        idOrName:
+          type: string
+          required: true
+      /actions/retry:
+        post:
+          displayName: postCdpCommunicationCappingActionRetry
+          description: Retry DMO and CI creation for communication capping configuration
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CommunicationCappingActionResponseRepresentation
+        uriParameters:
+          idOrName:
+            type: string
+            required: true

package/src/raml/luvio.raml

@@ -0,0 +1,24 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'communication-capping'
+(luvio.ttl): 60000
+
+types:
+  CommunicationCappingActionResponseRepresentation:
+    (luvio.key):
+      success: success
+
+/ssot:
+  /communication-cappings:
+    /{idOrName}:
+      get:
+        (luvio.adapter):
+          name: getCommunicationCappingRepresentation
+    /{idOrName}/actions/retry:
+      post:
+        (luvio.adapter):
+          name: triggerDMOCICreation