@salesforce/lds-adapters-marketing-cdp 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,353 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.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:
+  CdpObjectBaseInputRepresentation:
+    description: Base CDP Input representation
+    type: object
+    discriminator: kind
+    properties:
+      kind:
+        description: refers to the `kind` property of object `CdpObjectBaseInputRepresentation`
+        type: string
+      dataspaceName:
+        description: dataspaceName
+        type: string
+        required: false
+      description:
+        description: description
+        type: string
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+  CdpObjectBaseOutputRepresentation:
+    description: Represents Cdp Base Output
+    type: object
+    discriminator: kind
+    properties:
+      kind:
+        description: refers to the `kind` property of object `CdpObjectBaseOutputRepresentation`
+        type: string
+      createdBy:
+        description: created by
+        type: string
+        required: false
+      createdDate:
+        description: created date
+        type: string
+        required: false
+      dataspaceName:
+        description: dataspacename
+        type: string
+        required: false
+      description:
+        description: description
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      modifiedBy:
+        description: modified by
+        type: string
+        required: false
+      modifiedDate:
+        description: modified date
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+  CdpApplicationDataGraphDataRecencyInputRepresentation:
+    description: ADG Recency Criteria input representation
+    type: object
+    properties:
+      fieldName:
+        description: field_name
+        type: string
+      value:
+        description: value
+        type: integer
+      valueType:
+        description: value_type
+        type: string
+      valueUnit:
+        description: value_unit
+        type: string
+  CdpApplicationDataGraphFieldInputRepresentation:
+    description: ADG Field input representation
+    type: object
+    properties:
+      isKeyColumn:
+        description: is column a key
+        type: boolean
+      sourceFieldName:
+        description: source field name
+        type: string
+  CdpApplicationDataGraphFieldOutputRepresentation:
+    description: Represents Cdp Application Data Graph Field Output
+    type: object
+    properties:
+      isKeyColumn:
+        description: isKeyColumn
+        type: boolean
+      sourceFieldName:
+        description: source_field_developer_name
+        type: string
+  CdpApplicationDataGraphInputRepresentation:
+    description: Input representation for creating CDP ADG
+    type: object
+    properties:
+      dataspaceName:
+        description: dataspaceName
+        type: string
+        required: false
+      description:
+        description: description
+        type: string
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      primaryObjectName:
+        description: Primary Object Name
+        type: string
+      primaryObjectType:
+        description: primary object type
+        type: string
+      sourceObject:
+        description: source object
+        type: any
+  CdpApplicationDataGraphSourceObjectOutputRepresentation:
+    description: Represents Cdp Application Data Graph Source Output
+    type: object
+    properties:
+      fields:
+        description: fields
+        type: array
+        items:
+          type: CdpApplicationDataGraphFieldOutputRepresentation
+      path:
+        description: path
+        type: array
+        items:
+          type: CdpApplicationDataGraphPathToParentOutputRepresentation
+        required: false
+      recencyCriteria:
+        description: recencyCriteria
+        type: CdpApplicationDataGraphRecencyCriteriaOutputRepresentation
+        required: false
+      relatedObjects:
+        description: relatedObjects
+        type: array
+        items:
+          type: any #Add any to remove circular dependency
+      type:
+        description: type
+        type: string
+        enum:
+          - Cio
+          - Dmo
+  CdpApplicationDataGraphOutputRepresentation:
+    description: Represents Cdp Application Data Graph Output
+    type: CdpObjectBaseOutputRepresentation
+    properties:
+      extendedProperties:
+        description: extended properties
+        type: string
+      idDmoName:
+        description: id_dmo_name
+        type: string
+      primaryObjectName:
+        description: primary object developer name
+        type: string
+      primaryObjectType:
+        description: primary object type
+        type: string
+        enum:
+          - Cio
+          - Dmo
+      sourceObject:
+        description: object
+        type: CdpApplicationDataGraphSourceObjectOutputRepresentation
+      status:
+        description: status
+        type: string
+      valuesDmoName:
+        description: values dmo name
+        type: string
+      version:
+        description: version
+        type: string
+  CdpApplicationDataGraphPathToParentInputRepresentation:
+    description: ADG Source Object Path input representation
+    type: object
+    properties:
+      fieldName:
+        description: field_name
+        type: string
+      parentFieldName:
+        description: parent_field_name
+        type: string
+  CdpApplicationDataGraphPathToParentOutputRepresentation:
+    description: Represents Cdp Application Data Graph Path to Parent Output
+    type: object
+    properties:
+      fieldName:
+        description: field name
+        type: string
+      parentFieldName:
+        description: parent_field_name
+        type: string
+  CdpApplicationDataGraphRecencyCriteriaOutputRepresentation:
+    description: Represents Cdp Application Data Graph Recency Output
+    type: object
+    properties:
+      fieldName:
+        description: field_name
+        type: string
+      value:
+        description: value
+        type: integer
+      valueType:
+        description: value_type
+        type: string
+      valueUnit:
+        description: value_unit
+        type: string
+  CdpApplicationDataGraphSourceInputRepresentation:
+    description: ADG Source Object input representation
+    type: CdpObjectBaseInputRepresentation
+    properties:
+      fields:
+        description: fields
+        type: array
+        items:
+          type: CdpApplicationDataGraphFieldInputRepresentation
+      path:
+        description: path
+        type: array
+        items:
+          type: CdpApplicationDataGraphPathToParentInputRepresentation
+      recencyCriteria:
+        description: recencyCriteria
+        type: any
+      relatedObjects:
+        description: relatedObjects
+        type: array
+        items:
+          type: any
+      type:
+        description: type
+        type: string
+        enum:
+          - Cio
+          - Dmo
+  CdpDataGraphRetryInputRepresentation:
+    description: Input representation for retry running error state CDP Data Graph
+    type: object
+    properties:
+      dataGraphName:
+        description: data_graph_name
+        type: string
+  CdpDataGraphRetryOutputRepresentation:
+    description: Represents Cdp Data Graph Retry Output
+    type: object
+    properties:
+      dataGraphName:
+        description: data_graph_name
+        type: string
+      lastRunStatus:
+        description: last run status
+        type: string
+      status:
+        description: status
+        type: string
+/ssot:
+  /application-data-graphs:
+    post:
+      displayName: postCdpApplicationDataGraph
+      description: Creates ADG
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpApplicationDataGraphOutputRepresentation
+      body:
+        application/json:
+          type: CdpApplicationDataGraphInputRepresentation
+          (oas-body-name): input
+  /application-data-graphs/{adgName}:
+    get:
+      displayName: getCdpApplicationDataGraph
+      description: Query ADG
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpApplicationDataGraphOutputRepresentation
+    delete:
+      displayName: deleteCdpApplicationDataGraph
+      description: Delete ADG
+      responses:
+        '200':
+          description: Success
+    uriParameters:
+      adgName:
+        type: string
+        required: true
+  /application-data-graphs/retry:
+    put:
+      displayName: putCdpDataGraphRetry
+      description: retry for failed or error state data graph
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDataGraphRetryOutputRepresentation
+      body:
+        application/json:
+          type: CdpDataGraphRetryInputRepresentation
+          (oas-body-name): input

package/src/raml/luvio.raml

@@ -0,0 +1,49 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'CDP'
+(luvio.ttl): 3000000
+
+types:
+  CdpObjectBaseOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      name: name
+  CdpApplicationDataGraphOutputRepresentation:
+    (luvio.opaque): true
+  CdpApplicationDataGraphSourceObjectOutputRepresentation:
+    (luvio.opaque): true
+  CdpApplicationDataGraphInputRepresentation:
+    (luvio.opaque): true
+  CdpApplicationDataGraphFieldOutputRepresentation:
+    (luvio.opaque): true
+  CdpApplicationDataGraphSourceInputRepresentation:
+    (luvio.opaque): true
+  CdpDataGraphRetryOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.key):
+      name: dataGraphName
+
+/ssot:
+  /application-data-graphs:
+    post:
+      (luvio.adapter):
+        name: createAdg
+  /application-data-graphs/{adgName}:
+    get:
+      (luvio.adapter):
+        name: getAdg
+      (luvio.key):
+        name: urlParams.adgName
+    delete:
+      (luvio.adapter):
+        name: deleteAdg
+      (luvio.key):
+        name: urlParams.adgName
+  /application-data-graphs/retry:
+    put:
+      (luvio.adapter):
+        name: retryDataGraph