@salesforce/lds-adapters-service-articlefeedback 1.344.0

package/src/raml/api.raml

@@ -0,0 +1,166 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '64.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v64.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:
+  ArticleFeedbackInvitationInputRepresentation:
+    description: Represents the input payload for generating survey invitation for
+      Knowledge Article Version
+    type: object
+    properties:
+      communityId:
+        description: Community id.
+        type: string
+        required: false
+      knowledgeArticleVersionId:
+        description: Knowledge Article Version id.
+        type: string
+  ArticleFeedbackInvitationRepresentation:
+    description: Invitation link data for Article Feedback
+    type: object
+    properties:
+      invitationId:
+        description: Survey invitation Id
+        type: string | nil
+      invitationUrl:
+        description: Survey invitation url
+        type: string | nil
+      knowledgeArticleVersionId:
+        description: Knowledge Article Version id
+        type: string
+      responseSubmitted:
+        description: Article feedback Invitation Response submit
+        type: boolean | nil
+  ArticleFeedbackQuestionResponseRepresentation:
+    description: Article Feedback question Response for Article feedback responses
+      representation
+    type: object
+    properties:
+      questionName:
+        description: Question Name
+        type: string
+      questionOrder:
+        description: Question Order
+        type: integer
+      questionResponse:
+        description: Question Response
+        type: string
+      questionType:
+        description: Question Type
+        type: string
+  ArticleFeedbackResponseCollectionRepresentation:
+    description: List of Article feedback response representation
+    type: object
+    properties:
+      articleFeedbackResponseRepresentationList:
+        description: KnowledgeArticle version feedback response list
+        type: array
+        items:
+          type: ArticleFeedbackResponseRepresentation
+  ArticleFeedbackResponseRepresentation:
+    description: Article Feedback Response for given survey invitation representation
+    type: object
+    properties:
+      articleFeedbackQuestionResponseRepresentationList:
+        description: list of article feedback question response
+        type: array
+        items:
+          type: ArticleFeedbackQuestionResponseRepresentation
+      completionDate:
+        description: Completion date
+        type: string
+      responseId:
+        description: Response Id
+        type: string
+      responseName:
+        description: Response Name
+        type: string
+      submitterId:
+        description: Submitter Id
+        type: string
+      submitterName:
+        description: Submitter Name
+        type: string
+
+/connect:
+  /article-feedback:
+    /invitations:
+      get:
+        displayName: getArticleFeedbackInvitation
+        description: Get the survey invitation for the given knowledge article version
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ArticleFeedbackInvitationRepresentation
+        queryParameters:
+          communityId:
+            type: string
+            required: false
+          knowledgeArticleVersionId:
+            type: string
+      post:
+        displayName: postArticleFeedbackInvitation
+        description: Create Survey invitation for Knowledge Article version
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ArticleFeedbackInvitationRepresentation
+        body:
+          application/json:
+            type: ArticleFeedbackInvitationInputRepresentation
+            (oas-body-name): invitationInput
+    /responses:
+      get:
+        displayName: getArticleFeedbackResponse
+        description: Get the survey response for the given knowledge article version
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ArticleFeedbackResponseCollectionRepresentation
+        queryParameters:
+          communityId:
+            type: string
+            required: false
+          isUserResponse:
+            type: boolean
+            required: false
+          knowledgeArticleVersionId:
+            type: string
+            required: false
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false

package/src/raml/luvio.raml

@@ -0,0 +1,43 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'articlefeedback'
+(luvio.ttl): 900000
+
+types:
+  ArticleFeedbackInvitationRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: knowledgeArticleVersionId
+  ArticleFeedbackInvitationInputRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: knowledgeArticleVersionId
+  ArticleFeedbackResponseCollectionRepresentation:
+    (luvio.ttl): 300
+  ArticleFeedbackQuestionResponseRepresentation:
+    (luvio.ttl): 300
+  ArticleFeedbackResponseRepresentation:
+    (luvio.ttl): 300
+    (luvio.key):
+      id: responseId
+
+/connect:
+  /article-feedback/invitations:
+    get:
+      (luvio.adapter):
+        name: getSurveyInvitation
+      (luvio.key):
+        id: queryParams.knowledgeArticleVersionId
+
+    post:
+      (luvio.adapter):
+        name: createSurveyInvitation
+
+  /article-feedback/responses:
+    get:
+      (luvio.adapter):
+        name: getArticleFeedbackResponsesPaginated