@gobodo/gobodo-api-promise 0.1.224 → 0.1.226

package/dist/api/AdsApi.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _CacheInvalidation = _interopRequireDefault(require("../model/CacheInvalidation"));
 var _JsonValue = _interopRequireDefault(require("../model/JsonValue"));
 var _PurgeDataDefaultResponse = _interopRequireDefault(require("../model/PurgeDataDefaultResponse"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -17,7 +18,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * gobodo-api
  * REST Interface for Gobodo API
  *
- * The version of the OpenAPI document: 0.1.224
+ * The version of the OpenAPI document: 0.1.226
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Ads service.
 * @module api/AdsApi
-* @version 0.1.224
+* @version 0.1.226
 */
 var AdsApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -49,11 +50,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
    * @param {Object} opts Optional parameters
    * @param {String} [authorization] The authorization token of the logged in user
    * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-   * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+   * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
    * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
    * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-   * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
-   * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+   * @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). May be provided as repeated query params.
+   * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
    * @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
@@ -70,11 +71,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
       var pathParams = {};
       var queryParams = {
         'cacheduration': opts['cacheduration'],
-        'cachegroup': opts['cachegroup'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
-        'cacheuser': opts['cacheuser'],
-        'invalidationkeys': opts['invalidationkeys']
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
       };
       var headerParams = {
         'Authorization': opts['authorization'],
@@ -98,11 +99,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} opts.cachegroup Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} opts.cachekey Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} opts.cachescope Cache scope for the REST request cache layer.
-     * @param {String} opts.cacheuser Optional cache user hint for cache-aware infrastructure.
-     * @param {String} opts.invalidationkeys JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -124,11 +125,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
-     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -144,11 +145,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
       var pathParams = {};
       var queryParams = {
         'cacheduration': opts['cacheduration'],
-        'cachegroup': opts['cachegroup'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
-        'cacheuser': opts['cacheuser'],
-        'invalidationkeys': opts['invalidationkeys']
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
       };
       var headerParams = {
         'Authorization': opts['authorization'],
@@ -171,11 +172,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} opts.cachegroup Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} opts.cachekey Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} opts.cachescope Cache scope for the REST request cache layer.
-     * @param {String} opts.cacheuser Optional cache user hint for cache-aware infrastructure.
-     * @param {String} opts.invalidationkeys JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -197,11 +198,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
-     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -223,11 +224,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
       };
       var queryParams = {
         'cacheduration': opts['cacheduration'],
-        'cachegroup': opts['cachegroup'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
-        'cacheuser': opts['cacheuser'],
-        'invalidationkeys': opts['invalidationkeys']
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
       };
       var headerParams = {
         'Authorization': opts['authorization'],
@@ -251,11 +252,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} opts.cachegroup Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} opts.cachekey Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} opts.cachescope Cache scope for the REST request cache layer.
-     * @param {String} opts.cacheuser Optional cache user hint for cache-aware infrastructure.
-     * @param {String} opts.invalidationkeys JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -276,11 +277,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
-     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -302,11 +303,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
       };
       var queryParams = {
         'cacheduration': opts['cacheduration'],
-        'cachegroup': opts['cachegroup'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
-        'cacheuser': opts['cacheuser'],
-        'invalidationkeys': opts['invalidationkeys']
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
       };
       var headerParams = {
         'Authorization': opts['authorization'],
@@ -329,11 +330,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} opts.cachegroup Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} opts.cachekey Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} opts.cachescope Cache scope for the REST request cache layer.
-     * @param {String} opts.cacheuser Optional cache user hint for cache-aware infrastructure.
-     * @param {String} opts.invalidationkeys JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -354,11 +355,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
-     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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
@@ -381,11 +382,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
       };
       var queryParams = {
         'cacheduration': opts['cacheduration'],
-        'cachegroup': opts['cachegroup'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
-        'cacheuser': opts['cacheuser'],
-        'invalidationkeys': opts['invalidationkeys']
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
       };
       var headerParams = {
         'Authorization': opts['authorization'],
@@ -408,11 +409,11 @@ var AdsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} opts.authorization The authorization token of the logged in user
      * @param {Number} opts.cacheduration Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {String} opts.cachegroup Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
      * @param {Array.<String>} opts.cachekey Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
      * @param {module:model/String} opts.cachescope Cache scope for the REST request cache layer.
-     * @param {String} opts.cacheuser Optional cache user hint for cache-aware infrastructure.
-     * @param {String} opts.invalidationkeys JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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). May be provided as repeated query params.
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
      * @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