@datocms/cma-client 0.1.0

package/src/generated/resources/ItemType.ts

@@ -0,0 +1,227 @@
+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 ItemType extends BaseResource {
+  static readonly TYPE: 'item_type' = 'item_type';
+
+  /**
+   * Create a new model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
+   */
+  create(body: SimpleSchemaTypes.ItemTypeCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.ItemTypeCreateSchema>(body, {
+        type: 'item_type',
+        attributes: [
+          'name',
+          'api_key',
+          'singleton',
+          'all_locales_required',
+          'sortable',
+          'modular_block',
+          'draft_mode_active',
+          'tree',
+          'ordering_direction',
+          'ordering_meta',
+          'collection_appeareance',
+          'collection_appearance',
+          'hint',
+        ],
+        relationships: [
+          'ordering_field',
+          'title_field',
+          'image_preview_field',
+          'excerpt_field',
+          'workflow',
+        ],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
+   */
+  rawCreate(
+    body: SchemaTypes.ItemTypeCreateSchema,
+  ): Promise<SchemaTypes.ItemTypeCreateTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeCreateTargetSchema>({
+      method: 'POST',
+      url: `/item-types`,
+      body,
+    });
+  }
+
+  /**
+   * Update a model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
+   */
+  update(
+    itemTypeId: string | SimpleSchemaTypes.ItemTypeData,
+    body: SimpleSchemaTypes.ItemTypeUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(itemTypeId),
+      Utils.serializeRequestBody<SchemaTypes.ItemTypeUpdateSchema>(body, {
+        id: Utils.toId(itemTypeId),
+        type: 'item_type',
+        attributes: [
+          'name',
+          'api_key',
+          'collection_appeareance',
+          'collection_appearance',
+          'singleton',
+          'all_locales_required',
+          'sortable',
+          'modular_block',
+          'draft_mode_active',
+          'tree',
+          'ordering_direction',
+          'ordering_meta',
+          'has_singleton_item',
+          'hint',
+        ],
+        relationships: [
+          'ordering_field',
+          'title_field',
+          'image_preview_field',
+          'excerpt_field',
+          'workflow',
+        ],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeUpdateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
+   */
+  rawUpdate(
+    itemTypeId: string,
+    body: SchemaTypes.ItemTypeUpdateSchema,
+  ): Promise<SchemaTypes.ItemTypeUpdateJobSchema> {
+    return this.client.request<SchemaTypes.ItemTypeUpdateJobSchema>({
+      method: 'PUT',
+      url: `/item-types/${itemTypeId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all models
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all models
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
+   */
+  rawList(): Promise<SchemaTypes.ItemTypeInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeInstancesTargetSchema>({
+      method: 'GET',
+      url: `/item-types`,
+    });
+  }
+
+  /**
+   * Retrieve a model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
+   */
+  find(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
+    return this.rawFind(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
+   */
+  rawFind(itemTypeId: string): Promise<SchemaTypes.ItemTypeSelfTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeSelfTargetSchema>({
+      method: 'GET',
+      url: `/item-types/${itemTypeId}`,
+    });
+  }
+
+  /**
+   * Duplicate model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
+   */
+  duplicate(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
+    return this.rawDuplicate(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeDuplicateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Duplicate model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
+   */
+  rawDuplicate(
+    itemTypeId: string,
+  ): Promise<SchemaTypes.ItemTypeDuplicateTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeDuplicateTargetSchema>({
+      method: 'POST',
+      url: `/item-types/${itemTypeId}/duplicate`,
+    });
+  }
+
+  /**
+   * Delete a model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
+   */
+  destroy(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
+    return this.rawDestroy(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeDestroyJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a model
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
+   */
+  rawDestroy(
+    itemTypeId: string,
+  ): Promise<SchemaTypes.ItemTypeDestroyJobSchema> {
+    return this.client.request<SchemaTypes.ItemTypeDestroyJobSchema>({
+      method: 'DELETE',
+      url: `/item-types/${itemTypeId}`,
+    });
+  }
+}

package/src/generated/resources/ItemTypeFilter.ts

@@ -0,0 +1,163 @@
+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 ItemTypeFilter extends BaseResource {
+  static readonly TYPE: 'item_type_filter' = 'item_type_filter';
+
+  /**
+   * Create a new filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/create
+   */
+  create(body: SimpleSchemaTypes.ItemTypeFilterCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.ItemTypeFilterCreateSchema>(body, {
+        type: 'item_type_filter',
+        attributes: ['name', 'filter', 'shared'],
+        relationships: ['item_type'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeFilterCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/create
+   */
+  rawCreate(
+    body: SchemaTypes.ItemTypeFilterCreateSchema,
+  ): Promise<SchemaTypes.ItemTypeFilterCreateTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeFilterCreateTargetSchema>({
+      method: 'POST',
+      url: `/item-type-filters`,
+      body,
+    });
+  }
+
+  /**
+   * Update a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/update
+   */
+  update(
+    itemTypeFilterId: string | SimpleSchemaTypes.ItemTypeFilterData,
+    body: SimpleSchemaTypes.ItemTypeFilterUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(itemTypeFilterId),
+      Utils.serializeRequestBody<SchemaTypes.ItemTypeFilterUpdateSchema>(body, {
+        id: Utils.toId(itemTypeFilterId),
+        type: 'item_type_filter',
+        attributes: ['name', 'shared', 'filter'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeFilterUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/update
+   */
+  rawUpdate(
+    itemTypeFilterId: string,
+    body: SchemaTypes.ItemTypeFilterUpdateSchema,
+  ): Promise<SchemaTypes.ItemTypeFilterUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeFilterUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/item-type-filters/${itemTypeFilterId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all filters
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeFilterInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all filters
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/instances
+   */
+  rawList(): Promise<SchemaTypes.ItemTypeFilterInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeFilterInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: `/item-type-filters`,
+      },
+    );
+  }
+
+  /**
+   * Retrieve a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/self
+   */
+  find(itemTypeFilterId: string | SimpleSchemaTypes.ItemTypeFilterData) {
+    return this.rawFind(Utils.toId(itemTypeFilterId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeFilterSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/self
+   */
+  rawFind(
+    itemTypeFilterId: string,
+  ): Promise<SchemaTypes.ItemTypeFilterSelfTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeFilterSelfTargetSchema>({
+      method: 'GET',
+      url: `/item-type-filters/${itemTypeFilterId}`,
+    });
+  }
+
+  /**
+   * Delete a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/destroy
+   */
+  destroy(itemTypeFilterId: string | SimpleSchemaTypes.ItemTypeFilterData) {
+    return this.rawDestroy(Utils.toId(itemTypeFilterId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemTypeFilterDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type_filter/destroy
+   */
+  rawDestroy(
+    itemTypeFilterId: string,
+  ): Promise<SchemaTypes.ItemTypeFilterDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.ItemTypeFilterDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/item-type-filters/${itemTypeFilterId}`,
+    });
+  }
+}

package/src/generated/resources/ItemVersion.ts

@@ -0,0 +1,137 @@
+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 ItemVersion extends BaseResource {
+  static readonly TYPE: 'item_version' = 'item_version';
+
+  /**
+   * Restore an old record version
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/restore
+   */
+  restore(itemVersionId: string | SimpleSchemaTypes.ItemVersionData) {
+    return this.rawRestore(Utils.toId(itemVersionId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemVersionRestoreJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Restore an old record version
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/restore
+   */
+  rawRestore(
+    itemVersionId: string,
+  ): Promise<SchemaTypes.ItemVersionRestoreJobSchema> {
+    return this.client.request<SchemaTypes.ItemVersionRestoreJobSchema>({
+      method: 'POST',
+      url: `/versions/${itemVersionId}/restore`,
+    });
+  }
+
+  /**
+   * List all record versions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/instances
+   */
+  list(
+    itemId: string | SimpleSchemaTypes.ItemData,
+    queryParams?: SimpleSchemaTypes.ItemVersionInstancesHrefSchema,
+  ) {
+    return this.rawList(Utils.toId(itemId), queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemVersionInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all record versions
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/instances
+   */
+  rawList(
+    itemId: string,
+    queryParams?: SchemaTypes.ItemVersionInstancesHrefSchema,
+  ): Promise<SchemaTypes.ItemVersionInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.ItemVersionInstancesTargetSchema>({
+      method: 'GET',
+      url: `/items/${itemId}/versions`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/instances
+   */
+  async *listPagedIterator(
+    itemId: string | SimpleSchemaTypes.ItemData,
+    queryParams?: SimpleSchemaTypes.ItemVersionInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      Utils.toId(itemId),
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.ItemVersionInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by rawList()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/instances
+   */
+  rawListPagedIterator(
+    itemId: string,
+    queryParams?: SchemaTypes.ItemVersionInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    return Utils.rawPageIterator<
+      SchemaTypes.ItemVersionInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 15,
+        maxLimit: 50,
+      },
+      (page) => this.rawList(itemId, { ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
+
+  /**
+   * Retrieve a record version
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/self
+   */
+  find(itemVersionId: string | SimpleSchemaTypes.ItemVersionData) {
+    return this.rawFind(Utils.toId(itemVersionId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ItemVersionSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a record version
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/item-version/self
+   */
+  rawFind(
+    itemVersionId: string,
+  ): Promise<SchemaTypes.ItemVersionSelfTargetSchema> {
+    return this.client.request<SchemaTypes.ItemVersionSelfTargetSchema>({
+      method: 'GET',
+      url: `/versions/${itemVersionId}`,
+    });
+  }
+}

package/src/generated/resources/JobResult.ts

@@ -0,0 +1,33 @@
+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 JobResult extends BaseResource {
+  static readonly TYPE: 'job_result' = 'job_result';
+
+  /**
+   * Retrieve a job result
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/job-result/self
+   */
+  find(jobResultId: string | SimpleSchemaTypes.JobResultData) {
+    return this.rawFind(Utils.toId(jobResultId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.JobResultSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a job result
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/job-result/self
+   */
+  rawFind(jobResultId: string): Promise<SchemaTypes.JobResultSelfTargetSchema> {
+    return this.client.request<SchemaTypes.JobResultSelfTargetSchema>({
+      method: 'GET',
+      url: `/job-results/${jobResultId}`,
+    });
+  }
+}

package/src/generated/resources/MaintenanceMode.ts

@@ -0,0 +1,90 @@
+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 MaintenanceMode extends BaseResource {
+  static readonly TYPE: 'maintenance_mode' = 'maintenance_mode';
+
+  /**
+   * Retrieve maintenence mode
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
+   */
+  find() {
+    return this.rawFind().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MaintenanceModeSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve maintenence mode
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
+   */
+  rawFind(): Promise<SchemaTypes.MaintenanceModeSelfTargetSchema> {
+    return this.client.request<SchemaTypes.MaintenanceModeSelfTargetSchema>({
+      method: 'GET',
+      url: `/maintenance-mode`,
+    });
+  }
+
+  /**
+   * Activate maintenance mode: this means that the primary environment will be read-only
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
+   */
+  activate(queryParams?: SimpleSchemaTypes.MaintenanceModeActivateHrefSchema) {
+    return this.rawActivate(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MaintenanceModeActivateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Activate maintenance mode: this means that the primary environment will be read-only
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
+   */
+  rawActivate(
+    queryParams?: SchemaTypes.MaintenanceModeActivateHrefSchema,
+  ): Promise<SchemaTypes.MaintenanceModeActivateTargetSchema> {
+    return this.client.request<SchemaTypes.MaintenanceModeActivateTargetSchema>(
+      {
+        method: 'PUT',
+        url: `/maintenance-mode/activate`,
+        queryParams,
+      },
+    );
+  }
+
+  /**
+   * De-activate maintenance mode
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
+   */
+  deactivate() {
+    return this.rawDeactivate().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MaintenanceModeDeactivateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * De-activate maintenance mode
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
+   */
+  rawDeactivate(): Promise<SchemaTypes.MaintenanceModeDeactivateTargetSchema> {
+    return this.client.request<SchemaTypes.MaintenanceModeDeactivateTargetSchema>(
+      {
+        method: 'PUT',
+        url: `/maintenance-mode/deactivate`,
+      },
+    );
+  }
+}