@salesforce/lds-adapters-uiapi 1.234.0 → 1.236.0

package/src/raml/api.raml

@@ -1093,15 +1093,6 @@ types:
       label:
         description: Form section label.
         type: string
-  GraphQLBatchInputRepresentation:
-    description: GraphQL Batch Input Rep
-    type: object
-    properties:
-      batchQuery:
-        description: The list of graphQL operations to keep and update.
-        type: array
-        items:
-          type: object
   GraphQLErrorLocation:
     description: The location where a GraphQL error occurred.
     type: object
@@ -1170,30 +1161,6 @@ types:
         required: false
         items:
           type: GraphQLErrorRepresentation
-  GraphQLBatchRepresentation: # TODO: Handrolled
-    description: Batch of GraphQL results
-    type: object
-    properties:
-      results:
-        description: Collection of batch result items. One for each request input.
-        type: array
-        items:
-          type: CompositeGraphQLResultRepresentation
-  CompositeGraphQLResultRepresentation: # TODO: Handrolled
-    type: object
-    properties:
-      statusCode:
-        type: number
-      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
@@ -4452,21 +4419,6 @@ types:
         type: GraphQLInputRepresentation
         # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
         (oas-body-name): queryInput
-/graphql/batch:
-  post:
-    displayName: postGraphQLBatch
-    description: Post a batch graphQL request.
-    responses:
-      '200':
-        description: Success
-        body:
-          application/json:
-            type: GraphQLBatchRepresentation # TODO: Handrolled type
-    body:
-      application/json:
-        type: GraphQLBatchInputRepresentation
-        # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-        (oas-body-name): batchQueryInput
 /ui-api:
   /actions:
     /flexipage/{flexipageNames}:
@@ -5074,169 +5026,7 @@ types:
               type: string
               (oas-collectionFormat): csv
       /related-list:
-        # get:
-        #   description: Retrieve presentation-ready action data about specific recordId
-        #     for the RelatedList subcontexts relatedListIds.
-        #   responses:
-        #     '200':
-        #       description: Success
-        #       body:
-        #         application/json:
-        #           type: ActionRepresentation
-        #   queryParameters:
-        #     actionTypes:
-        #       type: array
-        #       required: false
-        #       items:
-        #         type: string
-        #         enum:
-        #           - ActionLink
-        #           - CustomButton
-        #           - InvocableAction
-        #           - ProductivityAction
-        #           - 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
-        #       items:
-        #         type: string
-        #         enum:
-        #           - ActivityComposer
-        #           - CollaborateComposer
-        #           - Page
-        #           - SingleActionLinks
-        #         (oas-collectionFormat): csv
-        post:
-          description: Returns record data to populate a related list.
-          responses:
-            '200':
-              description: Success
-              body:
-                application/json:
-                  type:
-                    ActionRepresentation
-                    # TODO: parameters conflicts
-          #queryParameters:
-          #  actionTypes:
-          #    type: array
-          #    required: false
-          #    items:
-          #      type: string
-          #      enum:
-          #      - ActionLink
-          #      - CustomButton
-          #      - InvocableAction
-          #      - ProductivityAction
-          #      - 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
-          #    items:
-          #      type: string
-          #      enum:
-          #      - ActivityComposer
-          #      - CollaborateComposer
-          #      - Page
-          #      - SingleActionLinks
-          #      (oas-collectionFormat): csv
-          body:
-            application/json:
-              type: ActionInputRepresentation
-              # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-              (oas-body-name): listRecordActionsQuery
-        uriParameters:
-          recordIds:
-            type: array
-            required: true
-            items:
-              type: string
-              (oas-collectionFormat): csv
         /batch:
-          # TODO: Hand rolled
-          # get:
-          #   description: Retrieve presentation-ready action data about specific
-          #     recordId for the RelatedList subcontexts relatedListIds but returned
-          #     in the manner LDS expects for batching.
-          #   responses:
-          #     '200':
-          #       description: Success
-          #       body:
-          #         application/json:
-          #           type: SimplifiedBatchRepresentation
-          #   queryParameters:
-          #     actionTypes:
-          #       type: array
-          #       required: false
-          #       items:
-          #         type: string
-          #         enum:
-          #           - ActionLink
-          #           - CustomButton
-          #           - InvocableAction
-          #           - ProductivityAction
-          #           - 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
-          #       items:
-          #         type: string
-          #         enum:
-          #           - ActivityComposer
-          #           - CollaborateComposer
-          #           - Page
-          #           - SingleActionLinks
-          #         (oas-collectionFormat): csv
           post:
             description: Returns a batch of record data to populate several related lists.
             responses:
@@ -5244,7 +5034,7 @@ types:
                 description: Success
                 body:
                   application/json:
-                    type: SimplifiedBatchRepresentation
+                    type: ActionRelatedListsCollectionBatchRepresentation
             body:
               application/json:
                 type: ActionRelatedListsBatchInputRepresentation
@@ -5308,32 +5098,6 @@ types:
                     - Page
                     - SingleActionLinks
                   (oas-collectionFormat): csv
-          post:
-            description: Returns a batch of record data to populate several related
-              lists.
-            responses:
-              '200':
-                description: Success
-                body:
-                  application/json:
-                    type: RelatedListRecordCollectionBatchRepresentation
-            body:
-              application/json:
-                type: ActionRelatedListsBatchInputRepresentation
-                # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-          uriParameters:
-            recordIds:
-              type: array
-              required: true
-              items:
-                type: string
-                (oas-collectionFormat): csv
-            relatedListIds:
-              type: array
-              required: true
-              items:
-                type: string
-                (oas-collectionFormat): csv
         /{relatedListId}:
           post:
             displayName: postActionRelatedList
@@ -5452,38 +5216,36 @@ types:
             items:
               type: string
               (oas-collectionFormat): csv
-  /aggregate-ui:
-    get:
-      displayName: getAggregateUi
-      description: Retrieve presentation-ready metadata and data.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: AggregateUiRepresentation
-      queryParameters:
-        formFactor:
-          type: string
-          required: false
-          default: Large
-        query:
-          type: string
-          required: false
-    post:
-      displayName: postAggregateUi
-      description: Executes multiple requests within a single request
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: AggregateRepresentation
-      body:
-        application/json:
-          type: AggregateInputRepresentation
-          # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-          (oas-body-name): input
+  # /aggregate-ui:
+  #   get:
+  #     description: Retrieve presentation-ready metadata and data.
+  #     responses:
+  #       '200':
+  #         description: Success
+  #         body:
+  #           application/json:
+  #             type: AggregateUiRepresentation
+  #     queryParameters:
+  #       formFactor:
+  #         type: string
+  #         required: false
+  #         default: Large
+  #       query:
+  #         type: string
+  #         required: false
+  #   post:
+  #     description: Executes multiple requests within a single request
+  #     responses:
+  #       '200':
+  #         description: Success
+  #         body:
+  #           application/json:
+  #             type: AggregateRepresentation
+  #     body:
+  #       application/json:
+  #         type: AggregateInputRepresentation
+  #         # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+  #         (oas-body-name): input
   /apps:
     get:
       displayName: getApps
@@ -5610,121 +5372,114 @@ types:
         required: true
         examples: # TODO: hand rolled
           getDuplicateConfigurationResponse1: 'Lead'
-  /favorites:
-    get:
-      displayName: getFavoriteCollection
-      description: Gets a collection of favorites.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: FavoriteCollectionRepresentation
-    post:
-      displayName: postFavoriteCollection
-      description: Creates a single favorite.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: FavoriteRepresentation
-      queryParameters:
-        name:
-          type: string
-          required: false
-        sortOrder:
-          type: integer
-          required: false
-        target:
-          type: string
-          required: false
-        targetType:
-          type: string
-          required: false
-          enum:
-            - ListView
-            - ObjectHome
-            - Record
-            - Tab
-      body:
-        application/json:
-          type: FavoriteInputRepresentation
-          # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-          (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.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: FavoriteCollectionRepresentation
-        body:
-          application/json:
-            type: FavoriteBatchCollectionInputRepresentation
-            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-            (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':
-            description: Success
-            body:
-              application/json:
-                type: FavoriteRepresentation
-      patch:
-        displayName: patchFavorite
-        description: Updates a single favorite by ID.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: FavoriteRepresentation
-        queryParameters:
-          name:
-            type: string
-            required: false
-          sortOrder:
-            type: integer
-            required: false
-        body:
-          application/json:
-            type: FavoriteInputRepresentation
-            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-            (oas-body-name): favorite
-      uriParameters:
-        favoriteId:
-          type: string
-          required: true
-    /{favoriteId}/usage:
-      patch:
-        displayName: patchFavoriteUsage
-        description: Increments the accessCount and sets the lastAccessDate to the
-          current system time.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: FavoriteRepresentation
-      uriParameters:
-        favoriteId:
-          type: string
-          required: true
+  # /favorites:
+  #   get:
+  #     description: Gets a collection of favorites.
+  #     responses:
+  #       '200':
+  #         description: Success
+  #         body:
+  #           application/json:
+  #             type: FavoriteCollectionRepresentation
+  #   post:
+  #     description: Creates a single favorite.
+  #     responses:
+  #       '200':
+  #         description: Success
+  #         body:
+  #           application/json:
+  #             type: FavoriteRepresentation
+  #     queryParameters:
+  #       name:
+  #         type: string
+  #         required: false
+  #       sortOrder:
+  #         type: integer
+  #         required: false
+  #       target:
+  #         type: string
+  #         required: false
+  #       targetType:
+  #         type: string
+  #         required: false
+  #         enum:
+  #           - ListView
+  #           - ObjectHome
+  #           - Record
+  #           - Tab
+  #     body:
+  #       application/json:
+  #         type: FavoriteInputRepresentation
+  #         # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+  #         (oas-body-name): favorite
+  #   /batch:
+  #     put:
+  #       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.
+  #       responses:
+  #         '200':
+  #           description: Success
+  #           body:
+  #             application/json:
+  #               type: FavoriteCollectionRepresentation
+  #       body:
+  #         application/json:
+  #           type: FavoriteBatchCollectionInputRepresentation
+  #           # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+  #           (oas-body-name): favorites
+  #   /{favoriteId}:
+  #     delete:
+  #       description: Deletes a single favorite by ID.
+  #       responses:
+  #         '200':
+  #           description: Success
+  #     get:
+  #       description: Retrieve a single favorite by ID.
+  #       responses:
+  #         '200':
+  #           description: Success
+  #           body:
+  #             application/json:
+  #               type: FavoriteRepresentation
+  #     patch:
+  #       description: Updates a single favorite by ID.
+  #       responses:
+  #         '200':
+  #           description: Success
+  #           body:
+  #             application/json:
+  #               type: FavoriteRepresentation
+  #       queryParameters:
+  #         name:
+  #           type: string
+  #           required: false
+  #         sortOrder:
+  #           type: integer
+  #           required: false
+  #       body:
+  #         application/json:
+  #           type: FavoriteInputRepresentation
+  #           # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
+  #           (oas-body-name): favorite
+  #     uriParameters:
+  #       favoriteId:
+  #         type: string
+  #         required: true
+  #   /{favoriteId}/usage:
+  #     patch:
+  #       description: Increments the accessCount and sets the lastAccessDate to the
+  #         current system time.
+  #       responses:
+  #         '200':
+  #           description: Success
+  #           body:
+  #             application/json:
+  #               type: FavoriteRepresentation
+  #     uriParameters:
+  #       favoriteId:
+  #         type: string
+  #         required: true
   /forms/{apiName}:
     get:
       displayName: getForm
@@ -5739,49 +5494,6 @@ 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
@@ -7406,78 +7118,6 @@ types:
           required: true
   /related-list-records:
     /batch/{parentRecordId}:
-      get:
-        displayName: getRelatedListRecordsBatch
-        description: Returns a batch of record data to populate several related
-          lists.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: SimplifiedBatchRepresentation
-        queryParameters:
-          fields:
-            type: string
-            required: false
-          optionalFields:
-            type: string
-            required: false
-          pageSize:
-            type: string
-            required: false
-          sortBy:
-            type: string
-            required: false
-          where:
-            type: string
-            required: false
-      post:
-        displayName: postRelatedListRecordsBatch
-        description: Returns a batch of record data to populate several related
-          lists.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: SimplifiedBatchRepresentation
-        body:
-          application/json:
-            type: RelatedListRecordsBatchInputRepresentation
-            # required: false - W-9109412: Property 'required' not supported in a RAML 1.0 object node
-            (oas-body-name): listRecordsQuery
-      uriParameters:
-        parentRecordId:
-          type: string
-          required: true
-    /batch/{parentRecordId}/{relatedListIds}:
-      get:
-        displayName: getRelatedListRecordsBatch
-        description: Returns a batch of record data to populate several related
-          lists.
-        responses:
-          '200':
-            description: Success
-            body:
-              application/json:
-                type: SimplifiedBatchRepresentation
-        queryParameters:
-          fields:
-            type: string
-            required: false
-          optionalFields:
-            type: string
-            required: false
-          pageSize:
-            type: string
-            required: false
-          sortBy:
-            type: string
-            required: false
-          where:
-            type: string
-            required: false
       post:
         displayName: postRelatedListRecordsBatch
         description: Returns a batch of record data to populate several related
@@ -7487,7 +7127,7 @@ types:
             description: Success
             body:
               application/json:
-                type: RelatedListRecordCollectionBatchRepresentation # TODO: hand rolled
+                type: RelatedListRecordCollectionBatchRepresentation # Handrolled due to duplicate raml types
         body:
           application/json:
             type: RelatedListRecordsBatchInputRepresentation
@@ -7497,50 +7137,7 @@ types:
         parentRecordId:
           type: string
           required: true
-        relatedListIds:
-          type: array
-          required: true
-          items:
-            type: string
-            (oas-collectionFormat): csv
     /{parentRecordId}/{relatedListId}:
-      # TODO: this breaks the ResourceRequestConfig of getRelatedListRecordsBatch
-      # get:
-      #   description: Returns record data to populate a related list.
-      #   responses:
-      #     '200':
-      #       description: Success
-      #       body:
-      #         application/json:
-      #           type: RelatedListRecordCollectionRepresentation
-      #   queryParameters:
-      #     fields:
-      #       type: array
-      #       required: false
-      #       items:
-      #         type: string
-      #         (oas-collectionFormat): csv
-      #     optionalFields:
-      #       type: array
-      #       required: false
-      #       items:
-      #         type: string
-      #         (oas-collectionFormat): csv
-      #     pageSize:
-      #       type: integer
-      #       required: false
-      #     pageToken:
-      #       type: string
-      #       required: false
-      #     sortBy:
-      #       type: array
-      #       required: false
-      #       items:
-      #         type: string
-      #         (oas-collectionFormat): csv
-      #     where:
-      #        type: string
-      #        required: false
       post:
         displayName: postRelatedListRecords
         description: Returns record data to populate a related list.
@@ -7550,35 +7147,6 @@ types:
             body:
               application/json:
                 type: RelatedListRecordCollectionRepresentation
-        # TODO: parameters conflicts
-        # queryParameters:
-        #   fields:
-        #     type: array
-        #     required: false
-        #     items:
-        #       type: string
-        #       (oas-collectionFormat): csv
-        #   optionalFields:
-        #     type: array
-        #     required: false
-        #     items:
-        #       type: string
-        #       (oas-collectionFormat): csv
-        #   pageSize:
-        #     type: integer
-        #     required: false
-        #   pageToken:
-        #     type: string
-        #     required: false
-        #   sortBy:
-        #     type: array
-        #     required: false
-        #     items:
-        #       type: string
-        #       (oas-collectionFormat): csv
-        #   where:
-        #     type: string
-        #     required: false
         body:
           application/json:
             type: RelatedListRecordsInputRepresentation