@salesforce/lds-adapters-community-info 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,170 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.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:
+  CommunityCollectionRepresentation:
+    description: A list of Communities.
+    type: object
+    properties:
+      communities:
+        description: List of communities available to the current user.
+        type: array
+        items:
+          type: CommunityRepresentation
+      total:
+        description: Total number of communities available to the current user.
+        type: integer
+  CommunityRepresentation:
+    description: Communities are customizable public or private spaces for employees,
+      customers, and partners to collaborate on best practices and business processes.
+    type: object
+    properties:
+      allowChatterAccessWithoutLogin:
+        description: Specifies whether guest users can access public Chatter groups
+          in the community without logging in.
+        type: boolean | nil
+      allowMembersToFlag:
+        description: Specifies whether members of this community are allowed to flag
+          content.
+        type: boolean | nil
+      builderBasedSnaEnabled:
+        description: Specifies whether the Service Not Available page is an auto-generated
+          Experience Builder-based page (true) or a static resource page that is set
+          in Workspaces|Administration|Pages (false).
+        type: boolean | nil
+      builderUrl:
+        description: Builder URL for the Community
+        type: string | nil
+      contentSpaceId:
+        description: 18-character content space Id of the managed content for Enhanced
+          Site.
+        type: string | nil
+      description:
+        description: Community’s description.
+        type: string | nil
+      guestMemberVisibilityEnabled:
+        description: Specifies whether guest members can see other members of the
+          community or not.
+        type: boolean | nil
+      id:
+        description: 18-character Id of the community.
+        type: string | nil
+      imageOptimizationCDNEnabled:
+        description: Specifies whether image optimization is enabled for sites hosted
+          on iCDN platforms or not
+        type: boolean | nil
+      invitationsEnabled:
+        description: Specifies if members of the community can invite other members
+          to the community, true if they can, false otherwise.
+        type: boolean | nil
+      knowledgeableEnabled:
+        description: Specifies if the community is able to have knowledgeable users
+          on topics and knowledgeable about topics.
+        type: boolean | nil
+      loginUrl:
+        description: Full login URL for the Community
+        type: string | nil
+      memberVisibilityEnabled:
+        description: Specifies whether members can see other members of the community
+          or not.This is honored when 'Control user visibility within a community'
+          perm is enabled
+        type: boolean | nil
+      name:
+        description: Community's name.
+        type: string | nil
+      nicknameDisplayEnabled:
+        description: Specifies whether nickname display is enabled in the community
+          or not.
+        type: boolean | nil
+      privateMessagesEnabled:
+        description: Specifies if members of the community can send and receive Private
+          Messages to other members in the community, true if they can, false otherwise.
+        type: boolean | nil
+      reputationEnabled:
+        description: Specifies whether Reputation is calculated and displayed for
+          community members.
+        type: boolean | nil
+      sendWelcomeEmail:
+        description: Specifies if a welcome email is automatically generated and sent
+          to any new member. true if email is sent, false otherwise
+        type: boolean | nil
+      siteAsContainerEnabled:
+        description: Specifies whether the community is site.com template enabled
+          or not.
+        type: boolean | nil
+      siteUrl:
+        description: Site URL for the Community, which is custom domain + URL prefix.
+        type: string | nil
+      status:
+        description: Community's publish status.
+        type: string | nil
+        enum:
+          - Inactive
+          - Live
+          - UnderConstruction
+      templateName:
+        description: Community’s template name.
+        type: string | nil
+      url:
+        description: Full URL to community.
+        type: string | nil
+      urlPathPrefix:
+        description: Community-specific URL prefix.
+        type: string | nil
+
+/connect:
+  /communities:
+    get:
+      displayName: getCommunityCollection
+      description: Returns all the communities available to the context user, optionally
+        filtered by status.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CommunityCollectionRepresentation
+      queryParameters:
+        status:
+          type: string
+          required: false
+          enum:
+            - Inactive
+            - Live
+            - UnderConstruction
+  /communities/{communityId}:
+    get:
+      description: Returns information about the specified community.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CommunityRepresentation
+    uriParameters:
+      communityId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,32 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'CommunityInfo'
+(luvio.ttl): 2592000000
+
+types:
+  CommunityCollectionRepresentation:
+    (luvio.ttl): 60000
+  CommunityRepresentation:
+    (luvio.ttl): 3600000
+    (luvio.key):
+      id: id
+    (luvio.updateAvailable):
+      name: notifyCommunityUpdateAvailable
+      parameters:
+        id: id
+
+/connect:
+  /communities/{communityId}:
+    get:
+      (luvio.adapter):
+        name: getCommunity
+      (luvio.key):
+        id: urlParams.communityId
+  /communities:
+    get:
+      (luvio.adapter):
+        name: getCommunities