@salesforce/lds-adapters-revenue-place-order 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,138 @@
+#%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:
+  PlaceOrderInputWrapperRepresentation: # TODO hand rolled. W-8334626
+    description: Wrapper for place order input representation
+    type: object
+    properties:
+      inputRequest:
+        type: PlaceOrderInputRepresentation
+        description: Place Order Input Representation
+  PlaceOrderInputRepresentation:
+    description: Place Order API input representation
+    type: object
+    properties:
+      graph:
+        description: The sobject graph representing the order payload to be ingested.
+        type: object
+      pricingPref:
+        description: Pricing Preference for this place order process.
+        type: string
+        enum:
+          - Force
+          - Skip
+          - System
+      configurationInput:
+        description: Configuration input to control the call to config API
+        type: string
+        enum:
+          - Skip
+          - RunAndAllowErrors
+          - RunAndBlockErrors
+        required: false # TODO hand rolled. W-9275477
+      configurationOptions:
+        description: Configuration options to specify which config API functionality to opt in/out of
+        type: ConfiguratorOptionsInputRepresentation
+        required: false # TODO hand rolled. W-9275477
+      catalogRatesPref:
+        description: Catalog Rates Preference for this place order process.
+        type: string
+        enum:
+          - Fetch
+          - Skip
+        required: false # TODO hand rolled. W-9275477
+  PlaceOrderErrorResponseRepresentation:
+    description: Place Order Error response representation
+    type: object
+    properties:
+      errorCode:
+        description: Error Code
+        type: string
+      message:
+        description: Message stating the reason for error, if any
+        type: string
+      referenceId:
+        description: Reference ID
+        type: string
+  PlaceOrderOutputRepresentation:
+    description: Place Order API output representation
+    type: object
+    properties:
+      errors:
+        description: List of errors encountered during the synchronous processing.
+        type: array
+        items:
+          type: PlaceOrderErrorResponseRepresentation
+      orderId:
+        description: Order Id
+        type: string
+      requestId:
+        description: The request id of the process that can be used to query async
+          status.
+        type: string
+        required: false # TODO hand rolled. W-9275477
+      statusURL:
+        description: The async status URL, if available
+        type: string
+        required: false # TODO hand rolled. W-9275477
+      success:
+        description: Whether or not the synchronous part of the processing is successful
+        type: boolean
+  ConfiguratorOptionsInputRepresentation:
+    description: Input Representation for the Configurator Options
+    type: object
+    properties:
+      addDefaultConfiguration:
+        description: Whether to add default configurations
+        type: boolean
+        required: false # TODO hand rolled. W-9275477
+      executeConfigurationRules:
+        description: Whether to execute Configuration Rules
+        type: boolean
+        required: false # TODO hand rolled. W-9275477
+      validateAmendRenewCancel:
+        description: Whether to run amend/renew/cancel related validations
+        type: boolean
+        required: false # TODO hand rolled. W-9275477
+      validateProductCatalog:
+        description: Whether to run validations against the Product Catalog
+        type: boolean
+        required: false # TODO hand rolled. W-9275477
+/commerce/sales-orders/actions/place:
+  post:
+    displayName: postPlaceOrder
+    description: Place an Order
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: PlaceOrderOutputRepresentation
+    body:
+      application/json:
+        type: PlaceOrderInputWrapperRepresentation
+        (oas-body-name): inputRequest

package/src/raml/luvio.raml

@@ -0,0 +1,102 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: 'luvio://annotations.raml'
+
+(luvio.keyPrefix): 'place-order'
+
+types:
+  PlaceOrderOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      orderId: orderId
+
+/commerce/sales-orders/actions/place:
+  post:
+    (luvio.adapter):
+      name: placeOrder
+      tests:
+        validConfigs:
+          - |
+            {
+              "inputRequest":
+              {
+                "pricingPref": "Force",
+                "catalogRatesPref": "Fetch",
+                "configurationInput": "RunAndAllowErrors",
+                "configuratorOptions":
+                {
+                  "addDefaultConfiguration": true,
+                  "executeConfigurationRules": true,
+                  "validateAmendRenewCancel": true,
+                  "validateProductCatalog": true
+                },
+                "graph": 
+                {
+                  "graphId": "placeOrder",
+                  "records": 
+                  [
+                    {
+                      "referenceId": "refOrder",
+                      "record": 
+                      {
+                        "attributes": 
+                        {
+                          "type": "Order",
+                          "method": "PATCH",
+                          "id": "8011Q00000NvSX6QAN"
+                        },
+                        "Description": "Update Order description"
+                      }
+                    },
+                    {
+                      "referenceId": "refOrderItem",
+                      "record": 
+                      {
+                        "attributes": 
+                        {
+                          "type": "OrderItem",
+                          "method": "PATCH",
+                          "id": "8021Q00000d82aEQAQ"
+                        },
+                        "Quantity": 5.0
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+
+        invalidConfigs:
+          - |
+            {
+              "pricingPref": "Skip"
+            }
+          - |
+            {
+              "catalogRatesPref": "skip"
+            }
+          - |
+            {
+              "configurationInput": "Skip"
+            }
+          - |
+            {
+              "graph": {}
+            }
+          - |
+            { 
+              "inputRequest":
+              {
+                "graph": {}
+              }
+            }
+          - |
+            { 
+              "inputRequest":
+              {
+                "pricingPref": "force"
+              }
+            }