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

package/src/raml/api.raml

@@ -0,0 +1,659 @@
+#%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:
+  InterestTagAssignmentInputRepresentation:
+    description: Input representation for interest tag entity assignment
+    type: object
+    properties:
+      recordsForTag:
+        description: Entity records to be assigned to a tag
+        type: object
+        properties:
+          TagId: string
+          RecordIds:
+            type: array
+            items:
+              type: string
+      tagsForRecord:
+        description: tags to be assigned to an entity
+        type: object
+        properties:
+          RecordId: string
+          TagIds:
+            type: array
+            items:
+              type: string
+  InterestTagAssignmentOutputRepresentation:
+    description: Interest tag entity assignment output representation.
+    type: object
+    properties:
+      errors:
+        description: Error messages occurred for the interest tag entity assignments
+        type: array
+        items:
+          type: string
+      isCreated:
+        description: Created flag whether the Interest Tag Entity assignment was successfully
+          created or not
+        type: boolean
+      isSuccess:
+        description: Success flag for Create of Interest Tag Entity assignment
+        type: boolean
+  InterestTagCreateCollectionOutputRepresentation:
+    description: A Collection of interest tag output representation- InterestTagCreateResult.
+    type: object
+    properties:
+      results:
+        description: List of Interest Tag Records created
+        type: array
+        items:
+          type: InterestTagCreateResult
+  InterestTagCreateInputListRepresentation:
+    description: Interest Tags create input list
+    type: object
+    properties:
+      interestTagList:
+        description: List of Interest tags to be created
+        type: array
+        items:
+          type: object
+  InterestTagCreateInputRepresentation:
+    description: Input representation for creating interest tags
+    type: object
+    properties:
+      categoryId:
+        description: CategoryId of the Interest Tag
+        type: string
+      recordId:
+        description: Id of the reecord to which Interest Tag needs to be associated
+          to
+        type: string
+      tagDescription:
+        description: Description of the Interest Tag
+        type: string
+      tagName:
+        description: Name of the Interest Tag
+        type: string
+  InterestTagCreateResult:
+    description: Create interest tag results representation
+    type: object
+    properties:
+      error:
+        description: Error message of the Interest Tag that could be created
+        type: string
+      isCreated:
+        description: Created flag whether the Interest Tag was successfully created
+          or not
+        type: boolean
+      isSuccess:
+        description: Success flag for Create of Interest Tags
+        type: boolean
+      tagId:
+        description: Interest Tag Id that got created.
+        type: string
+  InterestTagListRepresentation:
+    description: A list of interest tags.
+    type: object
+    properties:
+      tags:
+        description: interest tag list
+        type: array
+        items:
+          type: InterestTagRepresentation
+  InterestTagRepresentation:
+    description: The response for an interest tag.
+    type: object
+    properties:
+      categories:
+        description: The categories associated to the tag
+        type: array
+        items:
+          type: TagCategoryRepresentation
+      name:
+        description: The tag name
+        type: string
+      recordAssignmentId:
+        description: The id of the assignment record of the tagid and recordId
+        type: string
+      tagId:
+        description: The tag Id
+        type: string
+  InterestTagUpdateInputRepresentation:
+    description: Interest Tags update input request
+    type: object
+    properties:
+      addCategoryIds:
+        description: The categories to be assigned on this tag
+        type: array
+        items:
+          type: string
+      removeCategoryIds:
+        description: The categories to be removed on this tag
+        type: array
+        items:
+          type: string
+      tagDescription:
+        description: The new tag description to be set on this tag
+        type: string
+      tagName:
+        description: The new tag name to be set on this tag
+        type: string
+  InterestTagUpdateOutputRepresentation:
+    description: The response for interest tag update call.
+    type: object
+    properties:
+      isSuccess:
+        description: indicate whether the call is succeeded
+        type: boolean
+      isUpdated:
+        description: indicate whether the tag is updated
+        type: boolean
+  RecordsForTag:
+    description: Input representation for records for tag
+    type: object
+    properties:
+      recordIds:
+        description: Entity Record Ids
+        type: array
+        items:
+          type: string
+      tagId:
+        description: Interest Tag Id
+        type: string
+  TagCategoryListRepresentation:
+    description: A list of tag categories.
+    type: object
+    properties:
+      categories:
+        description: tag category list
+        type: array
+        items:
+          type: TagCategoryWithParentRepresentation
+  TagCategoryRepresentation:
+    description: The response for a category.
+    type: object
+    properties:
+      categoryId:
+        description: The category Id
+        type: string
+      icon:
+        description: The icon of the category
+        type: string
+      name:
+        description: The category name
+        type: string
+  TagCategoryWithParentRepresentation:
+    description: The representation of a category with its parent category.
+    type: object
+    properties:
+      categoryId:
+        description: The category Id
+        type: string
+      icon:
+        description: The icon name of this category
+        type: string
+      name:
+        description: The category name
+        type: string
+      parentCategoryId:
+        description: The parent category Id
+        type: string
+      parentCategoryName:
+        description: The parent category name
+        type: string
+      tagCategoryAssignmentId:
+        description: The TagCategoryAssignmentId of this category with the given tagId
+        type: string
+  TagRecordAssignment:
+    description: Tag record assignment representation
+    type: object
+    properties:
+      assignmentId:
+        description: The id of the tag entity assignment record of the tagid and recordId
+        type: string
+      objectName:
+        description: Object Name for the Record.
+        type: string
+      recordId:
+        description: Record ID.
+        type: string
+      recordName:
+        description: Record Name.
+        type: string
+  TagRecordAssignmentCollectionRepresentation:
+    description: A Collection of record assignments for a tag.
+    type: object
+    properties:
+      assignments:
+        description: List of record assignments for a tag.
+        type: array
+        items:
+          type: TagRecordAssignment
+  TagsForRecord:
+    description: Input representation for tags for record
+    type: object
+    properties:
+      recordId:
+        description: Entity Record Id
+        type: string
+      tagIds:
+        description: Interest Tag Ids
+        type: array
+        items:
+          type: string
+  CategoryCreatedResult:
+    description: Category created result representation
+    type: object
+    properties:
+      id:
+        description: ID of the category that was created
+        type: string
+      name:
+        description: Name of the category that was created
+        type: string
+  InterestTagAndCategoryCreateInputRepresentation:
+    description: Interest Tags and Categories create input
+    type: object
+    properties:
+      interestTags:
+        description: List of Interest tags and categories to be created
+        type: array
+        items:
+          type: InterestTagAndCategoryItemInputRepresentation
+  InterestTagAndCategoryCreateOutputRepresentation:
+    description: Output representation for interest tag and category creation.
+    type: object
+    properties:
+      categories:
+        description: List of categories that were created
+        type: array
+        items:
+          type: CategoryCreatedResult
+      errors:
+        description: List of errors that occurred during processing
+        type: array
+        items:
+          type: InterestTagAndCategoryErrorOutputRepresentation
+      isSuccess:
+        description: Indicates whether the operation was successful (true when no
+          errors, false when errors are present)
+        type: boolean
+      tags:
+        description: List of tags that were created
+        type: array
+        items:
+          type: TagCreatedOutputRepresentation
+  InterestTagAndCategoryErrorOutputRepresentation:
+    description: Interest tag and category error output representation
+    type: object
+    properties:
+      message:
+        description: Error message describing what went wrong
+        type: string
+      type:
+        description: Type of error that occurred (TagCreation, CategoryCreation,
+          TagAndCategoryAssociation, TagAndRecordAssociation)
+        type: string
+        enum:
+          - CategoryCreation
+          - TagAndCategoryAssociation
+          - TagAndRecordAssociation
+          - TagCreation
+  InterestTagAndCategoryItemInputRepresentation:
+    description: Interest Tag and Category item input
+    type: object
+    properties:
+      categoryDescription:
+        description: Description of the category
+        type: string
+        required: false
+      categoryIcon:
+        description: Icon of the category
+        type: string
+        required: false
+      categoryId:
+        description: ID of the category
+        type: string
+        required: false
+      categoryName:
+        description: Name of the category
+        type: string
+        required: false
+      tags:
+        description: List of tags associated with this category
+        type: array
+        items:
+          type: InterestTagItemInputRepresentation
+  TagCreatedOutputRepresentation:
+    description: Tag created result representation
+    type: object
+    properties:
+      id:
+        description: ID of the tag that was created
+        type: string
+      name:
+        description: Name of the tag that was created
+        type: string
+  InterestTagItemInputRepresentation:
+    description: Interest Tag item input
+    type: object
+    properties:
+      recordId:
+        description: ID of the record to associate with the tag
+        type: string
+        required: false
+      tagDescription:
+        description: Description of the tag
+        type: string
+        required: false
+      tagId:
+        description: ID of the tag
+        type: string
+        required: false
+      tagName:
+        description: Name of the tag
+        type: string
+        required: false
+
+/connect/interest-tags:
+  /assignments:
+    get:
+      description: API to get record assignments for a tag.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TagRecordAssignmentCollectionRepresentation
+      queryParameters:
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+        orderBy:
+          type: string
+          required: false
+        sort:
+          type: string
+          required: false
+    post:
+      description: API to create tag record assignment.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: InterestTagAssignmentOutputRepresentation
+      body:
+        application/json:
+          type: InterestTagAssignmentInputRepresentation
+          # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          #required: false
+          (oas-body-name): createInterestTagEntityAssignmentData
+    /entity/{recordId}:
+      get:
+        description: Get a list of tags assigned to the given record.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: InterestTagListRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+          sort:
+            type: string
+            required: false
+      uriParameters:
+        recordId:
+          type: string
+          required: true
+    /tag/{tagId}:
+      get:
+        description: API to get record assignments for a tag.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: TagRecordAssignmentCollectionRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          orderBy:
+            type: string
+            required: false
+          sort:
+            type: string
+            required: false
+      post:
+        description: API to create tag record assignment.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: InterestTagAssignmentOutputRepresentation
+        body:
+          application/json:
+            type: InterestTagAssignmentInputRepresentation
+            # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            #required: false
+            (oas-body-name): createInterestTagEntityAssignmentData
+      uriParameters:
+        tagId:
+          type: string
+          required: true
+  /categories:
+    get:
+      description: Get a list of tag categories assigned to an interest tag.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TagCategoryListRepresentation
+      queryParameters:
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+        orderBy:
+          type: string
+          required: false
+        sort:
+          type: string
+          required: false
+        tagId:
+          type: string
+          required: false
+  /tags:
+    delete:
+      description: API to delete interest tags by Ids.
+      responses:
+        '200':
+          description: Success
+      queryParameters:
+        tagIds:
+          type: array
+          required: false
+          items:
+            type: string
+            (oas-collectionFormat): csv
+    get:
+      description: Get a list of tags assigned to the given category.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: InterestTagListRepresentation
+      queryParameters:
+        categoryId:
+          type: string
+          required: false
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+        orderBy:
+          type: string
+          required: false
+        sort:
+          type: string
+          required: false
+    patch:
+      description: API to update an interest tag.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: InterestTagUpdateOutputRepresentation
+      body:
+        application/json:
+          type: InterestTagUpdateInputRepresentation
+          # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          #required: false
+          (oas-body-name): updateInterestTagData
+    # TODO: Hand rolled
+    # post:
+    #   description: API to create interest tag.
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: InterestTagCreateCollectionOutputRepresentation
+    #   body:
+    #     application/json:
+    #       type: InterestTagCreateInputListRepresentation
+    #       # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+    #       #required: false
+    #       (oas-body-name): createInterestTagData
+  /tags/{tagId}:
+    delete:
+      description: API to delete interest tags by Ids.
+      responses:
+        '200':
+          description: Success
+      queryParameters:
+        tagIds:
+          type: array
+          required: false
+          items:
+            type: string
+            (oas-collectionFormat): csv
+    get:
+      description: Get a list of tags assigned to the given category.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: InterestTagListRepresentation
+      queryParameters:
+        categoryId:
+          type: string
+          required: false
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+        orderBy:
+          type: string
+          required: false
+        sort:
+          type: string
+          required: false
+    patch:
+      description: API to update an interest tag.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: InterestTagUpdateOutputRepresentation
+      body:
+        application/json:
+          type: InterestTagUpdateInputRepresentation
+          # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          #required: false
+          (oas-body-name): updateInterestTagData
+    # TODO: Hand rolled
+    # post:
+    #   description: API to create interest tag.
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: InterestTagCreateCollectionOutputRepresentation
+    #   body:
+    #     application/json:
+    #       type: InterestTagCreateInputListRepresentation
+    #       # TODO: Hand-rolled W-8334626 due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+    #       #required: false
+    #       (oas-body-name): createInterestTagData
+    uriParameters:
+      tagId:
+        type: string
+        required: true
+  /tags-and-categories:
+    post:
+      displayName: postInterestTagAndCategory
+      description: API to create interest tags and categories together.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: InterestTagAndCategoryCreateOutputRepresentation
+      body:
+        application/json:
+          type: InterestTagAndCategoryCreateInputRepresentation
+          (oas-body-name): createInterestTagAndCategoryData

package/src/raml/luvio.raml

@@ -0,0 +1,53 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'interesttagging'
+(luvio.ttl): 360000
+
+types:
+  InterestTagListRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 10000
+  InterestTagAssignmentOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 10000
+    (luvio.key):
+      errors: errors
+      isCreated: isCreated
+      isSuccess: isSuccess
+  InterestTagAndCategoryCreateOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 10000
+    (luvio.key):
+      isSuccess: isSuccess
+
+/connect/interest-tags:
+  /assignments:
+    post:
+      description: assign tags to an entity or assign entities to a tag
+      (luvio.adapter):
+        name: createInterestTagEntityAssignment
+  /assignments/entity/{recordId}:
+    get:
+      (luvio.adapter):
+        name: getTagsByRecordId
+  /assignments/tag/{tagId}:
+    get:
+      (luvio.adapter):
+        name: getInterestTagEntityAssignments
+  /tags:
+    get:
+      (luvio.adapter):
+        name: getTagsByCategoryId
+  /categories:
+    get:
+      (luvio.adapter):
+        name: getTagCategoriesByTagId
+  /tags-and-categories:
+    post:
+      description: create interest tags and categories together
+      (luvio.adapter):
+        name: createInterestTagsAndCategories