@datocms/cma-client 0.1.0

package/src/generated/resources/UploadFilter.ts

@@ -0,0 +1,161 @@
+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 UploadFilter extends BaseResource {
+  static readonly TYPE: 'upload_filter' = 'upload_filter';
+
+  /**
+   * Create a new filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/create
+   */
+  create(body: SimpleSchemaTypes.UploadFilterCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.UploadFilterCreateSchema>(body, {
+        type: 'upload_filter',
+        attributes: ['name', 'filter', 'shared'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadFilterCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UploadFilterCreateTargetSchema>({
+      method: 'POST',
+      url: `/upload-filters`,
+      body,
+    });
+  }
+
+  /**
+   * 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,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(uploadFilterId),
+      Utils.serializeRequestBody<SchemaTypes.UploadFilterUpdateSchema>(body, {
+        id: Utils.toId(uploadFilterId),
+        type: 'upload_filter',
+        attributes: ['name', 'shared', 'filter'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadFilterUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UploadFilterUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/upload-filters/${uploadFilterId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all filters
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadFilterInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all filters
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances
+   */
+  rawList(): Promise<SchemaTypes.UploadFilterInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.UploadFilterInstancesTargetSchema>({
+      method: 'GET',
+      url: `/upload-filters`,
+    });
+  }
+
+  /**
+   * Retrieve a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/self
+   */
+  find(uploadFilterId: string | SimpleSchemaTypes.UploadFilterData) {
+    return this.rawFind(Utils.toId(uploadFilterId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadFilterSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/self
+   */
+  rawFind(
+    uploadFilterId: string,
+  ): Promise<SchemaTypes.UploadFilterSelfTargetSchema> {
+    return this.client.request<SchemaTypes.UploadFilterSelfTargetSchema>({
+      method: 'GET',
+      url: `/upload-filters/${uploadFilterId}`,
+    });
+  }
+
+  /**
+   * Delete a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy
+   */
+  destroy(uploadFilterId: string | SimpleSchemaTypes.UploadFilterData) {
+    return this.rawDestroy(Utils.toId(uploadFilterId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadFilterDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a filter
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy
+   */
+  rawDestroy(
+    uploadFilterId: string,
+  ): Promise<SchemaTypes.UploadFilterDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.UploadFilterDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/upload-filters/${uploadFilterId}`,
+    });
+  }
+}

package/src/generated/resources/UploadRequest.ts

@@ -0,0 +1,42 @@
+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 UploadRequest extends BaseResource {
+  static readonly TYPE: 'upload_request' = 'upload_request';
+
+  /**
+   * Request a new upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-request/create
+   */
+  create(body: SimpleSchemaTypes.UploadRequestCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.UploadRequestCreateSchema>(body, {
+        type: 'upload_request',
+        attributes: ['filename'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadRequestCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UploadRequestCreateTargetSchema>({
+      method: 'POST',
+      url: `/upload-requests`,
+      body,
+    });
+  }
+}

package/src/generated/resources/UploadSmartTag.ts

@@ -0,0 +1,78 @@
+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' = '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) {
+    return this.rawList(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadSmartTagInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UploadSmartTagInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: `/upload-smart-tags`,
+        queryParams,
+      },
+    );
+  }
+
+  /**
+   * 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
+   */
+  async *listPagedIterator(
+    queryParams?: SimpleSchemaTypes.UploadSmartTagInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.UploadSmartTagInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * 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,
+  ) {
+    return Utils.rawPageIterator<
+      SchemaTypes.UploadSmartTagInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 50,
+        maxLimit: 500,
+      },
+      (page) => this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
+}

package/src/generated/resources/UploadTag.ts

@@ -0,0 +1,110 @@
+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' = '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) {
+    return this.rawList(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadTagInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UploadTagInstancesTargetSchema>({
+      method: 'GET',
+      url: `/upload-tags`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
+   */
+  async *listPagedIterator(
+    queryParams?: SimpleSchemaTypes.UploadTagInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.UploadTagInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * 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,
+  ) {
+    return Utils.rawPageIterator<
+      SchemaTypes.UploadTagInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 50,
+        maxLimit: 500,
+      },
+      (page) => this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
+
+  /**
+   * Create a new upload tag
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/create
+   */
+  create(body: SimpleSchemaTypes.UploadTagCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.UploadTagCreateSchema>(body, {
+        type: 'upload_tag',
+        attributes: ['name'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadTagCreateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UploadTagCreateTargetSchema>({
+      method: 'POST',
+      url: `/upload-tags`,
+      body,
+    });
+  }
+}

package/src/generated/resources/UsageCounter.ts

@@ -0,0 +1,40 @@
+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 UsageCounter extends BaseResource {
+  static readonly TYPE: 'usage_counter' = '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,
+  ) {
+    return this.rawFind(Utils.toId(usageCounterId), queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UsageCounterSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UsageCounterSelfTargetSchema>({
+      method: 'GET',
+      url: `/usage-log-counters/${usageCounterId}`,
+      queryParams,
+    });
+  }
+}

package/src/generated/resources/User.ts

@@ -0,0 +1,130 @@
+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 User extends BaseResource {
+  static readonly TYPE: 'user' = '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,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(userId),
+      Utils.serializeRequestBody<SchemaTypes.UserUpdateSchema>(body, {
+        id: Utils.toId(userId),
+        type: 'user',
+        attributes: ['is_active'],
+        relationships: ['role'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UserUpdateTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UserUpdateTargetSchema>({
+      method: 'PUT',
+      url: `/users/${userId}`,
+      body,
+    });
+  }
+
+  /**
+   * List all collaborators
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UserInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all collaborators
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
+   */
+  rawList(): Promise<SchemaTypes.UserInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.UserInstancesTargetSchema>({
+      method: 'GET',
+      url: `/users`,
+    });
+  }
+
+  /**
+   * Retrieve a collaborator
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
+   */
+  find(userId: string | SimpleSchemaTypes.UserData) {
+    return this.rawFind(Utils.toId(userId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UserSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve a collaborator
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
+   */
+  rawFind(userId: string): Promise<SchemaTypes.UserSelfTargetSchema> {
+    return this.client.request<SchemaTypes.UserSelfTargetSchema>({
+      method: 'GET',
+      url: `/users/${userId}`,
+    });
+  }
+
+  /**
+   * Delete a collaborator
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/user/destroy
+   */
+  destroy(
+    userId: string | SimpleSchemaTypes.UserData,
+    queryParams?: SimpleSchemaTypes.UserDestroyHrefSchema,
+  ) {
+    return this.rawDestroy(Utils.toId(userId), queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UserDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * 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> {
+    return this.client.request<SchemaTypes.UserDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/users/${userId}`,
+      queryParams,
+    });
+  }
+}