@datocms/cma-client 0.1.8 → 1.1.0

package/src/generated/resources/Item.ts

@@ -341,7 +341,7 @@ export default class Item extends BaseResource {
    *
    * @deprecated This API call is to be considered private and might change without notice
    */
-  batchDestroy(queryParams?: SimpleSchemaTypes.ItemBatchDestroyHrefSchema) {
+  batchDestroy(queryParams: SimpleSchemaTypes.ItemBatchDestroyHrefSchema) {
     return this.rawBatchDestroy(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemBatchDestroyJobSchema>(
         body,
@@ -357,7 +357,7 @@ export default class Item extends BaseResource {
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawBatchDestroy(
-    queryParams?: SchemaTypes.ItemBatchDestroyHrefSchema,
+    queryParams: SchemaTypes.ItemBatchDestroyHrefSchema,
   ): Promise<SchemaTypes.ItemBatchDestroyJobSchema> {
     return this.client.request<SchemaTypes.ItemBatchDestroyJobSchema>({
       method: 'DELETE',
@@ -373,7 +373,7 @@ export default class Item extends BaseResource {
    *
    * @deprecated This API call is to be considered private and might change without notice
    */
-  batchPublish(queryParams?: SimpleSchemaTypes.ItemBatchPublishHrefSchema) {
+  batchPublish(queryParams: SimpleSchemaTypes.ItemBatchPublishHrefSchema) {
     return this.rawBatchPublish(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemBatchPublishJobSchema>(
         body,
@@ -389,7 +389,7 @@ export default class Item extends BaseResource {
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawBatchPublish(
-    queryParams?: SchemaTypes.ItemBatchPublishHrefSchema,
+    queryParams: SchemaTypes.ItemBatchPublishHrefSchema,
   ): Promise<SchemaTypes.ItemBatchPublishJobSchema> {
     return this.client.request<SchemaTypes.ItemBatchPublishJobSchema>({
       method: 'PUT',
@@ -405,7 +405,7 @@ export default class Item extends BaseResource {
    *
    * @deprecated This API call is to be considered private and might change without notice
    */
-  batchUnpublish(queryParams?: SimpleSchemaTypes.ItemBatchUnpublishHrefSchema) {
+  batchUnpublish(queryParams: SimpleSchemaTypes.ItemBatchUnpublishHrefSchema) {
     return this.rawBatchUnpublish(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemBatchUnpublishJobSchema>(
         body,
@@ -421,7 +421,7 @@ export default class Item extends BaseResource {
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawBatchUnpublish(
-    queryParams?: SchemaTypes.ItemBatchUnpublishHrefSchema,
+    queryParams: SchemaTypes.ItemBatchUnpublishHrefSchema,
   ): Promise<SchemaTypes.ItemBatchUnpublishJobSchema> {
     return this.client.request<SchemaTypes.ItemBatchUnpublishJobSchema>({
       method: 'PUT',

package/src/generated/resources/SearchResult.ts

@@ -11,7 +11,7 @@ export default class SearchResult extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
    */
-  list(queryParams?: SimpleSchemaTypes.SearchResultInstancesHrefSchema) {
+  list(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema) {
     return this.rawList(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.SearchResultInstancesTargetSchema>(
         body,
@@ -25,7 +25,7 @@ export default class SearchResult extends BaseResource {
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
    */
   rawList(
-    queryParams?: SchemaTypes.SearchResultInstancesHrefSchema,
+    queryParams: SchemaTypes.SearchResultInstancesHrefSchema,
   ): Promise<SchemaTypes.SearchResultInstancesTargetSchema> {
     return this.client.request<SchemaTypes.SearchResultInstancesTargetSchema>({
       method: 'GET',
@@ -33,4 +33,44 @@ export default class SearchResult extends BaseResource {
       queryParams,
     });
   }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
+   */
+  async *listPagedIterator(
+    queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.SearchResultInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by rawList()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
+   */
+  rawListPagedIterator(
+    queryParams: SchemaTypes.SearchResultInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    return Utils.rawPageIterator<
+      SchemaTypes.SearchResultInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 20,
+        maxLimit: 100,
+      },
+      (page) => this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
 }

package/src/generated/resources/Site.ts

@@ -11,8 +11,8 @@ export default class Site extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
    */
-  find() {
-    return this.rawFind().then((body) =>
+  find(queryParams?: SimpleSchemaTypes.SiteSelfHrefSchema) {
+    return this.rawFind(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.SiteSelfTargetSchema>(
         body,
       ),
@@ -24,10 +24,13 @@ export default class Site extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
    */
-  rawFind(): Promise<SchemaTypes.SiteSelfTargetSchema> {
+  rawFind(
+    queryParams?: SchemaTypes.SiteSelfHrefSchema,
+  ): Promise<SchemaTypes.SiteSelfTargetSchema> {
     return this.client.request<SchemaTypes.SiteSelfTargetSchema>({
       method: 'GET',
       url: `/site`,
+      queryParams,
     });
   }
 

package/src/generated/resources/User.ts

@@ -76,8 +76,11 @@ export default class User extends BaseResource {
    *
    * 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) =>
+  find(
+    userId: string | SimpleSchemaTypes.UserData,
+    queryParams?: SimpleSchemaTypes.UserSelfHrefSchema,
+  ) {
+    return this.rawFind(Utils.toId(userId), queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.UserSelfTargetSchema>(
         body,
       ),
@@ -89,10 +92,40 @@ export default class User extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
    */
-  rawFind(userId: string): Promise<SchemaTypes.UserSelfTargetSchema> {
+  rawFind(
+    userId: string,
+    queryParams?: SchemaTypes.UserSelfHrefSchema,
+  ): Promise<SchemaTypes.UserSelfTargetSchema> {
     return this.client.request<SchemaTypes.UserSelfTargetSchema>({
       method: 'GET',
       url: `/users/${userId}`,
+      queryParams,
+    });
+  }
+
+  /**
+   * Retrieve current signed-in user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/user/me
+   */
+  findMe(queryParams?: SimpleSchemaTypes.UserMeHrefSchema) {
+    return this.rawFindMe(queryParams).then((body) =>
+      Utils.deserializeResponseBody<SimpleSchemaTypes.UserMeTargetSchema>(body),
+    );
+  }
+
+  /**
+   * Retrieve current signed-in user
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/user/me
+   */
+  rawFindMe(
+    queryParams?: SchemaTypes.UserMeHrefSchema,
+  ): Promise<SchemaTypes.UserMeTargetSchema> {
+    return this.client.request<SchemaTypes.UserMeTargetSchema>({
+      method: 'GET',
+      url: `/users/me`,
+      queryParams,
     });
   }