rest-client-vue 1.2.0-b3 → 1.2.1-a

package/dist/index.d.ts

@@ -66,8 +66,6 @@ export declare type Resource = object;
  */
 export declare type ResourceId<T = string | number> = T;
 
-export declare type ResourcePropertyUpdate = object;
-
 /** A subcollection belonging to each resource of a certain type. */
 export declare interface ResourceSubcollection {
     /** The subcollection name, which is used in constructing its path. */
@@ -287,14 +285,23 @@ export declare interface RestCollection<T extends Resource = Resource> {
      */
     saveResources: (resources: T[]) => Promise<T[] | undefined>;
     /**
-     * Partial update of one or more resources.
+     * Partial update of one resource.
+     *
+     * If you call this with await, it will return once the API call has completed, and if the APi call succeeded, it will
+     * return the newly saved item.
+     *
+     * @param partialResource The partial resource to update.
+     */
+    updateResource: (partialResource: T) => Promise<T | null | undefined>;
+    /**
+     * Partial update of multiple resources.
      *
      * If you call this with await, it will return once the API call has completed, and if the APi call succeeded, it will
-     * return the updated items.
+     * return the saved items.
      *
-     * @param resourcePropertyUpdates A list of resource IDs, property paths, values, and update methods to apply.
+     * @param partialResources The partial resources to update.
      */
-    updateResources: (resourcePropertyUpdates: T[]) => Promise<T[] | undefined>;
+    updateResources: (partialResources: T[]) => Promise<T[] | undefined>;
     /**
      * Record which resources have failed validation.
      *
@@ -482,7 +489,7 @@ export declare interface RestResourceClient<T extends Resource = Resource> {
     refreshResource: () => Promise<T | null | undefined>;
     deleteResource: () => Promise<void>;
     saveResource: (resource: T) => Promise<T | null | undefined>;
-    updateResource: (resourcePropertyUpdates: T[]) => Promise<T | null | undefined>;
+    updateResource: (partialResource: T) => Promise<T | null | undefined>;
     makeCustomApiRequest: (params: MakeCustomApiRequestParams) => Promise<any>;
 }