@salesforce/lds-adapters-uiapi 1.200.0 → 1.201.0

package/src/raml/api.raml

@@ -1354,6 +1354,124 @@ types:
       visibilityEditable:
         description: Indicates whether the visibility of the listview can be edited.
         type: boolean
+  ListObjectColumnRepresentation:
+    description: ListObjectColumnRepresentation
+    type: object
+    properties:
+      alias:
+        description: The alias for this column.
+        type: string
+      dataType:
+        description: The data type for this column.
+        type: string | nil
+        enum:
+          - Address
+          - Anytype
+          - Base64
+          - Boolean
+          - ComboBox
+          - ComplexValue
+          - Currency
+          - Date
+          - DateTime
+          - Double
+          - Email
+          - EncryptedString
+          - Int
+          - JunctionIdList
+          - Location
+          - Long
+          - MultiPicklist
+          - Percent
+          - Phone
+          - Picklist
+          - Reference
+          - String
+          - TextArea
+          - Time
+          - Url
+      defaultFilterOperator:
+        description: The default filter operator for this column.
+        type: string
+        enum:
+          - Contains
+          - Equals
+          - Excludes
+          - GreaterOrEqual
+          - GreaterThan
+          - Includes
+          - LessOrEqual
+          - LessThan
+          - NotContain
+          - NotEqual
+          - StartsWith
+          - Within
+      displayable:
+        description: Whether or not this column is displayable.
+        type: boolean
+      fieldApiName:
+        description: The field API name for this column.
+        type: string
+      filterable:
+        description: Whether or not this column is filterable.
+        type: boolean
+      label:
+        description: The label for this column.
+        type: string
+      picklistValues:
+        description: The list of allowed picklist values for this column.
+        type: array
+        items:
+          type: ListObjectPicklistValueRepresentation
+      sortable:
+        description: Whether or not this column is sortable.
+        type: boolean
+      supportedFilterOperators:
+        description: The supported filter operators for this column.
+        type: array
+        items:
+          type: string
+          enum:
+            - Contains
+            - Equals
+            - Excludes
+            - GreaterOrEqual
+            - GreaterThan
+            - Includes
+            - LessOrEqual
+            - LessThan
+            - NotContain
+            - NotEqual
+            - StartsWith
+            - Within
+  ListObjectInfoRepresentation:
+    description: ListObjectInfoRepresentation
+    type: object
+    properties:
+      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.
+        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
+  ListObjectPicklistValueRepresentation:
+    description: ListObjectPicklistValueRepresentation
+    type: object
+    properties:
+      apiName:
+        description: The API name for this picklist value.
+        type: string
+      label:
+        description: The label name for this picklist value.
+        type: string
   ListOrderByInfoRepresentation:
     description: ListOrderByInfoRepresentation
     type: object
@@ -5583,6 +5701,21 @@ types:
         objectApiName:
           type: string
           required: true
+  /list-object-info:
+    /{objectApiName}:
+      get:
+        displayName: getListObjectInfo
+        description: Retrieve list object info.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ListObjectInfoRepresentation
+      uriParameters:
+        objectApiName:
+          type: string
+          required: true
   /list-records:
     /{listViewId}:
       get:

package/src/raml/luvio.raml

@@ -87,6 +87,12 @@ types:
   ListInfoBatchRepresentation:
     examples:
       mockListInfosResponse: !include ../mocks/types/ListInfoBatchRepresentation/list-infos.json
+  ListObjectInfoRepresentation:
+    examples:
+      mockListObjectInfoAccount: !include ../mocks/types/ListObjectInfoRepresentation/list-object-info-Account.json
+    (luvio.key):
+      objectApiName: objectApiName
+    (luvio.ttl): 900000
   ListRecordCollectionRepresentation:
     (luvio.ttl): 30000
     (luvio.private):
@@ -853,6 +859,26 @@ types:
           name: updateListInfoByName
           coercedParams:
             objectApiName: SalesforceObjectId
+  /list-object-info:
+    '/{objectApiName}':
+      uriParameters:
+        objectApiName:
+          examples:
+            mockListObjectInfoAccount: Account
+      get:
+        (luvio.adapter):
+          name: getListObjectInfo
+          tests:
+            expectedResponses:
+              - configInput: |
+                  {
+                    "objectApiName": "Account"
+                  }
+                mockPayloadId: mockListObjectInfoAccount
+          coercedParams:
+            objectApiName: SalesforceObjectId
+        (luvio.key):
+          objectApiName: urlParams.objectApiName
   /list-records:
     '/{listViewId}':
       get: