@gobodo/gobodo-api-promise 0.1.97 → 0.1.100

package/dist/api/GeocodeApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Geocode service.
 * @module api/GeocodeApi
-* @version 0.1.97
+* @version 0.1.100
 */
 export default class GeocodeApi {
     /**
@@ -14,8 +14,9 @@ export default class GeocodeApi {
     constructor(apiClient?: any);
     apiClient: any;
     /**
-     * @param {Number} id The id of the object that we are retrieving geolocation information from
-     * @param {module:model/GeocodePayload} geocodePayload Conversation object or array of objects to create
+     * Create Geocode
+     * Create a new geocode
+     * @param {module:model/GeocodePayload} geocodePayload Geocode data to create
      * @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
@@ -23,16 +24,18 @@ export default class GeocodeApi {
      * @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} [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 data of type {@link module:model/Geocode} and HTTP response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GeocodeResponse} and HTTP response
      */
-    createGeocodesWithHttpInfo(id: number, geocodePayload: any, opts: any): Promise<any>;
+    createGeocodeWithHttpInfo(geocodePayload: any, opts: any): Promise<any>;
     /**
-     * @param {Number} id The id of the object that we are retrieving geolocation information from
-     * @param {module:model/GeocodePayload} geocodePayload Conversation object or array of objects to create
+     * Create Geocode
+     * Create a new geocode
+     * @param {module:model/GeocodePayload} geocodePayload Geocode data to create
      * @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
@@ -40,27 +43,26 @@ export default class GeocodeApi {
      * @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.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}, with data of type {@link module:model/Geocode}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GeocodeResponse}
      */
-    createGeocodes(id: number, geocodePayload: any, opts?: { [key: string]: any;  [key: string]: any; 
+    createGeocode(geocodePayload: any, opts?: { [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
         cachekey?: Array<string>;
         cachescope?: any;
         cacheuser?: Array<string>;
-        zeusportalPostasApp?: number;
-        zeusportalPostas?: number;
-        zeusportalPostasSite?: number;
-        transactionid?: string;
     }): Promise<any>;
     /**
-     * @param {Number} id The id of the geocode to delete
-     * @param {Number} geocodeid The id of the object whose properties we are updating
+     * Geocode Object
+     * Add geocode to an object
+     * @param {Number} objectId
+     * @param {module:model/GeocodePayload} geocodePayload Geocode data
      * @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
@@ -68,16 +70,19 @@ export default class GeocodeApi {
      * @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} [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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GeocodeResponse} and HTTP response
      */
-    deleteGeocodeWithHttpInfo(id: number, geocodeid: number, opts: any): Promise<any>;
+    geocodeObjectWithHttpInfo(objectId: number, geocodePayload: any, opts: any): Promise<any>;
     /**
-     * @param {Number} id The id of the geocode to delete
-     * @param {Number} geocodeid The id of the object whose properties we are updating
+     * Geocode Object
+     * Add geocode to an object
+     * @param {Number} objectId
+     * @param {module:model/GeocodePayload} geocodePayload Geocode data
      * @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
@@ -85,69 +90,23 @@ export default class GeocodeApi {
      * @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.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}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GeocodeResponse}
      */
-    deleteGeocode(id: number, geocodeid: number, opts?: { [key: string]: any;  [key: string]: any; 
+    geocodeObject(objectId: number, geocodePayload: any, opts?: { [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
         cachekey?: Array<string>;
         cachescope?: any;
         cacheuser?: Array<string>;
-        zeusportalPostasApp?: number;
-        zeusportalPostas?: number;
-        zeusportalPostasSite?: number;
-        transactionid?: string;
     }): Promise<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 {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} [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
-     */
-    get2WithHttpInfo(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 {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.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}
-     */
-    get2(opts?: { [key: string]: any;  [key: string]: any; 
-        authorization?: string;
-        cacheduration?: number;
-        cachegroup?: Array<string>;
-        cachekey?: Array<string>;
-        cachescope?: any;
-        cacheuser?: Array<string>;
-        zeusportalPostasApp?: number;
-        zeusportalPostas?: number;
-        zeusportalPostasSite?: number;
-        transactionid?: string;
-    }): Promise<any>;
-    /**
-     * Gets and object by id
+     * Get Geocode by id
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -156,15 +115,16 @@ export default class GeocodeApi {
      * @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} [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 data of type {@link Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>} and HTTP response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GeocodeResponse} and HTTP response
      */
-    get3WithHttpInfo(id: number, opts: any): Promise<any>;
+    getGeocodeWithHttpInfo(id: number, opts: any): Promise<any>;
     /**
-     * Gets and object by id
+     * Get Geocode by id
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
@@ -173,66 +133,20 @@ export default class GeocodeApi {
      * @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.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}, with data of type {@link Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>}
-     */
-    get3(id: number, opts?: { [key: string]: any;  [key: string]: any; 
-        authorization?: string;
-        cacheduration?: number;
-        cachegroup?: Array<string>;
-        cachekey?: Array<string>;
-        cachescope?: any;
-        cacheuser?: Array<string>;
-        zeusportalPostasApp?: number;
-        zeusportalPostas?: number;
-        zeusportalPostasSite?: number;
-        transactionid?: string;
-    }): Promise<any>;
-    /**
-     * @param {Number} id The id of the object to retrieve the geolocation information
-     * @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 {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} [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 data of type {@link Array.<module:model/GraphGeocode>} and HTTP response
-     */
-    getGeocodesWithHttpInfo(id: number, opts: any): Promise<any>;
-    /**
-     * @param {Number} id The id of the object to retrieve the geolocation information
-     * @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 {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.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}, with data of type {@link Array.<module:model/GraphGeocode>}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GeocodeResponse}
      */
-    getGeocodes(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+    getGeocode(id: number, opts?: { [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
         cachekey?: Array<string>;
         cachescope?: any;
         cacheuser?: Array<string>;
-        zeusportalPostasApp?: number;
-        zeusportalPostas?: number;
-        zeusportalPostasSite?: number;
-        transactionid?: string;
     }): Promise<any>;
 }
 //# sourceMappingURL=GeocodeApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"GeocodeApi.d.ts","sourceRoot":"","sources":["../../src/api/GeocodeApi.js"],"names":[],"mappings":"AAoBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAKpD;;;;;;;;;;;;;;;OAeG;IACH,uDAdW,GAA2B,2BAuDrC;IAED;;;;;;;;;;;;;;;OAeG;IACH,2CAdW,GAA2B,QAEnC;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;KAClC,gBAOF;IAGD;;;;;;;;;;;;;;;OAeG;IACH,kFA0CC;IAED;;;;;;;;;;;;;;;OAeG;IACH,mDAZG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;KAClC,gBAOF;IAGD;;;;;;;;;;;;;;OAcG;IACH,0CAgCC;IAED;;;;;;;;;;;;;;OAcG;IACH,WAZG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;KAClC,gBAOF;IAGD;;;;;;;;;;;;;;;OAeG;IACH,sDAqCC;IAED;;;;;;;;;;;;;;;OAeG;IACH,uBAZG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;KAClC,gBAOF;IAGD;;;;;;;;;;;;;;OAcG;IACH,6DAqCC;IAED;;;;;;;;;;;;;;OAcG;IACH,8BAZG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;QACD,mBAAmB;QACnB,gBAAgB;QAChB,oBAAoB;QACpB,aAAa;KAClC,gBAOF;CAGJ"}
+{"version":3,"file":"GeocodeApi.d.ts","sourceRoot":"","sources":["../../src/api/GeocodeApi.js"],"names":[],"mappings":"AAmBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAKpD;;;;;;;;;;;;;;;;;OAiBG;IACH,0CAfW,GAA2B,2BAoDrC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,8BAfW,GAA2B,QAEnC;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,gBAYF;IAGD;;;;;;;;;;;;;;;;;;OAkBG;IACH,4DAfW,GAA2B,2BAyDrC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,gDAfW,GAA2B,QAEnC;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,gBAYF;IAGD;;;;;;;;;;;;;;;;OAgBG;IACH,4DAsCC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,6BAbG;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,gBAYF;CAGJ"}