feat: rename folder endpoint (#661)

Author: cloudinary-pkoniu

lib/api.js

@@ -339,14 +339,14 @@ exports.delete_folder = function delete_folder(path, callback, options = {}) {
   return call_api("delete", uri, {}, callback, options);
 };
 
-exports.update_folder = function delete_folderupdate_folder(old_path, new_path, callback, options = {}) {
+exports.rename_folder = function rename_folder(old_path, new_path, callback, options = {}) {
   let uri;
   uri = ['folders', old_path];
-  let update_folder_params = {
+  let rename_folder_params = {
     to_folder: new_path
   };
   options.content_type = 'json';
-  return call_api('put', uri, update_folder_params, callback, options);
+  return call_api('put', uri, rename_folder_params, callback, options);
 };
 
 exports.upload_mappings = function upload_mappings(callback, options = {}) {

lib/v2/api.js

@@ -35,7 +35,7 @@ v1_adapters(exports, api, {
   root_folders: 0,
   sub_folders: 1,
   delete_folder: 1,
-  update_folder: 2,
+  rename_folder: 2,
   create_folder: 1,
   upload_mappings: 0,
   upload_mapping: 1,

test/integration/api/admin/folders_api_spec.js

@@ -22,14 +22,14 @@ describe('Admin API - Folders', () => {
     mocked.xhr.restore();
   });
 
-  describe('update_folder', () => {
-    it('should send a request with correct parameters', () => {
-      cloudinary.v2.api.update_folder('old/path', 'new/path');
+  describe('rename_folder', () => {
+    it('should send a request to update folder endpoint with correct parameters', () => {
+      cloudinary.v2.api.rename_folder('old/path', 'new/path');
 
-      // sinon.assert.calledWith(xhr, sinon.match({
-      //   pathname: sinon.match('old/path'),
-      //   method: sinon.match('PUT')
-      // }));
+      sinon.assert.calledWith(mocked.request, sinon.match({
+        pathname: sinon.match('old%2Fpath'),
+        method: sinon.match('PUT')
+      }));
       sinon.assert.calledWith(mocked.write, sinon.match(helper.apiJsonParamMatcher('to_folder', 'new/path')));
     });
   });

types/cloudinary_ts_spec.ts

@@ -1179,6 +1179,9 @@ cloudinary.v2.api.delete_folder('foo', {
     agent: new Http.Agent()
 });
 
+// $ExpectType Promise<RenameFolderResponse>
+cloudinary.v2.api.rename_folder('old/path', 'new/path');
+
 // $ExpectType Promise<NewAssetRelationResponse>
 cloudinary.v2.api.add_related_assets('public-id', 'public-id-to-relate');
 

types/index.d.ts

@@ -859,6 +859,17 @@ declare module 'cloudinary' {
         request_id: string,
     }
 
+    export interface RenameFolderResponse {
+        from: {
+            name: string,
+            path: string,
+        }
+        to: {
+            name: string,
+            path: string,
+        }
+    }
+
     export namespace v2 {
 
         /****************************** Global Utils *************************************/
@@ -1160,6 +1171,8 @@ declare module 'cloudinary' {
 
             function delete_folder(path: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
 
+            function rename_folder(old_path: string, new_path: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<RenameFolderResponse>;
+
             function add_related_assets(public_id: string, public_ids_to_relate: string | Array<string>, options?: AdminApiOptions, callback?: ResponseCallback): Promise<NewAssetRelationResponse>;
 
             function add_related_assets_by_asset_id(asset_id: string, public_ids_to_relate: string | Array<string>, options?: AdminApiOptions, callback?: ResponseCallback): Promise<NewAssetRelationResponse>;