@salesforce/lds-adapters-industries-context 1.186.0 → 1.194.0

package/src/raml/api.raml

@@ -173,8 +173,12 @@ types:
       attributes:
         description: List of Attributes
         type: array
+        required: false
         items:
           type: ContextAttributeRepresentation
+      contextAttributeListId:
+        description: Unique Id - Required for LDS
+        type: string
       contextNodeId:
         description: Id of ContextNode
         type: string
@@ -215,6 +219,57 @@ types:
         description: Id of (Parent) ContextNodeMapping
         type: string
         required: false # TODO Hand-rolled W-12486791
+  ContextAttributeMappingsInputRepresentation:
+    description: Input/Update representation of Context Attribute Mapping
+    type: object
+    properties:
+      contextAttributeId:
+        description: Reference to ContextAttribute
+        type: string
+      contextAttributeMappingId:
+        description: ID of this Attribute Mapping - Required for Update
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      contextInputAttributeName:
+        description: Context Input Attribute Name
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      deleteExistingHydrationDetail:
+        description: flag to specify deletion of existing hydration detail
+        type: boolean
+        required: false # TODO Hand-rolled W-12486791
+      hydrationDetails:
+        description: List of ContextAttributeHydrationDetail
+        type: array
+        required: false # TODO Hand-rolled W-12486791
+        items:
+          type: object
+  ContextAttributeMappingListInputRepresentation:
+    description: Input/Update representation of Context Attribute Mapping List
+    type: object
+    properties:
+      contextAttributeMappings:
+        description: List of ContextAttributeMappings
+        type: array
+        items:
+          type: object
+  ContextAttributeMappingListRepresentation:
+    description: Output representation of List of Context Attribute Mappings
+    type: object
+    properties:
+      contextAttributeMappingListId:
+        description: Unique Id - Required for LDS
+        type: string
+      contextAttributeMappings:
+        description: List of ContextNodeMappings
+        type: array
+        required: false
+        items:
+          type: ContextAttributeMappingRepresentation
+      isSuccess:
+        description: Success
+        type: boolean
+        required: false
   ContextAttributeMappingRepresentation:
     description: Output representation of Context Attribute Mapping
     type: object
@@ -341,6 +396,10 @@ types:
         description: Id of (Parent) ContextNode
         type: string
         required: false
+      contextTagId:
+        description: Id of this ContextTag
+        type: string
+        required: false
       isSuccess:
         description: Success
         type: boolean
@@ -349,6 +408,53 @@ types:
         description: Name
         type: string
         required: false
+  ContextAttributesInputRepresentation:
+    description: Input representation of Context Attribute
+    type: object
+    properties:
+      contextAttributeId:
+        description: ID of this Attribute - Required for Update
+        type: string
+      dataType:
+        description: DataType
+        type: string
+      domainSet:
+        description: Comma separated node names referenced by this attribute
+        type: string
+      fieldType:
+        description: Field Type
+        type: string
+      isKey:
+        description: Is Key?
+        type: boolean
+      isValue:
+        description: Is Value?
+        type: boolean
+      name:
+        description: Name
+        type: string
+      tags:
+        description: Context Tags
+        type: array
+        items:
+          type: object
+  # TODO Hand-rolled W-8334626
+  ContextAttributesListInputWrapperRepresentation:
+    description: Wrapper Input representation for ContextAttributesListInputRepresentation
+    type: object
+    properties:
+      contextAttributeListInput:
+        description: Input representation of Context Attribute List
+        type: ContextAttributesListInputRepresentation
+  ContextAttributesListInputRepresentation:
+    description: Input representation of Context Attribute List
+    type: object
+    properties:
+      contextAttributes:
+        description: List of Context Attributes
+        type: array
+        items:
+          type: object
   ContextDataRecordRepresentation:
     description: Output representation of Context Data Record
     type: object
@@ -550,6 +656,9 @@ types:
         type: array
         items:
           type: ContextDefinitionInfoRepresentation
+      contextDefinitionListId:
+        description: Unique Id - Required for LDS
+        type: string
       isSuccess:
         description: Success
         type: boolean
@@ -688,6 +797,50 @@ types:
         description: Is Editable
         type: boolean
         required: false
+  # TODO Hand-rolled W-8334626
+  ContextDefinitionsInputWrapperRepresentation:
+    description: Wrapper Input representation for ContextDefinitionsInputRepresentation
+    type: object
+    properties:
+      contextDefinitionInput:
+        description: Input representation of Context Definitions
+        type: ContextDefinitionsInputRepresentation
+  ContextDefinitionsInputRepresentation:
+    description: Input representation of Context Definition
+    type: object
+    properties:
+      description:
+        description: Short description of ContextDefinition
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      developerName:
+        description: Developer Name
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      endDate:
+        description: End Date
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      isActive:
+        description: Is Active
+        type: boolean
+        required: false # TODO Hand-rolled W-12486791
+      name:
+        description: Name of ContextDefinition
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      payload:
+        description: JSON Payload to create ContextDefinition
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      sourceDefinitionId:
+        description: Id of ContextDefinition to be Cloned
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      startDate:
+        description: Start Date
+        type: string
+        required: false # TODO Hand-rolled W-12486791
   ContextInfoRepresentation:
     description: Output representation of Context Info
     type: object
@@ -763,6 +916,66 @@ types:
       name:
         description: Name of ContextMapping
         type: string
+  ContextMappingsInputRepresentation:
+    description: Input representation of Context Mapping
+    type: object
+    properties:
+      contextMappingId:
+        description: ID of this Context Mapping - Required for Update
+        type: string
+      contextNodeMappings:
+        description: List of ContextNodeMappings
+        type: array
+        items:
+          type: object
+      description:
+        description: Description of ContextMapping
+        type: string
+      generateInputMappings:
+        description: Generate Default Input Mappings.
+        type: boolean
+      generateSObjectMappings:
+        description: Generate Default SObject Mappings.
+        type: boolean
+      isDefault:
+        description: Is Default
+        type: boolean
+      name:
+        description: Name of ContextMapping
+        type: string
+  ContextMappingListInputWrapperRepresentation:
+    description: Wrapper Input representation for ContextMappingListInputRepresentation
+    type: object
+    properties:
+      contextMappingInput:
+        description: Input representation of Context List Mapping
+        type: ContextMappingListInputRepresentation
+  ContextMappingListInputRepresentation:
+    description: Input representation of Context Mapping List
+    type: object
+    properties:
+      contextMappings:
+        description: List of ContextMappings
+        type: array
+        items:
+          type: object
+  ContextMappingListRepresentation:
+    description: Output representation of List of Context Mappings
+    type: object
+    properties:
+      contextMappingListId:
+        description: Unique Id - Required for LDS
+        type: string
+      contextMappings:
+        description: List of ContextMappings
+        type: array
+        required: false
+        items:
+          type: ContextMappingRepresentation
+      isSuccess:
+        description: Success
+        type: boolean
+        required: false
   ContextMappingRepresentation:
     description: Output representation of Context Mapping
     type: object
@@ -858,6 +1071,41 @@ types:
           type: object
         required: false # TODO Hand-rolled W-12486791
   # TODO Hand-rolled W-8334626
+  ContextNodeListInputWrapperRepresentation:
+    description: Wrapper Input representation for ContextNodeMappingInputRepresentation
+    type: object
+    properties:
+      contextNodeInput:
+        description: Input representation of Context Node List
+        type: ContextNodeListInputRepresentation
+  ContextNodeListInputRepresentation:
+    description: Input representation of Context Node List
+    type: object
+    properties:
+      contextNodes:
+        description: List of ContextNodes
+        type: array
+        items:
+          type: object
+        required: false # TODO Hand-rolled W-12486791
+  ContextNodeListRepresentation:
+    description: Output representation of List of Context Nodes
+    type: object
+    properties:
+      contextNodeListId:
+        description: Unique Id - Required for LDS
+        type: string
+      contextNodes:
+        description: List of ContextNodes
+        type: array
+        required: false
+        items:
+          type: ContextNodeRepresentation
+      isSuccess:
+        description: Success
+        type: boolean
+        required: false
+  # TODO Hand-rolled W-8334626
   ContextNodeMappingInputWrapperRepresentation:
     description: Wrapper Input representation for ContextNodeMappingInputRepresentation
     type: object
@@ -883,6 +1131,40 @@ types:
       sObjectName:
         description: SObject Name
         type: string
+  # TODO Hand-rolled W-8334626
+  ContextNodeMappingListInputWrapperRepresentation:
+    description: Wrapper Input representation for ContextNodeMappingListInputRepresentation
+    type: object
+    properties:
+      contextNodeMappingInput:
+        description: Input representation of Context Node Mapping
+        type: ContextNodeMappingListInputRepresentation
+  ContextNodeMappingListInputRepresentation:
+    description: Input representation of Context Node Mapping List
+    type: object
+    properties:
+      contextNodeMappings:
+        description: List of ContextNodeMappings
+        type: array
+        items:
+          type: object
+  ContextNodeMappingListRepresentation:
+    description: Output representation of List of Context Node Mappings
+    type: object
+    properties:
+      contextNodeMappingListId:
+        description: Unique Id - Required for LDS
+        type: string
+      contextNodeMappings:
+        description: List of ContextNodeMappings
+        type: array
+        required: false
+        items:
+          type: ContextNodeMappingRepresentation
+      isSuccess:
+        description: Success
+        type: boolean
+        required: false
   ContextNodeMappingRepresentation:
     description: Output representation of Context Node Mapping
     type: object
@@ -911,6 +1193,24 @@ types:
         description: SObject Name
         type: string
         required: false
+  ContextNodeMappingsInputRepresentation:
+    description: Input representation of Context Node Mapping
+    type: object
+    properties:
+      attributeMappings:
+        description: List of ContextAttributeMappings
+        type: array
+        items:
+          type: object
+      contextNodeId:
+        description: Reference to ContextNode
+        type: string
+      contextNodeMappingId:
+        description: ID of this Context Node Mapping - Required for Update
+        type: string
+      sObjectName:
+        description: SObject Name
+        type: string
   ContextNodeRepresentation:
     description: Output representation of Context Node
     type: object
@@ -1135,6 +1435,59 @@ types:
         type: array
         items:
           type: string
+  ContextTagInputRepresentation:
+    description: Input representation of Context Tag
+    type: object
+    properties:
+      contextAttributeId:
+        description: Id of (Parent) ContextAttribute
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      contextNodeId:
+        description: Id of (Parent) ContextNode
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      contextTagId:
+        description: ID of this Context Tag - Required for Update
+        type: string
+        required: false # TODO Hand-rolled W-12486791
+      name:
+        description: Name
+        type: string
+    # TODO Hand-rolled W-8334626
+  ContextTagListInputWrapperRepresentation:
+    description: Wrapper Input representation for ContextTagListInputRepresentation
+    type: object
+    properties:
+      contextTagInput:
+        description: Input representation of Context Tag
+        type: ContextTagListInputRepresentation
+  ContextTagListInputRepresentation:
+    description: Input representation of Context Tag List
+    type: object
+    properties:
+      contextTags:
+        description: List of ContextTags
+        type: array
+        items:
+          type: object
+  ContextTagListRepresentation:
+    description: Output representation of List of Context Tags
+    type: object
+    properties:
+      contextTagListId:
+        description: Unique Id - Required for LDS
+        type: string
+      contextTags:
+        description: List of ContextTags
+        type: array
+        required: false
+        items:
+          type: ContextAttributeTagRepresentation
+      isSuccess:
+        description: Success
+        type: boolean
+        required: false
   UpdateContextAttributesInputRepresentation:
     description: Input representation for updating ContextAttributes
     type: object
@@ -1224,6 +1577,400 @@ types:
             description: Unique ID to represent a Context
             type: string
             required: true
+  /context-definitions:
+    get:
+      displayName: getContextDefinitions
+      description: Get ContextDefinition List
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextDefinitionListRepresentation
+      queryParameters:
+        includeInactive:
+          type: boolean
+          required: false
+          default: true
+    post:
+      displayName: createContextServiceDefinition
+      description: Create Context Definition
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextDefinitionInfoRepresentation
+      body:
+        application/json:
+          # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+          type: ContextDefinitionsInputWrapperRepresentation
+          # required: false # TODO Hand rolled W-12486791.
+          (oas-body-name): contextDefinitionInput
+    /info/{contextDefinitionId}:
+      get:
+        displayName: getContextServiceDefinitionInfo
+        description: Get Info of a Context Definition
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContextDefinitionInfoRepresentation
+      uriParameters:
+        contextDefinitionId:
+          description: Unique ID to represent a Context Definition
+          type: string
+          required: true
+    /{contextDefinitionId}:
+      delete:
+        displayName: deleteContextServiceDefinition
+        description: Delete a Context Definition
+        responses:
+          '200':
+            description: Success
+      get:
+        displayName: getContextServiceDefinition
+        description: Get a Context Definition
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContextDefinitionRepresentation
+      patch:
+        displayName: updateContextServiceDefinition
+        description: Patch a Context Definition
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContextDefinitionInfoRepresentation
+        body:
+          application/json:
+            # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+            type: ContextDefinitionInputWrapperRepresentation
+            # required: false # TODO Hand rolled W-12486791.
+            (oas-body-name): contextDefinitionInput
+      uriParameters:
+        contextDefinitionId:
+          description: Unique ID to represent a Context Definition
+          type: string
+          required: true
+      /context-mappings:
+        patch:
+          displayName: patchContextMappings
+          description: Patch ContextMappings
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextMappingListRepresentation
+          body:
+            application/json:
+              type: ContextMappingListInputWrapperRepresentation
+              # required: false # TODO Hand rolled W-12486791.
+              (oas-body-name): contextMappingInput
+        post:
+          displayName: postContextMappings
+          description: Create ContextMappings
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextMappingListRepresentation
+          body:
+            application/json:
+              type: ContextMappingListInputWrapperRepresentation
+              # required: false # TODO Hand rolled W-12486791.
+              (oas-body-name): contextMappingInput
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+      /context-mappings/{contextMappingId}:
+        delete:
+          displayName: deleteContextMapping
+          description: Delete a Context Mapping
+          responses:
+            '200':
+              description: Success
+        get:
+          displayName: getContextMapping
+          description: Get a Context Mapping
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextMappingRepresentation
+        patch:
+          displayName: patchContextMapping
+          description: Patch a Context Mapping
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextMappingRepresentation
+          body:
+            application/json:
+              type: ContextMappingInputWrapperRepresentation
+              # required: false # TODO Hand rolled W-12486791.
+              (oas-body-name): contextMappingInput
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+          contextMappingId:
+            description: Unique ID to represent a Context Mapping
+            type: string
+            required: true
+      /context-nodes:
+        patch:
+          displayName: patchContextNodes
+          description: Update Context Nodes
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextNodeListRepresentation
+          body:
+            application/json:
+              # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+              type: ContextNodeListInputWrapperRepresentation
+              # required: false # TODO Hand rolled W-12486791.
+              (oas-body-name): contextNodeInput
+        post:
+          displayName: postContextNodes
+          description: Create Context Nodes
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextNodeListRepresentation
+          body:
+            application/json:
+              # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+              type: ContextNodeListInputWrapperRepresentation
+              # required: false # TODO Hand rolled W-12486791.
+              (oas-body-name): contextNodeInput
+      /context-tags:
+        get:
+          displayName: getContextTags
+          description: Get ContextTags
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextTagListRepresentation
+        patch:
+          displayName: patchContextTags
+          description: Create ContextTags
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextTagListRepresentation
+          body:
+            application/json:
+              type: ContextTagListInputWrapperRepresentation
+              # required: false # TODO Hand rolled W-12486791.
+              (oas-body-name): contextTagInput
+        post:
+          displayName: postContextTags
+          description: Create ContextTags
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextTagListRepresentation
+          body:
+            application/json:
+              type: ContextTagListInputWrapperRepresentation
+              # required: false # TODO Hand rolled W-12486791.
+              (oas-body-name): contextTagInput
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+      /context-nodes/{contextNodeId}:
+        delete:
+          displayName: deleteContextServiceNode
+          description: Delete a Context Node
+          responses:
+            '200':
+              description: Success
+        get:
+          displayName: getContextServiceNode
+          description: Get a Context Node
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextNodeRepresentation
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+          contextNodeId:
+            description: Unique ID to represent a Context Node
+            type: string
+            required: true
+      /context-tags/{contextTagId}:
+        delete:
+          displayName: deleteContextTag
+          description: Delete a Context Tag
+          responses:
+            '200':
+              description: Success
+        get:
+          displayName: getContextTag
+          description: Get a Context Tag
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContextAttributeTagRepresentation
+        uriParameters:
+          contextDefinitionId:
+            description: Unique ID to represent a Context Definition
+            type: string
+            required: true
+          contextTagId:
+            description: Unique ID to represent a Context Tag
+            type: string
+            required: true
+  /context-mappings/{contextMappingId}/context-node-mappings:
+    patch:
+      description: Update Context Node Mappings
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextNodeMappingListRepresentation
+      body:
+        application/json:
+          # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+          type: ContextNodeMappingListInputWrapperRepresentation
+          # required: false # TODO Hand rolled W-12486791.
+          (oas-body-name): contextNodeMappingInput
+    post:
+      description: Create Context Node Mappings
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextNodeMappingListRepresentation
+      body:
+        application/json:
+          # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+          type: ContextNodeMappingListInputWrapperRepresentation
+          # required: false # TODO Hand rolled W-12486791.
+          (oas-body-name): contextNodeMappingInput
+    uriParameters:
+      contextMappingId:
+        description: Unique ID to represent a Context Mapping
+        type: string
+        required: true
+  /context-mappings/{contextMappingId}/context-node-mappings/{contextNodeMappingId}:
+    delete:
+      description: Delete a Context Node Mapping
+      responses:
+        '200':
+          description: Success
+    get:
+      description: Get a Context Node Mapping.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextNodeMappingRepresentation
+    uriParameters:
+      contextNodeMappingId:
+        type: string
+        required: true
+      contextMappingId:
+        type: string
+        required: true
+  /context-nodes/{contextNodeId}/context-attributes:
+    patch:
+      displayName: updateContextAttributes
+      description: Update Context Attributes
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextAttributeListRepresentation
+      body:
+        application/json:
+          # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+          type: ContextAttributesListInputWrapperRepresentation
+          # required: false # TODO Hand rolled W-12486791.
+          (oas-body-name): contextAttributeListInput
+    post:
+      displayName: createContextAttributes
+      description: Add Context Attributes
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextAttributeListRepresentation
+      body:
+        application/json:
+          # TODO: Hand rolled 'type' to provide a wrapper that uses the oas-body-name
+          type: ContextAttributesListInputWrapperRepresentation
+          # required: false # TODO Hand rolled W-12486791.
+          (oas-body-name): contextAttributeListInput
+    uriParameters:
+      contextNodeId:
+        description: Unique ID to represent a Context Node
+        type: string
+        required: true
+  /context-nodes/{contextNodeId}/context-attributes/{contextAttributeId}:
+    delete:
+      displayName: deleteContextServiceAttribute
+      description: Delete a Context Attribute
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getContextServiceAttribute
+      description: Get a Context Attribute
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextAttributeRepresentation
+    uriParameters:
+      contextAttributeId:
+        description: Unique ID to represent a Context Attribute
+        type: string
+        required: true
+      contextNodeId:
+        description: Unique ID to represent a Context Node
+        type: string
+        required: true
   /contextdefinition:
     get:
       description: Get Context Definition List