@salesforce/lds-adapters-marketing-cdp 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,808 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.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:
+  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
+  CdpDataGraphDataRecencyInputRepresentation:
+    description: Data Graph 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
+  CdpDataGraphFieldInputRepresentation:
+    description: Data Graph Field input representation
+    type: object
+    properties:
+      ciFieldType:
+        description: ci field type
+        type: string
+        required: false
+      dataType:
+        description: Field Data Type
+        type: string
+        required: false
+      devName:
+        description: developer name
+        type: string
+        required: false
+      isDGRootKeyField:
+        description: Is DG Root Key Field
+        type: boolean
+        required: false
+      isKeyColumn:
+        description: is column a key
+        type: boolean
+      isProjected:
+        description: is projected field
+        type: boolean
+        required: false
+      keyQualifierName:
+        description: key qualifier name
+        type: string
+        required: false
+      sourceFieldName:
+        description: source field name
+        type: string
+      usageTag:
+        description: usage tag
+        type: string
+        required: false
+  CdpDataGraphFieldOutputRepresentation:
+    description: Represents Cdp Data Graph Field Output
+    type: object
+    properties:
+      ciFieldType:
+        description: ci_field_type
+        type: string
+        required: false
+      dataType:
+        description: Field Data Type
+        type: string
+        required: false
+      isDGRootKeyField:
+        description: Is DG Root Key Field
+        type: boolean
+        required: false
+      isKeyColumn:
+        description: isKeyColumn
+        type: boolean
+      isProjected:
+        description: is_projected
+        type: boolean
+        required: false
+      keyQualifierName:
+        description: key_qualifier_name
+        type: string
+        required: false
+      sourceFieldName:
+        description: source_field_developer_name
+        type: string
+      usageTag:
+        description: usage_tag
+        type: string
+        required: false
+      dependency:
+        description: dependency
+        type: array
+        items:
+          type: DependencyOutputRepresentation
+        required: false
+      devName:
+        description: dev_name
+        type: string
+        required: false
+      ciFormula:
+        description: ciFormula
+        type: string
+        required: false
+      sourceFieldLabel:
+        description: source_field_Label
+        type: string
+        required: false
+  CdpDataGraphInputRepresentation:
+    description: Input representation for creating CDP Data Graph
+    type: object
+    properties:
+      dataspaceName:
+        description: dataspaceName
+        type: string
+        required: false
+      dataKitName:
+        description: dataKitName
+        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
+      sourceObject:
+        description: source object
+        type: any
+      templateName:
+        description: data graph templateName
+        type: string
+        required: false
+      type:
+        description: data graph type
+        type: string
+        required: false
+      isRecordCachingDisabled:
+        description: Is prefetch is disabled for given data graph
+        type: boolean
+        required: false
+      isRealTimeToggleEnabled:
+        description: Is RTDG Toggle enaled for Non-Web SDK Ingestion for given data graph
+        type: boolean
+        required: false
+      cacheDurationInDays:
+        description: No of days last accessed records are cached
+        type: integer
+        required: false
+      maxRecordsCached:
+        description: Max no of records to cache
+        type: integer
+        required: false
+      sessionEnd:
+        description: Session duration
+        type: integer
+        required: false
+      sessionEndTimeUnit:
+        description: Unit of Session duration
+        type: string
+        required: false
+      fullRefreshConfig:
+        description: Full Refresh Config
+        type: DataGraphFullRefreshConfigInputRepresentation
+        required: false
+      incrementalRefreshConfig:
+        description: Incremental transform mapping developer name
+        type: DataGraphIncrementalRefreshConfigInputRepresentation
+        required: false
+  CdpDataGraphSourceObjectOutputRepresentation:
+    description: Represents Cdp Data Graph Source Output
+    type: object
+    properties:
+      fields:
+        description: fields
+        type: array
+        items:
+          type: CdpDataGraphFieldOutputRepresentation
+      fragmentDMOName:
+        description: fragmentDMOName
+        type: string
+        required: false
+      jsonPath:
+        description: jsonPath
+        type: string
+        required: false
+      path:
+        description: path
+        type: array
+        items:
+          type: CdpDataGraphPathToParentOutputRepresentation
+        required: false
+      filterCriteria:
+        description: filterCriteria
+        type: CdpDataGraphFilterCriteriaOutputRepresentation
+        required: false
+      recencyCriteria:
+        description: recencyCriteria
+        type: array
+        items:
+          type: CdpDataGraphRecencyCriteriaOutputRepresentation
+        required: false
+      relatedObjects:
+        description: relatedObjects
+        type: array
+        items:
+          type: any #Add any to remove circular dependency
+      dependency:
+        description: dependency
+        type: array
+        items:
+          type: DependencyOutputRepresentation
+        required: false
+      devName:
+        description: devName
+        type: string
+        required: false
+      fragmentDMOLabel:
+        description: fragmentDMOLabel
+        type: string
+        required: false
+      referenceDeveloperName:
+        description: referenceDeveloperName
+        type: string
+        required: false
+      relatedSegments:
+        description: relatedSegments
+        type: array
+        items:
+          type: CdpDataGraphRelatedSegmentOutputRepresentation
+        required: false
+      type:
+        description: type
+        type: string
+        required: false
+  CdpDataGraphOutputRepresentation:
+    description: Represents Cdp Data Graph Output
+    type: CdpObjectBaseOutputRepresentation
+    properties:
+      dayZeroMappingDevName:
+        description: Day0 dependency mapping developer name
+        type: string
+        required: false
+      dayZeroTransformDevName:
+        description: Day0 transform developer name
+        type: string
+        required: false
+      extendedProperties:
+        description: extended properties
+        type: string
+      idDmoLabel:
+        description: id_dmo_Label
+        type: string
+        required: false
+      idDmoName:
+        description: id_dmo_name
+        type: string
+        required: false
+      incrementalMappingDevName:
+        description: incremental transform developer name
+        type: string
+        required: false
+      incrementalTransformDevName:
+        description: incremental dependency mapping developer name
+        type: string
+        required: false
+      lastRunStatus:
+        description: last run status
+        type: string
+        required: false
+      primaryObjectLabel:
+        description: primary object Label
+        type: string
+        required: false
+      primaryObjectName:
+        description: primary object developer name
+        type: string
+      sourceObject:
+        description: object
+        type: CdpDataGraphSourceObjectOutputRepresentation
+      status:
+        description: status
+        type: string
+      valuesDmoLabel:
+        description: values dmo Label
+        type: string
+        required: false
+      valuesDmoName:
+        description: values dmo name
+        type: string
+      version:
+        description: version
+        type: string
+      type:
+        description: Data Graph Type
+        type: string
+        required: false
+      isRecordCachingDisabled:
+        description: Is prefetch is disabled for given data graph
+        type: boolean
+        required: false
+      isRealTimeToggleEnabled:
+        description: Is RTDG Toggle enaled for Non-Web SDK Ingestion for given data graph
+        type: boolean
+        required: false
+      cacheDurationInDays:
+        description: No of days last accessed records are cached
+        type: integer
+        required: false
+      maxRecordsCached:
+        description: Max no of records to cache
+        type: integer
+        required: false
+      sessionEnd:
+        description: Session duration
+        type: integer
+        required: false
+      sessionEndTimeUnit:
+        description: Unit of Session duration
+        type: string
+        required: false
+      fullRefreshConfig:
+        description: full refresh config
+        type: DataGraphFullRefreshConfigOutputRepresentation
+        required: false
+      incrementalRefreshConfig:
+        description: incremental refresh config
+        type: DataGraphIncrementalRefreshConfigOutputRepresentation
+        required: false
+  CdpDataGraphPathToParentInputRepresentation:
+    description: Data Graph Source Object Path input representation
+    type: object
+    properties:
+      fieldName:
+        description: field_name
+        type: string
+      parentFieldName:
+        description: parent_field_name
+        type: string
+  CdpDataGraphPathToParentOutputRepresentation:
+    description: Represents Cdp Data Graph Path to Parent Output
+    type: object
+    properties:
+      fieldName:
+        description: field name
+        type: string
+      parentFieldName:
+        description: parent_field_name
+        type: string
+  CdpDataGraphRecencyCriteriaOutputRepresentation:
+    description: Represents Cdp 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
+  CdpDataGraphSourceInputRepresentation:
+    description: Data Graph Source Object input representation
+    type: CdpObjectBaseInputRepresentation
+    properties:
+      fields:
+        description: fields
+        type: array
+        items:
+          type: CdpDataGraphFieldInputRepresentation
+      jsonPath:
+        description: jsonPath
+        type: string
+        required: false
+      path:
+        description: path
+        type: array
+        items:
+          type: CdpDataGraphPathToParentInputRepresentation
+      filterCriteria:
+        description: filter Criteria
+        type: CdpDataGraphFilterCriteriaInputRepresentation
+        required: false
+      recencyCriteria:
+        description: recencyCriteria
+        type: array
+        items:
+          type: object
+      relatedObjects:
+        description: relatedObjects
+        type: array
+        items:
+          type: any
+  CdpDataGraphRelatedSegmentOutputRepresentation:
+    description: Represents Data Graph Related Segment
+    type: object
+    properties:
+      id:
+        description: id
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+      label:
+        description: label
+        type: string
+  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
+  DependencyOutputRepresentation:
+    description: Represents Dependency Output
+    type: object
+    properties:
+      developerName:
+        description: developerName
+        type: string
+      displayName:
+        description: displayName
+        type: string
+      entityType:
+        description: entityType
+        type: string
+      entityTypePluralLabel:
+        description: entityTypePluralLabel
+        type: string
+      id:
+        description: id
+        type: string
+      linkable:
+        description: linkable
+        type: boolean
+  CdpDataGraphDependencyOutputRepresentation:
+    description: Represents Cdp Data Graph Dependency Output
+    type: CdpObjectBaseOutputRepresentation
+    properties:
+      dependency:
+        description: dependency
+        type: array
+        items:
+          type: DependencyOutputRepresentation
+  CdpDataGraphDraftOutputRepresentation:
+    description: Represents Cdp Data Graph Draft Output
+    type: object
+    properties:
+      outputRepresentation:
+        description: Output Representation of Draft Data Graph
+        type: CdpDataGraphOutputRepresentation
+  CdpDataGraphDraftInputRepresentation:
+    description: Input representation for draft in CDP Data Graph
+    type: object
+    properties:
+      dataGraphName:
+        description: data_graph_name
+        type: string
+      jsonSchema:
+        description: save data graph draft json schema
+        type: string
+  DataGraphFullRefreshConfigInputRepresentation:
+    description: Data Graph Full Refresh Config input representation
+    type: object
+    properties:
+      schedule:
+        description: schedule
+        type: object
+        required: false
+  DataGraphScheduleInputRepresentation:
+    description: Data Graph Schedule input representation
+    type: object
+    properties:
+      frequency:
+        description: frequency
+        type: integer
+        required: false
+      timeGranularity:
+        description: time granularity
+        type: string
+        required: false
+  DataGraphIncrementalRefreshConfigInputRepresentation:
+    description: Data Graph Incremental Refresh input representation
+    type: object
+    properties:
+      enabled:
+        description: enabled
+        type: boolean
+        required: false
+  DataGraphIncrementalRefreshConfigOutputRepresentation:
+    description: Represents Cdp Data Graph Full Refresh Config Output
+    type: object
+    properties:
+      enabled:
+        description: enabled
+        type: boolean
+        required: false
+  DataGraphFullRefreshConfigOutputRepresentation:
+    description: Represents Cdp Data Graph Full Refresh Config Output Output
+    type: object
+    properties:
+      schedule:
+        description: schedule
+        type: DataGraphScheduleOutputRepresentation
+        required: false
+  DataGraphScheduleOutputRepresentation:
+    description: Represents Data Graph Full refresh Schedule
+    type: object
+    properties:
+      frequency:
+        description: frequency
+        type: integer
+        required: false
+      timeGranularity:
+        description: time Granularity
+        type: string
+        required: false
+  CdpDataGraphFilterConditionInputRepresentation:
+    description: Data Graph Filter Condition input representation
+    type: object
+    properties:
+      fieldName:
+        description: field Name
+        type: string
+      operator:
+        description: comparison operators for Data Graph filter conditions
+        type: string
+      values:
+        description: adhoc filter values
+        type: array
+        items:
+          type: string
+        required: false
+  CdpDataGraphFilterConditionOutputRepresentation:
+    description: Represents Cdp Data Graph Filter Condition Output
+    type: object
+    properties:
+      fieldName:
+        description: field API name
+        type: string
+      operator:
+        description: comparison operators for Data Graph filter conditions
+        type: string
+      values:
+        description: Adhoc filter values
+        type: array
+        items:
+          type: string
+        required: false
+  CdpDataGraphFilterCriteriaInputRepresentation:
+    description: Data Graph Filter Criteria input representation
+    type: object
+    properties:
+      conditions:
+        description: filter conditions
+        type: array
+        items:
+          type: CdpDataGraphFilterConditionInputRepresentation
+      operator:
+        description: Filter operators to combine conditions. Example, 'And, 'Or'
+        type: string
+  CdpDataGraphFilterCriteriaOutputRepresentation:
+    description: Represents Cdp Data Graph Filter Criteria Output
+    type: object
+    properties:
+      conditions:
+        description: filter conditions
+        type: array
+        items:
+          type: CdpDataGraphFilterConditionOutputRepresentation
+      operator:
+        description: Filter operators to combine conditions. Example, 'And, 'Or'
+        type: string
+
+/ssot:
+  /data-graphs:
+    post:
+      displayName: postCdpDataGraph
+      description: Creates Data Graph
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDataGraphOutputRepresentation
+      body:
+        application/json:
+          type: CdpDataGraphInputRepresentation
+          (oas-body-name): input
+    put:
+      displayName: putCdpDataGraph
+      description: Edit Data Graph
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDataGraphOutputRepresentation
+      queryParameters:
+        editScheduleOnly:
+          type: boolean
+          required: false
+      body:
+        application/json:
+          type: CdpDataGraphInputRepresentation
+          (oas-body-name): input
+  /data-graphs/{dataGraphName}:
+    get:
+      displayName: getCdpDataGraph
+      description: Query Data Graph
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDataGraphOutputRepresentation
+      queryParameters:
+        includeCIDetails:
+          type: boolean
+          required: false
+        includeSegmentDetails:
+          type: boolean
+          required: false
+    delete:
+      displayName: deleteCdpDataGraph
+      description: Delete Data Graph
+      responses:
+        '200':
+          description: Success
+    uriParameters:
+      dataGraphName:
+        type: string
+        required: true
+  /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
+  /data-graphs/dependency/{dataGraphName}:
+    get:
+      displayName: getCdpDataGraphDependency
+      description: Query Dependency list for Data Graph
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDataGraphDependencyOutputRepresentation
+    uriParameters:
+      dataGraphName:
+        type: string
+        required: true
+  /data-graphs/draft:
+    post:
+      displayName: postCdpDataGraphDraft
+      description: Save Data Graph Draft
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDataGraphDraftOutputRepresentation
+      body:
+        application/json:
+          type: CdpDataGraphDraftInputRepresentation
+          (oas-body-name): input
+  /data-graphs/draft/{dataGraphName}:
+    get:
+      displayName: getCdpDataGraphDraft
+      description: Query Data Graph Draft
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CdpDataGraphDraftOutputRepresentation
+    uriParameters:
+      dataGraphName:
+        type: string
+        required: true