chore: types for asset relations api

Author: cloudinary-pkoniu

types/cloudinary_ts_spec.ts

@@ -1131,6 +1131,18 @@ cloudinary.v2.api.delete_folder('foo',{
     agent: new Http.Agent()
 });
 
+// $ExpectType Promise<NewAssetRelationResponse>
+cloudinary.v2.api.add_related_assets('public-id', 'public-id-to-relate');
+
+// $ExpectType Promise<NewAssetRelationResponse>
+cloudinary.v2.api.add_related_assets_by_asset_id('asset-id', 'public-id-to-relate');
+
+// $ExpectType Promise<DeleteAssetRelation>
+cloudinary.v2.api.delete_related_assets('public-id', 'public-id-to-unrelate');
+
+// $ExpectType Promise<DeleteAssetRelation>
+cloudinary.v2.api.delete_related_assets_by_asset_id('asset-id', 'public-id-to-unrelate');
+
 // $ExpectType Promise<any>
 cloudinary.v2.uploader.create_slideshow({
     manifest_json: {

types/index.d.ts

@@ -642,6 +642,30 @@ declare module 'cloudinary' {
         http_code: number;
     }
 
+    export interface BaseAssetRelation {
+        asset: string;
+        status: 200;
+    }
+    export interface AssetRelationSuccess extends BaseAssetRelation {
+        message: 'success';
+        code: 'success_ids'
+    }
+
+    export interface AssetRelationAlreadyExists extends BaseAssetRelation {
+        message: 'resource already exists';
+        code: 'already_exists_ids';
+    }
+
+    export interface NewAssetRelationResponse {
+        failed: [any],
+        success: Array<AssetRelationSuccess | AssetRelationAlreadyExists>
+    }
+
+    export interface DeleteAssetRelation {
+        failed: [any],
+        success: Array<AssetRelationSuccess>
+    }
+
     export interface MetadataFieldApiOptions {
         external_id?: string;
         type?: string;
@@ -1092,6 +1116,14 @@ declare module 'cloudinary' {
 
             function delete_folder(path: string, options?: AdminApiOptions, callback?: ResponseCallback): Promise<any>;
 
+            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>;
+
+            function delete_related_assets(public_id: string, public_ids_to_unrelate: string | Array<string>, options?: AdminApiOptions, callback?: ResponseCallback): Promise<DeleteAssetRelation>;
+
+            function delete_related_assets_by_asset_id(asset_id: string, public_ids_to_unrelate: string | Array<string>, options?: AdminApiOptions, callback?: ResponseCallback): Promise<DeleteAssetRelation>;
+
             /****************************** Structured Metadata API V2 Methods *************************************/
 
             function add_metadata_field(field: MetadataFieldApiOptions, options?: AdminApiOptions, callback?: ResponseCallback): Promise<MetadataFieldApiResponse>;