@salesforce/lds-adapters-service-serviceemployee 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,690 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.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:
+  AvailableUserOptionsInputRepresentation:
+    description: Input representation of payload for getting all user Settings List
+    type: object
+    properties:
+      permissionSets?:
+        description: The permissionSets to filter the get call
+        type: PermissionSetsInputRepresentation
+      profiles?:
+        description: The profile licenses to filter the get call
+        type: LicenseDetailsInputRepresentation
+  AvailableUserOptionsOutputRepresentation:
+    description: Output representation of AvailableUserOptions
+    type: object
+    properties:
+      emailEncodings:
+        description: List of emailEncodings
+        type: array
+        items:
+          type: EmailEncodingDetailsRepresentation
+      permissionSetGroups?:
+        description: List of Permission Set Groups
+        type: array
+        items:
+          type: PermissionSetGroupsDetailsRepresentation
+      permissionSets?:
+        description: List of permissionSets
+        type: array
+        items:
+          type: PermissionSetsDetailsRepresentation
+      profiles:
+        description: List of profiles
+        type: array
+        items:
+          type: ProfileDetailsRepresentation
+      employeeStatuses:
+        description: List of employee status
+        type: array
+        items:
+          type: string
+  EmailEncodingDetailsRepresentation:
+    description: Output representation for email emailEncodings for available user options
+    type: object
+    properties:
+      value:
+        description: The Value of the Email encoding
+        type: string
+      label:
+        description: The Label of the Email encoding
+        type: string
+  EmployeeProfileCardFieldValueOutputRepresentation:
+    description: Output representation to show field name, field value, display name,
+      field type of a compact layout on an entity on employee profile card
+    type: object
+    properties:
+      displayName:
+        description: display name based of the field on the given compact layout
+        type: string
+      fieldName:
+        description: field name based on the given compact layout
+        type: string
+      fieldType:
+        description: field type based on the given compact layout
+        type: string
+      fieldValue:
+        description: field value of the field name based on the given compact layout
+        type: string | nil # TODO Hand-rolled W-15814029
+  EmployeeProfileCardInputListRepresentation:
+    description: Input representation to fetch details for the given list of compact
+      layout
+    type: object
+    properties:
+      fieldDetails:
+        description: List of compact layout to fetch field details
+        type: array
+        items:
+          type: any # TODO Hand-rolled W-15814029
+      objectId:
+        description: Account id
+        type: string
+  EmployeeProfileCardInputRepresentation:
+    description: Input representation to fetch field details for a given compact layout
+    type: object
+    properties:
+      objectName:
+        description: Entity name for the given compact layout
+        type: string
+      type:
+        description: Type to fetch the field details from compact layout
+        type: string
+      typeId:
+        description: Id of the given compact layout
+        type: string
+  EmployeeProfileCardListOutputRepresentation:
+    description: Output representation to show list of field value of a given compact
+      layout on an entity on employee profile card
+    type: object
+    properties:
+      fieldValueDataList:
+        description: field value data list for employee profile card
+        type: array
+        items:
+          type: EmployeeProfileCardOutputRepresentation
+      status:
+        description: status of api for employee profile card
+        type: EmployeeProfileCardStatusOutputRepresentation
+  EmployeeProfileCardOutputRepresentation:
+    description: Output representation to show field value of a given compact layout
+      on an entity on employee card
+    type: object
+    properties:
+      entityName:
+        description: entity name of the given compact layout
+        type: string
+      fieldValueData:
+        description: field value data for the given compact layout
+        type: array
+        items:
+          type: EmployeeProfileCardFieldValueOutputRepresentation
+  EmployeeProfileCardStatusOutputRepresentation:
+    description: Output representation to show status and message for the api call
+    type: object
+    properties:
+      code:
+        description: get status code
+        type: integer
+      message:
+        description: get status message
+        type: string
+  EmployeeUserProvisioningJobInputRepresentation:
+    description: Input representation for creating a provisioning job
+    type: object
+    properties: {}
+  EmployeeUserProvisioningJobOutputRepresentation:
+    description: Output representation of creating a provisioning job
+    type: object
+    properties:
+      provisioningJobId:
+        description: Provisioning Job Id
+        type: string
+  GenericResultRepresentation:
+    description: Output representation of updating User Settings for Employee Service
+    type: object
+    properties:
+      statusCode:
+        description: The details of the status
+        type: string | nil
+      statusMessage:
+        description: The details of the status message
+        type: string | nil
+  LicenseDetailsInputRepresentation:
+    description: Input representation of payload for license as a filter criteria for profiles
+    type: object
+    properties:
+      licenses:
+        description: The licenses to be fed to filter the get call for profiles
+        type: array
+        items:
+          type: string
+  PermissionDetailsRepresentation:
+    description: Output representation of a Permission Details
+    type: object
+    properties:
+      description?:
+        description: The description of the permission
+        type: string
+      label?:
+        description: The label of the permission
+        type: string
+      permissionId?:
+        description: The permission id of the permission
+        type: string
+      permissionName?:
+        description: The permission name of the permission
+        type: string
+  PermissionSetsInputRepresentation:
+    description: Input representation of payload for Permission Sets
+    type: object
+    properties:
+      licenses:
+        description: The licenses to be fed to filter the get call for Permission
+          Sets
+        type: array
+        items:
+          type: string
+  PermissionSetGroupsDetailsRepresentation:
+    description: Output representation of a Permission Set Groups Details
+    type: object
+    properties:
+      id:
+        description: The Id of the permission set group
+        type: string
+      label:
+        description: The Label of the permission set group
+        type: string
+      name:
+        description: The Name of the permission set group
+        type: string
+  PermissionSetsDetailsRepresentation:
+    description: Output representation of a Permission Set Details
+    type: object
+    properties:
+      id:
+        description: The Id of the permission set
+        type: string
+      label:
+        description: The Label of the permission set
+        type: string
+      licenseId:
+        description: The LicenseId of the permission set
+        type: string
+      name:
+        description: The Name of the permission set
+        type: string
+      profileId:
+        description: The profile id of the profile linked to permission set
+        type: string
+  ProfileDetailsRepresentation:
+    description: Output representation of profile
+    type: object
+    properties:
+      licenseId?:
+        description: The LicenseId of the profile
+        type: string | nil
+      licenseName?:
+        description: The LicenseName of the profile
+        type: string | nil
+      profileId?:
+        description: The profile id of the profile
+        type: string | nil
+      profileName?:
+        description: The profile name of the profile
+        type: string | nil
+  UserProfileInputRepresentation:
+    description: Input representation of user profile for portal
+    type: object
+    properties:
+      userProfileEntity:
+        description: set the entity level information
+        type: array
+        items:
+          type: any
+  UserProfileFieldsInputRepresentation:
+    description: Input representation of user profile fields for portal
+    type: object
+    properties:
+      fieldApiName:
+        description: set the fieldAPIName for each field
+        type: string
+  UserProfileOutputRepresentation:
+    description: Output representation of user profile for portal
+    type: object
+    properties:
+      profileDetails:
+        description: set the profile details
+        type: array
+        items:
+          type: UserProfileDetailOutputRepresentation
+      status:
+        description: set the status
+        type: ServiceEmployeeStatusOutputRepresentation
+  UserProfileDetailOutputRepresentation:
+    description: Output representation to get the object level information for the entities chosen in user profile.
+    type: object
+    properties:
+      objectName:
+        description: set the object name
+        type: string
+      fieldData:
+        description: set the field data for this object
+        type: array
+        items:
+          type: any
+  ServiceEmployeeStatusOutputRepresentation:
+    description: Status code for fetch of user profile for portal
+    type: object
+    properties:
+      code:
+        description: set the status code
+        type: integer
+      message:
+        description: set the message
+        type: string
+  UserProfileEntitySelectionInputRepresentation:
+    description: Input representation of user profile for portal
+    type: object
+    properties:
+      objectName:
+        description: set the intents for deriving recommendations
+        type: string
+      fields:
+        description: set the intents for deriving recommendations
+        type: array
+        items:
+          type: any
+  UserSettingsInputRepresentation:
+    description: Input representation for User settings for Emp2+PA user creation
+    type: object
+    properties:
+      autoCreateFlag?:
+        description: The property to set the auto create flag for the Emp2+PA user
+          creation
+        type: boolean
+      autoDeactivateFlag?:
+        description: The property to set the auto deactivate flag for the Emp2+PA
+          user creation
+        type: boolean
+      domain?:
+        description: The property to set the domain for the Emp2+PA user creation
+        type: string
+      emailEncoding?:
+        description: The property to set the Email Encoding for the Emp2+PA user creation
+        type: string
+      permissionId?:
+        description: The property to set the permission set Id for the Emp2+PA user
+          creation
+        type: string
+      profileId?:
+        description: The property to set the profile id flag for the Emp2+PA user
+          creation
+        type: string
+      syncEmployee2Users?:
+        description: The property to set the sync Employee2 users flag for the Emp2+PA
+          user creation
+        type: boolean
+      employeeStatus?:
+        description: Employee Status
+        type: string
+      sourceOfInvocation?:
+        description: The property to set the source of user setting page
+        type: string
+  UserSettingsOutputRepresentations:
+    description: Output representation of User Settings for Employee Service
+    type: object
+    properties:
+      autoCreateFlag?:
+        description: The details of the auto create flag
+        type: boolean
+      autoDeactivateFlag?:
+        description: The details of the auto deactivate flag
+        type: boolean
+      domain?:
+        description: The details of the domain
+        type: string | nil
+      emailEncoding?:
+        description: The details of the Email encoding
+        type: string
+      permissionSetDetailsRepresentation?:
+        description: The details of the permission sets
+        type: PermissionDetailsRepresentation | nil
+      profileDetailsRepresentation?:
+        description: The details of the profile
+        type: ProfileDetailsRepresentation | nil
+      syncEmployee2Users:
+        description: The flag for the sync of Employee2 users
+        type: boolean
+      employeeStatus?:
+        description: Employee Status
+        type: string | nil
+  EnablementProgramItemDetailsOutputRepresentation:
+    description: Abstract Enablement Program Summary item representation
+    discriminator: type
+    type: object
+    properties:
+      description:
+        description: Description of the enablement program summary item
+        type: string
+      id:
+        description: Id of the enablement program summary item
+        type: string
+      sequenceNumber:
+        description: Sequence Number of the enablement task
+        type: integer
+      title:
+        description: Title of the enablement program summary item
+        type: string
+      type:
+        description: Type of enablement program summary item
+        type: string
+        enum:
+          - Milestone
+          - Section
+          - Task
+  EnablementProgramListOutputRepresentation:
+    description: List of Employee Enablement Program Summary Representations
+    type: object
+    properties:
+      hasMore:
+        description: Indicates if there are more programs available than the results
+          returned
+        type: boolean
+      programSummaryList:
+        description: List of employee enablement program summaries
+        type: array
+        items:
+          type: EnablementProgramOutputRepresentation
+      status:
+        description: 'status of api for employee enablement program list '
+        type: EnablementProgramListStatusOutputRepresentation
+  EnablementProgramListStatusOutputRepresentation:
+    description: Output representation to show status and message for the api call
+    type: object
+    properties:
+      code:
+        description: get status code
+        type: integer
+      message:
+        description: get status message
+        type: string
+  EnablementProgramOutputRepresentation:
+    description: Enablement Program Summary Representation
+    type: object
+    properties:
+      assigneeId:
+        description: Assignee of associated with the Program if applicable
+        type: string | nil
+      collaboratorPersona:
+        description: Collaborator persona details.
+        type: ProgramPersonaOutputRepresentation | nil
+      completedDate:
+        description: Completed date of the enablement program for the current user
+        type: string | nil
+      completedPercent:
+        description: Percent complete of the enablement program for the current user
+        format: double
+        type: number
+      description:
+        description: Description of the enablement program
+        type: string | nil
+      doesAllowSelfEnrollment:
+        description: Does the program allow self enrollment
+        type: boolean | nil
+      dueDate:
+        description: Due date for enablement program.
+        type: string | nil
+      id:
+        description: Id of the enablement program
+        type: string
+      isCompleted:
+        description: Indicates if the current user has completed the enablement program
+        type: boolean
+      isOverdue:
+        description: Indicates if the current user is overdue on the enablement program
+        type: boolean
+      items:
+        description: List of items for the enablement program
+        type: array
+        items:
+          # type: EnablementProgramItemDetailsOutputRepresentation
+          type: any
+      learningItemId:
+        description: Learning Item Id of the enablement program
+        type: string | nil
+      networkId:
+        description: Network ID of associated with the Program if applicable
+        type: string | nil
+      programEnrollmentType:
+        description: Enrollment type of the program like assigned and self enrolled
+        type: string | nil
+      programOverAllStatus:
+        description: Status of the program like Assigned InProgress
+        type: string | nil
+      programType:
+        description: The type of enablement program
+        type: string
+        enum:
+          - EmployeeServiceEnablement
+          - Enablement
+          - PtnrEnablement
+      status:
+        description: Status of the enablement program
+        type: string
+        enum:
+          - Archived
+          - Draft
+          - Published
+      systemModstamp:
+        description: System modification timestamp of the enablement program
+        type: string | nil
+      title:
+        description: Name of the enablement program
+        type: string | nil
+  EnablementProgramSectionOutputRepresentation:
+    description: Enablement program section with multiple tasks.
+    discriminatorValue: Section
+    type: EnablementProgramItemDetailsOutputRepresentation
+    properties:
+      tasks:
+        description: List of tasks for the enablement program section
+        type: array
+        items:
+          type: EnablementProgramTaskOutputRepresentation
+  EnablementProgramTaskOutputRepresentation:
+    description: Representation of enablement program task.
+    discriminatorValue: Task
+    type: EnablementProgramItemDetailsOutputRepresentation
+    properties:
+      completedDate:
+        description: The date the item was completed
+        type: string | nil
+      dueDate:
+        description: Due date for the current assignment
+        type: string | nil
+      isOverdue:
+        description: Indicates if the item is overdue or not
+        type: boolean | nil
+      learningItemId:
+        description: Learning Item Id of the enablement task
+        type: string | nil
+      personaConfig:
+        description: Metadata for the persona this task is assigned to.
+        type: object
+        properties:
+          //:
+            type: object
+      programDay:
+        description: The day the program task is due
+        type: integer
+      taskCategory:
+        description: Category Type of the enablement task
+        type: string
+        enum:
+          - Exercise
+          - Milestone
+      taskSubCategory:
+        description: Sub Category Type of the enablement task
+        type: string
+  ProgramPersonaOutputRepresentation:
+    description: Enablement program Collaborator Persona.
+    discriminatorValue: Persona
+    type: object
+    properties:
+      name:
+        description: Name of the Collaborator
+        type: string | nil
+      persona:
+        description: Persona of the Collaborator
+        type: string | nil
+      userId:
+        description: UserId of the Collaborator
+        type: string | nil
+/connect:
+  /employee-hub/employee-profile-card/employee-details:
+    post:
+      displayName: postEmployeeCard
+      description: method for fetching the field details from a given compact layout
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EmployeeProfileCardListOutputRepresentation
+      body:
+        application/json:
+          type: EmployeeProfileCardInputListRepresentation
+          # TODO Hand-rolled W-15814029, removed 'required: false'
+          (oas-body-name): employeeProfileCardInputList
+  /employee-hub/profile/user/{userId}:
+    post:
+      displayName: getUserProfileDetails
+      description: Method for fetching the field details from a given set of entities and corresponding fields
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: UserProfileOutputRepresentation
+      body:
+        application/json:
+          type: UserProfileInputRepresentation
+          (oas-body-name): userProfile
+  /employee/enablement/programs:
+    get:
+      displayName: getEmployeeEnablementPrograms
+      description: Enablement Program Summary Collection
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EnablementProgramListOutputRepresentation
+      queryParameters:
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+        statusFilter:
+          type: array
+          required: false
+          items:
+            type: string
+            enum:
+              - All
+              - Assigned
+              - AvailableForSelfEnrollment
+              - Completed
+              - InProgress
+              - SelfEnrolled
+            (oas-collectionFormat): csv
+        userIds:
+          type: array
+          required: false
+          items:
+            type: string
+            (oas-collectionFormat): csv
+  /service-employee:
+    /employee-user-provisioning:
+      post:
+        displayName: postEmployeeUserProvisioningJob
+        description: API resource to initiate employee user provisioning
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EmployeeUserProvisioningJobOutputRepresentation
+        body:
+          application/json:
+            type: EmployeeUserProvisioningJobInputRepresentation
+            (oas-body-name): initiateEmpUserProvisioningInputRepresentation
+    /user-settings:
+      patch:
+        displayName: updateUserSettings
+        description: API to update user settings for creating user from EMP2 +PA
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GenericResultRepresentation
+        body:
+          application/json:
+            type: UserSettingsInputRepresentation
+            (oas-body-name): userSettingsInputReq
+    /user-settings/details:
+      get:
+        displayName: getUserSettings
+        description: API to get User setting for creating user from EMP2 +PA
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: UserSettingsOutputRepresentations
+        queryParameters:
+          sourceOfInvocation:
+            type: string
+            required: false
+  /serviceEmployee/availableUserOptions:
+    post:
+      displayName: availableUserOptions
+      description: API resource to get all user Settings to be filled by admin for User provisioning
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AvailableUserOptionsOutputRepresentation
+      body:
+        application/json:
+          type: AvailableUserOptionsInputRepresentation
+          (oas-body-name): availableUserOptions