@gobodo/gobodo-api 0.1.240 → 1.0.1

package/dist/api/PaymentRoutingApi.js

@@ -5,9 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _CacheInvalidation = _interopRequireDefault(require("../model/CacheInvalidation"));
-var _PaymentRoutingConfigRequest = _interopRequireDefault(require("../model/PaymentRoutingConfigRequest"));
-var _PaymentRoutingConfigResponse = _interopRequireDefault(require("../model/PaymentRoutingConfigResponse"));
+var _TenantPaymentRoutingConfig = _interopRequireDefault(require("../model/TenantPaymentRoutingConfig"));
+var _TenantPaymentRoutingConfigUpdate = _interopRequireDefault(require("../model/TenantPaymentRoutingConfigUpdate"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -15,11 +14,11 @@ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o =
 function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
- * gobodo-api
- * REST Interface for Gobodo API
+ * Gobodo Spring API
+ * Typed Spring MVC v1 API for Gobodo graph metadata.
  *
- * The version of the OpenAPI document: 0.1.240
- * Contact: info@gobodo.io
+ * The version of the OpenAPI document: 1.0.1
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -29,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * PaymentRouting service.
 * @module api/PaymentRoutingApi
-* @version 0.1.240
+* @version 1.0.1
 */
 var PaymentRoutingApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -48,29 +47,28 @@ var PaymentRoutingApi = exports["default"] = /*#__PURE__*/function () {
    * Callback function to receive the result of the getTenantPaymentRoutingConfig operation.
    * @callback module:api/PaymentRoutingApi~getTenantPaymentRoutingConfigCallback
    * @param {String} error Error message, if any.
-   * @param {module:model/PaymentRoutingConfigResponse} data The data returned by the service call.
+   * @param {module:model/TenantPaymentRoutingConfig} data The data returned by the service call.
    * @param {String} response The complete HTTP response.
    */
 
   /**
-   * Get payment routing config for tenant
+   * Get payment routing config for a site, application or the current tenant
    * @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 {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 {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
-   * @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 {Number} [siteId] 
    * @param {Number} [appId] 
+   * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+   * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+   * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+   * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+   * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+   * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+   * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+   * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+   * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+   * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+   * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
    * @param {module:api/PaymentRoutingApi~getTenantPaymentRoutingConfigCallback} callback The callback function, accepting three arguments: error, data, response
-   * data is of type: {@link module:model/PaymentRoutingConfigResponse}
+   * data is of type: {@link module:model/TenantPaymentRoutingConfig}
    */
   return _createClass(PaymentRoutingApi, [{
     key: "getTenantPaymentRoutingConfig",
@@ -79,28 +77,27 @@ var PaymentRoutingApi = exports["default"] = /*#__PURE__*/function () {
       var postBody = null;
       var pathParams = {};
       var queryParams = {
-        'cacheduration': opts['cacheduration'],
-        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
+        'siteId': opts['siteId'],
+        'appId': opts['appId'],
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
-        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi'),
-        'siteId': opts['siteId'],
-        'appId': opts['appId']
+        'invalidationkeys': opts['invalidationkeys']
       };
       var headerParams = {
-        'Authorization': opts['authorization'],
-        'zeusportal-postas-app': opts['zeusportalPostasApp'],
-        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'transactionid': opts['transactionid'],
         'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
         'zeusportal-postas-site': opts['zeusportalPostasSite'],
-        'transactionid': opts['transactionid']
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
       };
       var formParams = {};
-      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = [];
-      var accepts = ['application/json'];
-      var returnType = _PaymentRoutingConfigResponse["default"];
+      var accepts = ['*/*'];
+      var returnType = _TenantPaymentRoutingConfig["default"];
       return this.apiClient.callApi('/payments/routing/config', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
 
@@ -108,64 +105,62 @@ var PaymentRoutingApi = exports["default"] = /*#__PURE__*/function () {
      * Callback function to receive the result of the updateTenantPaymentRoutingConfig operation.
      * @callback module:api/PaymentRoutingApi~updateTenantPaymentRoutingConfigCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PaymentRoutingConfigResponse} data The data returned by the service call.
+     * @param {module:model/TenantPaymentRoutingConfig} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
 
     /**
-     * Update payment routing config for tenant
-     * @param {module:model/PaymentRoutingConfigRequest} paymentRoutingConfigRequest Payment routing fields to update
+     * Update payment routing config for a site, application or the current tenant
+     * @param {module:model/TenantPaymentRoutingConfigUpdate} tenantPaymentRoutingConfigUpdate 
      * @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 {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 {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
-     * @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 {Number} [siteId] 
      * @param {Number} [appId] 
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
      * @param {module:api/PaymentRoutingApi~updateTenantPaymentRoutingConfigCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PaymentRoutingConfigResponse}
+     * data is of type: {@link module:model/TenantPaymentRoutingConfig}
      */
   }, {
     key: "updateTenantPaymentRoutingConfig",
-    value: function updateTenantPaymentRoutingConfig(paymentRoutingConfigRequest, opts, callback) {
+    value: function updateTenantPaymentRoutingConfig(tenantPaymentRoutingConfigUpdate, opts, callback) {
       opts = opts || {};
-      var postBody = paymentRoutingConfigRequest;
-      // verify the required parameter 'paymentRoutingConfigRequest' is set
-      if (paymentRoutingConfigRequest === undefined || paymentRoutingConfigRequest === null) {
-        throw new Error("Missing the required parameter 'paymentRoutingConfigRequest' when calling updateTenantPaymentRoutingConfig");
+      var postBody = tenantPaymentRoutingConfigUpdate;
+      // verify the required parameter 'tenantPaymentRoutingConfigUpdate' is set
+      if (tenantPaymentRoutingConfigUpdate === undefined || tenantPaymentRoutingConfigUpdate === null) {
+        throw new Error("Missing the required parameter 'tenantPaymentRoutingConfigUpdate' when calling updateTenantPaymentRoutingConfig");
       }
       var pathParams = {};
       var queryParams = {
-        'cacheduration': opts['cacheduration'],
-        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
+        'siteId': opts['siteId'],
+        'appId': opts['appId'],
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
-        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi'),
-        'siteId': opts['siteId'],
-        'appId': opts['appId']
+        'invalidationkeys': opts['invalidationkeys']
       };
       var headerParams = {
-        'Authorization': opts['authorization'],
-        'zeusportal-postas-app': opts['zeusportalPostasApp'],
-        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'transactionid': opts['transactionid'],
         'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
         'zeusportal-postas-site': opts['zeusportalPostasSite'],
-        'transactionid': opts['transactionid']
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
       };
       var formParams = {};
-      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = ['application/json'];
-      var accepts = ['application/json'];
-      var returnType = _PaymentRoutingConfigResponse["default"];
+      var accepts = ['*/*'];
+      var returnType = _TenantPaymentRoutingConfig["default"];
       return this.apiClient.callApi('/payments/routing/config', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
   }]);

package/dist/api/PhoneNumbersApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * PhoneNumbers service.
 * @module api/PhoneNumbersApi
-* @version 0.1.240
+* @version 1.0.1
 */
 export default class PhoneNumbersApi {
     /**
@@ -14,144 +14,134 @@ export default class PhoneNumbersApi {
     constructor(apiClient?: any);
     apiClient: any;
     /**
-     * Callback function to receive the result of the createPhoneNumberForPage operation.
-     * @callback module:api/PhoneNumbersApi~createPhoneNumberForPageCallback
+     * Callback function to receive the result of the createPagePhoneNumber operation.
+     * @callback module:api/PhoneNumbersApi~createPagePhoneNumberCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PhoneNumber} data The data returned by the service call.
+     * @param {module:model/PhoneNumberResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Creates a phone number for a page
-     * Creates a phone number for a page. Only the page creator or a platform administrator.
+     * Add a page phone number (page creator or admin)
      * @param {Number} pageId
+     * @param {module:model/PhoneNumberInput} phoneNumberInput
      * @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 {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 {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
-     * @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:api/PhoneNumbersApi~createPhoneNumberForPageCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PhoneNumber}
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/PhoneNumbersApi~createPagePhoneNumberCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PhoneNumberResponse}
      */
-    createPhoneNumberForPage(pageId: number, opts: any, callback: any): any;
+    createPagePhoneNumber(pageId: number, phoneNumberInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the createPhoneNumberForUser operation.
-     * @callback module:api/PhoneNumbersApi~createPhoneNumberForUserCallback
+     * Callback function to receive the result of the createUserPhoneNumber operation.
+     * @callback module:api/PhoneNumbersApi~createUserPhoneNumberCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PhoneNumber} data The data returned by the service call.
+     * @param {module:model/PhoneNumberResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Creates a phone number for a user
-     * Creates a phone number for a user. Only the user or a platform administrator.
      * @param {Number} userId
+     * @param {module:model/PhoneNumberInput} phoneNumberInput
      * @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 {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 {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
-     * @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:api/PhoneNumbersApi~createPhoneNumberForUserCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PhoneNumber}
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/PhoneNumbersApi~createUserPhoneNumberCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PhoneNumberResponse}
      */
-    createPhoneNumberForUser(userId: number, opts: any, callback: any): any;
+    createUserPhoneNumber(userId: number, phoneNumberInput: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getPhoneNumber operation.
      * @callback module:api/PhoneNumbersApi~getPhoneNumberCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PhoneNumber} data The data returned by the service call.
+     * @param {module:model/PhoneNumberResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Returns a phone number by id
-     * Returns a phone number by it's id. Platform administrators only.
+     * Get a phone number by id (admin only)
      * @param {Number} id
      * @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 {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 {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
-     * @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 {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
      * @param {module:api/PhoneNumbersApi~getPhoneNumberCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PhoneNumber}
+     * data is of type: {@link module:model/PhoneNumberResponse}
      */
     getPhoneNumber(id: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getPhoneNumbersByPage operation.
-     * @callback module:api/PhoneNumbersApi~getPhoneNumbersByPageCallback
+     * Callback function to receive the result of the listPagePhoneNumbers operation.
+     * @callback module:api/PhoneNumbersApi~listPagePhoneNumbersCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/PhoneNumber>} data The data returned by the service call.
+     * @param {Array.<module:model/PhoneNumberResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Returns all phone numbers for a given page
-     * Returns all phone numbers for a given page
      * @param {Number} pageId
      * @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 {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 {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
-     * @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:api/PhoneNumbersApi~getPhoneNumbersByPageCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/PhoneNumber>}
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/PhoneNumbersApi~listPagePhoneNumbersCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/PhoneNumberResponse>}
      */
-    getPhoneNumbersByPage(pageId: number, opts: any, callback: any): any;
+    listPagePhoneNumbers(pageId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getPhoneNumbersByUser operation.
-     * @callback module:api/PhoneNumbersApi~getPhoneNumbersByUserCallback
+     * Callback function to receive the result of the listUserPhoneNumbers operation.
+     * @callback module:api/PhoneNumbersApi~listUserPhoneNumbersCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/PhoneNumber>} data The data returned by the service call.
+     * @param {Array.<module:model/PhoneNumberResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Returns all phone numbers for a given user
-     * Returns all phone numbers for a given user. Only the user or a platform administrator.
-     * @param {Number} userid
+     * List a user's phone numbers (the user or an admin)
+     * @param {Number} userId
      * @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 {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 {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
-     * @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:api/PhoneNumbersApi~getPhoneNumbersByUserCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/PhoneNumber>}
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/PhoneNumbersApi~listUserPhoneNumbersCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/PhoneNumberResponse>}
      */
-    getPhoneNumbersByUser(userid: number, opts: any, callback: any): any;
+    listUserPhoneNumbers(userId: number, opts: any, callback: any): any;
 }
 //# sourceMappingURL=PhoneNumbersApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PhoneNumbersApi.d.ts","sourceRoot":"","sources":["../../src/api/PhoneNumbersApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,8DAHW,GAA2D,OA0CrE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,8DAHW,GAA2D,OA0CrE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gDAHW,GAAiD,OA0C3D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,2DAHW,GAAwD,OA0ClE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,2DAHW,GAAwD,OA0ClE;CAGJ"}
+{"version":3,"file":"PhoneNumbersApi.d.ts","sourceRoot":"","sources":["../../src/api/PhoneNumbersApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,wDAhBW,GAA6B,uBAa7B,GAAwD,OA6ClE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,wDAhBW,GAA6B,uBAa7B,GAAwD,OA6ClE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,gDAHW,GAAiD,OAyC3D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,0DAHW,GAAuD,OAyCjE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,0DAHW,GAAuD,OAyCjE;CAGJ"}