@datocms/cma-client 0.1.0

package/src/generated/resources/ScheduledUnpublishing.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 ScheduledUnpublishing extends BaseResource {
+  static readonly TYPE: 'scheduled_unpublishing' = 'scheduled_unpublishing';
+
+  /**
+   * Create a new scheduled unpublishing
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create
+   */
+  create(
+    itemId: string | SimpleSchemaTypes.ItemData,
+    body: SimpleSchemaTypes.ScheduledUnpublishingCreateSchema,
+  ) {
+    return this.rawCreate(
+      Utils.toId(itemId),
+      Utils.serializeRequestBody<SchemaTypes.ScheduledUnpublishingCreateSchema>(
+        body,
+        {
+          type: 'scheduled_unpublishing',
+          attributes: ['unpublishing_scheduled_at'],
+          relationships: [],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ScheduledUnpublishingCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new scheduled unpublishing
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create
+   */
+  rawCreate(
+    itemId: string,
+    body: SchemaTypes.ScheduledUnpublishingCreateSchema,
+  ): Promise<SchemaTypes.ScheduledUnpublishingCreateTargetSchema> {
+    return this.client.request<SchemaTypes.ScheduledUnpublishingCreateTargetSchema>(
+      {
+        method: 'POST',
+        url: `/items/${itemId}/scheduled-unpublishing`,
+        body,
+      },
+    );
+  }
+
+  /**
+   * Delete a scheduled unpublishing
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy
+   */
+  destroy(itemId: string | SimpleSchemaTypes.ItemData) {
+    return this.rawDestroy(Utils.toId(itemId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.ScheduledUnpublishingDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a scheduled unpublishing
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy
+   */
+  rawDestroy(
+    itemId: string,
+  ): Promise<SchemaTypes.ScheduledUnpublishingDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.ScheduledUnpublishingDestroyTargetSchema>(
+      {
+        method: 'DELETE',
+        url: `/items/${itemId}/scheduled-unpublishing`,
+      },
+    );
+  }
+}

package/src/generated/resources/SearchResult.ts

@@ -0,0 +1,36 @@
+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 SearchResult extends BaseResource {
+  static readonly TYPE: 'search_result' = 'search_result';
+
+  /**
+   * Search for results
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
+   */
+  list(queryParams?: SimpleSchemaTypes.SearchResultInstancesHrefSchema) {
+    return this.rawList(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SearchResultInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Search for results
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
+   */
+  rawList(
+    queryParams?: SchemaTypes.SearchResultInstancesHrefSchema,
+  ): Promise<SchemaTypes.SearchResultInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.SearchResultInstancesTargetSchema>({
+      method: 'GET',
+      url: `/search-results`,
+      queryParams,
+    });
+  }
+}

package/src/generated/resources/Session.ts

@@ -0,0 +1,46 @@
+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 Session extends BaseResource {
+  static readonly TYPE: 'session' = 'session';
+
+  /**
+   * Create a new session
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  create(body: SimpleSchemaTypes.SessionCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.SessionCreateSchema>(body, {
+        type: 'email_credentials',
+        attributes: ['email', 'password', 'otp_code'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SessionCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new session
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawCreate(
+    body: SchemaTypes.SessionCreateSchema,
+  ): Promise<SchemaTypes.SessionCreateTargetSchema> {
+    return this.client.request<SchemaTypes.SessionCreateTargetSchema>({
+      method: 'POST',
+      url: `/sessions`,
+      body,
+    });
+  }
+}

package/src/generated/resources/Site.ts

@@ -0,0 +1,77 @@
+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 Site extends BaseResource {
+  static readonly TYPE: 'site' = 'site';
+
+  /**
+   * Retrieve the site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
+   */
+  find() {
+    return this.rawFind().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve the site
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
+   */
+  rawFind(): Promise<SchemaTypes.SiteSelfTargetSchema> {
+    return this.client.request<SchemaTypes.SiteSelfTargetSchema>({
+      method: 'GET',
+      url: `/site`,
+    });
+  }
+
+  /**
+   * Update the site's settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
+   */
+  update(body: SimpleSchemaTypes.SiteUpdateSchema) {
+    return this.rawUpdate(
+      Utils.serializeRequestBody<SchemaTypes.SiteUpdateSchema>(body, {
+        type: 'site',
+        attributes: [
+          'no_index',
+          'favicon',
+          'global_seo',
+          'name',
+          'theme',
+          'locales',
+          'timezone',
+          'require_2fa',
+          'ip_tracking_enabled',
+        ],
+        relationships: ['sso_default_role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteUpdateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update the site's settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
+   */
+  rawUpdate(
+    body: SchemaTypes.SiteUpdateSchema,
+  ): Promise<SchemaTypes.SiteUpdateJobSchema> {
+    return this.client.request<SchemaTypes.SiteUpdateJobSchema>({
+      method: 'PUT',
+      url: `/site`,
+      body,
+    });
+  }
+}

package/src/generated/resources/SiteInvitation.ts

@@ -0,0 +1,184 @@
+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 SiteInvitation extends BaseResource {
+  static readonly TYPE: 'site_invitation' = 'site_invitation';
+
+  /**
+   * Invite a new user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/create
+   */
+  create(body: SimpleSchemaTypes.SiteInvitationCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.SiteInvitationCreateSchema>(body, {
+        type: 'site_invitation',
+        attributes: ['email'],
+        relationships: ['role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteInvitationCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Invite a new user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/create
+   */
+  rawCreate(
+    body: SchemaTypes.SiteInvitationCreateSchema,
+  ): Promise<SchemaTypes.SiteInvitationCreateTargetSchema> {
+    return this.client.request<SchemaTypes.SiteInvitationCreateTargetSchema>({
+      method: 'POST',
+      url: `/site-invitations`,
+      body,
+    });
+  }
+
+  /**
+   * Update an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/update
+   */
+  update(
+    siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData,
+    body: SimpleSchemaTypes.SiteInvitationUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(siteInvitationId),
+      Utils.serializeRequestBody<SchemaTypes.SiteInvitationUpdateSchema>(body, {
+        id: Utils.toId(siteInvitationId),
+        type: 'site_invitation',
+        attributes: [],
+        relationships: ['role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteInvitationUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/update
+   */
+  rawUpdate(
+    siteInvitationId: string,
+    body: SchemaTypes.SiteInvitationUpdateSchema,
+  ): Promise<SchemaTypes.SiteInvitationUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.SiteInvitationUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/site-invitations/${siteInvitationId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all invitations
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteInvitationInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all invitations
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances
+   */
+  rawList(): Promise<SchemaTypes.SiteInvitationInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.SiteInvitationInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: `/site-invitations`,
+      },
+    );
+  }
+
+  /**
+   * Retrieve an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/self
+   */
+  find(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData) {
+    return this.rawFind(Utils.toId(siteInvitationId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteInvitationSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/self
+   */
+  rawFind(
+    siteInvitationId: string,
+  ): Promise<SchemaTypes.SiteInvitationSelfTargetSchema> {
+    return this.client.request<SchemaTypes.SiteInvitationSelfTargetSchema>({
+      method: 'GET',
+      url: `/site-invitations/${siteInvitationId}`,
+    });
+  }
+
+  /**
+   * Delete an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy
+   */
+  destroy(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData) {
+    return this.rawDestroy(Utils.toId(siteInvitationId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SiteInvitationDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy
+   */
+  rawDestroy(
+    siteInvitationId: string,
+  ): Promise<SchemaTypes.SiteInvitationDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.SiteInvitationDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/site-invitations/${siteInvitationId}`,
+    });
+  }
+
+  /**
+   * Resend an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend
+   */
+  resend(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData) {
+    return this.rawResend(Utils.toId(siteInvitationId));
+  }
+
+  /**
+   * Resend an invitation
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend
+   */
+  rawResend(siteInvitationId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'POST',
+      url: `/site-invitations/${siteInvitationId}/resend`,
+    });
+  }
+}

package/src/generated/resources/SsoGroup.ts

@@ -0,0 +1,127 @@
+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 SsoGroup extends BaseResource {
+  static readonly TYPE: 'sso_group' = 'sso_group';
+
+  /**
+   * List all SSO groups
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoGroupInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all SSO groups
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/instances
+   */
+  rawList(): Promise<SchemaTypes.SsoGroupInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.SsoGroupInstancesTargetSchema>({
+      method: 'GET',
+      url: `/sso-groups`,
+    });
+  }
+
+  /**
+   * Sync SSO provider groups to DatoCMS roles
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/copy_roles
+   */
+  copyRoles(ssoGroupId: string | SimpleSchemaTypes.SsoGroupData) {
+    return this.rawCopyRoles(Utils.toId(ssoGroupId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoGroupCopyRolesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Sync SSO provider groups to DatoCMS roles
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/copy_roles
+   */
+  rawCopyRoles(
+    ssoGroupId: string,
+  ): Promise<SchemaTypes.SsoGroupCopyRolesTargetSchema> {
+    return this.client.request<SchemaTypes.SsoGroupCopyRolesTargetSchema>({
+      method: 'POST',
+      url: `/sso-groups/${ssoGroupId}/copy-roles`,
+    });
+  }
+
+  /**
+   * Update a SSO group
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/update
+   */
+  update(
+    ssoGroupId: string | SimpleSchemaTypes.SsoGroupData,
+    body: SimpleSchemaTypes.SsoGroupUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(ssoGroupId),
+      Utils.serializeRequestBody<SchemaTypes.SsoGroupUpdateSchema>(body, {
+        id: Utils.toId(ssoGroupId),
+        type: 'sso_group',
+        attributes: ['priority'],
+        relationships: ['role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoGroupUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a SSO group
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/update
+   */
+  rawUpdate(
+    ssoGroupId: string,
+    body: SchemaTypes.SsoGroupUpdateSchema,
+  ): Promise<SchemaTypes.SsoGroupUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.SsoGroupUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/sso-groups/${ssoGroupId}`,
+      body,
+    });
+  }
+
+  /**
+   * Delete a group
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/destroy
+   */
+  destroy(ssoGroupId: string | SimpleSchemaTypes.SsoGroupData) {
+    return this.rawDestroy(Utils.toId(ssoGroupId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoGroupDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a group
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/destroy
+   */
+  rawDestroy(
+    ssoGroupId: string,
+  ): Promise<SchemaTypes.SsoGroupDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.SsoGroupDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/sso-groups/${ssoGroupId}`,
+    });
+  }
+}

package/src/generated/resources/SsoSettings.ts

@@ -0,0 +1,94 @@
+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 SsoSettings extends BaseResource {
+  static readonly TYPE: 'sso_settings' = 'sso_settings';
+
+  /**
+   * Retrieve SSO Settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/self
+   */
+  find() {
+    return this.rawFind().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoSettingsSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve SSO Settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/self
+   */
+  rawFind(): Promise<SchemaTypes.SsoSettingsSelfTargetSchema> {
+    return this.client.request<SchemaTypes.SsoSettingsSelfTargetSchema>({
+      method: 'GET',
+      url: `/sso-settings`,
+    });
+  }
+
+  /**
+   * Generate SSO token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/generate_token
+   */
+  generateToken() {
+    return this.rawGenerateToken().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoSettingsGenerateTokenTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Generate SSO token
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/generate_token
+   */
+  rawGenerateToken(): Promise<SchemaTypes.SsoSettingsGenerateTokenTargetSchema> {
+    return this.client.request<SchemaTypes.SsoSettingsGenerateTokenTargetSchema>(
+      {
+        method: 'PUT',
+        url: `/sso-settings/generate-token`,
+      },
+    );
+  }
+
+  /**
+   * Update SSO Settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/update
+   */
+  update(body: SimpleSchemaTypes.SsoSettingsUpdateSchema) {
+    return this.rawUpdate(
+      Utils.serializeRequestBody<SchemaTypes.SsoSettingsUpdateSchema>(body, {
+        type: 'sso_settings',
+        attributes: ['idp_saml_metadata_url'],
+        relationships: ['default_role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoSettingsUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update SSO Settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/update
+   */
+  rawUpdate(
+    body: SchemaTypes.SsoSettingsUpdateSchema,
+  ): Promise<SchemaTypes.SsoSettingsUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.SsoSettingsUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/sso-settings`,
+      body,
+    });
+  }
+}