@datocms/cma-client 0.1.0

package/dist/esm/generated/resources/Item.d.ts

@@ -0,0 +1,255 @@
+import * as Utils from '@datocms/rest-client-utils';
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+export default class Item extends BaseResource {
+    static readonly TYPE: 'item';
+    /**
+     * List all records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/instances
+     */
+    list(queryParams?: SimpleSchemaTypes.ItemInstancesHrefSchema): Promise<SimpleSchemaTypes.ItemInstancesTargetSchema>;
+    /**
+     * List all records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/instances
+     */
+    rawList(queryParams?: SchemaTypes.ItemInstancesHrefSchema): Promise<SchemaTypes.ItemInstancesTargetSchema>;
+    /**
+     * Async iterator to auto-paginate over elements returned by list()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/instances
+     */
+    listPagedIterator(queryParams?: SimpleSchemaTypes.ItemInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.Item, void, unknown>;
+    /**
+     * Async iterator to auto-paginate over elements returned by rawList()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/instances
+     */
+    rawListPagedIterator(queryParams?: SchemaTypes.ItemInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.Item, void, unknown>;
+    /**
+     * Validates an existing record field
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_existing
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    validateExisting(itemId: string | SimpleSchemaTypes.ItemData, body: SimpleSchemaTypes.ItemValidateExistingSchema): Promise<void>;
+    /**
+     * Validates an existing record field
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_existing
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    rawValidateExisting(itemId: string, body: SchemaTypes.ItemValidateExistingSchema): Promise<void>;
+    /**
+     * Validates a record field
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_new
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    validateNew(body: SimpleSchemaTypes.ItemValidateNewSchema): Promise<void>;
+    /**
+     * Validates a record field
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_new
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    rawValidateNew(body: SchemaTypes.ItemValidateNewSchema): Promise<void>;
+    /**
+     * Create a new record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/create
+     */
+    create(body: SimpleSchemaTypes.ItemCreateSchema): Promise<SimpleSchemaTypes.Item>;
+    /**
+     * Create a new record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/create
+     */
+    rawCreate(body: SchemaTypes.ItemCreateSchema): Promise<SchemaTypes.ItemCreateTargetSchema>;
+    /**
+     * Duplicate a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/duplicate
+     */
+    duplicate(itemId: string | SimpleSchemaTypes.ItemData): Promise<SimpleSchemaTypes.Item>;
+    /**
+     * Duplicate a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/duplicate
+     */
+    rawDuplicate(itemId: string): Promise<SchemaTypes.ItemDuplicateJobSchema>;
+    /**
+     * Update a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/update
+     */
+    update(itemId: string | SimpleSchemaTypes.ItemData, body: SimpleSchemaTypes.ItemUpdateSchema): Promise<SimpleSchemaTypes.Item>;
+    /**
+     * Update a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/update
+     */
+    rawUpdate(itemId: string, body: SchemaTypes.ItemUpdateSchema): Promise<SchemaTypes.ItemUpdateTargetSchema>;
+    /**
+     * Referenced records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/references
+     */
+    references(itemId: string | SimpleSchemaTypes.ItemData, queryParams?: SimpleSchemaTypes.ItemReferencesHrefSchema): Promise<SimpleSchemaTypes.ItemReferencesTargetSchema>;
+    /**
+     * Referenced records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/references
+     */
+    rawReferences(itemId: string, queryParams?: SchemaTypes.ItemReferencesHrefSchema): Promise<SchemaTypes.ItemReferencesTargetSchema>;
+    /**
+     * Retrieve a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/self
+     */
+    find(itemId: string | SimpleSchemaTypes.ItemData, queryParams?: SimpleSchemaTypes.ItemSelfHrefSchema): Promise<SimpleSchemaTypes.Item>;
+    /**
+     * Retrieve a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/self
+     */
+    rawFind(itemId: string, queryParams?: SchemaTypes.ItemSelfHrefSchema): Promise<SchemaTypes.ItemSelfTargetSchema>;
+    /**
+     * Delete a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/destroy
+     */
+    destroy(itemId: string | SimpleSchemaTypes.ItemData): Promise<SimpleSchemaTypes.Item>;
+    /**
+     * Delete a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/destroy
+     */
+    rawDestroy(itemId: string): Promise<SchemaTypes.ItemDestroyJobSchema>;
+    /**
+     * Delete multiple records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/batch_destroy
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    batchDestroy(queryParams?: SimpleSchemaTypes.ItemBatchDestroyHrefSchema): Promise<SimpleSchemaTypes.ItemBatchDestroyJobSchema>;
+    /**
+     * Delete multiple records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/batch_destroy
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    rawBatchDestroy(queryParams?: SchemaTypes.ItemBatchDestroyHrefSchema): Promise<SchemaTypes.ItemBatchDestroyJobSchema>;
+    /**
+     * Publish multiple records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/batch_publish
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    batchPublish(queryParams?: SimpleSchemaTypes.ItemBatchPublishHrefSchema): Promise<SimpleSchemaTypes.ItemBatchPublishJobSchema>;
+    /**
+     * Publish multiple records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/batch_publish
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    rawBatchPublish(queryParams?: SchemaTypes.ItemBatchPublishHrefSchema): Promise<SchemaTypes.ItemBatchPublishJobSchema>;
+    /**
+     * Unpublish multiple records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/batch_unpublish
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    batchUnpublish(queryParams?: SimpleSchemaTypes.ItemBatchUnpublishHrefSchema): Promise<SimpleSchemaTypes.ItemBatchUnpublishJobSchema>;
+    /**
+     * Unpublish multiple records
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/batch_unpublish
+     *
+     * @deprecated This API call is to be considered private and might change without notice
+     */
+    rawBatchUnpublish(queryParams?: SchemaTypes.ItemBatchUnpublishHrefSchema): Promise<SchemaTypes.ItemBatchUnpublishJobSchema>;
+    /**
+     * Publish a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/publish
+     */
+    publish(itemId: string | SimpleSchemaTypes.ItemData, queryParams?: SimpleSchemaTypes.ItemPublishHrefSchema): Promise<SimpleSchemaTypes.Item>;
+    /**
+     * Publish a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/publish
+     */
+    rawPublish(itemId: string, queryParams?: SchemaTypes.ItemPublishHrefSchema): Promise<SchemaTypes.ItemPublishTargetSchema>;
+    /**
+     * Unpublish a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/unpublish
+     */
+    unpublish(itemId: string | SimpleSchemaTypes.ItemData, queryParams?: SimpleSchemaTypes.ItemUnpublishHrefSchema): Promise<SimpleSchemaTypes.Item>;
+    /**
+     * Unpublish a record
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/unpublish
+     */
+    rawUnpublish(itemId: string, queryParams?: SchemaTypes.ItemUnpublishHrefSchema): Promise<SchemaTypes.ItemUnpublishTargetSchema>;
+    /**
+     * Publish items in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_publish
+     */
+    bulkPublish(body: SimpleSchemaTypes.ItemBulkPublishSchema): Promise<SimpleSchemaTypes.ItemBulkPublishJobSchema>;
+    /**
+     * Publish items in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_publish
+     */
+    rawBulkPublish(body: SchemaTypes.ItemBulkPublishSchema): Promise<SchemaTypes.ItemBulkPublishJobSchema>;
+    /**
+     * Unpublish items in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_unpublish
+     */
+    bulkUnpublish(body: SimpleSchemaTypes.ItemBulkUnpublishSchema): Promise<SimpleSchemaTypes.ItemBulkUnpublishJobSchema>;
+    /**
+     * Unpublish items in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_unpublish
+     */
+    rawBulkUnpublish(body: SchemaTypes.ItemBulkUnpublishSchema): Promise<SchemaTypes.ItemBulkUnpublishJobSchema>;
+    /**
+     * Destroy items in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_destroy
+     */
+    bulkDestroy(body: SimpleSchemaTypes.ItemBulkDestroySchema): Promise<SimpleSchemaTypes.ItemBulkDestroyJobSchema>;
+    /**
+     * Destroy items in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_destroy
+     */
+    rawBulkDestroy(body: SchemaTypes.ItemBulkDestroySchema): Promise<SchemaTypes.ItemBulkDestroyJobSchema>;
+    /**
+     * Move items to stage in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_move_to_stage
+     */
+    bulkMoveToStage(body: SimpleSchemaTypes.ItemBulkMoveToStageSchema): Promise<SimpleSchemaTypes.ItemBulkMoveToStageJobSchema>;
+    /**
+     * Move items to stage in bulk
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item/bulk_move_to_stage
+     */
+    rawBulkMoveToStage(body: SchemaTypes.ItemBulkMoveToStageSchema): Promise<SchemaTypes.ItemBulkMoveToStageJobSchema>;
+}