@salesforce/lds-adapters-revenue-harmonizebilling 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,195 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.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:
+  InvoiceDraftToPostedInputRepresentation:
+    description: Connect API representation for Invoice Draft to Posted api
+    type: object
+    properties:
+      correlationId:
+        description: Correlation ID
+        type: string
+        required: false # TODO handrolled W-13817376
+      invoiceIds:
+        description: List of draft invoices to be posted.
+        type: array
+        items:
+          type: string
+  RevenueAsyncRepresentation: #TODO handrolled W-13817376
+    description: Connect API representation of an async service result
+    type: object
+    properties:
+      errors:
+        description: List of errors
+        type: array
+        items:
+          type: ErrorResponseRepresentation
+      requestIdentifier:
+        description: Unique request identifier that can be used to poll async request
+        type: string
+      statusURL:
+        description: a StatusURL for tracking this operation
+        required: false # TODO handrolled W-13817376
+        type: string
+      success:
+        description: Flag indicating the overall enqueue status
+        type: boolean
+
+  ErrorResponseRepresentation:
+    description: Error response representation
+    type: object
+    properties:
+      errorCode:
+        description: Error Code
+        type: string
+      message:
+        description: Message stating the reason for error, if any
+        type: string
+
+  ResumeBillingEntityInputRepresentation:
+    description: Input representation for resume billing operation for Entity.
+    type: object
+    properties:
+      referenceId:
+        description: Entity Id to be resumed for Billing.
+        type: string
+      resumeDate:
+        description: The date on which billing is resumed.
+        type: string
+
+  ResumeBillingInputRepresentation:
+    description: Input representation for resume billing operation.
+    type: object
+    properties:
+      referenceIds:
+        description: List of input representation to be resumed for Billing.
+        type: array
+        items:
+          type: ResumeBillingEntityInputRepresentation
+
+  SuspendBillingEntityInputRepresentation:
+    description: Input representation for suspend billing operation for entity.
+    type: object
+    properties:
+      referenceId:
+        description: Entity Id to be suspended for Billing.
+        type: string
+      resumeDate:
+        description: The date till which Account/BSG is suspended for Billing.
+        type: string
+      suspendDate:
+        description: The date from which Account/BSG is suspended for Billing.
+        type: string
+
+  SuspendBillingInputRepresentation:
+    description: Input representation for suspend billing operation.
+    type: object
+    properties:
+      referenceIds:
+        description: Input representation of entity Ids to be suspended for Billing.
+        type: array
+        items:
+          type: SuspendBillingEntityInputRepresentation
+
+  SuspendResumeBillingEntityOutputRepresentation:
+    description: Connect API representation for suspend/resume billing output response.
+    type: object
+    properties:
+      errorCode:
+        description: Error Code of the error thrown.
+        type: string
+      errorMessage:
+        description: Error Message of the error thrown.
+        type: string
+      isSuccess:
+        description: Suspend Billing processing status.
+        type: boolean
+      referenceId:
+        description: Entity Id for which suspend billing is called.
+        type: string
+
+  SuspendResumeBillingOutputRepresentation:
+    description: Output representation of the list of Account/BSGs which are suspended/resumed
+      for billing.
+    type: object
+    properties:
+      result:
+        description: Response detail of the entities for which suspend/resume billing
+          is initiated.
+        type: array
+        items:
+          type: SuspendResumeBillingEntityOutputRepresentation
+
+/commerce:
+  /invoicing:
+    /actions:
+      /resume-billing:
+        post:
+          displayName: postResumeBilling
+          description: Resume billing for accounts or BSGs
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SuspendResumeBillingOutputRepresentation
+          body:
+            application/json:
+              type: ResumeBillingInputRepresentation
+              #required: false
+              (oas-body-name): inputRequest
+      /suspend-billing:
+        post:
+          displayName: postSuspendBilling
+          description: Hold/suspend the billing for accounts or BSGs
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: SuspendResumeBillingOutputRepresentation
+          body:
+            application/json:
+              type: SuspendBillingInputRepresentation
+              #required: false
+              (oas-body-name): inputRequest
+    /invoices:
+      /collection/actions:
+        /post:
+          post:
+            displayName: postInvoiceDraftToPosted
+            description: Post a Draft Invoice
+            responses:
+              '200':
+                description: Success
+                body:
+                  application/json:
+                    type: RevenueAsyncRepresentation
+            body:
+              application/json:
+                type: InvoiceDraftToPostedInputRepresentation
+                #required: false # TODO handrolled W-13817376
+                (oas-body-name): inputRequest

package/src/raml/luvio.raml

@@ -0,0 +1,34 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'HarmonizeBilling'
+
+types:
+  RevenueAsyncRepresentation:
+    (luvio.ttl): 1000
+  SuspendResumeBillingOutputRepresentation:
+    (luvio.ttl): 1000
+
+/commerce:
+  /invoicing:
+    /invoices:
+      /collection/actions:
+        /post:
+          post:
+            (luvio.method): get
+            (luvio.adapter):
+              name: postDraftInvoices
+    /actions:
+      /resume-billing:
+        post:
+          (luvio.method): get
+          (luvio.adapter):
+            name: resumeBilling
+      /suspend-billing:
+        post:
+          (luvio.method): get
+          (luvio.adapter):
+            name: suspendBilling