@gobodo/gobodo-api 0.1.239 → 1.0.0

package/dist/api/EmailsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Emails service.
 * @module api/EmailsApi
-* @version 0.1.239
+* @version 1.0.0
 */
 export default class EmailsApi {
     /**
@@ -14,116 +14,131 @@ export default class EmailsApi {
     constructor(apiClient?: any);
     apiClient: any;
     /**
-     * Callback function to receive the result of the createEmailForPage operation.
-     * @callback module:api/EmailsApi~createEmailForPageCallback
+     * Callback function to receive the result of the createPageEmailAddress operation.
+     * @callback module:api/EmailsApi~createPageEmailAddressCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/EmailAddress} data The data returned by the service call.
+     * @param {module:model/EmailAddressResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Creates an email address for a page
-     * Creates an email address for a page
      * @param {Number} pageId
+     * @param {module:model/EmailAddressInput} emailAddressInput
      * @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/EmailsApi~createEmailForPageCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/EmailAddress}
+     * @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/EmailsApi~createPageEmailAddressCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/EmailAddressResponse}
      */
-    createEmailForPage(pageId: number, opts: any, callback: any): any;
+    createPageEmailAddress(pageId: number, emailAddressInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the createEmailForUser operation.
-     * @callback module:api/EmailsApi~createEmailForUserCallback
+     * Callback function to receive the result of the createUserEmailAddress operation.
+     * @callback module:api/EmailsApi~createUserEmailAddressCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/EmailAddress} data The data returned by the service call.
+     * @param {module:model/EmailAddressResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Creates an email address for a user
-     * Creates an email address for a user
      * @param {Number} userId
+     * @param {module:model/EmailAddressInput} emailAddressInput
      * @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/EmailsApi~createEmailForUserCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/EmailAddress}
+     * @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/EmailsApi~createUserEmailAddressCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/EmailAddressResponse}
      */
-    createEmailForUser(userId: number, opts: any, callback: any): any;
+    createUserEmailAddress(userId: number, emailAddressInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getEmailsByPage operation.
-     * @callback module:api/EmailsApi~getEmailsByPageCallback
+     * Callback function to receive the result of the listPageEmailAddresses operation.
+     * @callback module:api/EmailsApi~listPageEmailAddressesCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/EmailAddress>} data The data returned by the service call.
+     * @param {Array.<module:model/EmailAddressResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Returns all email addresses for a given page
-     * Returns all email addresses 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/EmailsApi~getEmailsByPageCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/EmailAddress>}
+     * @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/EmailsApi~listPageEmailAddressesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/EmailAddressResponse>}
      */
-    getEmailsByPage(pageId: number, opts: any, callback: any): any;
+    listPageEmailAddresses(pageId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getEmailsByUser operation.
-     * @callback module:api/EmailsApi~getEmailsByUserCallback
+     * Callback function to receive the result of the listUserEmailAddresses operation.
+     * @callback module:api/EmailsApi~listUserEmailAddressesCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/EmailAddress>} data The data returned by the service call.
+     * @param {Array.<module:model/EmailAddressResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Returns all email addresses for a given user
-     * Returns all email addresses for a given user
      * @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/EmailsApi~getEmailsByUserCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/EmailAddress>}
+     * @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/EmailsApi~listUserEmailAddressesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/EmailAddressResponse>}
      */
-    getEmailsByUser(userId: number, opts: any, callback: any): any;
+    listUserEmailAddresses(userId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the sendEmail operation.
+     * @callback module:api/EmailsApi~sendEmailCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/SendEmailResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * @param {module:model/SendEmailInput} sendEmailInput
+     * @param {Object} opts Optional parameters
+     * @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/EmailsApi~sendEmailCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/SendEmailResponse}
+     */
+    sendEmail(sendEmailInput: any, opts: any, callback: any): any;
 }
 //# sourceMappingURL=EmailsApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"EmailsApi.d.ts","sourceRoot":"","sources":["../../src/api/EmailsApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wDAHW,GAA+C,OA0CzD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wDAHW,GAA+C,OA0CzD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qDAHW,GAA4C,OA0CtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,qDAHW,GAA4C,OA0CtD;CAGJ"}
+{"version":3,"file":"EmailsApi.d.ts","sourceRoot":"","sources":["../../src/api/EmailsApi.js"],"names":[],"mappings":"AAoBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,0DAhBW,GAA8B,uBAa9B,GAAmD,OA6C7D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,0DAhBW,GAA8B,uBAa9B,GAAmD,OA6C7D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,4DAHW,GAAmD,OAyC7D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,4DAHW,GAAmD,OAyC7D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,0BAhBW,GAA2B,uBAa3B,GAAsC,OAwChD;CAGJ"}