@salesforce/lds-adapters-service-basesetup 1.308.0

package/src/raml/api.raml

@@ -0,0 +1,211 @@
+#%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:
+  EnableFeatureSetInputRepresentation:
+    description: Enable Field Service feature set
+    type: object
+    properties:
+      additionalInfo:
+        description: Additional info storing user inputs
+        type: object
+        properties:
+          //:
+            type: object
+      featureApiName:
+        description: Feature API Name
+        type: string
+      featureSetApiName:
+        description: Feature Set API Name
+        type: string
+  EnableFeatureSetOutputRepresentation:
+    description: Output representation of enable feature set
+    type: object
+    properties:
+      errors:
+        description: Top level errors
+        type: array
+        items:
+          type: FeatureSetErrorRepresentation
+      featureSetApiName:
+        description: Feature set API Name
+        type: string
+      featureSetStatus:
+        description: Feature set status
+        type: string
+      featureStatusList:
+        description: List of statuses for each feature in feature set
+        type: array
+        items:
+          type: FeatureStatusRepresentation
+  FeatureActionDetailRepresentation:
+    description: Feature Action Detail representation
+    type: object
+    properties:
+      iconName:
+        description: Feature Action Detail Icon Name
+        type: string
+      label:
+        description: Feature Action Detail Label
+        type: string
+      title:
+        description: Feature Action Detail Title
+        type: string
+  FeatureActionRepresentation:
+    description: Representation of feature action
+    type: object
+    properties:
+      actionDetail:
+        description: Action detail
+        type: FeatureActionDetailRepresentation
+      actionType:
+        description: Feature Action type
+        type: string
+  FeatureRepresentation:
+    description: Representation of Feature Details
+    type: object
+    properties:
+      errors:
+        description: Errors
+        type: array
+        items:
+          type: FeatureSetErrorRepresentation
+      featureAction:
+        description: Feature Action for specific feature
+        type: FeatureActionRepresentation | nil
+      featureApiName:
+        description: API name that uniquely identifies a feature
+        type: string
+      featureStatus:
+        description: Status of a specific feature
+        type: string
+      resourceUrl:
+        description: URL to public documentation
+        type: string | nil
+      title:
+        description: Title for a specific feature
+        type: string | nil
+  FeatureSetErrorRepresentation:
+    description: Output representation of feature set error
+    type: object
+    properties:
+      errorCode:
+        description: Error code
+        type: string
+      errorMessage:
+        description: Error message
+        type: string
+  FeatureSetRepresentation:
+    description: Output representation for featureSetDetails endpoint (FeatureSet
+      Detail)
+    type: object
+    properties:
+      description:
+        description: Description for a specific feature set
+        type: string
+      errors:
+        description: Errors
+        type: array
+        items:
+          type: FeatureSetErrorRepresentation
+      featureCategory:
+        description: Category for a specific feature set
+        type: string | nil
+      featureSetApiName:
+        description: API name that uniquely identifies a feature set
+        type: string
+      featureSetStatus:
+        description: The status for a specific feature set
+        type: string
+      features:
+        description: The features for the specified feature set
+        type: array
+        items:
+          type: FeatureRepresentation
+      order:
+        description: The order for a specific feature set
+        type: integer | nil
+      previewImageUrl:
+        description: Preview Image URL
+        type: string | nil
+      title:
+        description: Title for a specific feature set
+        type: string | nil
+  FeatureStatusRepresentation:
+    description: Output representation of feature status
+    type: object
+    properties:
+      errors:
+        description: Errors
+        type: array
+        items:
+          type: FeatureSetErrorRepresentation
+      featureApiName:
+        description: Feature API Name
+        type: string
+      featureStatus:
+        description: Feature status
+        type: string
+/connect/base-setup:
+  /enableFeatureSet:
+    post:
+      displayName: postEnableFeatureSet
+      description: Enable Field Service feature set
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EnableFeatureSetOutputRepresentation
+      body:
+        application/json:
+          type: EnableFeatureSetInputRepresentation
+          # required: false # TODO Hand-rolled
+          (oas-body-name): EnableFeatureSetInputRepresentation
+  /featureSetDetail:
+    get:
+      displayName: getFeatureSetDetail
+      description: Get the details of the Feature Set
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FeatureSetRepresentation
+      queryParameters:
+        featureApiNames:
+          description: |-
+            The names of the specific features in the feature set to retrieve the detail of.
+            If absent, all features of the feature set are returned.
+          type: array
+          required: false
+          items:
+            type: string
+            (oas-collectionFormat): csv
+        featureSetApiName:
+          description: The name of the feature set to retrieve the detail of
+          type: string
+          required: true # TODO Hand-rolled W-16177531

package/src/raml/luvio.raml

@@ -0,0 +1,28 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'basesetup'
+(luvio.ttl): 100
+
+types:
+  FeatureSetRepresentation:
+    (luvio.key):
+      featureSetApiName: featureSetApiName
+  EnableFeatureSetOutputRepresentation:
+    (luvio.key):
+      featureSetApiName: featureSetApiName
+
+/connect/base-setup:
+  /featureSetDetail:
+    get:
+      (luvio.adapter):
+        name: getFeatureSetDetail
+      (luvio.key):
+        featureSetApiName: queryParams.featureSetApiName
+  /enableFeatureSet:
+    post:
+      (luvio.adapter):
+        name: enableFeatureSet