@gobodo/gobodo-api-promise 0.1.174 → 0.1.176

package/dist/api/ImagesApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Images service.
 * @module api/ImagesApi
-* @version 0.1.174
+* @version 0.1.176
 */
 export default class ImagesApi {
     /**
@@ -14,51 +14,7 @@ export default class ImagesApi {
     constructor(apiClient?: any);
     apiClient: any;
     /**
-     * Root for the API
-     * @param {Object} opts Optional parameters
-     * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] The how long the cache entry should persist
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} [cachescope] The scope of storage of the cache item
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
-     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
-     * @param {String} [transactionid] The id of the transaction this operation is being run in
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
-     */
-    get22WithHttpInfo(opts: any): Promise<any>;
-    /**
-     * Root for the API
-     * @param {Object} opts Optional parameters
-     * @param {String} opts.authorization The authorization token of the logged in user
-     * @param {Number} opts.cacheduration The how long the cache entry should persist
-     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
-     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
-     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
-     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
-     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation
-     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} opts.zeusportalPostasOrg The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-     * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
-     * @param {String} opts.transactionid The id of the transaction this operation is being run in
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
-     */
-    get22(opts?: { [key: string]: any;  [key: string]: any; 
-        authorization?: string;
-        cacheduration?: number;
-        cachegroup?: Array<string>;
-        cachekey?: Array<string>;
-        cachescope?: any;
-        cacheuser?: Array<string>;
-    }): Promise<any>;
-    /**
-     * Get Image By Id
-     * Returns the image with the given id
+     * Get image by id
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -77,8 +33,7 @@ export default class ImagesApi {
      */
     getImageByIdWithHttpInfo(id: number, opts: any): Promise<any>;
     /**
-     * Get Image By Id
-     * Returns the image with the given id
+     * Get image by id
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
@@ -104,9 +59,8 @@ export default class ImagesApi {
         cacheuser?: Array<string>;
     }): Promise<any>;
     /**
-     * Updates an image
-     * Updates the image with the given id
-     * @param {Number} id
+     * List Images
+     * Get all images, optionally filtered by container (e.g. category), with recursive subcategories and optional relationship type
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] The how long the cache entry should persist
@@ -120,14 +74,16 @@ export default class ImagesApi {
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
      * @param {String} [transactionid] The id of the transaction this operation is being run in
-     * @param {module:model/PurgeDataDefaultResponse} [purgeDataDefaultResponse]
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Image} and HTTP response
+     * @param {Number} [container] Optional graph object ID of the container (e.g. category) to filter by
+     * @param {Boolean} [recursive] When true and container is a category, include images in subcategories
+     * @param {Number} [relationshipTypeId] Optional relationship type ID to filter container relationship
+     * @param {String} [relationshipTypeKey] Optional relationship type key (e.g. CONTAINER); preferred over id if both set
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
-    updateImageWithHttpInfo(id: number, opts: any): Promise<any>;
+    listImagesWithHttpInfo(opts: any): Promise<any>;
     /**
-     * Updates an image
-     * Updates the image with the given id
-     * @param {Number} id
+     * List Images
+     * Get all images, optionally filtered by container (e.g. category), with recursive subcategories and optional relationship type
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration The how long the cache entry should persist
@@ -141,10 +97,13 @@ export default class ImagesApi {
      * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
      * @param {String} opts.transactionid The id of the transaction this operation is being run in
-     * @param {module:model/PurgeDataDefaultResponse} opts.purgeDataDefaultResponse
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Image}
+     * @param {Number} opts.container Optional graph object ID of the container (e.g. category) to filter by
+     * @param {Boolean} opts.recursive When true and container is a category, include images in subcategories
+     * @param {Number} opts.relationshipTypeId Optional relationship type ID to filter container relationship
+     * @param {String} opts.relationshipTypeKey Optional relationship type key (e.g. CONTAINER); preferred over id if both set
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
-    updateImage(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+    listImages(opts?: { [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -153,6 +112,7 @@ export default class ImagesApi {
         cacheuser?: Array<string>;
     }): Promise<any>;
     /**
+     * Update image
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -167,13 +127,12 @@ export default class ImagesApi {
      * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
      * @param {String} [transactionid] The id of the transaction this operation is being run in
-     * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
-     * @param {Array.<module:model/InputPart>} [parts]
-     * @param {String} [preamble]
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PurgeDataDefaultResponse} and HTTP response
+     * @param {module:model/PurgeDataDefaultResponse} [purgeDataDefaultResponse]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
-    upload1WithHttpInfo(id: number, opts: any): Promise<any>;
+    updateImageWithHttpInfo(id: number, opts: any): Promise<any>;
     /**
+     * Update image
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
@@ -188,12 +147,10 @@ export default class ImagesApi {
      * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
      * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
      * @param {String} opts.transactionid The id of the transaction this operation is being run in
-     * @param {Object.<String, {String: [InputPart]}>} opts.formDataMap
-     * @param {Array.<module:model/InputPart>} opts.parts
-     * @param {String} opts.preamble
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PurgeDataDefaultResponse}
+     * @param {module:model/PurgeDataDefaultResponse} opts.purgeDataDefaultResponse
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
-    upload1(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+    updateImage(id: number, opts?: { [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -202,9 +159,7 @@ export default class ImagesApi {
         cacheuser?: Array<string>;
     }): Promise<any>;
     /**
-     * Upload images
-     * Uploads one or more images with optional metadata and relationship information
-     * @param {File} file The image file to upload
+     * Upload image(s)
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] The how long the cache entry should persist
@@ -224,13 +179,14 @@ export default class ImagesApi {
      * @param {Number} [reltypeid] ID of the relationship type
      * @param {String} [reltypekey] Key of the relationship type
      * @param {String} [description] Description for the uploaded image(s)
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/Image>} and HTTP response
+     * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
+     * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
-    uploadImageWithHttpInfo(file: File, opts: any): Promise<any>;
+    uploadImageWithHttpInfo(opts: any): Promise<any>;
     /**
-     * Upload images
-     * Uploads one or more images with optional metadata and relationship information
-     * @param {File} file The image file to upload
+     * Upload image(s)
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration The how long the cache entry should persist
@@ -250,9 +206,12 @@ export default class ImagesApi {
      * @param {Number} opts.reltypeid ID of the relationship type
      * @param {String} opts.reltypekey Key of the relationship type
      * @param {String} opts.description Description for the uploaded image(s)
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/Image>}
+     * @param {Object.<String, {String: [InputPart]}>} opts.formDataMap
+     * @param {Array.<module:model/InputPart>} opts.parts
+     * @param {String} opts.preamble
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
-    uploadImage(file: File, opts?: { [key: string]: any;  [key: string]: any; 
+    uploadImage(opts?: { [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -261,9 +220,7 @@ export default class ImagesApi {
         cacheuser?: Array<string>;
     }): Promise<any>;
     /**
-     * Upload images via base64
-     * Uploads one or more images using base64 data URIs with optional metadata and relationship information. Supports multiple formats: 1) Data URI: {\"file\": \"data:image/png;base64,...\"} 2) Direct base64: {\"file\": \"iVBORw0KGgoAAAANSUhEUgAA...\", \"fileName\": \"image.png\", \"mimeType\": \"image/png\"} 3) Object format: {\"file\": {\"uri\": \"data:image/png;base64,...\", \"name\": \"filename.png\", \"type\": \"image/png\", \"size\": 12345}}
-     * @param {module:model/Base64ImageUpload} base64ImageUpload JSON containing base64 image data - file is required and can be a string (data URI or direct base64) or an object
+     * Upload image(s) via base64
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] The how long the cache entry should persist
@@ -283,13 +240,12 @@ export default class ImagesApi {
      * @param {Number} [reltypeid] ID of the relationship type
      * @param {String} [reltypekey] Key of the relationship type
      * @param {String} [description] Description for the uploaded image(s)
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/Image>} and HTTP response
+     * @param {module:model/Base64ImageUpload} [base64ImageUpload]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
-    uploadImageBase64WithHttpInfo(base64ImageUpload: any, opts: any): Promise<any>;
+    uploadImageBase64WithHttpInfo(opts: any): Promise<any>;
     /**
-     * Upload images via base64
-     * Uploads one or more images using base64 data URIs with optional metadata and relationship information. Supports multiple formats: 1) Data URI: {\"file\": \"data:image/png;base64,...\"} 2) Direct base64: {\"file\": \"iVBORw0KGgoAAAANSUhEUgAA...\", \"fileName\": \"image.png\", \"mimeType\": \"image/png\"} 3) Object format: {\"file\": {\"uri\": \"data:image/png;base64,...\", \"name\": \"filename.png\", \"type\": \"image/png\", \"size\": 12345}}
-     * @param {module:model/Base64ImageUpload} base64ImageUpload JSON containing base64 image data - file is required and can be a string (data URI or direct base64) or an object
+     * Upload image(s) via base64
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration The how long the cache entry should persist
@@ -309,9 +265,10 @@ export default class ImagesApi {
      * @param {Number} opts.reltypeid ID of the relationship type
      * @param {String} opts.reltypekey Key of the relationship type
      * @param {String} opts.description Description for the uploaded image(s)
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/Image>}
+     * @param {module:model/Base64ImageUpload} opts.base64ImageUpload
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
-    uploadImageBase64(base64ImageUpload: any, opts?: { [key: string]: any;  [key: string]: any; 
+    uploadImageBase64(opts?: { [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;

package/dist/api/ImagesApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ImagesApi.d.ts","sourceRoot":"","sources":["../../src/api/ImagesApi.js"],"names":[],"mappings":"AAqBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAKpD;;;;;;;;;;;;;;;;OAgBG;IACH,2CAkCC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,YAdG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;OAkBG;IACH,8DAuCC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,+BAdG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,6DAuCC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,8BAfG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAcF;IAGD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,yDA0CC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0BAjBG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAgBF;IAGD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,8BAtBW,IAAI,2BAmEd;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,kBAtBW,IAAI,QAEZ;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAmBF;IAGD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,iDAtBW,GAA8B,2BAkExC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,qCAtBW,GAA8B,QAEtC;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAmBF;CAGJ"}
+{"version":3,"file":"ImagesApi.d.ts","sourceRoot":"","sources":["../../src/api/ImagesApi.js"],"names":[],"mappings":"AAqBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAKpD;;;;;;;;;;;;;;;;;OAiBG;IACH,8DAuCC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,+BAdG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,gDAsCC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,iBAlBG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAiBF;IAGD;;;;;;;;;;;;;;;;;;OAkBG;IACH,6DAuCC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,8BAfG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAcF;IAGD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,iDA2CC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,kBAvBG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAsBF;IAGD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,uDAwCC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,wBArBG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAoBF;CAGJ"}