@salesforce/lds-adapters-platform-sharing 1.279.0

package/src/raml/api.raml

@@ -0,0 +1,689 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v61.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:
+  AccessLevelFieldRepresentation:
+    description: Representation of an access level field.
+    type: object
+    properties:
+      entityAccessLevelLabel:
+        description: The entity access level label.
+        type: string
+      entityApiName:
+        description: The entity api name.
+        type: string
+      externalAccess:
+        description: The field external access level options.
+        type: array
+        items:
+          type: string
+      internalAccess:
+        description: The field internal access level options.
+        type: array
+        items:
+          type: string
+  AccessLevelRepresentation:
+    description: Representation of an Access Level for the Sharing Expand List Page
+    type: object
+    properties:
+      label:
+        description: The object access level label
+        type: string
+      objectApiName:
+        description: The object's apiName
+        type: string
+      objectLabel:
+        description: The user's access level to this object
+        type: string
+  GroupCollectionRepresentation:
+    description: Representation of a collection of Groups that includes Queues and
+      Public Group Types.
+    type: object
+    properties:
+      publicGroupRepresentations:
+        description: The list of Public Groups.
+        type: array
+        items:
+          type: PublicGroupRepresentation
+      queueRepresentations:
+        description: The list of Queues.
+        type: array
+        items:
+          type: QueueRepresentation
+  IncludedGroupsSharingRepresentation:
+    description: Output representation of included public groups where given group
+      is member
+    type: object
+    properties:
+      createdBy:
+        description: Included Groups Created By.
+        type: string
+      createdOn:
+        description: Included Groups Created Timestamp
+        type: string
+      developerName:
+        description: Included Groups Developer name.
+        type: string
+      grantAccessHierarchies:
+        description: Information for Grant Access Using Hierarchies
+        type: boolean
+      label:
+        description: Group label.
+        type: string
+  ListViewGroupSharingRepresentation:
+    description: Output representation of an list views shared with public group.
+    type: object
+    properties:
+      developerName:
+        description: List view developer name.
+        type: string
+      label:
+        description: List view label.
+        type: string
+  PublicGroupRepresentation:
+    description: Output representation of an instance of a PublicGroup for a given
+      user.
+    type: object
+    properties:
+      developerName:
+        description: The API name of the Public Group.
+        type: string
+      includeBosses:
+        description: The Grant Access Using Hierarchy status of the Public Group.
+        type: boolean
+      name:
+        description: The name of the Public Group.
+        type: string
+  PublicGroupSummaryInputRepresentation:
+    description: Input representation for public group summary.
+    type: object
+    properties:
+      entityKeyPrefix:
+        description: The entity key prefix
+        type: string
+      groupId:
+        description: The group id for which data needs to be fetched
+        type: string
+      limit:
+        description: Limit param
+        type: integer
+      offset:
+        description: Offset param
+        type: integer
+      operation:
+        description: Data required for which tab
+        type: string
+  PublicGroupSummaryRepresentation:
+    description: Parent output representation for all form of data emitted by this
+      API
+    type: object
+    properties:
+      includedGroupsSharing:
+        description: Included In Public Groups
+        type: array
+        items:
+          type: IncludedGroupsSharingRepresentation
+      listViewGroupSharing:
+        description: Output response data for list view tab
+        type: array
+        items:
+          type: ListViewGroupSharingRepresentation
+      reportAndDashboardFolderGroupSharing:
+        description: Report and Dashboard Folder shared with a group
+        type: array
+        items:
+          type: ReportAndDashboardFolderGroupSharingRepresentation
+      sharingRulesCriteriaGroupSharing:
+        description: Output response data for criteria based sharing rules tab
+        type: array
+        items:
+          type: SharingRulesCriteriaGroupSharingRepresentation
+      sharingRulesOwnerGroupSharing:
+        description: Output response data for owner based sharing rules tab
+        type: array
+        items:
+          type: SharingRulesOwnerGroupSharingRepresentation
+  QueueRepresentation:
+    description: Output representation of an instance of a Queue for a given user.
+    type: object
+    properties:
+      developerName:
+        description: The API name of the queue.
+        type: string
+      name:
+        description: The name of the Queue.
+        type: string
+  RecordAccessDetailRepresentation:
+    description: Representation of a record access detail.
+    type: object
+    properties:
+      recordId:
+        description: Unique identifier for record
+        type: string
+      sharingReasons:
+        description: List of sharing reasons
+        type: array
+        items:
+          type: SharingReasonRepresentation
+      userId:
+        description: Unique identifier for user
+        type: string
+  RecordUserAccessCollectionRepresentation:
+    description: Representation of a collection of record user accesses.
+    type: object
+    properties:
+      currentPageUrl:
+        description: URL to the current page of access.
+        type: string
+      nextPageUrl:
+        description: URL to the next page of access.
+        type: string
+      previousPageUrl:
+        description: URL to the previous page of access.
+        type: string
+      recordId:
+        description: Record Id
+        type: string
+      recordUserAccesses:
+        description: The list of user record accesses
+        type: array
+        items:
+          type: RecordUserAccessRepresentation
+  RecordUserAccessRepresentation:
+    description: Representation of a RecordUserAccess for the Sharing Expand List
+      Page
+    type: object
+    properties:
+      accessLevels:
+        description: A list of access levels the user has for this entity and related
+          entities
+        type: array
+        items:
+          type: AccessLevelRepresentation
+      user:
+        description: The user of this record user access
+        type: UserOrGroupRepresentation
+  ReportAndDashboardFolderGroupSharingRepresentation:
+    description: Output representation of report and dashboard folders shared with
+      a public group.
+    type: object
+    properties:
+      accessLevel:
+        description: Report and Dashboard Folder Access Level.
+        type: string
+      createdBy:
+        description: Report and Dashboard Folder Created By.
+        type: string
+      createdOn:
+        description: Report and Dashboard Folder Created Date.
+        type: string
+      developerName:
+        description: Report and Dashboard Folder Developer Name.
+        type: string
+      label:
+        description: Report and Dashboard Folder label.
+        type: string
+      type:
+        description: Report and Dashboard Folder type. It can be either 'Report' or
+          'Dashboard'.
+        type: string
+  ShareAccessLevelRepresentation:
+    description: Representation of a share access level per entity.
+    type: object
+    properties:
+      accessLevelFields:
+        description: The access level fields.
+        type: object
+        properties:
+          //:
+            type: AccessLevelFieldRepresentation
+      accessLevelOptions:
+        description: The access level options.
+        type: object
+        properties:
+          //:
+            type: string
+  ShareRelationshipArrayRepresentation:
+    description: Representation of a share relationship array.
+    type: object
+    properties:
+      path:
+        description: Share relationships array.
+        type: array
+        items:
+          type: ShareRelationshipRepresentation
+  ShareRelationshipCollectionRepresentation:
+    description: Representation of a share relationship collection.
+    type: object
+    properties:
+      relationships:
+        description: Share relationships.
+        type: array
+        items:
+          type: ShareRelationshipRepresentation
+  ShareRelationshipRepresentation:
+    description: Representation of a share relationship.
+    type: object
+    properties:
+      developerName:
+        description: Developer name.
+        type: string
+      id:
+        description: Id.
+        type: string
+      type:
+        description: Relationship type.
+        type: string
+  SharingReasonRepresentation:
+    description: Representation of a sharing reason.
+    type: object
+    properties:
+      accessLevel:
+        description: Level of Access.
+        type: string
+      reasonForAccess:
+        description: Reason for access.
+        type: string
+      relationship:
+        description: Relationship to the share recipient.
+        type: string
+      relationshipPaths:
+        description: Share relationship map.
+        type: array
+        items:
+          type: ShareRelationshipArrayRepresentation
+      shareRecipient:
+        description: Share recipient.
+        type: UserOrGroupRepresentation
+  SharingRuleCollectionRepresentation:
+    description: Representation of a collection of sharing rule.
+    type: object
+    properties:
+      sharingRuleRepresentations:
+        description: The list of sharing rules.
+        type: array
+        items:
+          type: SharingRuleRepresentation
+  SharingRuleRepresentation:
+    description: Output representation of an instance of a sharing rule for a given
+      entity.
+    type: object
+    properties:
+      caseChildAccessLevel:
+        description: The case child access level of the sharing rule, this field is
+          only available for the Account entity.
+        type: string
+      conChildAccessLevel:
+        description: The contact child access level of the sharing rule, this field
+          is only available for the Account entity.
+        type: string
+      description:
+        description: The description of the sharing rule.
+        type: string
+      id:
+        description: The id of the sharing rule.
+        type: string
+      label:
+        description: The label of the sharing rule.
+        type: string
+      mainAccessLevel:
+        description: The main access level of the sharing rule.
+        type: string
+      name:
+        description: The API name of the sharing rule.
+        type: string
+      oppChildAccessLevel:
+        description: The opportunity child access level of the sharing rule, this
+          field is only available for the Account entity.
+        type: string
+      ruleType:
+        description: Sharing rule type
+        type: string
+        enum:
+          - Criteria
+          - Owner
+      sharedFrom:
+        description: User Role or Group that this sharing rule will share from.
+        type: UserOrGroupRepresentation
+      sharedWith:
+        description: User Role or Group that this sharing rule will share with.
+        type: UserOrGroupRepresentation
+  SharingRulesCriteriaGroupSharingRepresentation:
+    description: Output representation of criteria based sharing rules shared with
+      public group.
+    type: object
+    properties:
+      accessLevel:
+        description: Criteria Sharing Rule accessLevel.
+        type: string
+      criteria:
+        description: Sharing Rule criteria
+        type: string
+      developerName:
+        description: Criteria Sharing Rule developer name.
+        type: string
+      label:
+        description: Criteria Sharing Rule label.
+        type: string
+  SharingRulesOwnerGroupSharingRepresentation:
+    description: Output representation of owner based sharing rules shared with public
+      group.
+    type: object
+    properties:
+      accessLevel:
+        description: Owner Sharing Rule accesslevel.
+        type: string
+      developerName:
+        description: Owner Sharing Rule developer name.
+        type: string
+      label:
+        description: Owner Sharing Rule label.
+        type: string
+      sharedFrom:
+        description: Owner Sharing Rule shared from group.
+        type: string
+  SupportedObjectListRepresentation:
+    description: Representation of a list of supported objects
+    type: object
+    properties:
+      supportedObjectList:
+        description: The list of objects supported by the share-access-levels API.
+        type: array
+        items:
+          type: string
+  UserOrGroupRepresentation:
+    description: Representation of user or group with whom an object can be shared.
+    type: object
+    properties:
+      id:
+        description: Id of a user or group.
+        type: string
+      name:
+        description: Name of a user or group.
+        type: string
+  UserOrGroupTypeRepresentation:
+    description: Representation of an instance of a folder share recipient.
+    type: object
+    properties:
+      label:
+        description: The label of the user or group type.
+        type: string
+      sharingModelType:
+        description: The sharing model of user or group type
+        type: string
+      userOrGroupType:
+        description: The user or group type.
+        type: string
+        enum:
+          - AccountRelationshipGroup
+          - AllCustomerPortal
+          - ChannelProgramGroup
+          - CollaborationGroup
+          - CustomerPortalUser
+          - GuestUserGroup
+          - LicenseManagerUser
+          - LitePortalUserAccessGroup
+          - MLMyTeam
+          - Manager
+          - ManagerAndSubordinatesInternal
+          - Organization
+          - PRMOrganization
+          - PardotUserGroup
+          - PardotUserRestrictedGroup
+          - Participant
+          - PartnerNetworkConnection
+          - PartnerUser
+          - Personal
+          - PortalRoleAt
+          - PortalRoleDown
+          - Queue
+          - Regular
+          - Role
+          - RoleAndSubordinates
+          - RoleAndSubordinatesInternal
+          - SharingRecordCollGroup
+          - SharingRuleGroup
+          - Sites
+          - Territory
+          - TerritoryAndSubordinates
+          - User
+  UserOrGroupTypesCollectionRepresentation:
+    description: Representation of a collection of user or group types.
+    type: object
+    properties:
+      userOrGroupTypes:
+        description: The list of user or group types.
+        type: array
+        items:
+          type: UserOrGroupTypeRepresentation
+  UsersOrGroupsCollectionRepresentation:
+    description: Representation of a collection of users and/or groups.
+    type: object
+    properties:
+      usersOrGroups:
+        description: The list of users and/or groups.
+        type: array
+        items:
+          type: UserOrGroupRepresentation
+/sharing:
+  /groups-for-user/{userId}/{groupType}:
+    get:
+      displayName: getGroup
+      description: Get the collection of groups
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: GroupCollectionRepresentation
+      queryParameters:
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+    uriParameters:
+      groupType:
+        type: string
+        required: true
+      userId:
+        type: string
+        required: true
+  /publicGroupsSummary:
+    post:
+      displayName: postPublicGroupSummary
+      description: Gets the for public groups summary based on operation type
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PublicGroupSummaryRepresentation
+      body:
+        application/json:
+          type: PublicGroupSummaryInputRepresentation
+          (oas-body-name): publicGroup
+  /record-access-detail/{recordId}/{userId}:
+    get:
+      displayName: getRecordAccessDetail
+      description: Get record access details.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecordAccessDetailRepresentation
+      queryParameters:
+        displayRelationshipPaths:
+          type: boolean
+          required: false
+          default: false
+        maxReasons:
+          type: integer
+          required: false
+    uriParameters:
+      recordId:
+        type: string
+        required: true
+      userId:
+        type: string
+        required: true
+  /rules/{entityApiName}:
+    get:
+      displayName: getSharingRules
+      description: Get the collection of sharing rules
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SharingRuleCollectionRepresentation
+      queryParameters:
+        ruleType:
+          type: string
+          required: false
+          enum:
+            - Criteria
+            - Owner
+    uriParameters:
+      entityApiName:
+        type: string
+        required: true
+  /share-access-levels:
+    get:
+      displayName: getShareAccessLevelList
+      description: Get the list of objects supported for manual sharing in LEX
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SupportedObjectListRepresentation
+  /share-access-levels/{objectApiName}:
+    get:
+      displayName: getShareAccessLevel
+      description: Get the share access level per object.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ShareAccessLevelRepresentation
+    uriParameters:
+      objectApiName:
+        type: string
+        required: true
+  /user-or-group-types:
+    get:
+      displayName: getUserOrGroupTypesCollection
+      description: Get the user or group types.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: UserOrGroupTypesCollectionRepresentation
+  /users-or-groups:
+    get:
+      displayName: getUsersOrGroupsCollection
+      description: Get the users or groups an object can be shared with.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: UsersOrGroupsCollectionRepresentation
+      queryParameters:
+        limit:
+          type: integer
+          required: false
+        op:
+          type: string
+          required: false
+        parentId:
+          type: string
+          required: false
+        q:
+          type: string
+          required: false
+        shareToType:
+          type: string
+          required: false
+          enum:
+            - AccountRelationshipGroup
+            - AllCustomerPortal
+            - ChannelProgramGroup
+            - CollaborationGroup
+            - CustomerPortalUser
+            - GuestUserGroup
+            - LicenseManagerUser
+            - LitePortalUserAccessGroup
+            - MLMyTeam
+            - Manager
+            - ManagerAndSubordinatesInternal
+            - Organization
+            - PRMOrganization
+            - PardotUserGroup
+            - PardotUserRestrictedGroup
+            - Participant
+            - PartnerNetworkConnection
+            - PartnerUser
+            - Personal
+            - PortalRoleAt
+            - PortalRoleDown
+            - Queue
+            - Regular
+            - Role
+            - RoleAndSubordinates
+            - RoleAndSubordinatesInternal
+            - SharingRecordCollGroup
+            - SharingRuleGroup
+            - Sites
+            - Territory
+            - TerritoryAndSubordinates
+            - User
+  /{recordId}/user-access-levels:
+    get:
+      displayName: getRecordUserAccessCollection
+      description: Get Record User Accesses for ${recordId}
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecordUserAccessCollectionRepresentation
+      queryParameters:
+        page:
+          type: integer
+          required: false
+        pageSize:
+          type: integer
+          required: false
+    uriParameters:
+      recordId:
+        type: string
+        required: true