@salesforce/lds-adapters-revenue-sales-transaction-contexts 1.303.0

package/src/raml/api.raml

@@ -0,0 +1,251 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v62.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:
+  ContextNodeInputRepresentation:
+    description: Input representation for Context nodes of ramp segments
+    type: object
+    properties:
+      contextNode:
+        description: Input Representation for context node to be added or updated
+        type: object
+        properties:
+          //:
+            type: any
+      contextNodePath:
+        description: Input Representation for context node path
+        type: array
+        items:
+          type: string
+  CreateRampDealInputWrapperRepresentation:
+    description: Input Wrapper Representation for Create ramp deal connect API
+    type: object
+    properties:
+      createRampDealInputParam:
+        type: CreateRampDealInputRepresentation
+  CreateRampDealInputRepresentation:
+    description: Create ramp deal connect API input representation
+    type: object
+    properties:
+      executionSettings:
+        description: Execution Settings like run pricing, run config rules
+        type: object
+      segmentType:
+        description: 'Segment type: FreeTrial/Custom/Annual'
+        type: string
+        enum:
+          - Custom
+          - FreeTrial
+          - Yearly
+      subscriptionTerm:
+        description: Subscription term period
+        type: integer
+      subscriptionTermUnit:
+        description: 'Subscription term unit : Months/Years'
+        type: string
+        enum:
+          - Annual
+          - Days
+          - Months
+      transactionId:
+        description: Transaction Id, quoteId or orderId
+        type: string
+      transactionLineId:
+        description: Transaction Line Id, quoteLineId or orderItemId
+        type: string
+      trialTerm:
+        description: Trial term period
+        type: integer
+      trialTermUnit:
+        description: 'Trial term unit : Days'
+        type: string
+        enum:
+          - Annual
+          - Days
+          - Months
+  DeleteRampDealInputWrapperRepresentation:
+    description: Input Wrapper Representation for Delete ramp deal connect API
+    type: object
+    properties:
+      deleteRampDealInputParam:
+        type: DeleteRampDealInputRepresentation
+  DeleteRampDealInputRepresentation:
+    description: Delete ramp deal connect API input representation
+    type: object
+    properties:
+      rampDealIds:
+        description: Ramp deal grouping ID
+        type: array
+        items:
+          type: string
+  ExecutionSettingsInputRepresentation:
+    description: Input Representation for how the Ramp Deal api will execute
+    type: object
+    properties:
+      executeConfigRules:
+        description: Whether to execute Config rules or not
+        type: boolean
+      executePricing:
+        description: Whether to execute Pricing or not
+        type: boolean
+  RampDealServiceErrorResponseRepresentation:
+    description: Price ramps Service Error response representation
+    type: object
+    properties:
+      errorCode:
+        description: Error Code from Ramp Service Response. For example, INVALID_INPUT_ERROR,
+        type: string
+      message:
+        description: Error message from Price Ramps Service Response.
+        type: string
+  RampDealServiceOutputRepresentation:
+    description: Price Ramp APIs output representation
+    type: object
+    properties:
+      errors:
+        description: List of errors encountered during the API processing.
+        type: array
+        items:
+          type: RampDealServiceErrorResponseRepresentation
+      salesTransactionContext:
+        description: SalesTransaction context object with updated price ramp information.
+        type: object
+        properties:
+          //:
+            type: any
+      success:
+        description: API request successfully completed
+        type: boolean
+      transactionContextId:
+        description: SalesTransaction context Id.
+        type: string
+  UpdateRampDealInputWrapperRepresentation:
+    description: Input Wrapper Representation for Update ramp deal connect API
+    type: object
+    properties:
+      updateRampDealInputParam:
+        type: UpdateRampDealInputRepresentation
+  UpdateRampDealInputRepresentation:
+    description: Update ramp deal connect API input representation
+    type: object
+    properties:
+      addedNodes:
+        description: Input Representation for adding new nodes
+        type: array
+        items:
+          type: object
+      deletedNodes:
+        description: Input Representation for deleting new nodes
+        type: array
+        items:
+          type: object
+      executionSettings:
+        description: Execution Settings like run pricing, run config rules
+        type: object
+      updatedNodes:
+        description: Input Representation for updating new nodes
+        type: array
+        items:
+          type: object
+/connect/revenue-management/sales-transaction-contexts/{resourceId}/actions:
+  /ramp-deal-create:
+    post:
+      displayName: postCreateRampDeal
+      description: Post request for creating ramp deal for SalesTransaction(Quote
+        or Order).
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RampDealServiceOutputRepresentation
+      body:
+        application/json:
+          type: CreateRampDealInputWrapperRepresentation
+          (oas-body-name): createRampDealInputParam
+    uriParameters:
+      resourceId:
+        type: string
+        required: true
+  /ramp-deal-delete:
+    post:
+      displayName: postDeleteRampDeal
+      description: Post request for deleting ramp deal for SalesTransaction(Quote
+        or Order).
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RampDealServiceOutputRepresentation
+      body:
+        application/json:
+          type: DeleteRampDealInputWrapperRepresentation
+          (oas-body-name): deleteRampDealInputParam
+    uriParameters:
+      resourceId:
+        type: string
+        required: true
+  /ramp-deal-update:
+    post:
+      displayName: postUpdateRampDeal
+      description: Post request for updating price ramps for SalesTransaction(Quote
+        or Order).
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RampDealServiceOutputRepresentation
+      body:
+        application/json:
+          type: UpdateRampDealInputWrapperRepresentation
+          (oas-body-name): updateRampDealInputParam
+    uriParameters:
+      resourceId:
+        type: string
+        required: true
+  /ramp-deal-view:
+    get:
+      displayName: getViewRampDeal
+      description: Get the segments for the Ramp deal
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RampDealServiceOutputRepresentation
+      queryParameters:
+        transactionId:
+          type: string
+          required: false
+        transactionLineId:
+          type: string
+          required: false
+    uriParameters:
+      resourceId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,33 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'sales-transaction-contexts'
+
+types:
+  RampDealServiceOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      transactionContextId: transactionContextId
+
+/connect/revenue-management/sales-transaction-contexts/{resourceId}/actions:
+  /ramp-deal-create:
+    post:
+      (luvio.adapter):
+        name: createRampDeal
+  /ramp-deal-delete:
+    post:
+      (luvio.adapter):
+        name: deleteRampDeal
+  /ramp-deal-update:
+    post:
+      (luvio.adapter):
+        name: updateRampDeal
+  /ramp-deal-view:
+    get:
+      (luvio.adapter):
+        name: viewRampDeal
+      (luvio.key):
+        transactionContextId: urlParams.resourceId