@datocms/cma-client 5.2.0-alpha.3 → 5.2.0-alpha.5

package/src/generated/resources/ItemType.ts

@@ -7,7 +7,7 @@ export default class ItemType extends BaseResource {
   static readonly TYPE = 'item_type' as const;
 
   /**
-   * Create a new model
+   * Create a new model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
    *
@@ -55,7 +55,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Create a new model
+   * Create a new model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
    *
@@ -75,7 +75,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Update a model
+   * Update a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
    *
@@ -125,7 +125,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Update a model
+   * Update a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
    *
@@ -144,7 +144,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * List all models
+   * List all models/block models
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
    *
@@ -160,7 +160,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * List all models
+   * List all models/block models
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
    *
@@ -175,7 +175,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Retrieve a model
+   * Retrieve a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
    *
@@ -189,7 +189,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Retrieve a model
+   * Retrieve a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
    *
@@ -204,7 +204,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Duplicate model
+   * Duplicate model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
    *
@@ -220,7 +220,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Duplicate model
+   * Duplicate model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
    *
@@ -237,7 +237,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Delete a model
+   * Delete a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
    *
@@ -254,7 +254,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Delete a model
+   * Delete a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
    *

package/src/generated/resources/Role.ts

@@ -29,7 +29,7 @@ export default class Role extends BaseResource {
           'environments_access',
           'can_manage_users',
           'can_manage_shared_filters',
-          'can_manage_site_search_sources',
+          'can_manage_search_indexes',
           'can_manage_upload_collections',
           'can_manage_build_triggers',
           'can_manage_webhooks',
@@ -40,15 +40,15 @@ export default class Role extends BaseResource {
           'can_manage_access_tokens',
           'can_perform_site_search',
           'can_access_build_events_log',
-          'can_access_site_search_source_events_log',
+          'can_access_search_index_events_log',
           'positive_item_type_permissions',
           'negative_item_type_permissions',
           'positive_upload_permissions',
           'negative_upload_permissions',
           'positive_build_trigger_permissions',
           'negative_build_trigger_permissions',
-          'positive_site_search_source_permissions',
-          'negative_site_search_source_permissions',
+          'positive_search_index_permissions',
+          'negative_search_index_permissions',
         ],
         relationships: ['inherits_permissions_from'],
       }),
@@ -100,7 +100,7 @@ export default class Role extends BaseResource {
           'environments_access',
           'can_manage_users',
           'can_manage_shared_filters',
-          'can_manage_site_search_sources',
+          'can_manage_search_indexes',
           'can_manage_upload_collections',
           'can_manage_build_triggers',
           'can_manage_webhooks',
@@ -111,15 +111,15 @@ export default class Role extends BaseResource {
           'can_manage_access_tokens',
           'can_perform_site_search',
           'can_access_build_events_log',
-          'can_access_site_search_source_events_log',
+          'can_access_search_index_events_log',
           'positive_item_type_permissions',
           'negative_item_type_permissions',
           'positive_upload_permissions',
           'negative_upload_permissions',
           'positive_build_trigger_permissions',
           'negative_build_trigger_permissions',
-          'positive_site_search_source_permissions',
-          'negative_site_search_source_permissions',
+          'positive_search_index_permissions',
+          'negative_search_index_permissions',
         ],
         relationships: ['inherits_permissions_from'],
       }),

package/src/generated/resources/SearchIndex.ts

@@ -0,0 +1,243 @@
+import * as Utils from '@datocms/rest-client-utils';
+import BaseResource from '../../BaseResource';
+import type * as ApiTypes from '../ApiTypes';
+import type * as RawApiTypes from '../RawApiTypes';
+
+export default class SearchIndex extends BaseResource {
+  static readonly TYPE = 'search_index' as const;
+
+  /**
+   * List all search indexes for a site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SearchIndexInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all search indexes for a site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawList(): Promise<RawApiTypes.SearchIndexInstancesTargetSchema> {
+    return this.client.request<RawApiTypes.SearchIndexInstancesTargetSchema>({
+      method: 'GET',
+      url: '/search-indexes',
+    });
+  }
+
+  /**
+   * Retrieve a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  find(searchIndexId: string | ApiTypes.SearchIndexData) {
+    return this.rawFind(Utils.toId(searchIndexId)).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SearchIndexSelfTargetSchema>(body),
+    );
+  }
+
+  /**
+   * Retrieve a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawFind(
+    searchIndexId: string,
+  ): Promise<RawApiTypes.SearchIndexSelfTargetSchema> {
+    return this.client.request<RawApiTypes.SearchIndexSelfTargetSchema>({
+      method: 'GET',
+      url: `/search-indexes/${searchIndexId}`,
+    });
+  }
+
+  /**
+   * Create a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  create(body: ApiTypes.SearchIndexCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<RawApiTypes.SearchIndexCreateSchema>(body, {
+        type: 'search_index',
+        attributes: ['name', 'enabled', 'frontend_url', 'user_agent_suffix'],
+        relationships: ['build_triggers'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SearchIndexCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawCreate(
+    body: RawApiTypes.SearchIndexCreateSchema,
+  ): Promise<RawApiTypes.SearchIndexCreateTargetSchema> {
+    return this.client.request<RawApiTypes.SearchIndexCreateTargetSchema>({
+      method: 'POST',
+      url: '/search-indexes',
+      body,
+    });
+  }
+
+  /**
+   * Update a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  update(
+    searchIndexId: string | ApiTypes.SearchIndexData,
+    body: ApiTypes.SearchIndexUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(searchIndexId),
+      Utils.serializeRequestBody<RawApiTypes.SearchIndexUpdateSchema>(body, {
+        id: Utils.toId(searchIndexId),
+        type: 'search_index',
+        attributes: ['name', 'enabled', 'frontend_url', 'user_agent_suffix'],
+        relationships: ['build_triggers'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SearchIndexUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawUpdate(
+    searchIndexId: string,
+    body: RawApiTypes.SearchIndexUpdateSchema,
+  ): Promise<RawApiTypes.SearchIndexUpdateTargetSchema> {
+    return this.client.request<RawApiTypes.SearchIndexUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/search-indexes/${searchIndexId}`,
+      body,
+    });
+  }
+
+  /**
+   * Trigger the indexing process
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  trigger(searchIndexId: string | ApiTypes.SearchIndexData) {
+    return this.rawTrigger(Utils.toId(searchIndexId));
+  }
+
+  /**
+   * Trigger the indexing process
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawTrigger(searchIndexId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'POST',
+      url: `/search-indexes/${searchIndexId}/trigger`,
+    });
+  }
+
+  /**
+   * Abort a the current indexing process and mark it as failed
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  abort(searchIndexId: string | ApiTypes.SearchIndexData) {
+    return this.rawAbort(Utils.toId(searchIndexId));
+  }
+
+  /**
+   * Abort a the current indexing process and mark it as failed
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawAbort(searchIndexId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'DELETE',
+      url: `/search-indexes/${searchIndexId}/abort`,
+    });
+  }
+
+  /**
+   * Delete a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  destroy(searchIndexId: string | ApiTypes.SearchIndexData) {
+    return this.rawDestroy(Utils.toId(searchIndexId)).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SearchIndexDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a search index
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawDestroy(
+    searchIndexId: string,
+  ): Promise<RawApiTypes.SearchIndexDestroyTargetSchema> {
+    return this.client.request<RawApiTypes.SearchIndexDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/search-indexes/${searchIndexId}`,
+    });
+  }
+}

package/src/generated/resources/{SiteSearchSourceEvent.ts → SearchIndexEvent.ts}

@@ -3,40 +3,40 @@ import BaseResource from '../../BaseResource';
 import type * as ApiTypes from '../ApiTypes';
 import type * as RawApiTypes from '../RawApiTypes';
 
-export default class SiteSearchSourceEvent extends BaseResource {
-  static readonly TYPE = 'site_search_source_event' as const;
+export default class SearchIndexEvent extends BaseResource {
+  static readonly TYPE = 'search_index_event' as const;
 
   /**
-   * List all site search indexing events
+   * List all search indexing events
    *
-   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  list(queryParams?: ApiTypes.SiteSearchSourceEventInstancesHrefSchema) {
+  list(queryParams?: ApiTypes.SearchIndexEventInstancesHrefSchema) {
     return this.rawList(queryParams).then((body) =>
-      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceEventInstancesTargetSchema>(
+      Utils.deserializeResponseBody<ApiTypes.SearchIndexEventInstancesTargetSchema>(
         body,
       ),
     );
   }
 
   /**
-   * List all site search indexing events
+   * List all search indexing events
    *
-   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
   rawList(
-    queryParams?: RawApiTypes.SiteSearchSourceEventInstancesHrefSchema,
-  ): Promise<RawApiTypes.SiteSearchSourceEventInstancesTargetSchema> {
-    return this.client.request<RawApiTypes.SiteSearchSourceEventInstancesTargetSchema>(
+    queryParams?: RawApiTypes.SearchIndexEventInstancesHrefSchema,
+  ): Promise<RawApiTypes.SearchIndexEventInstancesTargetSchema> {
+    return this.client.request<RawApiTypes.SearchIndexEventInstancesTargetSchema>(
       {
         method: 'GET',
-        url: '/site-search-source-events',
+        url: '/search-index-events',
         queryParams,
       },
     );
@@ -45,14 +45,14 @@ export default class SiteSearchSourceEvent extends BaseResource {
   /**
    * Async iterator to auto-paginate over elements returned by list()
    *
-   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
   async *listPagedIterator(
     queryParams?: Utils.OmitFromKnownKeys<
-      ApiTypes.SiteSearchSourceEventInstancesHrefSchema,
+      ApiTypes.SearchIndexEventInstancesHrefSchema,
       'page'
     >,
     iteratorOptions?: Utils.IteratorOptions,
@@ -62,7 +62,7 @@ export default class SiteSearchSourceEvent extends BaseResource {
       iteratorOptions,
     )) {
       yield Utils.deserializeJsonEntity<
-        ApiTypes.SiteSearchSourceEventInstancesTargetSchema[0]
+        ApiTypes.SearchIndexEventInstancesTargetSchema[0]
       >(element);
     }
   }
@@ -70,14 +70,14 @@ export default class SiteSearchSourceEvent extends BaseResource {
   /**
    * Async iterator to auto-paginate over elements returned by rawList()
    *
-   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
   rawListPagedIterator(
     queryParams?: Utils.OmitFromKnownKeys<
-      RawApiTypes.SiteSearchSourceEventInstancesHrefSchema,
+      RawApiTypes.SearchIndexEventInstancesHrefSchema,
       'page'
     >,
     iteratorOptions?: Utils.IteratorOptions,
@@ -85,50 +85,48 @@ export default class SiteSearchSourceEvent extends BaseResource {
     Utils.warnOnPageQueryParam(queryParams);
 
     return Utils.rawPageIterator<
-      RawApiTypes.SiteSearchSourceEventInstancesTargetSchema['data'][0]
+      RawApiTypes.SearchIndexEventInstancesTargetSchema['data'][0]
     >(
       {
         defaultLimit: 30,
         maxLimit: 500,
       },
-      (page: RawApiTypes.SiteSearchSourceEventInstancesHrefSchema['page']) =>
+      (page: RawApiTypes.SearchIndexEventInstancesHrefSchema['page']) =>
         this.rawList({ ...queryParams, page }),
       iteratorOptions,
     );
   }
 
   /**
-   * Retrieve a site search indexing event
+   * Retrieve a search indexing event
    *
-   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/self
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  find(siteSearchSourceEventId: string | ApiTypes.SiteSearchSourceEventData) {
-    return this.rawFind(Utils.toId(siteSearchSourceEventId)).then((body) =>
-      Utils.deserializeResponseBody<ApiTypes.SiteSearchSourceEventSelfTargetSchema>(
+  find(searchIndexEventId: string | ApiTypes.SearchIndexEventData) {
+    return this.rawFind(Utils.toId(searchIndexEventId)).then((body) =>
+      Utils.deserializeResponseBody<ApiTypes.SearchIndexEventSelfTargetSchema>(
         body,
       ),
     );
   }
 
   /**
-   * Retrieve a site search indexing event
+   * Retrieve a search indexing event
    *
-   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/self
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
    *
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
   rawFind(
-    siteSearchSourceEventId: string,
-  ): Promise<RawApiTypes.SiteSearchSourceEventSelfTargetSchema> {
-    return this.client.request<RawApiTypes.SiteSearchSourceEventSelfTargetSchema>(
-      {
-        method: 'GET',
-        url: `/site-search-source-events/${siteSearchSourceEventId}`,
-      },
-    );
+    searchIndexEventId: string,
+  ): Promise<RawApiTypes.SearchIndexEventSelfTargetSchema> {
+    return this.client.request<RawApiTypes.SearchIndexEventSelfTargetSchema>({
+      method: 'GET',
+      url: `/search-index-events/${searchIndexEventId}`,
+    });
   }
 }

package/src/generated/resources/index.ts

@@ -15,7 +15,7 @@ export { default as JobResult } from './JobResult';
 export { default as SubscriptionLimit } from './SubscriptionLimit';
 export { default as SubscriptionFeature } from './SubscriptionFeature';
 export { default as BuildEvent } from './BuildEvent';
-export { default as SiteSearchSourceEvent } from './SiteSearchSourceEvent';
+export { default as SearchIndexEvent } from './SearchIndexEvent';
 export { default as Item } from './Item';
 export { default as ItemVersion } from './ItemVersion';
 export { default as Upload } from './Upload';
@@ -29,7 +29,7 @@ export { default as MaintenanceMode } from './MaintenanceMode';
 export { default as Webhook } from './Webhook';
 export { default as WebhookCall } from './WebhookCall';
 export { default as BuildTrigger } from './BuildTrigger';
-export { default as SiteSearchSource } from './SiteSearchSource';
+export { default as SearchIndex } from './SearchIndex';
 export { default as ItemTypeFilter } from './ItemTypeFilter';
 export { default as UploadFilter } from './UploadFilter';
 export { default as SiteInvitation } from './SiteInvitation';