@datocms/cma-client 0.1.0

package/src/generated/resources/MenuItem.ts

@@ -0,0 +1,162 @@
+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 MenuItem extends BaseResource {
+  static readonly TYPE: 'menu_item' = 'menu_item';
+
+  /**
+   * Create a new menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/create
+   */
+  create(body: SimpleSchemaTypes.MenuItemCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.MenuItemCreateSchema>(body, {
+        type: 'menu_item',
+        attributes: ['label', 'external_url', 'position', 'open_in_new_tab'],
+        relationships: ['item_type', 'parent'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MenuItemCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/create
+   */
+  rawCreate(
+    body: SchemaTypes.MenuItemCreateSchema,
+  ): Promise<SchemaTypes.MenuItemCreateTargetSchema> {
+    return this.client.request<SchemaTypes.MenuItemCreateTargetSchema>({
+      method: 'POST',
+      url: `/menu-items`,
+      body,
+    });
+  }
+
+  /**
+   * Update a menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/update
+   */
+  update(
+    menuItemId: string | SimpleSchemaTypes.MenuItemData,
+    body: SimpleSchemaTypes.MenuItemUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(menuItemId),
+      Utils.serializeRequestBody<SchemaTypes.MenuItemUpdateSchema>(body, {
+        id: Utils.toId(menuItemId),
+        type: 'menu_item',
+        attributes: ['label', 'external_url', 'position', 'open_in_new_tab'],
+        relationships: ['item_type', 'parent'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MenuItemUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/update
+   */
+  rawUpdate(
+    menuItemId: string,
+    body: SchemaTypes.MenuItemUpdateSchema,
+  ): Promise<SchemaTypes.MenuItemUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.MenuItemUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/menu-items/${menuItemId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all menu items
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/instances
+   */
+  list(queryParams?: SimpleSchemaTypes.MenuItemInstancesHrefSchema) {
+    return this.rawList(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MenuItemInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all menu items
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/instances
+   */
+  rawList(
+    queryParams?: SchemaTypes.MenuItemInstancesHrefSchema,
+  ): Promise<SchemaTypes.MenuItemInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.MenuItemInstancesTargetSchema>({
+      method: 'GET',
+      url: `/menu-items`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Retrieve a menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/self
+   */
+  find(menuItemId: string | SimpleSchemaTypes.MenuItemData) {
+    return this.rawFind(Utils.toId(menuItemId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MenuItemSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/self
+   */
+  rawFind(menuItemId: string): Promise<SchemaTypes.MenuItemSelfTargetSchema> {
+    return this.client.request<SchemaTypes.MenuItemSelfTargetSchema>({
+      method: 'GET',
+      url: `/menu-items/${menuItemId}`,
+    });
+  }
+
+  /**
+   * Delete a menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy
+   */
+  destroy(menuItemId: string | SimpleSchemaTypes.MenuItemData) {
+    return this.rawDestroy(Utils.toId(menuItemId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.MenuItemDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a menu item
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy
+   */
+  rawDestroy(
+    menuItemId: string,
+  ): Promise<SchemaTypes.MenuItemDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.MenuItemDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/menu-items/${menuItemId}`,
+    });
+  }
+}

package/src/generated/resources/Plugin.ts

@@ -0,0 +1,199 @@
+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 Plugin extends BaseResource {
+  static readonly TYPE: 'plugin' = 'plugin';
+
+  /**
+   * Create a new plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/create
+   */
+  create(body: SimpleSchemaTypes.PluginCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.PluginCreateSchema>(body, {
+        type: 'plugin',
+        attributes: [
+          'package_name',
+          'name',
+          'description',
+          'url',
+          'permissions',
+          'plugin_type',
+          'field_types',
+          'parameter_definitions',
+          'package_version',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.PluginCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/create
+   */
+  rawCreate(
+    body: SchemaTypes.PluginCreateSchema,
+  ): Promise<SchemaTypes.PluginCreateTargetSchema> {
+    return this.client.request<SchemaTypes.PluginCreateTargetSchema>({
+      method: 'POST',
+      url: `/plugins`,
+      body,
+    });
+  }
+
+  /**
+   * Update a plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/update
+   */
+  update(
+    pluginId: string | SimpleSchemaTypes.PluginData,
+    body: SimpleSchemaTypes.PluginUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(pluginId),
+      Utils.serializeRequestBody<SchemaTypes.PluginUpdateSchema>(body, {
+        id: Utils.toId(pluginId),
+        type: 'plugin',
+        attributes: [
+          'name',
+          'description',
+          'url',
+          'parameters',
+          'package_version',
+          'permissions',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.PluginUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/update
+   */
+  rawUpdate(
+    pluginId: string,
+    body: SchemaTypes.PluginUpdateSchema,
+  ): Promise<SchemaTypes.PluginUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.PluginUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/plugins/${pluginId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all plugins
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.PluginInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all plugins
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/instances
+   */
+  rawList(): Promise<SchemaTypes.PluginInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.PluginInstancesTargetSchema>({
+      method: 'GET',
+      url: `/plugins`,
+    });
+  }
+
+  /**
+   * Retrieve a plugins
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
+   */
+  find(pluginId: string | SimpleSchemaTypes.PluginData) {
+    return this.rawFind(Utils.toId(pluginId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.PluginSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a plugins
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
+   */
+  rawFind(pluginId: string): Promise<SchemaTypes.PluginSelfTargetSchema> {
+    return this.client.request<SchemaTypes.PluginSelfTargetSchema>({
+      method: 'GET',
+      url: `/plugins/${pluginId}`,
+    });
+  }
+
+  /**
+   * Delete a plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/destroy
+   */
+  destroy(pluginId: string | SimpleSchemaTypes.PluginData) {
+    return this.rawDestroy(Utils.toId(pluginId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.PluginDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/destroy
+   */
+  rawDestroy(pluginId: string): Promise<SchemaTypes.PluginDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.PluginDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/plugins/${pluginId}`,
+    });
+  }
+
+  /**
+   * Retrieve all fields using the plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/fields
+   */
+  fields(pluginId: string | SimpleSchemaTypes.PluginData) {
+    return this.rawFields(Utils.toId(pluginId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.PluginFieldsTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve all fields using the plugin
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/fields
+   */
+  rawFields(pluginId: string): Promise<SchemaTypes.PluginFieldsTargetSchema> {
+    return this.client.request<SchemaTypes.PluginFieldsTargetSchema>({
+      method: 'GET',
+      url: `/plugins/${pluginId}/fields`,
+    });
+  }
+}

package/src/generated/resources/PublicInfo.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 PublicInfo extends BaseResource {
+  static readonly TYPE: 'public_info' = 'public_info';
+
+  /**
+   * Retrieve public site info
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/public-info/self
+   */
+  find() {
+    return this.rawFind().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.PublicInfoSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve public site info
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/public-info/self
+   */
+  rawFind(): Promise<SchemaTypes.PublicInfoSelfTargetSchema> {
+    return this.client.request<SchemaTypes.PublicInfoSelfTargetSchema>({
+      method: 'GET',
+      url: `/public-info`,
+    });
+  }
+}

package/src/generated/resources/Role.ts

@@ -0,0 +1,209 @@
+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 Role extends BaseResource {
+  static readonly TYPE: 'role' = 'role';
+
+  /**
+   * Create a new role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
+   */
+  create(body: SimpleSchemaTypes.RoleCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.RoleCreateSchema>(body, {
+        type: 'role',
+        attributes: [
+          'name',
+          'can_edit_favicon',
+          'can_edit_site',
+          'can_edit_schema',
+          'can_manage_menu',
+          'can_edit_environment',
+          'can_promote_environments',
+          'environments_access',
+          'can_manage_users',
+          'can_manage_shared_filters',
+          'can_manage_build_triggers',
+          'can_manage_webhooks',
+          'can_manage_environments',
+          'can_manage_sso',
+          'can_access_audit_log',
+          'can_manage_workflows',
+          'can_manage_access_tokens',
+          'can_perform_site_search',
+          'can_access_build_events_log',
+          'positive_item_type_permissions',
+          'negative_item_type_permissions',
+          'positive_upload_permissions',
+          'negative_upload_permissions',
+          'positive_build_trigger_permissions',
+          'negative_build_trigger_permissions',
+        ],
+        relationships: ['inherits_permissions_from'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.RoleCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
+   */
+  rawCreate(
+    body: SchemaTypes.RoleCreateSchema,
+  ): Promise<SchemaTypes.RoleCreateTargetSchema> {
+    return this.client.request<SchemaTypes.RoleCreateTargetSchema>({
+      method: 'POST',
+      url: `/roles`,
+      body,
+    });
+  }
+
+  /**
+   * Update a role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
+   */
+  update(
+    roleId: string | SimpleSchemaTypes.RoleData,
+    body: SimpleSchemaTypes.RoleUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(roleId),
+      Utils.serializeRequestBody<SchemaTypes.RoleUpdateSchema>(body, {
+        id: Utils.toId(roleId),
+        type: 'role',
+        attributes: [
+          'name',
+          'can_edit_favicon',
+          'can_edit_site',
+          'can_edit_schema',
+          'can_manage_menu',
+          'can_edit_environment',
+          'can_promote_environments',
+          'environments_access',
+          'can_manage_users',
+          'can_manage_shared_filters',
+          'can_manage_build_triggers',
+          'can_manage_webhooks',
+          'can_manage_environments',
+          'can_manage_sso',
+          'can_access_audit_log',
+          'can_manage_workflows',
+          'can_manage_access_tokens',
+          'can_perform_site_search',
+          'can_access_build_events_log',
+          'positive_item_type_permissions',
+          'negative_item_type_permissions',
+          'positive_upload_permissions',
+          'negative_upload_permissions',
+          'positive_build_trigger_permissions',
+          'negative_build_trigger_permissions',
+        ],
+        relationships: ['inherits_permissions_from'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.RoleUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
+   */
+  rawUpdate(
+    roleId: string,
+    body: SchemaTypes.RoleUpdateSchema,
+  ): Promise<SchemaTypes.RoleUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.RoleUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/roles/${roleId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all roles
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.RoleInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all roles
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
+   */
+  rawList(): Promise<SchemaTypes.RoleInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.RoleInstancesTargetSchema>({
+      method: 'GET',
+      url: `/roles`,
+    });
+  }
+
+  /**
+   * Retrieve a role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
+   */
+  find(roleId: string | SimpleSchemaTypes.RoleData) {
+    return this.rawFind(Utils.toId(roleId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.RoleSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
+   */
+  rawFind(roleId: string): Promise<SchemaTypes.RoleSelfTargetSchema> {
+    return this.client.request<SchemaTypes.RoleSelfTargetSchema>({
+      method: 'GET',
+      url: `/roles/${roleId}`,
+    });
+  }
+
+  /**
+   * Delete a role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
+   */
+  destroy(roleId: string | SimpleSchemaTypes.RoleData) {
+    return this.rawDestroy(Utils.toId(roleId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.RoleDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a role
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
+   */
+  rawDestroy(roleId: string): Promise<SchemaTypes.RoleDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.RoleDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/roles/${roleId}`,
+    });
+  }
+}

package/src/generated/resources/ScheduledPublication.ts

@@ -0,0 +1,81 @@
+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 ScheduledPublication extends BaseResource {
+  static readonly TYPE: 'scheduled_publication' = 'scheduled_publication';
+
+  /**
+   * Create a new scheduled publication
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create
+   */
+  create(
+    itemId: string | SimpleSchemaTypes.ItemData,
+    body: SimpleSchemaTypes.ScheduledPublicationCreateSchema,
+  ) {
+    return this.rawCreate(
+      Utils.toId(itemId),
+      Utils.serializeRequestBody<SchemaTypes.ScheduledPublicationCreateSchema>(
+        body,
+        {
+          type: 'scheduled_publication',
+          attributes: ['publication_scheduled_at'],
+          relationships: [],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ScheduledPublicationCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new scheduled publication
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create
+   */
+  rawCreate(
+    itemId: string,
+    body: SchemaTypes.ScheduledPublicationCreateSchema,
+  ): Promise<SchemaTypes.ScheduledPublicationCreateTargetSchema> {
+    return this.client.request<SchemaTypes.ScheduledPublicationCreateTargetSchema>(
+      {
+        method: 'POST',
+        url: `/items/${itemId}/scheduled-publication`,
+        body,
+      },
+    );
+  }
+
+  /**
+   * Delete a scheduled publication
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy
+   */
+  destroy(itemId: string | SimpleSchemaTypes.ItemData) {
+    return this.rawDestroy(Utils.toId(itemId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ScheduledPublicationDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a scheduled publication
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy
+   */
+  rawDestroy(
+    itemId: string,
+  ): Promise<SchemaTypes.ScheduledPublicationDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.ScheduledPublicationDestroyTargetSchema>(
+      {
+        method: 'DELETE',
+        url: `/items/${itemId}/scheduled-publication`,
+      },
+    );
+  }
+}