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

package/src/raml/api.raml

@@ -0,0 +1,135 @@
+#%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:
+  PlaceQuoteInputWrapperRepresentation: # TODO Hand-rolled W-8334626
+    description: Wrapper for place quote input representation
+    type: object
+    properties:
+      PlaceQuoteInput:
+        type: PlaceQuoteInputRepresentation
+        description: Place Quote Input Representation
+  PlaceQuoteInputRepresentation:
+    description: Input representation for place quote.
+    type: object
+    properties:
+      graph:
+        description: SObject Graph representing the quote structure for place quote
+        type: object
+      pricingPref:
+        description: Pricing Preference for place quote
+        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 place quote
+        type: string
+        enum:
+          - Fetch
+          - Skip
+        required: false # TODO hand rolled. W-9275477
+  PlaceQuoteOutputRepresentation:
+    description: Place Quote output representation
+    type: object
+    properties:
+      quoteId:
+        description: QUOTE ID
+        type: string
+      requestIdentifier:
+        description: Unique request identifier that can be used to poll async request
+        type: string
+      responseError:
+        description: response error
+        type: array
+        items:
+          type: PlaceQuoteErrorResponseRepresentation
+      statusURL:
+        description: a StatusURL for tracking this operation
+        type: string
+      success:
+        description: success
+        type: boolean
+  PlaceQuoteErrorResponseRepresentation:
+    description: Error response representation
+    type: object
+    properties:
+      errorCode:
+        description: Code for Error
+        type: string
+      referenceId:
+        description: The Id of where the error lies
+        type: string
+      message:
+        description: Message stating the reason for error, if any
+        type: string
+  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/quotes/actions/place:
+  post:
+    description: place quote
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: PlaceQuoteOutputRepresentation
+    body:
+      application/json:
+        type: PlaceQuoteInputWrapperRepresentation
+        #required: false # TODO handrolled W-9314597
+        (oas-body-name): PlaceQuoteInput

package/src/raml/luvio.raml

@@ -0,0 +1,89 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'place-quote'
+
+types:
+  PlaceQuoteOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      quoteId: quoteId
+
+/commerce/quotes/actions/place:
+  post:
+    (luvio.adapter):
+      name: updateQuote
+      tests:
+        validConfigs:
+          - |
+            { "PlaceQuoteInput":
+              {
+                "pricingPref": "Force",
+                "catalogRatesPref": "Fetch",
+                "configurationInput": "RunAndAllowErrors",
+                "configuratorOptions":
+                {
+                  "addDefaultConfiguration": true,
+                  "executeConfigurationRules": true,
+                  "validateAmendRenewCancel": true,
+                  "validateProductCatalog": true
+                },                
+                "graph": {
+                  "graphId": "updateQuote",
+                    "records": [{
+                      "referenceId": "refQuote",
+                      "record": {
+                        "attributes": {
+                          "type": "Quote",
+                          "method": "PATCH",
+                          "id": "0Q0RO00000033pc0AA"
+                        }
+                      }
+                    },
+                    {
+                      "referenceId": "refQLIId",
+                      "record": {
+                        "attributes": {
+                          "type": "QuoteLineItem",
+                          "method": "PATCH",
+                          "id": "0QLT30000000145OAA"
+                        },
+                        "Discount": 2
+                      }
+                    }]
+                }
+              }
+            }
+        invalidConfigs:
+          - |
+            {
+              "pricingPref": "Skip"
+            }
+          - |
+            {
+              "catalogRatesPref": "skip"
+            }
+          - |
+            {
+              "configurationInput": "Skip"
+            }
+          - |
+            {
+              "graph": {}
+            }
+          - |
+            { "PlaceQuoteInput":
+              {
+                "graph": {}
+              }
+            }
+          - |
+            { "PlaceQuoteInput":
+              {
+                "pricingPref": "force"
+              }
+            }