@salesforce/lds-adapters-uiapi 1.231.0 → 1.232.0

package/src/raml/api.raml

@@ -2,11 +2,11 @@
 securedBy:
   - OAuth2
 title: Salesforce Connect API
-version: '57.0'
+version: '60.0'
 mediaType: application/json
 protocols:
   - https
-baseUri: /services/data/v59.0
+baseUri: /services/data/v60.0
 securitySchemes:
   OAuth2:
     type: OAuth 2.0
@@ -49,6 +49,7 @@ types:
           - LeadStatus
           - OpportunityStage
           - Standard
+          - WorkStepStatus
   AbstractRecordAvatarRepresentation:
     description: Represents an avatar associated to a record.
     discriminator: type
@@ -83,35 +84,25 @@ types:
           - Field
           - ReportChart
           - VisualforcePage
-  ActionOverrideRepresentation: # TODO: Handrolled
-    type: object
-    description: Connect API representation of a action override result
-    properties:
-      records:
-        description: Flexi page records
-        type: object
-  ActionRelatedListSingleBatchInputRepresentation:
+  ActionInputRepresentation:
     description: Query (using POST) for actions in multiple related lists.
     type: object
     properties:
       actionTypes:
-        description: The list of action types on the Related List
+        description: The list of action types
         type: array
         required: false #TODO: handrolled W-11898355
         items:
           type: string
       apiNames:
-        description: The API names of the actions on the Related List
+        description: The API names of the actions
         type: array
         required: false #TODO: handrolled W-11898355
         items:
           type: string
       formFactor:
         description: Required form factor.
-        type: string
         required: false #TODO: handrolled W-11898355
-      relatedListId:
-        description: The identifier for this related list.
         type: string
       retrievalMode:
         description: RetrievalMode used to fetch actions.
@@ -123,25 +114,35 @@ types:
         required: false #TODO: handrolled W-11898355
         items:
           type: string
-  ActionInputRepresentation:
+  ActionOverrideRepresentation: # TODO: Handrolled
+    type: object
+    description: Connect API representation of a action override result
+    properties:
+      records:
+        description: Flexi page records
+        type: object
+  ActionRelatedListSingleBatchInputRepresentation:
     description: Query (using POST) for actions in multiple related lists.
     type: object
     properties:
       actionTypes:
-        description: The list of action types
+        description: The list of action types on the Related List
         type: array
         required: false #TODO: handrolled W-11898355
         items:
           type: string
       apiNames:
-        description: The API names of the actions
+        description: The API names of the actions on the Related List
         type: array
         required: false #TODO: handrolled W-11898355
         items:
           type: string
       formFactor:
         description: Required form factor.
+        type: string
         required: false #TODO: handrolled W-11898355
+      relatedListId:
+        description: The identifier for this related list.
         type: string
       retrievalMode:
         description: RetrievalMode used to fetch actions.
@@ -282,7 +283,7 @@ types:
         type: string | nil # TODO Hand rolled
       description:
         description: Description for the app
-        type: string | nil
+        type: string | nil # TODO Hand rolled
       developerName:
         description: Unique developer name of the app
         type: string
@@ -308,7 +309,8 @@ types:
         description: Nav personalization setting
         type: boolean
       isNavTabPersistenceDisabled:
-        description: Indicates if the Lightning Console App should persist a user's workspace tabs
+        description: Indicates if the Lightning Console App should persist a user's
+          workspace tabs
         type: boolean
       label:
         description: Label of the app
@@ -379,6 +381,34 @@ types:
         description: The Profile Name
         type: string
         required: false # TODO: hand rolled
+  BatchInputRepresentation:
+    description: Batch Operations on Records.
+    type: object
+    properties:
+      allOrNone:
+        description: Set allOrNone param
+        type: boolean
+      operations:
+        description: Set operations
+        type: array
+        items:
+          type: object
+  BatchOperationInputRepresentation:
+    description: Batch operation.
+    type: object
+    properties:
+      records:
+        description: Set records param
+        type: array
+        items:
+          type: object
+      type:
+        description: Set records param
+        type: string
+        enum:
+          - Create
+          - Delete
+          - Update
   CanvasLayoutComponentRepresentation:
     description: Canvas record layout component.
     discriminatorValue: Canvas # TODO Hand rolled
@@ -1086,6 +1116,12 @@ types:
     description: A GraphQL Error.
     type: object
     properties:
+      extensions:
+        description: The extensions of the error occurred.
+        type: object
+        properties:
+          //:
+            type: object
       locations:
         description: The locations where the error occurred.
         type: array
@@ -1151,6 +1187,13 @@ types:
       result:
         description: object wrapper around inner representation
         type: GraphQLRepresentation
+  HealthCheckRepresentation:
+    description: api health check output
+    type: object
+    properties:
+      result:
+        description: Result.
+        type: string
   KeywordSearchRequestInputRepresentation:
     description: Input parameters to request on Search for keyword type
     type: object
@@ -1170,7 +1213,8 @@ types:
         type: string
         required: false #TODO: handrolled for W-11054463
       sortBy:
-        description: How to sort the results. You could, provide a 'FieldName' for ascending sorting or '-FieldName' for descending sorting
+        description: How to sort the results. You could, provide a 'FieldName' for
+          ascending sorting or '-FieldName' for descending sorting
         type: string
         required: false #TODO: handrolled for W-11717993
   KeywordSearchResultsRepresentation:
@@ -1224,6 +1268,44 @@ types:
       sortable:
         description: Whether the list column is sortable.
         type: boolean
+  ListFieldErrorRepresentation:
+    description: ListFieldErrorRepresentation
+    type: object
+    properties:
+      errorMessage:
+        description: Further information about the column's error.
+        type: string
+      fieldApiName:
+        description: API name for the field with an error.
+        type: string
+  ListFilterByInfoInputRepresentation:
+    description: Representation of a List Filter By Info input.
+    type: object
+    properties:
+      fieldApiName:
+        description: Input representation for API name for the field used to filter.
+        type: string
+      operandLabels:
+        description: Input representation for the values to filter by.
+        type: array
+        items:
+          type: string
+      operator:
+        description: Input representation for Operator (such as equals, starts with).
+        type: string
+        enum:
+          - Contains
+          - Equals
+          - Excludes
+          - GreaterOrEqual
+          - GreaterThan
+          - Includes
+          - LessOrEqual
+          - LessThan
+          - NotContain
+          - NotEqual
+          - StartsWith
+          - Within
   ListFilterByInfoRepresentation:
     description: ListFilterByInfoRepresentation
     type: object
@@ -1255,6 +1337,15 @@ types:
           - NotEqual
           - StartsWith
           - Within
+  ListInfoErrorRepresentation:
+    description: ListInfoErrorRepresentation
+    type: object
+    properties:
+      fieldErrors:
+        description: List of errors associated with specific fields.
+        type: array
+        items:
+          type: ListFieldErrorRepresentation
   ListInfoInputRepresentation:
     description: Representation of a List Info input.
     type: object
@@ -1334,13 +1425,13 @@ types:
         type: array
         items:
           type: ListOrderByInfoRepresentation
-      updateable:
-        description: Indicates whether the listview can be updated.
-        type: boolean
       scope:
         description: Scope information for this list view.
         type: ListScopeRepresentation | nil # TODO: hand rolled
         required: false # TODO: hand rolled
+      updateable:
+        description: Indicates whether the listview can be updated.
+        type: boolean
       userPreferences:
         description: All user preferences for this list view.
         type: ListUserPreferenceRepresentation
@@ -1363,7 +1454,7 @@ types:
         type: string
       dataType:
         description: The data type for this column.
-        type: string | nil
+        type: string
         enum:
           - Address
           - Anytype
@@ -1448,20 +1539,26 @@ types:
     description: ListObjectInfoRepresentation
     type: object
     properties:
+      # availableScopes:
+      #   description: Information about all available scopes for the given entity.
+      #   type: array
+      #   items:
+      #     type: ListObjectScopeRepresentation
       columns:
         description: Information about all available columns for the given entity.
         type: array
         items:
           type: ListObjectColumnRepresentation
       createable:
-        description: Indicates whether a new listview for this listview's SObject can be created.
+        description: Indicates whether a new listview for this listview's SObject
+          can be created.
         type: boolean
       objectApiName:
         description: The requested object API name.
         type: string
       relatedEntityApiName:
         description: Null, or the type of related entity to which this LV can be scoped.
-        type: string | nil
+        type: string | nil # TODO: hand rolled nil union
   ListObjectPicklistValueRepresentation:
     description: ListObjectPicklistValueRepresentation
     type: object
@@ -1472,6 +1569,31 @@ types:
       label:
         description: The label name for this picklist value.
         type: string
+  ListObjectScopeAvailableEntityRepresentation:
+    description: ListObjectScopeAvailableEntityRepresentation
+    type: object
+    properties:
+      id:
+        description: The id for this scope.
+        type: string
+      label:
+        description: The label for this scope.
+        type: string
+  ListObjectScopeRepresentation:
+    description: ListObjectScopeRepresentation
+    type: object
+    properties:
+      apiName:
+        description: The API name for this scope.
+        type: string
+      availableEntities:
+        description: The available entities for this scope.
+        type: array
+        items:
+          type: ListObjectScopeAvailableEntityRepresentation
+      label:
+        description: The label for this scope.
+        type: string
   ListOrderByInfoRepresentation:
     description: ListOrderByInfoRepresentation
     type: object
@@ -1579,6 +1701,19 @@ types:
       label:
         description: Label for the scope entity.
         type: string
+  ListScopeInputRepresentation:
+    description: Representation of a list scope for input.
+    type: object
+    properties:
+      apiName:
+        description: Input representation for the scope's API name.
+        type: string
+      entityId:
+        description: Input representation for the scope's entity id.
+        type: string
+      relatedEntityId:
+        description: Input representation for the scope's related entity id.
+        type: string
   ListScopeRelatedEntityRepresentation:
     description: ListScopeRelatedEntityRepresentation
     type: object
@@ -1601,13 +1736,13 @@ types:
         type: string
       entity:
         description: Entity for the scope.
-        type: ListScopeEntityRepresentation | nil
+        type: ListScopeEntityRepresentation | nil # TODO: hand rolled nil union type
       label:
         description: Label for the scope.
         type: string
       relatedEntity:
         description: Related entity for the scope.
-        type: ListScopeRelatedEntityRepresentation | nil
+        type: ListScopeRelatedEntityRepresentation | nil # TODO: hand rolled nil union type
   ListUiRepresentation:
     description: ListUiRepresentation
     type: object
@@ -1754,7 +1889,7 @@ types:
         type: string
       secondaryField:
         description: API name of the field used as a secondary display field.
-        type: string | nil
+        type: string | nil # TODO: Handrolled nil union
       targetInfo:
         description: Per target entity metadata
         type: object
@@ -2393,7 +2528,7 @@ types:
         description: The label of the action.
         type: string
       lwcComponent:
-        description: The lwcComponent this action will render, if applicable.
+        description: LWC Component associated with the action
         type: string | nil
       primaryColor:
         description: Hex Color Code, such as 7F8DE1
@@ -2582,18 +2717,18 @@ types:
         description: The success message of the operation.
         type: string
   QuickActionLayoutRepresentation:
-    description: Representation of a quick action create / update layout.
+    description: Quick action layout representation for a specific action api name
     type: object
     properties:
+      actionApiName:
+        description: quick action name
+        type: string
       eTag:
         description: ETag like field, readOnly, handy while caching.
         type: string
         (oas-readOnly): true
-      actionApiName:
-        description: quick action name
-        type: string
       layout:
-        description: quick action layout
+        description: record layout representation
         type: RecordLayoutRepresentation
   RecordCollectionRepresentation:
     description: Record Collection Representation.
@@ -2712,6 +2847,13 @@ types:
             type: array
             items:
               type: RecordExceptionErrorRepresentation
+  RecordIdRepresentation:
+    description: RecordId.
+    type: object
+    properties:
+      id:
+        description: The ID of this record.
+        type: string
   RecordInputRepresentation:
     description: Description of a record input.
     type: object
@@ -2789,6 +2931,7 @@ types:
           - Full
           - Mdp
           - Search
+          - Service_Document
       mode:
         description: Mode.
         type: string
@@ -2799,10 +2942,10 @@ types:
           - View
       objectApiName:
         description: Object API name.
-        type: string | nil
+        type: string | nil # TODO: Handrolled nil union
       recordTypeId:
         description: Record type ID.
-        type: string | nil
+        type: string | nil # TODO: Handrolled nil union
       saveOptions:
         description: Layout save options.
         type: array # TODO: remove nil union hand rolled
@@ -3112,7 +3255,7 @@ types:
       picklistValues:
         description: The picklist values for this column (or null if the column is
           not a picklist).
-        type: array
+        type: array # TODO: Handrolled array type
         items:
           type: object
           properties:
@@ -3204,13 +3347,13 @@ types:
         type: array
         items:
           type: string
-      filterable:
-        description: Indicates whether RelatedList supports QuickFilters.
-        type: boolean
       filterLogicString:
         description: This is the filter logic such as "(1 OR 2) and 3".  Indexes are
           1-based.
         type: string
+      filterable:
+        description: The value to determine quickFilter support on layout based RelatedLists
+        type: boolean
       filteredByInfo:
         description: Describes how the list view is filtered.
         type: array
@@ -3687,7 +3830,7 @@ types:
         description: Name.
         type: string
   SearchAnswersRecordRepresentation:
-    description: Record for search QnA answer
+    description: Record for Search Answers
     type: object
     properties:
       objectApiLabel:
@@ -3713,7 +3856,7 @@ types:
         description: The record’s snippet which includes the answer
         type: string
       records:
-        description: The list of records for QnA Answer
+        description: The list of records for search answer
         type: array
         items:
           type: SearchAnswersRecordRepresentation
@@ -3836,7 +3979,7 @@ types:
         description: Indicates if this select has static options.
         type: boolean
       multiple:
-        description: Indicates if this select allows multiple values selection.
+        description: Indicates if this select allows multiple values selection
         type: boolean
       staticOptions:
         description: Static options that will populate the select filter.
@@ -3954,15 +4097,15 @@ types:
       keywordSearchResults:
         description: Keyword Search Results Response
         type: KeywordSearchResultsRepresentation | nil
+      qnaResult:
+        description: Search Answers Response
+        type: SearchAnswersResultRepresentation | nil
       query:
         description: Search query that yielded the search results
         type: string
       queryId:
         description: Search’s request ID
         type: string
-      qnaResult:
-        description: Question and Answer Response
-        type: SearchAnswersResultRepresentation | nil
   SimplifiedBatchRepresentation:
     description: Result of an entire batch request operation. Results are ordered
       in the same order in which the requests were given. Results may either be a
@@ -4143,6 +4286,20 @@ types:
       valueType:
         description: wire data value type.
         type: string
+  WorkStepPicklistValueAttributeRepresentation:
+    description: Additional picklist value attributes for WorkStep statuses.
+    discriminatorValue: WorkStepStatus
+    type: AbstractPicklistValueAttributesRepresentation
+    properties:
+      sortOrder:
+        description: Indicate the order in which the work step statuses are displayed
+          in the status category's picklist. For more info, see the doc for the WorkStepStatus
+          standard object
+        type: integer
+      statusCode:
+        description: Indicate the status category that this status belongs to. For
+          more info, see the doc for the WorkStepStatus standard object
+        type: string
   BatchRepresentation:
     description: 'added by hand, was intended to be hidden and internal, connect-gen modeling is ignoring that and referencing it in two places above. both appear to be referencing abstract datatypes as the Batch Type, could be it.?'
     type: object
@@ -4277,6 +4434,7 @@ types:
         required: false
 /graphql:
   post:
+    displayName: postGraphQL
     description: Execute a GraphQL query.
     responses:
       '200':
@@ -4291,13 +4449,14 @@ types:
         (oas-body-name): queryInput
 /graphql/batch:
   post:
+    displayName: postGraphQLBatch
     description: Post a batch graphQL request.
     responses:
       '200':
         description: Success
         body:
           application/json:
-            type: GraphQLBatchRepresentation
+            type: GraphQLBatchRepresentation # TODO: Handrolled type
     body:
       application/json:
         type: GraphQLBatchInputRepresentation
@@ -4307,6 +4466,7 @@ types:
   /actions:
     /flexipage/{flexipageNames}:
       get:
+        displayName: getActionFlexipage
         description: Retrieve presentation-ready action data about specific flexipageNames.
         responses:
           '200':
@@ -4351,6 +4511,7 @@ types:
             (oas-collectionFormat): csv
     /global:
       get:
+        displayName: getActionGlobal
         description: Retrieve presentation-ready action data for Global context.
         responses:
           '200':
@@ -4400,6 +4561,7 @@ types:
               (oas-collectionFormat): csv
     /layout/{actionApiName}:
       get:
+        displayName: getActionLayout
         description: Retrieve a Quick Action layout.
         responses:
           '200':
@@ -4413,6 +4575,7 @@ types:
           required: true
     /list-view-chart/{objectApiNames}:
       get:
+        displayName: getActionListViewChart
         description: Retrieve presentation-ready action data about specific list-view-chart
           objectApiNames.
         responses:
@@ -4458,6 +4621,7 @@ types:
             (oas-collectionFormat): csv
     /list-view-record/{recordIds}:
       get:
+        displayName: getActionListViewRecord
         description: Retrieve presentation-ready action data about specific recordIds.
         responses:
           '200':
@@ -4502,6 +4666,7 @@ types:
             (oas-collectionFormat): csv
     /list-view/{listViewIds}:
       get:
+        displayName: getActionListView
         description: Retrieve presentation-ready action data about specific list-view
           listViewIds.
         responses:
@@ -4547,6 +4712,7 @@ types:
             (oas-collectionFormat): csv
     /lookup/{objectApiNames}:
       get:
+        displayName: getActionLookup
         description: Retrieve presentation-ready action data about specific lookup
           objectApiNames.
         responses:
@@ -4592,6 +4758,7 @@ types:
             (oas-collectionFormat): csv
     /mru-list/{objectApiNames}:
       get:
+        displayName: getActionMruList
         description: Retrieve presentation-ready action data about specific mru-list
           objectApiNames.
         responses:
@@ -4637,6 +4804,7 @@ types:
             (oas-collectionFormat): csv
     /object/{objectApiName}/record-create:
       get:
+        displayName: getActionObject
         description: Retrieve presentation-ready action data about specific objectApiName
           under the RecordCreate subcontext.
         responses:
@@ -4679,6 +4847,7 @@ types:
           required: true
     /overrides/{objectApiName}:
       get:
+        displayName: getActionOverride
         description: Retrieve evaluatable rules and flexipage names
         responses:
           '200':
@@ -4694,8 +4863,42 @@ types:
         objectApiName:
           type: string
           required: true
+    /perform-quick-action/{actionApiName}:
+      patch:
+        displayName: patchActionPerformQuickAction
+        description: performing a quick action that updates a record.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: QuickActionExecutionRepresentation
+        body:
+          application/json:
+            type: PerformActionInputRepresentation
+            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+            (oas-body-name): performQuickActionInput
+      post:
+        displayName: postActionPerformQuickAction
+        description: performing a quick action.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: QuickActionExecutionRepresentation
+        body:
+          application/json:
+            type: PerformActionInputRepresentation
+            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+            (oas-body-name): performQuickActionInput
+      uriParameters:
+        actionApiName:
+          type: string
+          required: true
     /photo/{recordIds}:
       get:
+        displayName: getActionPhoto
         description: Retrieve presentation-ready action data for photo of recorIds.
         responses:
           '200':
@@ -4740,6 +4943,7 @@ types:
             (oas-collectionFormat): csv
     /record-defaults/{actionApiName}:
       get:
+        displayName: getActionQuickActionDefaults
         description: Retrieve a quick action default values.
         responses:
           '200':
@@ -4761,39 +4965,9 @@ types:
         actionApiName:
           type: string
           required: true
-    /perform-quick-action/{actionApiName}:
-      patch:
-        description: performing a quick action that updates a record.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: QuickActionExecutionRepresentation
-        body:
-          application/json:
-            type: PerformActionInputRepresentation
-            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-            (oas-body-name): performQuickActionInput
-      post:
-        description: performing a quick action.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: QuickActionExecutionRepresentation
-        body:
-          application/json:
-            type: PerformActionInputRepresentation
-            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-            (oas-body-name): performQuickActionInput
-      uriParameters:
-        actionApiName:
-          type: string
-          required: true
     /record/{recordIds}:
       get:
+        displayName: getActionRecord
         description: Retrieve presentation-ready action data about specific recordIds.
         responses:
           '200':
@@ -4850,6 +5024,7 @@ types:
             (oas-collectionFormat): csv
       /record-edit:
         get:
+          displayName: getActionRecordEdit
           description: Retrieve presentation-ready action data about specific recordId
             under the RecordEdit subcontext.
           responses:
@@ -5079,9 +5254,9 @@ types:
                 (oas-collectionFormat): csv
         /batch/{relatedListIds}:
           get:
-            description: Retrieve presentation-ready action data about specific
-              recordId for the RelatedList subcontexts relatedListIds but returned
-              in the manner LDS expects for batching.
+            displayName: getActionRelatedList
+            description: Retrieve presentation-ready action data about specific recordId
+              for the RelatedList subcontexts relatedListIds.
             responses:
               '200':
                 description: Success
@@ -5102,9 +5277,21 @@ types:
                     - QuickAction
                     - StandardButton
                   (oas-collectionFormat): csv
+              apiNames:
+                type: array
+                required: false
+                items:
+                  type: string
+                  (oas-collectionFormat): csv
               formFactor:
                 type: string
                 required: false
+              retrievalMode:
+                type: string
+                required: false
+                enum:
+                  - All
+                  - PageLayout
               sections:
                 type: array
                 required: false
@@ -5144,6 +5331,7 @@ types:
                 (oas-collectionFormat): csv
         /{relatedListId}:
           post:
+            displayName: postActionRelatedList
             description: Returns record data to populate a related list.
             responses:
               '200':
@@ -5209,6 +5397,7 @@ types:
               required: true
       /related-list-record/{relatedListRecordIds}:
         get:
+          displayName: getActionRelatedListRecord
           description: Retrieve presentation-ready action data about specific recordId
             under the related-list-record relatedListRecordIds.
           responses:
@@ -5260,6 +5449,7 @@ types:
               (oas-collectionFormat): csv
   /aggregate-ui:
     get:
+      displayName: getAggregateUi
       description: Retrieve presentation-ready metadata and data.
       responses:
         '200':
@@ -5276,6 +5466,7 @@ types:
           type: string
           required: false
     post:
+      displayName: postAggregateUi
       description: Executes multiple requests within a single request
       responses:
         '200':
@@ -5290,6 +5481,7 @@ types:
           (oas-body-name): input
   /apps:
     get:
+      displayName: getApps
       description: Retrieves the list of apps accessible for current user
       responses:
         '200':
@@ -5300,12 +5492,13 @@ types:
       queryParameters:
         formFactor:
           type: string
-          required: true
+          required: false
         userCustomizations:
           type: boolean
           required: false
     /selected:
       get:
+        displayName: getCurrentApp
         description: Retrieves an app current user last selected or should see by
           default
         responses:
@@ -5317,12 +5510,13 @@ types:
         queryParameters:
           formFactor:
             type: string
-            required: true
+            required: false
           userCustomizations:
             type: boolean
             required: false
     /{appId}:
       get:
+        displayName: getApp
         description: Retrieves an app for the given app ID
         responses:
           '200':
@@ -5333,11 +5527,12 @@ types:
         queryParameters:
           formFactor:
             type: string
-            required: true
+            required: false
           userCustomizations:
             type: boolean
             required: false
       patch:
+        displayName: patchApp
         description: Returns the app metadata for the given App id and also saves
           this app as Last accessed app for the user
         responses:
@@ -5349,7 +5544,7 @@ types:
         queryParameters:
           formFactor:
             type: string
-            required: true
+            required: false
           userCustomizations:
             type: boolean
             required: false
@@ -5359,6 +5554,7 @@ types:
           required: true
     /{appId}/user-nav-items:
       get:
+        displayName: getUserNav
         description: Retrieves the user's personalized nav items.
         responses:
           '200':
@@ -5371,6 +5567,7 @@ types:
             type: string
             required: false
       put:
+        displayName: putUserNav
         description: Updates all the user's personalized nav items.
         responses:
           '200':
@@ -5389,6 +5586,7 @@ types:
           required: true
   /duplicates/{objectApiName}:
     get:
+      displayName: getDuplicateConfig
       description: Get duplicate management configuration for a specific entity
         object
       responses:
@@ -5409,6 +5607,7 @@ types:
           getDuplicateConfigurationResponse1: 'Lead'
   /favorites:
     get:
+      displayName: getFavoriteCollection
       description: Gets a collection of favorites.
       responses:
         '200':
@@ -5417,6 +5616,7 @@ types:
             application/json:
               type: FavoriteCollectionRepresentation
     post:
+      displayName: postFavoriteCollection
       description: Creates a single favorite.
       responses:
         '200':
@@ -5449,6 +5649,7 @@ types:
           (oas-body-name): favorite
     /batch:
       put:
+        displayName: putFavoriteBatch
         description: Updates all favorites at once. Sort order is updated to the
           given relative ordering and any favorites missing from the input payload
           are deleted.
@@ -5465,11 +5666,13 @@ types:
             (oas-body-name): favorites
     /{favoriteId}:
       delete:
+        displayName: deleteFavorite
         description: Deletes a single favorite by ID.
         responses:
           '200':
             description: Success
       get:
+        displayName: getFavorite
         description: Retrieve a single favorite by ID.
         responses:
           '200':
@@ -5478,6 +5681,7 @@ types:
               application/json:
                 type: FavoriteRepresentation
       patch:
+        displayName: patchFavorite
         description: Updates a single favorite by ID.
         responses:
           '200':
@@ -5503,6 +5707,7 @@ types:
           required: true
     /{favoriteId}/usage:
       patch:
+        displayName: patchFavoriteUsage
         description: Increments the accessCount and sets the lastAccessDate to the
           current system time.
         responses:
@@ -5517,6 +5722,7 @@ types:
           required: true
   /forms/{apiName}:
     get:
+      displayName: getForm
       description: Retrieve a specific form by name.
       responses:
         '200':
@@ -5528,8 +5734,52 @@ types:
       apiName:
         type: string
         required: true
+  /health-check:
+    delete:
+      displayName: deleteHealthCheck
+      description: UI API health check get operation
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getHealthCheck
+      description: UI API health check get operation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: HealthCheckRepresentation
+    patch:
+      displayName: patchHealthCheck
+      description: UI API health check get operation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: HealthCheckRepresentation
+    post:
+      displayName: postHealthCheck
+      description: UI API health check get operation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: HealthCheckRepresentation
+    put:
+      displayName: putHealthCheck
+      description: UI API health check get operation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: HealthCheckRepresentation
   /layout/{objectApiName}:
     get:
+      displayName: getLayout
       description: Retrieve a specific layout.
       responses:
         '200':
@@ -5549,6 +5799,7 @@ types:
             - Full
             - Mdp
             - Search
+            - Service_Document
         mode:
           type: string
           required: false
@@ -5566,6 +5817,7 @@ types:
         required: true
   /layout/{objectApiName}/user-state:
     get:
+      displayName: getLayoutUserState
       description: Retrieve a specific layout's user state.
       responses:
         '200':
@@ -5585,6 +5837,7 @@ types:
             - Full
             - Mdp
             - Search
+            - Service_Document
         mode:
           type: string
           required: false
@@ -5597,6 +5850,7 @@ types:
           type: string
           required: false
     patch:
+      displayName: patchLayoutUserState
       description: Update a specific layout's user state.
       responses:
         '200':
@@ -5616,6 +5870,7 @@ types:
             - Full
             - Mdp
             - Search
+            - Service_Document
         mode:
           type: string
           required: false
@@ -5639,6 +5894,7 @@ types:
   /list-info:
     /batch:
       get:
+        displayName: getListInfoBatch
         description: Retrieve a list of listInfo.
         responses:
           '200':
@@ -5661,6 +5917,7 @@ types:
               (oas-collectionFormat): csv
     /{listViewId}:
       get:
+        displayName: getListInfo
         description: Retrieve list info.
         responses:
           '200':
@@ -5668,12 +5925,27 @@ types:
             body:
               application/json:
                 type: ListInfoRepresentation
+      patch:
+        displayName: patchListInfo
+        description: Update list info
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ListInfoRepresentation
+        body:
+          application/json:
+            type: ListInfoInputRepresentation
+            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+            (oas-body-name): listInfoInput
       uriParameters:
         listViewId:
           type: string
           required: true
     /{objectApiName}/{listViewApiName}:
       get:
+        displayName: getListInfo
         description: Retrieve list info.
         responses:
           '200':
@@ -5682,7 +5954,8 @@ types:
               application/json:
                 type: ListInfoRepresentation
       patch:
-        description: 'Modify a list view'
+        displayName: patchListInfo
+        description: Update list info
         responses:
           '200':
             description: Success
@@ -5701,11 +5974,11 @@ types:
         objectApiName:
           type: string
           required: true
-  /list-object-info:
+  /list-object-info: # TODO Handrolled - compiler doesn't like generated raml
     /{objectApiName}:
       get:
         displayName: getListObjectInfo
-        description: Retrieve list object info.
+        description: Retrieve list info.
         responses:
           '200':
             description: Success
@@ -5719,6 +5992,7 @@ types:
   /list-records:
     /{listViewId}:
       get:
+        displayName: getListRecords
         description: Returns record data to populate a list.
         responses:
           '200':
@@ -5758,6 +6032,7 @@ types:
           required: true
     /{objectApiName}/{listViewApiName}:
       get:
+        displayName: getListRecords
         description: Returns record data to populate a list.
         responses:
           '200':
@@ -5801,6 +6076,7 @@ types:
   /list-ui:
     /{listViewId}:
       get:
+        displayName: getListUi
         description: Retrieve list data and info.
         responses:
           '200':
@@ -5840,6 +6116,7 @@ types:
           required: true
     /{objectApiName}:
       get:
+        displayName: getListCollection
         description: Retrieve lists for a given objectApiName.
         responses:
           '200':
@@ -5867,6 +6144,7 @@ types:
           required: true
     /{objectApiName}/{listViewApiName}:
       get:
+        displayName: getListUi
         description: Retrieve list data and info.
         responses:
           '200':
@@ -5955,6 +6233,7 @@ types:
         required: true
   /lookups/{objectApiName}/{fieldApiName}/{targetApiName}:
     get:
+      displayName: getLookupEntity
       description: Returns record search results for the given lookup field.
       responses:
         '200':
@@ -6000,6 +6279,7 @@ types:
         required: true
   /mru-list-info/{objectApiName}:
     get:
+      displayName: getMruListInfo
       description: Retrieve MRU list info.
       responses:
         '200':
@@ -6013,6 +6293,7 @@ types:
         required: true
   /mru-list-records/{objectApiName}:
     get:
+      displayName: getMruListRecords
       description: Returns record data to populate an MRU list.
       responses:
         '200':
@@ -6051,6 +6332,7 @@ types:
         required: true
   /mru-list-ui/{objectApiName}:
     get:
+      displayName: getMruListUi
       description: Retrieve MRU list data and info.
       responses:
         '200':
@@ -6090,6 +6372,7 @@ types:
         required: true
   /nav-items:
     get:
+      displayName: getNavItems
       description: Fetch all the nav items
       responses:
         '200':
@@ -6115,6 +6398,7 @@ types:
           required: false
   /object-info:
     get:
+      displayName: getObjectInfoDirectory
       description: Retrieve the object info directory.
       responses:
         '200':
@@ -6124,6 +6408,7 @@ types:
               type: ObjectInfoDirectoryRepresentation
     /batch/{objectApiNames}:
       get:
+        displayName: getObjectInfoBatch
         description: Retrieve metadata about a list of objects.
         responses:
           '200':
@@ -6140,6 +6425,7 @@ types:
             (oas-collectionFormat): csv
     /{objectApiName}:
       get:
+        displayName: getObjectInfo
         description: Retrieve metadata about a specific object.
         responses:
           '200':
@@ -6153,6 +6439,7 @@ types:
           required: true
       /picklist-values/{recordTypeId}:
         get:
+          displayName: getPicklistValuesByRecordType
           description: Returns the values for all picklist fields for a recordType
           responses:
             '200':
@@ -6169,6 +6456,7 @@ types:
             required: true
       /picklist-values/{recordTypeId}/{fieldApiName}:
         get:
+          displayName: getPicklistValues
           description: Returns the values for a specific picklist.
           responses:
             '200':
@@ -6188,6 +6476,7 @@ types:
             required: true
       /validation-rules-info:
         get:
+          displayName: getValidationRulesInfo
           description: Retrieve metadata of validation rules for the given object
           responses:
             '200':
@@ -6201,6 +6490,7 @@ types:
             required: true
   /predupe:
     post:
+      displayName: postPredupe
       description: Performs a predupe check on given a record.
       responses:
         '200':
@@ -6261,6 +6551,7 @@ types:
   /record-avatars:
     /batch/{recordIds}:
       get:
+        displayName: getRecordAvatarsBatch
         description: Retrieve avatar information about specific records.
         responses:
           '200':
@@ -6282,6 +6573,7 @@ types:
             (oas-collectionFormat): csv
     /{recordId}:
       get:
+        displayName: getRecordAvatars
         description: Retrieve avatar information about specific records.
         responses:
           '200':
@@ -6300,6 +6592,7 @@ types:
           required: true
     /{recordId}/association:
       post:
+        displayName: postRecordAvatarsAssociation
         description: Stores avatar association for specific records.
         responses:
           '200':
@@ -6319,6 +6612,7 @@ types:
   /record-defaults:
     /clone/{recordId}:
       get:
+        displayName: getRecordCloneDefaults
         description: Retrieve default values for fields for cloning a record with
           optional record type.
         responses:
@@ -6348,6 +6642,7 @@ types:
           required: true
     /create/{objectApiName}:
       get:
+        displayName: getRecordCreateDefaults
         description: Retrieve default values for fields for a new record of a particular
           object and optional record type.
         responses:
@@ -6378,6 +6673,7 @@ types:
     /template:
       /clone/{recordId}:
         get:
+          displayName: getRecordDefaultsTemplateClone
           description: Retrieve default values for fields for cloning a record with
             optional record type without layout information, and specifying only
             requested fields and object infos.
@@ -6403,6 +6699,7 @@ types:
             required: true
       /create/{objectApiName}:
         get:
+          displayName: getRecordDefaultsTemplateCreate
           description: Retrieve default values for fields for creating a new record
             of a particular object without layout information, and specifying only
             requested fields and object infos.
@@ -6428,6 +6725,7 @@ types:
             required: true
   /record-ui/{recordIds}:
     get:
+      displayName: getRecordUi
       description: Retrieve presentation-ready metadata and data about specific
         records.
       responses:
@@ -6460,6 +6758,7 @@ types:
               - Full
               - Mdp
               - Search
+              - Service_Document
             (oas-collectionFormat): csv
         modes:
           type: array
@@ -6498,6 +6797,7 @@ types:
           (oas-collectionFormat): csv
   /records:
     post:
+      displayName: postRecordDataCollection
       description: Create a new record.
       responses:
         '200':
@@ -6505,12 +6805,16 @@ types:
           body:
             application/json:
               type: RecordRepresentation
-      # TODO: hand rolled - manually commented out name collision. https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAorh3L
-      #queryParameters:
-      #  allowSaveOnDuplicate:
-      #    type: boolean
-      #    required: false
       queryParameters:
+        # TODO: hand rolled - manually commented out name collision. https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAorh3L
+        # allowSaveOnDuplicate:
+        #   type: boolean
+        #   required: false
+        #   default: false
+        includeFieldsInBody:
+          type: boolean
+          required: false
+          default: false
         triggerOtherEmail:
           type: boolean
           required: false
@@ -6533,8 +6837,25 @@ types:
             binaryInputList:
               type: file
               required: false
+      # TODO: Property '/batch' not supported in a RAML 1.0 operation node. Target Node: src/raml/api.raml#/web-api/end-points/%2Fui-api%2Frecords/post
+      # /batch:
+      #   post:
+      #     displayName: postBatchRecord
+      #     description: Create new records.
+      #     responses:
+      #       '200':
+      #         description: Success
+      #         body:
+      #           application/json:
+      #             type: BatchRepresentation
+      #     body:
+      #       application/json:
+      #         type: BatchInputRepresentation
+      #         # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+      #         (oas-body-name): recordInput
     /batch/{recordIds}:
       get:
+        displayName: getBatchRecordData
         description: Retrieve record data for a list of recordIds.
         responses:
           '200':
@@ -6568,6 +6889,7 @@ types:
                 - Full
                 - Mdp
                 - Search
+                - Service_Document
               (oas-collectionFormat): csv
           modes:
             type: array
@@ -6605,11 +6927,13 @@ types:
             (oas-collectionFormat): csv
     /{recordId}:
       delete:
+        displayName: deleteRecordData
         description: Delete record.
         responses:
           '200':
             description: Success
       get:
+        displayName: getRecordData
         description: Retrieve record data.
         responses:
           '200':
@@ -6649,6 +6973,7 @@ types:
                 - Full
                 - Mdp
                 - Search
+                - Service_Document
               (oas-collectionFormat): csv
           modes:
             type: array
@@ -6678,6 +7003,7 @@ types:
             required: false
             default: false
       patch:
+        displayName: patchRecordData
         description: Update an existing record.
         responses:
           '200':
@@ -6685,12 +7011,15 @@ types:
             body:
               application/json:
                 type: RecordRepresentation
-        # TODO: hand rolled - manually commented out name collision. https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAorh3L
-        #queryParameters:
-        #  allowSaveOnDuplicate:
-        #    type: boolean
-        #    required: false
         queryParameters:
+          # TODO: hand rolled - manually commented out name collision. https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAorh3L
+          # TODO: hand rolled - manually commented out name collision. https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAorh3L
+          #queryParameters:
+          # TODO: hand rolled - manually commented out name collision. https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAorh3L
+          #queryParameters:
+          #  allowSaveOnDuplicate:
+          #    type: boolean
+          #    required: false
           triggerOtherEmail:
             type: boolean
             required: false
@@ -6724,6 +7053,7 @@ types:
           required: true
     /{recordId}/child-relationships/{relationshipName}:
       get:
+        displayName: getChildRelationship
         description: Retrieve child relationship data on a parent record.
         responses:
           '200':
@@ -6823,6 +7153,7 @@ types:
   /related-list-count:
     /batch/{parentRecordId}/{relatedListNames}:
       get:
+        displayName: getRelatedListRecordCountBatch
         description: Retrieve a batch of record counts.
         responses:
           '200':
@@ -6846,6 +7177,7 @@ types:
             (oas-collectionFormat): csv
     /{parentRecordId}/{relatedListId}:
       get:
+        displayName: getRelatedListRecordCount
         description: Retrieve record counts.
         responses:
           '200':
@@ -6867,6 +7199,7 @@ types:
   /related-list-info:
     /batch/{parentObjectApiName}/{relatedListNames}:
       get:
+        displayName: getRelatedListInfoBatch
         description: Retrieve a batch of related list info.
         responses:
           '200':
@@ -6890,6 +7223,7 @@ types:
             (oas-collectionFormat): csv
     /{parentObjectApiName}:
       get:
+        displayName: getRelatedListInfoCollection
         description: Retrieve collection of related list summaries.
         responses:
           '200':
@@ -6907,6 +7241,7 @@ types:
           required: true
     /{parentObjectApiName}/{relatedListId}:
       get:
+        displayName: getRelatedListInfo
         description: Retrieve related info.
         responses:
           '200':
@@ -6934,6 +7269,7 @@ types:
             type: boolean
             required: false
       patch:
+        displayName: patchRelatedListInfo
         description: Update user preferences on an existing related list.
         responses:
           '200':
@@ -6959,6 +7295,7 @@ types:
           required: true
     /{parentRecordId}/{relatedListId}:
       get:
+        displayName: getRelatedListInfo
         description: Retrieve related info.
         responses:
           '200':
@@ -6986,6 +7323,7 @@ types:
             type: boolean
             required: false
       patch:
+        displayName: patchRelatedListInfo
         description: Update user preferences on an existing related list.
         responses:
           '200':
@@ -7012,6 +7350,7 @@ types:
   /related-list-preferences:
     /batch/{preferencesIds}:
       get:
+        displayName: getRelatedListPreferencesBatch
         description: Retrieve user preferences.
         responses:
           '200':
@@ -7028,11 +7367,13 @@ types:
             (oas-collectionFormat): csv
     /{preferencesId}:
       delete:
+        displayName: deleteRelatedListPreferences
         description: Deletes a single user preferences by preferencesId.
         responses:
           '200':
             description: Success
       get:
+        displayName: getRelatedListPreferences
         description: Retrieve user preferences.
         responses:
           '200':
@@ -7041,6 +7382,7 @@ types:
               application/json:
                 type: RelatedListUserPreferencesRepresentation
       patch:
+        displayName: patchRelatedListPreferences
         description: Update user preferences on an existing related list.
         responses:
           '200':
@@ -7060,6 +7402,7 @@ types:
   /related-list-records:
     /batch/{parentRecordId}:
       get:
+        displayName: getRelatedListRecordsBatch
         description: Returns a batch of record data to populate several related
           lists.
         responses:
@@ -7085,6 +7428,7 @@ types:
             type: string
             required: false
       post:
+        displayName: postRelatedListRecordsBatch
         description: Returns a batch of record data to populate several related
           lists.
         responses:
@@ -7104,6 +7448,7 @@ types:
           required: true
     /batch/{parentRecordId}/{relatedListIds}:
       get:
+        displayName: getRelatedListRecordsBatch
         description: Returns a batch of record data to populate several related
           lists.
         responses:
@@ -7129,6 +7474,7 @@ types:
             type: string
             required: false
       post:
+        displayName: postRelatedListRecordsBatch
         description: Returns a batch of record data to populate several related
           lists.
         responses:
@@ -7191,6 +7537,7 @@ types:
       #        type: string
       #        required: false
       post:
+        displayName: postRelatedListRecords
         description: Returns record data to populate a related list.
         responses:
           '200':
@@ -7239,58 +7586,63 @@ types:
         relatedListId:
           type: string
           required: true
-  /search-info/{objectApiName}/filters:
-    get:
-      description: Fetches filters metadata.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: SearchFilterMetadataCollectionRepresentation
-    uriParameters:
-      objectApiName:
-        type: string
-        required: true
-  /search-info/{objectApiName}/filters/{filterApiName}/options:
-    get:
-      description: List of options for the search filter field.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: SearchFilterOptionCollectionRepresentation
-      queryParameters:
-        q:
-          description: Query term to use for matching against filter options.
+  /search-info/{objectApiName}:
+    /filters:
+      get:
+        displayName: getSearchInfoFilterMetadataCollection
+        description: Fetches filters metadata.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SearchFilterMetadataCollectionRepresentation
+      uriParameters:
+        objectApiName:
           type: string
-          required: false
-    uriParameters:
-      filterApiName:
-        type: string
-        required: true
-      objectApiName:
-        type: string
-        required: true
-  /search-info/{objectApiName}/lookup/{fieldApiName}:
-    get:
-      description: Lookup field metadata
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: LookupMetadataRepresentation
-    uriParameters:
-      fieldApiName:
-        type: string
-        required: true
-      objectApiName:
-        type: string
-        required: true
+          required: true
+    /filters/{filterApiName}/options:
+      get:
+        displayName: getSearchInfoFilterOptions
+        description: List of options for the search filter field.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SearchFilterOptionCollectionRepresentation
+        queryParameters:
+          q:
+            description: Query term to use for matching against filter options.
+            type: string
+            required: false
+      uriParameters:
+        filterApiName:
+          type: string
+          required: true
+        objectApiName:
+          type: string
+          required: true
+    /lookup/{fieldApiName}:
+      get:
+        displayName: getLookupMetadata
+        description: Lookup field metadata
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LookupMetadataRepresentation
+      uriParameters:
+        fieldApiName:
+          type: string
+          required: true
+        objectApiName:
+          type: string
+          required: true
   /search/results:
     post:
+      displayName: postSearchResults
       description: List all results over entities
       responses:
         '200':
@@ -7333,6 +7685,7 @@ types:
           (oas-body-name): options
   /themes/active:
     get:
+      displayName: getTheming
       description: Retrieve the active theme.
       responses:
         '200':