@datocms/cma-client 0.1.0

package/src/generated/resources/SsoUser.ts

@@ -0,0 +1,115 @@
+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 SsoUser extends BaseResource {
+  static readonly TYPE: 'sso_user' = 'sso_user';
+
+  /**
+   * List all users
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoUserInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all users
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/instances
+   */
+  rawList(): Promise<SchemaTypes.SsoUserInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.SsoUserInstancesTargetSchema>({
+      method: 'GET',
+      url: `/sso-users`,
+    });
+  }
+
+  /**
+   * Returns a SSO user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/self
+   */
+  find(userId: string | SimpleSchemaTypes.UserData) {
+    return this.rawFind(Utils.toId(userId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoUserSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Returns a SSO user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/self
+   */
+  rawFind(userId: string): Promise<SchemaTypes.SsoUserSelfTargetSchema> {
+    return this.client.request<SchemaTypes.SsoUserSelfTargetSchema>({
+      method: 'GET',
+      url: `/sso-users/${userId}`,
+    });
+  }
+
+  /**
+   * Copy editors as SSO users
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users
+   */
+  copyUsers() {
+    return this.rawCopyUsers().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoUserCopyUsersTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Copy editors as SSO users
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users
+   */
+  rawCopyUsers(): Promise<SchemaTypes.SsoUserCopyUsersTargetSchema> {
+    return this.client.request<SchemaTypes.SsoUserCopyUsersTargetSchema>({
+      method: 'POST',
+      url: `/sso-users/copy-users`,
+    });
+  }
+
+  /**
+   * Delete a SSO user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy
+   */
+  destroy(
+    userId: string | SimpleSchemaTypes.UserData,
+    queryParams?: SimpleSchemaTypes.SsoUserDestroyHrefSchema,
+  ) {
+    return this.rawDestroy(Utils.toId(userId), queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SsoUserDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete a SSO user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy
+   */
+  rawDestroy(
+    userId: string,
+    queryParams?: SchemaTypes.SsoUserDestroyHrefSchema,
+  ): Promise<SchemaTypes.SsoUserDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.SsoUserDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/sso-users/${userId}`,
+      queryParams,
+    });
+  }
+}

package/src/generated/resources/SubscriptionFeature.ts

@@ -0,0 +1,35 @@
+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 SubscriptionFeature extends BaseResource {
+  static readonly TYPE: 'subscription_feature' = 'subscription_feature';
+
+  /**
+   * Get all the subscription features
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-feature/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SubscriptionFeatureInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Get all the subscription features
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-feature/instances
+   */
+  rawList(): Promise<SchemaTypes.SubscriptionFeatureInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.SubscriptionFeatureInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: `/subscription-features`,
+      },
+    );
+  }
+}

package/src/generated/resources/SubscriptionLimit.ts

@@ -0,0 +1,62 @@
+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 SubscriptionLimit extends BaseResource {
+  static readonly TYPE: 'subscription_limit' = 'subscription_limit';
+
+  /**
+   * Get all the subscription limits
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/instances
+   */
+  list() {
+    return this.rawList().then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SubscriptionLimitInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Get all the subscription limits
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/instances
+   */
+  rawList(): Promise<SchemaTypes.SubscriptionLimitInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.SubscriptionLimitInstancesTargetSchema>(
+      {
+        method: 'GET',
+        url: `/subscription-limits`,
+      },
+    );
+  }
+
+  /**
+   * Get a single subscription limit
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/self
+   */
+  find(subscriptionLimitId: string | SimpleSchemaTypes.SubscriptionLimitData) {
+    return this.rawFind(Utils.toId(subscriptionLimitId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.SubscriptionLimitSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Get a single subscription limit
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/self
+   */
+  rawFind(
+    subscriptionLimitId: string,
+  ): Promise<SchemaTypes.SubscriptionLimitSelfTargetSchema> {
+    return this.client.request<SchemaTypes.SubscriptionLimitSelfTargetSchema>({
+      method: 'GET',
+      url: `/subscription-limits/${subscriptionLimitId}`,
+    });
+  }
+}

package/src/generated/resources/Upload.ts

@@ -0,0 +1,391 @@
+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 Upload extends BaseResource {
+  static readonly TYPE: 'upload' = 'upload';
+
+  /**
+   * Create a new upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/create
+   */
+  create(body: SimpleSchemaTypes.UploadCreateSchema) {
+    return this.rawCreate(
+      Utils.serializeRequestBody<SchemaTypes.UploadCreateSchema>(body, {
+        type: 'upload',
+        attributes: [
+          'path',
+          'copyright',
+          'author',
+          'notes',
+          'default_field_metadata',
+          'tags',
+        ],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadCreateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Create a new upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/create
+   */
+  rawCreate(
+    body: SchemaTypes.UploadCreateSchema,
+  ): Promise<SchemaTypes.UploadCreateJobSchema> {
+    return this.client.request<SchemaTypes.UploadCreateJobSchema>({
+      method: 'POST',
+      url: `/uploads`,
+      body,
+    });
+  }
+
+  /**
+   * List all uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
+   */
+  list(queryParams?: SimpleSchemaTypes.UploadInstancesHrefSchema) {
+    return this.rawList(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadInstancesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * List all uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
+   */
+  rawList(
+    queryParams?: SchemaTypes.UploadInstancesHrefSchema,
+  ): Promise<SchemaTypes.UploadInstancesTargetSchema> {
+    return this.client.request<SchemaTypes.UploadInstancesTargetSchema>({
+      method: 'GET',
+      url: `/uploads`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
+   */
+  async *listPagedIterator(
+    queryParams?: SimpleSchemaTypes.UploadInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.UploadInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by rawList()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
+   */
+  rawListPagedIterator(
+    queryParams?: SchemaTypes.UploadInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    return Utils.rawPageIterator<
+      SchemaTypes.UploadInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 30,
+        maxLimit: 500,
+      },
+      (page) => this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
+
+  /**
+   * Retrieve an upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/self
+   */
+  find(uploadId: string | SimpleSchemaTypes.UploadData) {
+    return this.rawFind(Utils.toId(uploadId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadSelfTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Retrieve an upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/self
+   */
+  rawFind(uploadId: string): Promise<SchemaTypes.UploadSelfTargetSchema> {
+    return this.client.request<SchemaTypes.UploadSelfTargetSchema>({
+      method: 'GET',
+      url: `/uploads/${uploadId}`,
+    });
+  }
+
+  /**
+   * Delete an upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/destroy
+   */
+  destroy(uploadId: string | SimpleSchemaTypes.UploadData) {
+    return this.rawDestroy(Utils.toId(uploadId)).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadDestroyTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete an upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/destroy
+   */
+  rawDestroy(uploadId: string): Promise<SchemaTypes.UploadDestroyTargetSchema> {
+    return this.client.request<SchemaTypes.UploadDestroyTargetSchema>({
+      method: 'DELETE',
+      url: `/uploads/${uploadId}`,
+    });
+  }
+
+  /**
+   * Update an upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/update
+   */
+  update(
+    uploadId: string | SimpleSchemaTypes.UploadData,
+    body: SimpleSchemaTypes.UploadUpdateSchema,
+  ) {
+    return this.rawUpdate(
+      Utils.toId(uploadId),
+      Utils.serializeRequestBody<SchemaTypes.UploadUpdateSchema>(body, {
+        id: Utils.toId(uploadId),
+        type: 'upload',
+        attributes: [
+          'path',
+          'basename',
+          'copyright',
+          'author',
+          'notes',
+          'tags',
+          'default_field_metadata',
+        ],
+        relationships: ['creator'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadUpdateJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Update an upload
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/update
+   */
+  rawUpdate(
+    uploadId: string,
+    body: SchemaTypes.UploadUpdateSchema,
+  ): Promise<SchemaTypes.UploadUpdateJobSchema> {
+    return this.client.request<SchemaTypes.UploadUpdateJobSchema>({
+      method: 'PUT',
+      url: `/uploads/${uploadId}`,
+      body,
+    });
+  }
+
+  /**
+   * Batch add tags to uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_add_tags
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  batchAddTags(
+    queryParams: SimpleSchemaTypes.UploadBatchAddTagsHrefSchema,
+    body: SimpleSchemaTypes.UploadBatchAddTagsSchema,
+  ) {
+    return this.rawBatchAddTags(
+      queryParams,
+      Utils.serializeRequestBody<SchemaTypes.UploadBatchAddTagsSchema>(body, {
+        type: 'upload',
+        attributes: ['tags'],
+        relationships: [],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadBatchAddTagsJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Batch add tags to uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_add_tags
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawBatchAddTags(
+    queryParams: SchemaTypes.UploadBatchAddTagsHrefSchema,
+    body: SchemaTypes.UploadBatchAddTagsSchema,
+  ): Promise<SchemaTypes.UploadBatchAddTagsJobSchema> {
+    return this.client.request<SchemaTypes.UploadBatchAddTagsJobSchema>({
+      method: 'PUT',
+      url: `/uploads/batch-add-tags`,
+      body,
+      queryParams,
+    });
+  }
+
+  /**
+   * Delete multiple uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_destroy
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  batchDestroy(queryParams?: SimpleSchemaTypes.UploadBatchDestroyHrefSchema) {
+    return this.rawBatchDestroy(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadBatchDestroyJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Delete multiple uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_destroy
+   *
+   * @deprecated This API call is to be considered private and might change without notice
+   */
+  rawBatchDestroy(
+    queryParams?: SchemaTypes.UploadBatchDestroyHrefSchema,
+  ): Promise<SchemaTypes.UploadBatchDestroyJobSchema> {
+    return this.client.request<SchemaTypes.UploadBatchDestroyJobSchema>({
+      method: 'DELETE',
+      url: `/uploads/batch-destroy`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Referenced records
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/references
+   */
+  references(
+    uploadId: string | SimpleSchemaTypes.UploadData,
+    queryParams?: SimpleSchemaTypes.UploadReferencesHrefSchema,
+  ) {
+    return this.rawReferences(Utils.toId(uploadId), queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadReferencesTargetSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Referenced records
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/references
+   */
+  rawReferences(
+    uploadId: string,
+    queryParams?: SchemaTypes.UploadReferencesHrefSchema,
+  ): Promise<SchemaTypes.UploadReferencesTargetSchema> {
+    return this.client.request<SchemaTypes.UploadReferencesTargetSchema>({
+      method: 'GET',
+      url: `/uploads/${uploadId}/references`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Add tags to assets in bulk
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_tag
+   */
+  bulkTag(body: SimpleSchemaTypes.UploadBulkTagSchema) {
+    return this.rawBulkTag(
+      Utils.serializeRequestBody<SchemaTypes.UploadBulkTagSchema>(body, {
+        type: 'upload_bulk_tag_operation',
+        attributes: ['tags'],
+        relationships: ['uploads'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadBulkTagJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Add tags to assets in bulk
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_tag
+   */
+  rawBulkTag(
+    body: SchemaTypes.UploadBulkTagSchema,
+  ): Promise<SchemaTypes.UploadBulkTagJobSchema> {
+    return this.client.request<SchemaTypes.UploadBulkTagJobSchema>({
+      method: 'POST',
+      url: `/uploads/bulk/tag`,
+      body,
+    });
+  }
+
+  /**
+   * Destroy uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy
+   */
+  bulkDestroy(body: SimpleSchemaTypes.UploadBulkDestroySchema) {
+    return this.rawBulkDestroy(
+      Utils.serializeRequestBody<SchemaTypes.UploadBulkDestroySchema>(body, {
+        type: 'upload_bulk_destroy_operation',
+        attributes: [],
+        relationships: ['uploads'],
+      }),
+    ).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UploadBulkDestroyJobSchema>(
+        body,
+      ),
+    );
+  }
+
+  /**
+   * Destroy uploads
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy
+   */
+  rawBulkDestroy(
+    body: SchemaTypes.UploadBulkDestroySchema,
+  ): Promise<SchemaTypes.UploadBulkDestroyJobSchema> {
+    return this.client.request<SchemaTypes.UploadBulkDestroyJobSchema>({
+      method: 'POST',
+      url: `/uploads/bulk/destroy`,
+      body,
+    });
+  }
+}