@datocms/cma-client 5.2.0-alpha.2 → 5.2.0-alpha.4

package/dist/types/generated/RawApiTypes.d.ts

@@ -91,15 +91,15 @@ export type EnvironmentIdentity = string;
  */
 export type BuildTriggerIdentity = string;
 /**
- * ID of site_search_source
+ * ID of search_index
  *
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `definition` "identity".
  *
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `definition` "id".
  */
-export type SiteSearchSourceIdentity = string;
+export type SearchIndexIdentity = string;
 /**
  * This interface was referenced by `User`'s JSON-Schema
  * via the `definition` "type".
@@ -631,30 +631,30 @@ export type BuildEventInstancesHrefSchema = {
     [k: string]: unknown;
 };
 /**
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `definition` "type".
  */
-export type SiteSearchSourceEventType = 'site_search_source_event';
+export type SearchIndexEventType = 'search_index_event';
 /**
- * ID of site search source event
+ * ID of search index event
  *
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `definition` "identity".
  *
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `definition` "id".
  */
-export type SiteSearchSourceEventIdentity = string;
+export type SearchIndexEventIdentity = string;
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `definition` "type".
  */
-export type SiteSearchSourceType = 'site_search_source';
+export type SearchIndexType = 'search_index';
 /**
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `instances.hrefSchema` link.
  */
-export type SiteSearchSourceEventInstancesHrefSchema = {
+export type SearchIndexEventInstancesHrefSchema = {
     /**
      * Parameters to control offset-based pagination
      */
@@ -677,7 +677,7 @@ export type SiteSearchSourceEventInstancesHrefSchema = {
          */
         ids?: string;
         fields?: {
-            site_search_source_id?: {
+            search_index_id?: {
                 eq?: string;
             };
             event_type?: {
@@ -695,7 +695,7 @@ export type SiteSearchSourceEventInstancesHrefSchema = {
     /**
      * Fields used to order results
      */
-    order_by?: 'site_search_source_id_asc' | 'site_search_source_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
+    order_by?: 'search_index_id_asc' | 'search_index_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
     [k: string]: unknown;
 };
 /**
@@ -1098,11 +1098,11 @@ export type SearchResultInstancesHrefSchema = {
          */
         query: string;
         /**
-         * The site search source ID or name on which the search will be performed. If not provided, the first enabled site search source will be used.
+         * The search index ID or name on which the search will be performed. If not provided, the first enabled search index will be used.
          */
-        site_search_source_id?: string;
+        search_index_id?: string;
         /**
-         * **[Deprecated]** Use `site_search_source_id` instead. The build trigger ID or name on which the search will be performed. This parameter is only supported for backward compatibility and will return an error if the build trigger has multiple site search sources associated.
+         * **[Deprecated]** Use `search_index_id` instead. The build trigger ID or name on which the search will be performed. This parameter is only supported for backward compatibility and will return an error if the build trigger has multiple search indexes associated.
          */
         build_trigger_id?: string;
         /**
@@ -1617,9 +1617,9 @@ export type RoleAttributes = {
      */
     can_manage_build_triggers: boolean;
     /**
-     * Can create/edit Site Search Sources
+     * Can create/edit Search Indexes
      */
-    can_manage_site_search_sources: boolean;
+    can_manage_search_indexes: boolean;
     /**
      * Can create/edit webhooks
      */
@@ -1653,9 +1653,9 @@ export type RoleAttributes = {
      */
     can_access_build_events_log: boolean;
     /**
-     * Can access the site search source events log
+     * Can access the search index events log
      */
-    can_access_site_search_source_events_log: boolean;
+    can_access_search_index_events_log: boolean;
     /**
      * Allowed actions on a model (or all) for a role
      */
@@ -1765,16 +1765,16 @@ export type RoleAttributes = {
         build_trigger?: BuildTriggerIdentity | null;
     }[];
     /**
-     * Allowed site search sources for a role
+     * Allowed search indexes for a role
      */
-    positive_site_search_source_permissions: {
-        site_search_source?: SiteSearchSourceIdentity | null;
+    positive_search_index_permissions: {
+        search_index?: SearchIndexIdentity | null;
     }[];
     /**
-     * Prohibited site search sources for a role
+     * Prohibited search indexes for a role
      */
-    negative_site_search_source_permissions: {
-        site_search_source?: SiteSearchSourceIdentity | null;
+    negative_search_index_permissions: {
+        search_index?: SearchIndexIdentity | null;
     }[];
 };
 /**
@@ -1857,9 +1857,9 @@ export type RoleMeta = {
          */
         can_manage_build_triggers: boolean;
         /**
-         * Can create/edit Site Search Sources
+         * Can create/edit Search Indexes
          */
-        can_manage_site_search_sources: boolean;
+        can_manage_search_indexes: boolean;
         /**
          * Can create/edit webhooks
          */
@@ -1893,9 +1893,9 @@ export type RoleMeta = {
          */
         can_access_build_events_log: boolean;
         /**
-         * Can access the site search source events log
+         * Can access the search index events log
          */
-        can_access_site_search_source_events_log: boolean;
+        can_access_search_index_events_log: boolean;
         /**
          * Allowed actions on a model (or all) for a role
          */
@@ -2005,16 +2005,16 @@ export type RoleMeta = {
             build_trigger?: BuildTriggerIdentity | null;
         }[];
         /**
-         * Allowed site search sources for a role
+         * Allowed search indexes for a role
          */
-        positive_site_search_source_permissions: {
-            site_search_source?: SiteSearchSourceIdentity | null;
+        positive_search_index_permissions: {
+            search_index?: SearchIndexIdentity | null;
         }[];
         /**
-         * Prohibited site search sources for a role
+         * Prohibited search indexes for a role
          */
-        negative_site_search_source_permissions: {
-            site_search_source?: SiteSearchSourceIdentity | null;
+        negative_search_index_permissions: {
+            search_index?: SearchIndexIdentity | null;
         }[];
     };
 };
@@ -2070,9 +2070,9 @@ export type RoleCreateSchema = {
              */
             can_manage_shared_filters?: boolean;
             /**
-             * Can create/edit Site Search Sources
+             * Can create/edit Search Indexes
              */
-            can_manage_site_search_sources?: boolean;
+            can_manage_search_indexes?: boolean;
             /**
              * Can create/edit upload collections
              */
@@ -2114,9 +2114,9 @@ export type RoleCreateSchema = {
              */
             can_access_build_events_log?: boolean;
             /**
-             * Can access the site search source events log
+             * Can access the search index events log
              */
-            can_access_site_search_source_events_log?: boolean;
+            can_access_search_index_events_log?: boolean;
             /**
              * Allowed actions on a model (or all) for a role
              */
@@ -2226,16 +2226,16 @@ export type RoleCreateSchema = {
                 build_trigger?: BuildTriggerIdentity | null;
             }[];
             /**
-             * Allowed site search sources for a role
+             * Allowed search indexes for a role
              */
-            positive_site_search_source_permissions?: {
-                site_search_source?: SiteSearchSourceIdentity | null;
+            positive_search_index_permissions?: {
+                search_index?: SearchIndexIdentity | null;
             }[];
             /**
-             * Prohibited site search sources for a role
+             * Prohibited search indexes for a role
              */
-            negative_site_search_source_permissions?: {
-                site_search_source?: SiteSearchSourceIdentity | null;
+            negative_search_index_permissions?: {
+                search_index?: SearchIndexIdentity | null;
             }[];
         };
         /**
@@ -2312,9 +2312,9 @@ export type RoleUpdateSchema = {
              */
             can_manage_shared_filters?: boolean;
             /**
-             * Can create/edit Site Search Sources
+             * Can create/edit Search Indexes
              */
-            can_manage_site_search_sources?: boolean;
+            can_manage_search_indexes?: boolean;
             /**
              * Can create/edit upload collections
              */
@@ -2356,9 +2356,9 @@ export type RoleUpdateSchema = {
              */
             can_access_build_events_log?: boolean;
             /**
-             * Can access the site search source events log
+             * Can access the search index events log
              */
-            can_access_site_search_source_events_log?: boolean;
+            can_access_search_index_events_log?: boolean;
             /**
              * Allowed actions on a model (or all) for a role
              */
@@ -2468,16 +2468,16 @@ export type RoleUpdateSchema = {
                 build_trigger?: BuildTriggerIdentity | null;
             }[];
             /**
-             * Allowed site search sources for a role
+             * Allowed search indexes for a role
              */
-            positive_site_search_source_permissions?: {
-                site_search_source?: SiteSearchSourceIdentity | null;
+            positive_search_index_permissions?: {
+                search_index?: SearchIndexIdentity | null;
             }[];
             /**
-             * Prohibited site search sources for a role
+             * Prohibited search indexes for a role
              */
-            negative_site_search_source_permissions?: {
-                site_search_source?: SiteSearchSourceIdentity | null;
+            negative_search_index_permissions?: {
+                search_index?: SearchIndexIdentity | null;
             }[];
         };
         /**
@@ -3246,9 +3246,9 @@ export type SitePlanAttributes = {
      */
     build_triggers: null | number;
     /**
-     * Number of site search sources
+     * Number of search indexes
      */
-    site_search_sources: null | number;
+    search_indexes: null | number;
     /**
      * Number of plugins
      */
@@ -3413,7 +3413,7 @@ export type SitePlanAttributes = {
             amount_per_packet: number;
             price: number;
         };
-        site_search_sources?: {
+        search_indexes?: {
             amount_per_packet: number;
             price: number;
         };
@@ -6807,24 +6807,24 @@ export type BuildEventSelfTargetSchema = {
     data: BuildEvent;
 };
 /**
- * Represents an event occurred during the site search indexing process.
+ * Represents an event occurred during the search indexing process.
  *
  * This interface was referenced by `DatoApi`'s JSON-Schema
- * via the `definition` "site_search_source_event".
+ * via the `definition` "search_index_event".
  */
-export type SiteSearchSourceEvent = {
-    type: SiteSearchSourceEventType;
-    id: SiteSearchSourceEventIdentity;
-    attributes: SiteSearchSourceEventAttributes;
-    relationships: SiteSearchSourceEventRelationships;
+export type SearchIndexEvent = {
+    type: SearchIndexEventType;
+    id: SearchIndexEventIdentity;
+    attributes: SearchIndexEventAttributes;
+    relationships: SearchIndexEventRelationships;
 };
 /**
  * JSON API attributes
  *
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `definition` "attributes".
  */
-export type SiteSearchSourceEventAttributes = {
+export type SearchIndexEventAttributes = {
     /**
      * The type of activity
      */
@@ -6843,53 +6843,53 @@ export type SiteSearchSourceEventAttributes = {
 /**
  * JSON API links
  *
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `definition` "relationships".
  */
-export type SiteSearchSourceEventRelationships = {
+export type SearchIndexEventRelationships = {
     /**
-     * Source site search source
+     * Source search index
      */
-    site_search_source: {
-        data: SiteSearchSourceData;
+    search_index: {
+        data: SearchIndexData;
     };
 };
 /**
  * JSON API data
  *
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `definition` "data".
  */
-export type SiteSearchSourceData = {
-    type: SiteSearchSourceType;
-    id: SiteSearchSourceIdentity;
+export type SearchIndexData = {
+    type: SearchIndexType;
+    id: SearchIndexIdentity;
 };
 /**
  * JSON API data
  *
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `definition` "data".
  */
-export type SiteSearchSourceEventData = {
-    type: SiteSearchSourceEventType;
-    id: SiteSearchSourceEventIdentity;
+export type SearchIndexEventData = {
+    type: SearchIndexEventType;
+    id: SearchIndexEventIdentity;
 };
 /**
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `instances.targetSchema` link.
  */
-export type SiteSearchSourceEventInstancesTargetSchema = {
-    data: SiteSearchSourceEvent[];
+export type SearchIndexEventInstancesTargetSchema = {
+    data: SearchIndexEvent[];
     meta: {
         total_count: number;
     };
 };
 /**
- * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
+ * This interface was referenced by `SearchIndexEvent`'s JSON-Schema
  * via the `self.targetSchema` link.
  */
-export type SiteSearchSourceEventSelfTargetSchema = {
-    data: SiteSearchSourceEvent;
+export type SearchIndexEventSelfTargetSchema = {
+    data: SearchIndexEvent;
 };
 /**
  * JSON API links
@@ -9443,31 +9443,31 @@ export type BuildTriggerDestroyTargetSchema = {
     data: BuildTrigger;
 };
 /**
- * A Site Search Source represents a website that should be indexed by DatoCMS Site Search. When enabled, DatoCMS will periodically spider the website to update the search index.
+ * A Search Index represents a website that should be indexed by DatoCMS Site Search. When enabled, DatoCMS will periodically spider the website to update the search index.
  *
  * This interface was referenced by `DatoApi`'s JSON-Schema
- * via the `definition` "site_search_source".
+ * via the `definition` "search_index".
  */
-export type SiteSearchSource = {
-    type: SiteSearchSourceType;
-    id: SiteSearchSourceIdentity;
-    attributes: SiteSearchSourceAttributes;
-    relationships: SiteSearchSourceRelationships;
-    meta: SiteSearchSourceMeta;
+export type SearchIndex = {
+    type: SearchIndexType;
+    id: SearchIndexIdentity;
+    attributes: SearchIndexAttributes;
+    relationships: SearchIndexRelationships;
+    meta: SearchIndexMeta;
 };
 /**
  * JSON API attributes
  *
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `definition` "attributes".
  */
-export type SiteSearchSourceAttributes = {
+export type SearchIndexAttributes = {
     /**
-     * Name of the site search source
+     * Name of the search index
      */
     name: string;
     /**
-     * Whether the site search source is enabled or not
+     * Whether the search index is enabled or not
      */
     enabled: boolean;
     /**
@@ -9478,28 +9478,32 @@ export type SiteSearchSourceAttributes = {
      * The public URL of the frontend. This is the starting point from which the website's spidering will start
      */
     frontend_url: string | null;
+    /**
+     * Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
+     */
+    user_agent_suffix: string | null;
 };
 /**
  * JSON API links
  *
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `definition` "relationships".
  */
-export type SiteSearchSourceRelationships = {
+export type SearchIndexRelationships = {
     /**
-     * The build triggers connected to this site search source
+     * The build triggers connected to this search index
      */
     build_triggers: {
         data: BuildTriggerData[];
     };
 };
 /**
- * Meta information about the site search source
+ * Meta information about the search index
  *
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `definition` "meta".
  */
-export type SiteSearchSourceMeta = {
+export type SearchIndexMeta = {
     /**
      * Status of the site search indexing
      */
@@ -9510,33 +9514,33 @@ export type SiteSearchSourceMeta = {
     last_indexing_completed_at: string | null;
 };
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `instances.targetSchema` link.
  */
-export type SiteSearchSourceInstancesTargetSchema = {
-    data: SiteSearchSource[];
+export type SearchIndexInstancesTargetSchema = {
+    data: SearchIndex[];
 };
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `self.targetSchema` link.
  */
-export type SiteSearchSourceSelfTargetSchema = {
-    data: SiteSearchSource;
+export type SearchIndexSelfTargetSchema = {
+    data: SearchIndex;
 };
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `create.schema` link.
  */
-export type SiteSearchSourceCreateSchema = {
+export type SearchIndexCreateSchema = {
     data: {
-        type: SiteSearchSourceType;
+        type: SearchIndexType;
         attributes: {
             /**
-             * Name of the site search source
+             * Name of the search index
              */
             name: string;
             /**
-             * Whether the site search source is enabled or not
+             * Whether the search index is enabled or not
              */
             enabled: boolean;
             /**
@@ -9547,13 +9551,17 @@ export type SiteSearchSourceCreateSchema = {
              * The public URL of the frontend. This is the starting point from which the website's spidering will start
              */
             frontend_url: string | null;
+            /**
+             * Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
+             */
+            user_agent_suffix?: string | null;
         };
         /**
          * JSON API links
          */
         relationships?: {
             /**
-             * The build triggers connected to this site search source
+             * The build triggers connected to this search index
              */
             build_triggers?: {
                 data: BuildTriggerData[];
@@ -9562,27 +9570,27 @@ export type SiteSearchSourceCreateSchema = {
     };
 };
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `create.targetSchema` link.
  */
-export type SiteSearchSourceCreateTargetSchema = {
-    data: SiteSearchSource;
+export type SearchIndexCreateTargetSchema = {
+    data: SearchIndex;
 };
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `update.schema` link.
  */
-export type SiteSearchSourceUpdateSchema = {
+export type SearchIndexUpdateSchema = {
     data: {
-        type: SiteSearchSourceType;
-        id: SiteSearchSourceIdentity;
+        type: SearchIndexType;
+        id: SearchIndexIdentity;
         attributes: {
             /**
-             * Name of the site search source
+             * Name of the search index
              */
             name?: string;
             /**
-             * Whether the site search source is enabled or not
+             * Whether the search index is enabled or not
              */
             enabled?: boolean;
             /**
@@ -9593,13 +9601,17 @@ export type SiteSearchSourceUpdateSchema = {
              * The public URL of the frontend. This is the starting point from which the website's spidering will start
              */
             frontend_url?: string | null;
+            /**
+             * Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
+             */
+            user_agent_suffix?: string | null;
         };
         /**
          * JSON API links
          */
         relationships?: {
             /**
-             * The build triggers connected to this site search source
+             * The build triggers connected to this search index
              */
             build_triggers?: {
                 data: BuildTriggerData[];
@@ -9608,18 +9620,18 @@ export type SiteSearchSourceUpdateSchema = {
     };
 };
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `update.targetSchema` link.
  */
-export type SiteSearchSourceUpdateTargetSchema = {
-    data: SiteSearchSource;
+export type SearchIndexUpdateTargetSchema = {
+    data: SearchIndex;
 };
 /**
- * This interface was referenced by `SiteSearchSource`'s JSON-Schema
+ * This interface was referenced by `SearchIndex`'s JSON-Schema
  * via the `destroy.targetSchema` link.
  */
-export type SiteSearchSourceDestroyTargetSchema = {
-    data: SiteSearchSource;
+export type SearchIndexDestroyTargetSchema = {
+    data: SearchIndex;
 };
 /**
  * In DatoCMS you can create filters to help you (and other editors) quickly search for records