@salesforce/lds-adapters-commerce-configuration 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,152 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  CommerceConfigurationAttributeInputRepresentation:
+    description: Input representation of a commerce configuration attribute.
+    type: object
+    properties:
+      booleanValue:
+        description: The boolean value of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: boolean
+      integerValue:
+        description: The integer value of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: integer
+      numberValue:
+        description: The number value of the commerce configuration attribute.
+        # format: double # hand-rolled
+        required: false # hand-rolled
+        type: number
+      stringValue:
+        description: The string value of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: string
+      stringValues:
+        description: The list of string values of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: array
+        items:
+          type: string
+  CommerceConfigurationAttributeOutputRepresentation:
+    description: Output representation of a configuration attribute.
+    type: object
+    properties:
+      booleanValue:
+        description: The boolean value of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: boolean | nil
+      contextId:
+        description: The id of the context in scope of the context type.
+        type: string
+      contextType:
+        description: The type of context the configuration attribute applies for.
+        type: string
+        enum:
+          - CommerceChannel
+          - ExperienceNetwork
+          - Organization
+          - WebStore
+      id:
+        description: The id of the commerce configuration attribute.
+        type: string
+      integerValue:
+        description: The integer value of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: integer | nil
+      numberValue:
+        description: The number value of the commerce configuration attribute.
+        # format: double # hand-rolled removed, causes errors with union type
+        required: false # hand-rolled
+        type: number | nil
+      stringValue:
+        description: The string value of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: string | nil
+      stringValues:
+        description: The list of string values of the commerce configuration attribute.
+        required: false # hand-rolled
+        type: array
+        items:
+          type: string
+/commerce/configuration/{attributeId}/{contextType}/{contextId}:
+  delete:
+    displayName: deleteCommerceConfigurationAttribute
+    description: Removes the value of the commerce configuration attribute within
+      the given context. Be aware that values might still exist for other contexts.
+    responses:
+      '200':
+        description: Success
+  get:
+    displayName: getCommerceConfigurationAttribute
+    description: Read the value of the commerce configuration attribute for the given
+      context.  Optionally the context fallback chain is followed, if so it will start
+      with the provided context and stop once a value is found or the fallback chain
+      has  been followed to its end.         The fallback chain is reflected by the
+      eligible values as per ConfigurationContextType in order of appearance (top-down
+      / left-to-right).
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: CommerceConfigurationAttributeOutputRepresentation
+    queryParameters:
+      fallback:
+        type: boolean
+        required: false
+        default: false
+  put:
+    displayName: putCommerceConfigurationAttribute
+    description: Create (if not existing yet) or replace (if already existing) the
+      value of the commerce configuration attribute within the given context.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: CommerceConfigurationAttributeOutputRepresentation
+    body:
+      application/json:
+        type: CommerceConfigurationAttributeInputRepresentation
+        # required: false
+        (oas-body-name): commerceConfigurationAttributeInputRepresentation
+  uriParameters:
+    attributeId:
+      type: string
+      required: true
+    contextId:
+      type: string
+      required: true
+    contextType:
+      type: string
+      required: true
+      enum:
+        - CommerceChannel
+        - ExperienceNetwork
+        - Organization
+        - WebStore

package/src/raml/luvio.raml

@@ -0,0 +1,36 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'commerce-configuration'
+
+(luvio.ttl): 1000
+
+types:
+  CommerceConfigurationAttributeOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: id
+      contextId: contextId
+      contextType: contextType
+
+/commerce/configuration/{attributeId}/{contextType}/{contextId}:
+  delete:
+    (luvio.adapter):
+      name: deleteCommerceConfigurationAttribute
+    (luvio.key):
+      id: urlParams.attributeId
+      contextId: urlParams.contextId
+      contextType: urlParams.contextType
+  get:
+    (luvio.adapter):
+      name: getCommerceConfigurationAttribute
+    (luvio.key):
+      id: urlParams.attributeId
+      contextId: urlParams.contextId
+      contextType: urlParams.contextType
+  put:
+    (luvio.adapter):
+      name: putCommerceConfigurationAttribute