@datocms/cma-client 0.1.8 → 1.1.0

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

@@ -139,7 +139,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): Promise<SimpleSchemaTypes.ItemBatchDestroyJobSchema>;
+    batchDestroy(queryParams: SimpleSchemaTypes.ItemBatchDestroyHrefSchema): Promise<SimpleSchemaTypes.ItemBatchDestroyJobSchema>;
     /**
      * Delete multiple records
      *
@@ -147,7 +147,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): Promise<SchemaTypes.ItemBatchDestroyJobSchema>;
+    rawBatchDestroy(queryParams: SchemaTypes.ItemBatchDestroyHrefSchema): Promise<SchemaTypes.ItemBatchDestroyJobSchema>;
     /**
      * Publish multiple records
      *
@@ -155,7 +155,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): Promise<SimpleSchemaTypes.ItemBatchPublishJobSchema>;
+    batchPublish(queryParams: SimpleSchemaTypes.ItemBatchPublishHrefSchema): Promise<SimpleSchemaTypes.ItemBatchPublishJobSchema>;
     /**
      * Publish multiple records
      *
@@ -163,7 +163,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): Promise<SchemaTypes.ItemBatchPublishJobSchema>;
+    rawBatchPublish(queryParams: SchemaTypes.ItemBatchPublishHrefSchema): Promise<SchemaTypes.ItemBatchPublishJobSchema>;
     /**
      * Unpublish multiple records
      *
@@ -171,7 +171,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): Promise<SimpleSchemaTypes.ItemBatchUnpublishJobSchema>;
+    batchUnpublish(queryParams: SimpleSchemaTypes.ItemBatchUnpublishHrefSchema): Promise<SimpleSchemaTypes.ItemBatchUnpublishJobSchema>;
     /**
      * Unpublish multiple records
      *
@@ -179,7 +179,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): Promise<SchemaTypes.ItemBatchUnpublishJobSchema>;
+    rawBatchUnpublish(queryParams: SchemaTypes.ItemBatchUnpublishHrefSchema): Promise<SchemaTypes.ItemBatchUnpublishJobSchema>;
     /**
      * Publish a record
      *

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

@@ -1,3 +1,4 @@
+import * as Utils from '@datocms/rest-client-utils';
 import * as SchemaTypes from '../SchemaTypes';
 import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 import BaseResource from '../../BaseResource';
@@ -8,11 +9,23 @@ export default class SearchResult extends BaseResource {
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
      */
-    list(queryParams?: SimpleSchemaTypes.SearchResultInstancesHrefSchema): Promise<SimpleSchemaTypes.SearchResultInstancesTargetSchema>;
+    list(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema): Promise<SimpleSchemaTypes.SearchResultInstancesTargetSchema>;
     /**
      * Search for results
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
      */
-    rawList(queryParams?: SchemaTypes.SearchResultInstancesHrefSchema): Promise<SchemaTypes.SearchResultInstancesTargetSchema>;
+    rawList(queryParams: SchemaTypes.SearchResultInstancesHrefSchema): Promise<SchemaTypes.SearchResultInstancesTargetSchema>;
+    /**
+     * Async iterator to auto-paginate over elements returned by list()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
+     */
+    listPagedIterator(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.SearchResult, void, unknown>;
+    /**
+     * 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): AsyncGenerator<SchemaTypes.SearchResult, void, unknown>;
 }

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

@@ -8,13 +8,13 @@ export default class Site extends BaseResource {
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
      */
-    find(): Promise<SimpleSchemaTypes.Site>;
+    find(queryParams?: SimpleSchemaTypes.SiteSelfHrefSchema): Promise<SimpleSchemaTypes.Site>;
     /**
      * Retrieve the site
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
      */
-    rawFind(): Promise<SchemaTypes.SiteSelfTargetSchema>;
+    rawFind(queryParams?: SchemaTypes.SiteSelfHrefSchema): Promise<SchemaTypes.SiteSelfTargetSchema>;
     /**
      * Update the site's settings
      *

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

@@ -32,13 +32,25 @@ export default class User extends BaseResource {
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
      */
-    find(userId: string | SimpleSchemaTypes.UserData): Promise<SimpleSchemaTypes.User>;
+    find(userId: string | SimpleSchemaTypes.UserData, queryParams?: SimpleSchemaTypes.UserSelfHrefSchema): 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>;
+    rawFind(userId: string, queryParams?: SchemaTypes.UserSelfHrefSchema): Promise<SchemaTypes.UserSelfTargetSchema>;
+    /**
+     * Retrieve current signed-in user
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/user/me
+     */
+    findMe(queryParams?: SimpleSchemaTypes.UserMeHrefSchema): Promise<SimpleSchemaTypes.User | SimpleSchemaTypes.SsoUser | SimpleSchemaTypes.AccessToken | SimpleSchemaTypes.Account>;
+    /**
+     * 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>;
     /**
      * Delete a collaborator
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "0.1.8",
+  "version": "1.1.0",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -37,10 +37,10 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^0.1.8"
+    "@datocms/rest-client-utils": "^1.0.0"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^0.1.8"
+    "@datocms/dashboard-client": "^1.1.0"
   },
-  "gitHead": "ffb2f67a843f695e97dd14e2ca493f9dc9c87823"
+  "gitHead": "4d0d4eed18bed416c5ceaf7b2460a6c2065440fe"
 }

package/resources.json

@@ -57,6 +57,12 @@
         "name": "find",
         "rawName": "rawFind"
       },
+      {
+        "rel": "me",
+        "returnsCollection": false,
+        "name": "findMe",
+        "rawName": "rawFindMe"
+      },
       {
         "rel": "destroy",
         "returnsCollection": false,
@@ -722,6 +728,10 @@
       {
         "rel": "instances",
         "returnsCollection": true,
+        "paginatedResponse": {
+          "defaultLimit": 20,
+          "maxLimit": 100
+        },
         "name": "list",
         "rawName": "rawList"
       }