@datocms/cma-client 0.1.0

package/src/generated/resources/Webhook.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 Webhook extends BaseResource {
+  static readonly TYPE: 'webhook' = 'webhook';
+
+  /**
+   * Create a new webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
+   */
+  create(body: SimpleSchemaTypes.WebhookCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.WebhookCreateSchema>(body, {
+        type: 'webhook',
+        attributes: [
+          'name',
+          'url',
+          'custom_payload',
+          'headers',
+          'events',
+          'http_basic_user',
+          'http_basic_password',
+          'enabled',
+          'payload_api_version',
+          'nested_items_in_payload',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
+   */
+  rawCreate(
+    body: SchemaTypes.WebhookCreateSchema,
+  ): Promise<SchemaTypes.WebhookCreateTargetSchema> {
+    return this.client.request<SchemaTypes.WebhookCreateTargetSchema>({
+      method: 'POST',
+      url: `/webhooks`,
+      body,
+    });
+  }
+
+  /**
+   * Update a webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/update
+   */
+  update(
+    userId: string | SimpleSchemaTypes.UserData,
+    body: SimpleSchemaTypes.WebhookUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(userId),
+      Utils.serializeRequestBody<SchemaTypes.WebhookUpdateSchema>(body, {
+        type: 'webhook',
+        attributes: [
+          'name',
+          'url',
+          'custom_payload',
+          'headers',
+          'events',
+          'http_basic_user',
+          'http_basic_password',
+          'enabled',
+          'payload_api_version',
+          'nested_items_in_payload',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/update
+   */
+  rawUpdate(
+    userId: string,
+    body: SchemaTypes.WebhookUpdateSchema,
+  ): Promise<SchemaTypes.WebhookUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.WebhookUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/webhooks/${userId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all webhooks
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all webhooks
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
+   */
+  rawList(): Promise<SchemaTypes.WebhookInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.WebhookInstancesTargetSchema>({
+      method: 'GET',
+      url: `/webhooks`,
+    });
+  }
+
+  /**
+   * Retrieve a webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
+   */
+  find(userId: string | SimpleSchemaTypes.UserData) {
+    return this.rawFind(Utils.toId(userId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
+   */
+  rawFind(userId: string): Promise<SchemaTypes.WebhookSelfTargetSchema> {
+    return this.client.request<SchemaTypes.WebhookSelfTargetSchema>({
+      method: 'GET',
+      url: `/webhooks/${userId}`,
+    });
+  }
+
+  /**
+   * Delete a webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
+   */
+  destroy(userId: string | SimpleSchemaTypes.UserData) {
+    return this.rawDestroy(Utils.toId(userId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a webhook
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
+   */
+  rawDestroy(userId: string): Promise<SchemaTypes.WebhookDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.WebhookDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/webhooks/${userId}`,
+    });
+  }
+}

package/src/generated/resources/WebhookCall.ts

@@ -0,0 +1,97 @@
+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 WebhookCall extends BaseResource {
+  static readonly TYPE: 'webhook_call' = 'webhook_call';
+
+  /**
+   * List all webhooks calls
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+   */
+  list(queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema) {
+    return this.rawList(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WebhookCallInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all webhooks calls
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+   */
+  rawList(
+    queryParams?: SchemaTypes.WebhookCallInstancesHrefSchema,
+  ): Promise<SchemaTypes.WebhookCallInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.WebhookCallInstancesTargetSchema>({
+      method: 'GET',
+      url: `/webhook_calls`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+   */
+  async *listPagedIterator(
+    queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.WebhookCallInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by rawList()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+   */
+  rawListPagedIterator(
+    queryParams?: SchemaTypes.WebhookCallInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    return Utils.rawPageIterator<
+      SchemaTypes.WebhookCallInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 30,
+        maxLimit: 500,
+      },
+      (page) => this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
+
+  /**
+   * Re-send the webhook call
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook
+   */
+  resendWebhook(userId: string | SimpleSchemaTypes.UserData) {
+    return this.rawResendWebhook(Utils.toId(userId));
+  }
+
+  /**
+   * Re-send the webhook call
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook
+   */
+  rawResendWebhook(userId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'POST',
+      url: `/webhook_calls/${userId}/resend_webhook`,
+    });
+  }
+}

package/src/generated/resources/WhiteLabelSettings.ts

@@ -0,0 +1,72 @@
+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 WhiteLabelSettings extends BaseResource {
+  static readonly TYPE: 'white_label_settings' = 'white_label_settings';
+
+  /**
+   * Retrieve white-label settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self
+   */
+  find() {
+    return this.rawFind().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WhiteLabelSettingsSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve white-label settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self
+   */
+  rawFind(): Promise<SchemaTypes.WhiteLabelSettingsSelfTargetSchema> {
+    return this.client.request<SchemaTypes.WhiteLabelSettingsSelfTargetSchema>({
+      method: 'GET',
+      url: `/white-label-settings`,
+    });
+  }
+
+  /**
+   * Update white-label settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update
+   */
+  update(body: SimpleSchemaTypes.WhiteLabelSettingsUpdateSchema) {
+    return this.rawUpdate(
+      Utils.serializeRequestBody<SchemaTypes.WhiteLabelSettingsUpdateSchema>(
+        body,
+        {
+          type: 'white_label_settings',
+          attributes: ['custom_i18n_messages_template_url'],
+          relationships: [],
+        },
+      ),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WhiteLabelSettingsUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update white-label settings
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update
+   */
+  rawUpdate(
+    body: SchemaTypes.WhiteLabelSettingsUpdateSchema,
+  ): Promise<SchemaTypes.WhiteLabelSettingsUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.WhiteLabelSettingsUpdateTargetSchema>(
+      {
+        method: 'PUT',
+        url: `/white-label-settings`,
+        body,
+      },
+    );
+  }
+}

package/src/generated/resources/Workflow.ts

@@ -0,0 +1,153 @@
+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 Workflow extends BaseResource {
+  static readonly TYPE: 'workflow' = 'workflow';
+
+  /**
+   * Create a new workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
+   */
+  create(body: SimpleSchemaTypes.WorkflowCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.WorkflowCreateSchema>(body, {
+        type: 'workflow',
+        attributes: ['name', 'stages'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WorkflowCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
+   */
+  rawCreate(
+    body: SchemaTypes.WorkflowCreateSchema,
+  ): Promise<SchemaTypes.WorkflowCreateTargetSchema> {
+    return this.client.request<SchemaTypes.WorkflowCreateTargetSchema>({
+      method: 'POST',
+      url: `/workflows`,
+      body,
+    });
+  }
+
+  /**
+   * Update a workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/update
+   */
+  update(
+    workflowId: string | SimpleSchemaTypes.WorkflowData,
+    body: SimpleSchemaTypes.WorkflowUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(workflowId),
+      Utils.serializeRequestBody<SchemaTypes.WorkflowUpdateSchema>(body, {
+        id: Utils.toId(workflowId),
+        type: 'workflow',
+        attributes: ['name', 'stages'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WorkflowUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update a workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/update
+   */
+  rawUpdate(
+    workflowId: string,
+    body: SchemaTypes.WorkflowUpdateSchema,
+  ): Promise<SchemaTypes.WorkflowUpdateTargetSchema> {
+    return this.client.request<SchemaTypes.WorkflowUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/workflows/${workflowId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all workflows
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WorkflowInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all workflows
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
+   */
+  rawList(): Promise<SchemaTypes.WorkflowInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.WorkflowInstancesTargetSchema>({
+      method: 'GET',
+      url: `/workflows`,
+    });
+  }
+
+  /**
+   * Retrieve a workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
+   */
+  find(workflowId: string | SimpleSchemaTypes.WorkflowData) {
+    return this.rawFind(Utils.toId(workflowId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.WorkflowSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
+   */
+  rawFind(workflowId: string): Promise<SchemaTypes.WorkflowSelfTargetSchema> {
+    return this.client.request<SchemaTypes.WorkflowSelfTargetSchema>({
+      method: 'GET',
+      url: `/workflows/${workflowId}`,
+    });
+  }
+
+  /**
+   * Delete a workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
+   */
+  destroy(workflowId: string | SimpleSchemaTypes.WorkflowData) {
+    return this.rawDestroy(Utils.toId(workflowId));
+  }
+
+  /**
+   * Delete a workflow
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
+   */
+  rawDestroy(workflowId: string): Promise<void> {
+    return this.client.request<void>({
+      method: 'DELETE',
+      url: `/workflows/${workflowId}`,
+    });
+  }
+}

package/src/generated/resources/index.ts

@@ -0,0 +1,41 @@
+export { default as Role } from './Role';
+export { default as User } from './User';
+export { default as SsoUser } from './SsoUser';
+export { default as AuditLogEvent } from './AuditLogEvent';
+export { default as MenuItem } from './MenuItem';
+export { default as ItemType } from './ItemType';
+export { default as Field } from './Field';
+export { default as Fieldset } from './Fieldset';
+export { default as Session } from './Session';
+export { default as AccessToken } from './AccessToken';
+export { default as Plugin } from './Plugin';
+export { default as JobResult } from './JobResult';
+export { default as SubscriptionLimit } from './SubscriptionLimit';
+export { default as SubscriptionFeature } from './SubscriptionFeature';
+export { default as BuildEvent } from './BuildEvent';
+export { default as Item } from './Item';
+export { default as ItemVersion } from './ItemVersion';
+export { default as Upload } from './Upload';
+export { default as UploadRequest } from './UploadRequest';
+export { default as ScheduledPublication } from './ScheduledPublication';
+export { default as ScheduledUnpublishing } from './ScheduledUnpublishing';
+export { default as SearchResult } from './SearchResult';
+export { default as Environment } from './Environment';
+export { default as MaintenanceMode } from './MaintenanceMode';
+export { default as Webhook } from './Webhook';
+export { default as WebhookCall } from './WebhookCall';
+export { default as BuildTrigger } from './BuildTrigger';
+export { default as ItemTypeFilter } from './ItemTypeFilter';
+export { default as UploadFilter } from './UploadFilter';
+export { default as SiteInvitation } from './SiteInvitation';
+export { default as EditingSession } from './EditingSession';
+export { default as SsoGroup } from './SsoGroup';
+export { default as SsoSettings } from './SsoSettings';
+export { default as WhiteLabelSettings } from './WhiteLabelSettings';
+export { default as PublicInfo } from './PublicInfo';
+export { default as DailyUsage } from './DailyUsage';
+export { default as UsageCounter } from './UsageCounter';
+export { default as UploadTag } from './UploadTag';
+export { default as UploadSmartTag } from './UploadSmartTag';
+export { default as Site } from './Site';
+export { default as Workflow } from './Workflow';