@datocms/cma-client 0.1.0

package/dist/types/generated/resources/UploadFilter.d.ts

@@ -0,0 +1,66 @@
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+export default class UploadFilter extends BaseResource {
+    static readonly TYPE: 'upload_filter';
+    /**
+     * Create a new filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/create
+     */
+    create(body: SimpleSchemaTypes.UploadFilterCreateSchema): Promise<SimpleSchemaTypes.UploadFilter>;
+    /**
+     * Create a new filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/create
+     */
+    rawCreate(body: SchemaTypes.UploadFilterCreateSchema): Promise<SchemaTypes.UploadFilterCreateTargetSchema>;
+    /**
+     * Update a filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/update
+     */
+    update(uploadFilterId: string | SimpleSchemaTypes.UploadFilterData, body: SimpleSchemaTypes.UploadFilterUpdateSchema): Promise<SimpleSchemaTypes.UploadFilter>;
+    /**
+     * Update a filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/update
+     */
+    rawUpdate(uploadFilterId: string, body: SchemaTypes.UploadFilterUpdateSchema): Promise<SchemaTypes.UploadFilterUpdateTargetSchema>;
+    /**
+     * List all filters
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances
+     */
+    list(): Promise<SimpleSchemaTypes.UploadFilterInstancesTargetSchema>;
+    /**
+     * List all filters
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances
+     */
+    rawList(): Promise<SchemaTypes.UploadFilterInstancesTargetSchema>;
+    /**
+     * Retrieve a filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/self
+     */
+    find(uploadFilterId: string | SimpleSchemaTypes.UploadFilterData): Promise<SimpleSchemaTypes.UploadFilter>;
+    /**
+     * Retrieve a filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/self
+     */
+    rawFind(uploadFilterId: string): Promise<SchemaTypes.UploadFilterSelfTargetSchema>;
+    /**
+     * Delete a filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy
+     */
+    destroy(uploadFilterId: string | SimpleSchemaTypes.UploadFilterData): Promise<SimpleSchemaTypes.UploadFilter>;
+    /**
+     * Delete a filter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy
+     */
+    rawDestroy(uploadFilterId: string): Promise<SchemaTypes.UploadFilterDestroyTargetSchema>;
+}

package/dist/types/generated/resources/UploadRequest.d.ts

@@ -0,0 +1,18 @@
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+export default class UploadRequest extends BaseResource {
+    static readonly TYPE: 'upload_request';
+    /**
+     * Request a new upload
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-request/create
+     */
+    create(body: SimpleSchemaTypes.UploadRequestCreateSchema): Promise<SimpleSchemaTypes.UploadRequest>;
+    /**
+     * Request a new upload
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-request/create
+     */
+    rawCreate(body: SchemaTypes.UploadRequestCreateSchema): Promise<SchemaTypes.UploadRequestCreateTargetSchema>;
+}

package/dist/types/generated/resources/UploadSmartTag.d.ts

@@ -0,0 +1,31 @@
+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 UploadSmartTag extends BaseResource {
+    static readonly TYPE: 'upload_smart_tag';
+    /**
+     * List all automatically created upload tags
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     */
+    list(queryParams?: SimpleSchemaTypes.UploadSmartTagInstancesHrefSchema): Promise<SimpleSchemaTypes.UploadSmartTagInstancesTargetSchema>;
+    /**
+     * List all automatically created upload tags
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     */
+    rawList(queryParams?: SchemaTypes.UploadSmartTagInstancesHrefSchema): Promise<SchemaTypes.UploadSmartTagInstancesTargetSchema>;
+    /**
+     * Async iterator to auto-paginate over elements returned by list()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     */
+    listPagedIterator(queryParams?: SimpleSchemaTypes.UploadSmartTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.UploadSmartTag, void, unknown>;
+    /**
+     * Async iterator to auto-paginate over elements returned by rawList()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
+     */
+    rawListPagedIterator(queryParams?: SchemaTypes.UploadSmartTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.UploadSmartTag, void, unknown>;
+}

package/dist/types/generated/resources/UploadTag.d.ts

@@ -0,0 +1,43 @@
+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 UploadTag extends BaseResource {
+    static readonly TYPE: 'upload_tag';
+    /**
+     * List all manually created upload tags
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     */
+    list(queryParams?: SimpleSchemaTypes.UploadTagInstancesHrefSchema): Promise<SimpleSchemaTypes.UploadTagInstancesTargetSchema>;
+    /**
+     * List all manually created upload tags
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     */
+    rawList(queryParams?: SchemaTypes.UploadTagInstancesHrefSchema): Promise<SchemaTypes.UploadTagInstancesTargetSchema>;
+    /**
+     * Async iterator to auto-paginate over elements returned by list()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     */
+    listPagedIterator(queryParams?: SimpleSchemaTypes.UploadTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.UploadTag, void, unknown>;
+    /**
+     * Async iterator to auto-paginate over elements returned by rawList()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+     */
+    rawListPagedIterator(queryParams?: SchemaTypes.UploadTagInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.UploadTag, void, unknown>;
+    /**
+     * Create a new upload tag
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/create
+     */
+    create(body: SimpleSchemaTypes.UploadTagCreateSchema): Promise<SimpleSchemaTypes.UploadTag>;
+    /**
+     * Create a new upload tag
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/create
+     */
+    rawCreate(body: SchemaTypes.UploadTagCreateSchema): Promise<SchemaTypes.UploadTagCreateTargetSchema>;
+}

package/dist/types/generated/resources/UsageCounter.d.ts

@@ -0,0 +1,18 @@
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+export default class UsageCounter extends BaseResource {
+    static readonly TYPE: 'usage_counter';
+    /**
+     * Retrieve a project's usage counter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/usage-counter/self
+     */
+    find(usageCounterId: string | SimpleSchemaTypes.UsageCounterData, queryParams?: SimpleSchemaTypes.UsageCounterSelfHrefSchema): Promise<SimpleSchemaTypes.UsageCounter>;
+    /**
+     * Retrieve a project's usage counter
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/usage-counter/self
+     */
+    rawFind(usageCounterId: string, queryParams?: SchemaTypes.UsageCounterSelfHrefSchema): Promise<SchemaTypes.UsageCounterSelfTargetSchema>;
+}

package/dist/types/generated/resources/User.d.ts

@@ -0,0 +1,54 @@
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+export default class User extends BaseResource {
+    static readonly TYPE: 'user';
+    /**
+     * Update a collaborator
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/update
+     */
+    update(userId: string | SimpleSchemaTypes.UserData, body: SimpleSchemaTypes.UserUpdateSchema): Promise<SimpleSchemaTypes.User>;
+    /**
+     * Update a collaborator
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/update
+     */
+    rawUpdate(userId: string, body: SchemaTypes.UserUpdateSchema): Promise<SchemaTypes.UserUpdateTargetSchema>;
+    /**
+     * List all collaborators
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
+     */
+    list(): Promise<SimpleSchemaTypes.UserInstancesTargetSchema>;
+    /**
+     * List all collaborators
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
+     */
+    rawList(): Promise<SchemaTypes.UserInstancesTargetSchema>;
+    /**
+     * Retrieve a collaborator
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
+     */
+    find(userId: string | SimpleSchemaTypes.UserData): Promise<SimpleSchemaTypes.User>;
+    /**
+     * Retrieve a collaborator
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
+     */
+    rawFind(userId: string): Promise<SchemaTypes.UserSelfTargetSchema>;
+    /**
+     * Delete a collaborator
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/destroy
+     */
+    destroy(userId: string | SimpleSchemaTypes.UserData, queryParams?: SimpleSchemaTypes.UserDestroyHrefSchema): Promise<SimpleSchemaTypes.User>;
+    /**
+     * Delete a collaborator
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/destroy
+     */
+    rawDestroy(userId: string, queryParams?: SchemaTypes.UserDestroyHrefSchema): Promise<SchemaTypes.UserDestroyTargetSchema>;
+}

package/dist/types/generated/resources/Webhook.d.ts

@@ -0,0 +1,66 @@
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+export default class Webhook extends BaseResource {
+    static readonly TYPE: 'webhook';
+    /**
+     * Create a new webhook
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
+     */
+    create(body: SimpleSchemaTypes.WebhookCreateSchema): Promise<SimpleSchemaTypes.Webhook>;
+    /**
+     * Create a new webhook
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
+     */
+    rawCreate(body: SchemaTypes.WebhookCreateSchema): Promise<SchemaTypes.WebhookCreateTargetSchema>;
+    /**
+     * Update a webhook
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/update
+     */
+    update(userId: string | SimpleSchemaTypes.UserData, body: SimpleSchemaTypes.WebhookUpdateSchema): Promise<SimpleSchemaTypes.Webhook>;
+    /**
+     * 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>;
+    /**
+     * List all webhooks
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
+     */
+    list(): Promise<SimpleSchemaTypes.WebhookInstancesTargetSchema>;
+    /**
+     * List all webhooks
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
+     */
+    rawList(): Promise<SchemaTypes.WebhookInstancesTargetSchema>;
+    /**
+     * Retrieve a webhook
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
+     */
+    find(userId: string | SimpleSchemaTypes.UserData): Promise<SimpleSchemaTypes.Webhook>;
+    /**
+     * Retrieve a webhook
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
+     */
+    rawFind(userId: string): Promise<SchemaTypes.WebhookSelfTargetSchema>;
+    /**
+     * Delete a webhook
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
+     */
+    destroy(userId: string | SimpleSchemaTypes.UserData): Promise<SimpleSchemaTypes.Webhook>;
+    /**
+     * Delete a webhook
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
+     */
+    rawDestroy(userId: string): Promise<SchemaTypes.WebhookDestroyTargetSchema>;
+}

package/dist/types/generated/resources/WebhookCall.d.ts

@@ -0,0 +1,43 @@
+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';
+    /**
+     * List all webhooks calls
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+     */
+    list(queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema): Promise<SimpleSchemaTypes.WebhookCallInstancesTargetSchema>;
+    /**
+     * 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>;
+    /**
+     * Async iterator to auto-paginate over elements returned by list()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
+     */
+    listPagedIterator(queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.WebhookCall, void, unknown>;
+    /**
+     * 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): AsyncGenerator<SchemaTypes.WebhookCall, void, unknown>;
+    /**
+     * 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): Promise<void>;
+    /**
+     * 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>;
+}

package/dist/types/generated/resources/WhiteLabelSettings.d.ts

@@ -0,0 +1,30 @@
+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';
+    /**
+     * Retrieve white-label settings
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self
+     */
+    find(): Promise<SimpleSchemaTypes.WhiteLabelSettings>;
+    /**
+     * Retrieve white-label settings
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self
+     */
+    rawFind(): Promise<SchemaTypes.WhiteLabelSettingsSelfTargetSchema>;
+    /**
+     * Update white-label settings
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update
+     */
+    update(body: SimpleSchemaTypes.WhiteLabelSettingsUpdateSchema): Promise<SimpleSchemaTypes.WhiteLabelSettings>;
+    /**
+     * 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>;
+}

package/dist/types/generated/resources/Workflow.d.ts

@@ -0,0 +1,66 @@
+import * as SchemaTypes from '../SchemaTypes';
+import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import BaseResource from '../../BaseResource';
+export default class Workflow extends BaseResource {
+    static readonly TYPE: 'workflow';
+    /**
+     * Create a new workflow
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
+     */
+    create(body: SimpleSchemaTypes.WorkflowCreateSchema): Promise<SimpleSchemaTypes.Workflow>;
+    /**
+     * Create a new workflow
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
+     */
+    rawCreate(body: SchemaTypes.WorkflowCreateSchema): Promise<SchemaTypes.WorkflowCreateTargetSchema>;
+    /**
+     * Update a workflow
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/update
+     */
+    update(workflowId: string | SimpleSchemaTypes.WorkflowData, body: SimpleSchemaTypes.WorkflowUpdateSchema): Promise<SimpleSchemaTypes.Workflow>;
+    /**
+     * 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>;
+    /**
+     * List all workflows
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
+     */
+    list(): Promise<SimpleSchemaTypes.WorkflowInstancesTargetSchema>;
+    /**
+     * List all workflows
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
+     */
+    rawList(): Promise<SchemaTypes.WorkflowInstancesTargetSchema>;
+    /**
+     * Retrieve a workflow
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
+     */
+    find(workflowId: string | SimpleSchemaTypes.WorkflowData): Promise<SimpleSchemaTypes.Workflow>;
+    /**
+     * Retrieve a workflow
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
+     */
+    rawFind(workflowId: string): Promise<SchemaTypes.WorkflowSelfTargetSchema>;
+    /**
+     * Delete a workflow
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
+     */
+    destroy(workflowId: string | SimpleSchemaTypes.WorkflowData): Promise<void>;
+    /**
+     * Delete a workflow
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
+     */
+    rawDestroy(workflowId: string): Promise<void>;
+}

package/dist/types/generated/resources/index.d.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';