@salesforce/lds-adapters-industries-contextrules 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,221 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.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:
+  RuleLibraryTagMappingsCreateUpdateOutputRepresentation:
+    description: Output representation of create and update tag mapping
+    type: object
+    properties:
+      ids:
+        description: List of Ids of tag mapping
+        type: array
+        items:
+          type: string
+  RuleLibraryTagMappingsInputRepresentation:
+    description: Tag mapping input representation
+    type: object
+    properties:
+      mappingName:
+        description: Mapping name
+        type: string
+      sequenceNumber:
+        description: Sequence number
+        type: integer
+      tagName:
+        description: Tag Name
+        type: string
+      usageSubtype:
+        description: The usage sub type
+        type: string
+  RuleLibraryTagMappingsListWrapperRepresentation:
+    description: Tag mapping input representation list
+    type: object
+    properties:
+      ruleLibraryTagMappingInputList:
+        description: The list of tag mappings
+        type: array
+        items:
+          type: any
+  RuleLibraryTagMappingsOverallInputRepresentation:
+    description: Tag mapping input representation list
+    type: object
+    properties:
+      contextTagMappings:
+        description: The list representation of tag mappings
+        type: RuleLibraryTagMappingsListWrapperRepresentation
+  RuleLibraryTagMappingsReadOutputRepresentation:
+    description: Output representation of read tag mapping
+    type: object
+    properties:
+      id:
+        description: Id of the tag mapping
+        type: string
+      mappingName:
+        description: Mapping name
+        type: string
+      ruleLibraryApiName:
+        description: API name of the rule library
+        type: string
+      sequenceNumber:
+        description: Sequence number
+        type: integer
+        required: false
+      tagName:
+        description: Tag name
+        type: string
+      usageSubtype:
+        description: Usage subtype
+        type: string
+        required: false
+      versionNumber:
+        description: Version number
+        type: integer
+  RuleLibraryTagMappingsReadOutputRepresentationList:
+    description: Output representation list of read tag mapping
+    type: object
+    properties:
+      ruleLibraryTagMappings:
+        description: List of RuleLibraryTagMappingsReadOutputRepresentation
+        type: array
+        items:
+          type: RuleLibraryTagMappingsReadOutputRepresentation
+  UsageTypeOutputRepresentation:
+    description: Output representation of context rule usageType
+    type: object
+    properties:
+      mappingNames:
+        description: mapping names
+        type: array
+        items:
+          type: string
+      usageSubtypes:
+        description: Usage Subtypes
+        type: array
+        items:
+          type: UsageSubtypeOutputRepresentation
+      usageType:
+        description: Usage type
+        type: string
+  UsageSubtypeOutputRepresentation:
+    description: Output representation of context rule usageSubtype
+    type: object
+    properties:
+      subtypeMappingNames:
+        description: subType Mapping names
+        type: array
+        items:
+          type: string
+      usageSubtype:
+        description: Usage Subtype
+        type: string
+/connect/context-rules:
+  /context-tag-mappings/rule-library-api-name/{ruleLibraryApiName}/version-number/{versionNumber}:
+    get:
+      displayName: getRuleLibraryContextTagMappings
+      description: Read Tag Mapping
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RuleLibraryTagMappingsReadOutputRepresentationList
+    patch:
+      displayName: patchRuleLibraryContextTagMappings
+      description: Update Tag Mapping
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RuleLibraryTagMappingsCreateUpdateOutputRepresentation
+      body:
+        application/json:
+          type: RuleLibraryTagMappingsOverallInputRepresentation
+          # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          #required: false
+          (oas-body-name): tagMappingInputRepresentation
+    post:
+      displayName: postRuleLibraryContextTagMappings
+      description: Create Tag Mapping
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RuleLibraryTagMappingsCreateUpdateOutputRepresentation
+      body:
+        application/json:
+          type: RuleLibraryTagMappingsOverallInputRepresentation
+          # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          #required: false
+          (oas-body-name): tagMappingInputRepresentation
+    uriParameters:
+      ruleLibraryApiName:
+        type: string
+        required: true
+      versionNumber:
+        type: string
+        required: true
+  /context-tag-mappings/rule-library-api-name/{ruleLibraryApiName}/version-number/{versionNumber}/mapping-name/{mappingName}:
+    delete:
+      displayName: deleteRuleLibraryContextTagMappingDelete
+      description: Delete Tag Mapping
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getRuleLibraryContextTagMappingDelete
+      description: get Tag Mapping
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RuleLibraryTagMappingsReadOutputRepresentation
+    uriParameters:
+      mappingName:
+        type: string
+        required: true
+      ruleLibraryApiName:
+        type: string
+        required: true
+      versionNumber:
+        type: string
+        required: true
+  /usage-types/{usageType}:
+    get:
+      displayName: getContextRuleUsageType
+      description: Get UsageType detail
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: UsageTypeOutputRepresentation
+    uriParameters:
+      usageType:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,57 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'contextrules'
+(luvio.ttl): 360000
+
+types:
+  RuleLibraryTagMappingsCreateUpdateOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: ids
+  RuleLibraryTagMappingsReadOutputRepresentationList:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  RuleLibraryTagMappingsReadOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: mappingName
+  UsageTypeOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      id: usageType
+
+/connect/context-rules:
+  /context-tag-mappings/rule-library-api-name/{ruleLibraryApiName}/version-number/{versionNumber}:
+    get:
+      (luvio.adapter):
+        name: getContextTagMappings
+    post:
+      (luvio.adapter):
+        name: createContextTagMapping
+    patch:
+      (luvio.adapter):
+        name: updateContextTagMapping
+  /context-tag-mappings/rule-library-api-name/{ruleLibraryApiName}/version-number/{versionNumber}/mapping-name/{mappingName}:
+    get:
+      (luvio.adapter):
+        name: getContextTagMapping
+      (luvio.key):
+        id: urlParams.mappingName
+    delete:
+      (luvio.adapter):
+        name: deleteContextTagMapping
+      (luvio.key):
+        id: urlParams.mappingName
+  /usage-types/{usageType}:
+    get:
+      (luvio.adapter):
+        name: getUsageTypeDetail
+      (luvio.key):
+        id: urlParams.usageType