@datocms/cma-client 0.1.0

package/src/generated/resources/Environment.ts

@@ -0,0 +1,154 @@
+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 Environment extends BaseResource {
+  static readonly TYPE: 'environment' = 'environment';
+
+  /**
+   * Fork an existing environment
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
+   */
+  fork(
+    environmentId: string | SimpleSchemaTypes.EnvironmentData,
+    body: SimpleSchemaTypes.EnvironmentForkSchema,
+  ) {
+    return this.rawFork(
+      Utils.toId(environmentId),
+      Utils.serializeRequestBody<SchemaTypes.EnvironmentForkSchema>(body, {
+        id: Utils.toId(environmentId),
+        type: 'environment',
+        attributes: [],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EnvironmentForkJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Fork an existing environment
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
+   */
+  rawFork(
+    environmentId: string,
+    body: SchemaTypes.EnvironmentForkSchema,
+  ): Promise<SchemaTypes.EnvironmentForkJobSchema> {
+    return this.client.request<SchemaTypes.EnvironmentForkJobSchema>({
+      method: 'POST',
+      url: `/environments/${environmentId}/fork`,
+      body,
+    });
+  }
+
+  /**
+   * Promote an environment to primary
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
+   */
+  promote(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
+    return this.rawPromote(Utils.toId(environmentId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EnvironmentPromoteTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Promote an environment to primary
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
+   */
+  rawPromote(
+    environmentId: string,
+  ): Promise<SchemaTypes.EnvironmentPromoteTargetSchema> {
+    return this.client.request<SchemaTypes.EnvironmentPromoteTargetSchema>({
+      method: 'PUT',
+      url: `/environments/${environmentId}/promote`,
+    });
+  }
+
+  /**
+   * List all environments
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EnvironmentInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all environments
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
+   */
+  rawList(): Promise<SchemaTypes.EnvironmentInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.EnvironmentInstancesTargetSchema>({
+      method: 'GET',
+      url: `/environments`,
+    });
+  }
+
+  /**
+   * Retrieve a environment
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
+   */
+  find(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
+    return this.rawFind(Utils.toId(environmentId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EnvironmentSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a environment
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
+   */
+  rawFind(
+    environmentId: string,
+  ): Promise<SchemaTypes.EnvironmentSelfTargetSchema> {
+    return this.client.request<SchemaTypes.EnvironmentSelfTargetSchema>({
+      method: 'GET',
+      url: `/environments/${environmentId}`,
+    });
+  }
+
+  /**
+   * Delete a environment
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
+   */
+  destroy(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
+    return this.rawDestroy(Utils.toId(environmentId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.EnvironmentDestroyJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a environment
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
+   */
+  rawDestroy(
+    environmentId: string,
+  ): Promise<SchemaTypes.EnvironmentDestroyJobSchema> {
+    return this.client.request<SchemaTypes.EnvironmentDestroyJobSchema>({
+      method: 'DELETE',
+      url: `/environments/${environmentId}`,
+    });
+  }
+}

package/src/generated/resources/Field.ts

@@ -0,0 +1,271 @@
+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 Field extends BaseResource {
+  static readonly TYPE: 'field' = 'field';
+
+  /**
+   * Create a new field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
+   */
+  create(
+    itemTypeId: string | SimpleSchemaTypes.ItemTypeData,
+    body: SimpleSchemaTypes.FieldCreateSchema,
+  ) {
+    return this.rawCreate(
+      Utils.toId(itemTypeId),
+      Utils.serializeRequestBody<SchemaTypes.FieldCreateSchema>(body, {
+        type: 'field',
+        attributes: [
+          'label',
+          'field_type',
+          'api_key',
+          'localized',
+          'validators',
+          'appeareance',
+          'appearance',
+          'position',
+          'hint',
+          'default_value',
+        ],
+        relationships: ['fieldset'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldCreateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
+   */
+  rawCreate(
+    itemTypeId: string,
+    body: SchemaTypes.FieldCreateSchema,
+  ): Promise<SchemaTypes.FieldCreateJobSchema> {
+    return this.client.request<SchemaTypes.FieldCreateJobSchema>({
+      method: 'POST',
+      url: `/item-types/${itemTypeId}/fields`,
+      body,
+    });
+  }
+
+  /**
+   * Update a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
+   */
+  update(
+    fieldId: string | SimpleSchemaTypes.FieldData,
+    body: SimpleSchemaTypes.FieldUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(fieldId),
+      Utils.serializeRequestBody<SchemaTypes.FieldUpdateSchema>(body, {
+        id: Utils.toId(fieldId),
+        type: 'field',
+        attributes: [
+          'default_value',
+          'label',
+          'api_key',
+          'localized',
+          'validators',
+          'appeareance',
+          'appearance',
+          'position',
+          'field_type',
+          'hint',
+        ],
+        relationships: ['fieldset'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldUpdateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
+   */
+  rawUpdate(
+    fieldId: string,
+    body: SchemaTypes.FieldUpdateSchema,
+  ): Promise<SchemaTypes.FieldUpdateJobSchema> {
+    return this.client.request<SchemaTypes.FieldUpdateJobSchema>({
+      method: 'PUT',
+      url: `/fields/${fieldId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all fields
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/instances
+   */
+  list(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
+    return this.rawList(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all fields
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/instances
+   */
+  rawList(itemTypeId: string): Promise<SchemaTypes.FieldInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.FieldInstancesTargetSchema>({
+      method: 'GET',
+      url: `/item-types/${itemTypeId}/fields`,
+    });
+  }
+
+  /**
+   * List referenced fields
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  referencing(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
+    return this.rawReferencing(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldReferencingTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List referenced fields
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawReferencing(
+    itemTypeId: string,
+  ): Promise<SchemaTypes.FieldReferencingTargetSchema> {
+    return this.client.request<SchemaTypes.FieldReferencingTargetSchema>({
+      method: 'GET',
+      url: `/item-types/${itemTypeId}/fields/referencing`,
+    });
+  }
+
+  /**
+   * List related fields
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/related
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  related(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
+    return this.rawRelated(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldRelatedTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List related fields
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/related
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawRelated(
+    itemTypeId: string,
+  ): Promise<SchemaTypes.FieldRelatedTargetSchema> {
+    return this.client.request<SchemaTypes.FieldRelatedTargetSchema>({
+      method: 'GET',
+      url: `/item-types/${itemTypeId}/fields/related`,
+    });
+  }
+
+  /**
+   * Retrieve a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/self
+   */
+  find(fieldId: string | SimpleSchemaTypes.FieldData) {
+    return this.rawFind(Utils.toId(fieldId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/self
+   */
+  rawFind(fieldId: string): Promise<SchemaTypes.FieldSelfTargetSchema> {
+    return this.client.request<SchemaTypes.FieldSelfTargetSchema>({
+      method: 'GET',
+      url: `/fields/${fieldId}`,
+    });
+  }
+
+  /**
+   * Delete a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/destroy
+   */
+  destroy(fieldId: string | SimpleSchemaTypes.FieldData) {
+    return this.rawDestroy(Utils.toId(fieldId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldDestroyJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/destroy
+   */
+  rawDestroy(fieldId: string): Promise<SchemaTypes.FieldDestroyJobSchema> {
+    return this.client.request<SchemaTypes.FieldDestroyJobSchema>({
+      method: 'DELETE',
+      url: `/fields/${fieldId}`,
+    });
+  }
+
+  /**
+   * Duplicate a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/duplicate
+   */
+  duplicate(fieldId: string | SimpleSchemaTypes.FieldData) {
+    return this.rawDuplicate(Utils.toId(fieldId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldDuplicateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Duplicate a field
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/field/duplicate
+   */
+  rawDuplicate(fieldId: string): Promise<SchemaTypes.FieldDuplicateJobSchema> {
+    return this.client.request<SchemaTypes.FieldDuplicateJobSchema>({
+      method: 'POST',
+      url: `/fields/${fieldId}/duplicate`,
+    });
+  }
+}

package/src/generated/resources/Fieldset.ts

@@ -0,0 +1,178 @@
+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 Fieldset extends BaseResource {
+  static readonly TYPE: 'fieldset' = 'fieldset';
+
+  /**
+   * Create a new fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/create
+   */
+  create(
+    itemTypeId: string | SimpleSchemaTypes.ItemTypeData,
+    body: SimpleSchemaTypes.FieldsetCreateSchema,
+  ) {
+    return this.rawCreate(
+      Utils.toId(itemTypeId),
+      Utils.serializeRequestBody<SchemaTypes.FieldsetCreateSchema>(body, {
+        type: 'fieldset',
+        attributes: [
+          'title',
+          'hint',
+          'position',
+          'collapsible',
+          'start_collapsed',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldsetCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/create
+   */
+  rawCreate(
+    itemTypeId: string,
+    body: SchemaTypes.FieldsetCreateSchema,
+  ): Promise<SchemaTypes.FieldsetCreateTargetSchema> {
+    return this.client.request<SchemaTypes.FieldsetCreateTargetSchema>({
+      method: 'POST',
+      url: `/item-types/${itemTypeId}/fieldsets`,
+      body,
+    });
+  }
+
+  /**
+   * Update a fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/update
+   */
+  update(
+    fieldsetId: string | SimpleSchemaTypes.FieldsetData,
+    body: SimpleSchemaTypes.FieldsetUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(fieldsetId),
+      Utils.serializeRequestBody<SchemaTypes.FieldsetUpdateSchema>(body, {
+        id: Utils.toId(fieldsetId),
+        type: 'fieldset',
+        attributes: [
+          'title',
+          'hint',
+          'position',
+          'collapsible',
+          'start_collapsed',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldsetUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/update
+   */
+  rawUpdate(
+    fieldsetId: string,
+    body: SchemaTypes.FieldsetUpdateSchema,
+  ): Promise<SchemaTypes.FieldsetUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.FieldsetUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/fieldsets/${fieldsetId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all fieldsets
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/instances
+   */
+  list(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
+    return this.rawList(Utils.toId(itemTypeId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldsetInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all fieldsets
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/instances
+   */
+  rawList(
+    itemTypeId: string,
+  ): Promise<SchemaTypes.FieldsetInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.FieldsetInstancesTargetSchema>({
+      method: 'GET',
+      url: `/item-types/${itemTypeId}/fieldsets`,
+    });
+  }
+
+  /**
+   * Retrieve a fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/self
+   */
+  find(fieldsetId: string | SimpleSchemaTypes.FieldsetData) {
+    return this.rawFind(Utils.toId(fieldsetId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldsetSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/self
+   */
+  rawFind(fieldsetId: string): Promise<SchemaTypes.FieldsetSelfTargetSchema> {
+    return this.client.request<SchemaTypes.FieldsetSelfTargetSchema>({
+      method: 'GET',
+      url: `/fieldsets/${fieldsetId}`,
+    });
+  }
+
+  /**
+   * Delete a fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy
+   */
+  destroy(fieldsetId: string | SimpleSchemaTypes.FieldsetData) {
+    return this.rawDestroy(Utils.toId(fieldsetId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.FieldsetDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a fieldset
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy
+   */
+  rawDestroy(
+    fieldsetId: string,
+  ): Promise<SchemaTypes.FieldsetDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.FieldsetDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/fieldsets/${fieldsetId}`,
+    });
+  }
+}