@salesforce/lds-adapters-industries-field-service 0.1.0-dev1

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/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:
+  AppointmentSchedulingRepresentation:
+    description: Output Representation Of The Appointment Scheduling Response
+    type: object
+    properties:
+      appointmentSlots:
+        description: The details of the slots available for the service appointment
+        type: array
+        items:
+          type: AppointmentSlotRepresentation
+      errorCode:
+        description: The code of the error due to which the scheduling request failed
+        type: string
+      errorMessage:
+        description: The details of the error if the scheduling operation was unsuccessful
+        type: string
+      isSuccess:
+        description: Specifies if the scheduling operation was successful (true) or
+          not (false)
+        type: boolean
+      resourceId:
+        description: The details of the service resource assigned
+        type: string
+      serviceAppointmentId:
+        description: The details of the service appointment
+        type: string
+  AppointmentSlotRepresentation:
+    description: Output Representation Of The Appointment Slot Response For The Service
+      Appointment Request
+    type: object
+    properties:
+      finishInterval:
+        description: Service Appointment Slot Finish Interval
+        type: string
+      grade:
+        description: Service Appointment Slot Grade
+        format: double
+        type: number
+      startInterval:
+        description: Service Appointment Slot Start Interval
+        type: string
+  AssetCoverageInputRepresentation:
+    description: Input representation for Coverage
+    type: object
+    properties:
+      contractIds:
+        description: The list of contracts
+        type: array
+        items:
+          type: string
+      entitlementIds:
+        description: The list of entitlements
+        type: array
+        items:
+          type: string
+      warrantyIds:
+        description: The list of warranties
+        type: array
+        items:
+          type: string
+  PriceItemWithCoverageInputRepresentation:
+    description: Input representation to Price an Entity with Coverage
+    type: object
+    properties:
+      assetCoverageMap:
+        description: The map of assets and associated coverages
+        type: object
+        properties:
+          //:
+            type: AssetCoverageInputRepresentation
+      childItems:
+        description: The list of child items to be priced
+        type: array
+        items:
+          type: string
+      itemId:
+        description: The item Id to be priced
+        type: string
+      pricingProcedure:
+        description: The pricing procedure to be used
+        type: string
+  PriceItemWithCoverageRepresentation:
+    description: Output representation of the error response for the price item with
+      coverage request.
+    type: object
+    properties:
+      errorCode:
+        description: The code of the error due to which the request failed.
+        type: string
+      errorMessage:
+        description: The details of the error if the operation was unsuccessful.
+        type: string
+      isSuccess:
+        description: Specifies if the operation was successful (true) or not (false)
+        type: boolean
+      itemId:
+        description: The details of the item being processed.
+        type: string
+  ProductServiceCampaignItemsFromListInputRepresentation:
+    description: Input representation to create product service campaign items for
+      each actionable list member in an actionable list.
+    type: object
+    properties:
+      actionableListId:
+        description: The ID of the Actionable List record.
+        type: string
+  ProductServiceCampaignItemsFromListRepresentation:
+    description: Output representation of the error response for the product service
+      campaign items creation request.
+    type: object
+    properties:
+      errorCode:
+        description: The code of the error due to which the request failed.
+        type: string | nil
+      errorMessage:
+        description: The details of the error if the operation was unsuccessful.
+        type: string | nil
+      isSuccess:
+        description: Specifies if the operation was successful (true) or not (false)
+        type: boolean
+  WorkOrderForProductServiceCampaignItemInputRepresentation:
+    description: Input representation to create work orders for each specified product
+      service campaign item or each product service campaign item in a product service
+      campaign.
+    type: object
+    properties:
+      productServiceCampaignId:
+        description: The ID of the Product Service Campaign record.
+        type: string
+        required: false
+      productServiceCampaignItemIds:
+        description: The List of IDs of Product Service Campaign Items
+        type: array
+        required: false
+        items:
+          type: string | nil
+  WorkOrderForProductServiceCampaignItemRepresentation:
+    description: Output representation of the work orders that are created for product
+      service campaign items.
+    type: object
+    properties:
+      errorCode:
+        description: The code of the error due to which the request failed.
+        type: string
+        required: false
+      errorMessage:
+        description: The details of the error if the operation was unsuccessful.
+        type: string
+        required: false
+      isSuccess:
+        description: Specifies if the operation was successful (true) or not (false)
+        type: boolean
+/connect/industries-field-service:
+  /appointment-scheduling/slots/{serviceAppointmentId}/{schedulingPolicyId}:
+    get:
+      displayName: getAppointmentSlots
+      description: Get Service Appointment Slots
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppointmentSchedulingRepresentation
+    put:
+      displayName: bookAppointmentSlot
+      description: Book Service Appointment Slot
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppointmentSchedulingRepresentation
+    uriParameters:
+      serviceAppointmentId:
+        type: string
+        required: true
+      schedulingPolicyId:
+        type: string
+        required: true
+  /product-service-campaign:
+    /items-from-list:
+      post:
+        displayName: postCreateProductServiceCampaignItems
+        description: Creates Product Service Campaign Items for the Given Actionable
+          List
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ProductServiceCampaignItemsFromListRepresentation
+        body:
+          application/json:
+            type: ProductServiceCampaignItemsFromListInputRepresentation
+            (oas-body-name): createPSCIInput
+    /work-order:
+      post:
+        displayName: postCreateWorkOrders
+        description: Creates a work order for each specified product service campaign
+          item or each product service campaign item in a specified product service
+          campaign.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: WorkOrderForProductServiceCampaignItemRepresentation
+        body:
+          application/json:
+            type: WorkOrderForProductServiceCampaignItemInputRepresentation
+            (oas-body-name): createWorkOrdersInput
+  /work-order-estimation/price-item:
+    put:
+      displayName: putPriceItemWithCoverage
+      description: Price Item with Coverage.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PriceItemWithCoverageRepresentation
+      body:
+        application/json:
+          type: PriceItemWithCoverageInputRepresentation
+          (oas-body-name): priceItemWithCoverageInput

package/src/raml/luvio.raml

@@ -0,0 +1,60 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'field-service'
+(luvio.ttl): 1000
+
+types:
+  ProductServiceCampaignItemsFromListInputRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: actionableListId
+  ProductServiceCampaignItemsFromListRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      isSuccess: isSuccess
+  PriceItemWithCoverageRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      itemId: itemId
+  AppointmentSchedulingRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: serviceAppointmentId
+    (luvio.updateAvailable):
+      name: notifyAppointmentSchedulingUpdateAvailable
+      parameters:
+        id: serviceAppointmentId
+  WorkOrderForProductServiceCampaignItemInputRepresentation:
+    (luvio.ttl): 300
+  WorkOrderForProductServiceCampaignItemRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: isSuccess
+
+/connect/industries-field-service:
+  /product-service-campaign:
+    /items-from-list:
+      post:
+        (luvio.adapter):
+          name: createProductServiceCampaign
+    /work-order:
+      post:
+        (luvio.adapter):
+          name: createWorkOrders
+  /work-order-estimation/price-item:
+    put:
+      (luvio.adapter):
+        name: priceItemWithCoverage
+  /appointment-scheduling/slots/{serviceAppointmentId}/{schedulingPolicyId}:
+    get:
+      (luvio.adapter):
+        name: getAppointmentSlots
+      (luvio.key):
+        id: urlParams.serviceAppointmentId
+    put:
+      (luvio.adapter):
+        name: bookAppointmentSlot