@gobodo/gobodo-api 0.1.128 → 0.1.129

package/dist/api/ThemeMappingsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * ThemeMappings service.
 * @module api/ThemeMappingsApi
-* @version 0.1.128
+* @version 0.1.129
 */
 export default class ThemeMappingsApi {
     /**
@@ -21,7 +21,9 @@ export default class ThemeMappingsApi {
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} themeid
+     * Add URL patterns to a theme mapping
+     * @param {Number} themeid The theme mapping ID
+     * @param {Array.<String>} requestBody Array of URL patterns
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] The how long the cache entry should persist
@@ -35,10 +37,38 @@ export default class ThemeMappingsApi {
      * @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 {Array.<String>} [requestBody]
      * @param {module:api/ThemeMappingsApi~addUrlPatternsCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    addUrlPatterns(themeid: number, opts: any, callback: any): any;
+    addUrlPatterns(themeid: number, requestBody: Array<string>, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the cloneThemeMapping operation.
+     * @callback module:api/ThemeMappingsApi~cloneThemeMappingCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ThemeMapping} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Clone a theme mapping
+     * Clone an existing theme mapping to a new category. If rootcategoryid is not provided, uses the root category.
+     * @param {Number} themeid The theme mapping ID to clone
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:model/PurgeDataDefaultResponse} [purgeDataDefaultResponse] Clone request with optional rootcategoryid
+     * @param {module:api/ThemeMappingsApi~cloneThemeMappingCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ThemeMapping}
+     */
+    cloneThemeMapping(themeid: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createTheme operation.
      * @callback module:api/ThemeMappingsApi~createThemeCallback
@@ -48,8 +78,8 @@ export default class ThemeMappingsApi {
      */
     /**
      * Create a Theme Mapping
-     * Create a new theme mapping
-     * @param {module:model/ThemeMappingPayload} themeMappingPayload Conversation object or array of objects to create
+     * Create a new theme mapping. If neither rootcategoryid nor sitetypeid is provided, uses the root category.
+     * @param {module:model/ThemeMappingPayload} themeMappingPayload Theme mapping object to create
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] The how long the cache entry should persist
@@ -68,14 +98,41 @@ export default class ThemeMappingsApi {
      */
     createTheme(themeMappingPayload: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the get34 operation.
-     * @callback module:api/ThemeMappingsApi~get34Callback
+     * Callback function to receive the result of the deleteThemeMapping operation.
+     * @callback module:api/ThemeMappingsApi~deleteThemeMappingCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Delete a theme mapping
+     * @param {Number} themeid The theme mapping ID
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/ThemeMappingsApi~deleteThemeMappingCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteThemeMapping(themeid: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getThemeMapping operation.
+     * @callback module:api/ThemeMappingsApi~getThemeMappingCallback
      * @param {String} error Error message, if any.
      * @param {module:model/ThemeMapping} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} themeid
+     * Get a theme mapping by ID
+     * @param {Number} themeid The theme mapping ID
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [cacheduration] The how long the cache entry should persist
@@ -89,8 +146,93 @@ export default class ThemeMappingsApi {
      * @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/ThemeMappingsApi~get34Callback} callback The callback function, accepting three arguments: error, data, response
+     * @param {module:api/ThemeMappingsApi~getThemeMappingCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/ThemeMapping}
      */
-    get34(themeid: number, opts: any, callback: any): any;
+    getThemeMapping(themeid: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getThemeMappings operation.
+     * @callback module:api/ThemeMappingsApi~getThemeMappingsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ThemeMapping>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get theme mappings
+     * Get theme mappings for the root category. If categoryId or sitetypeId query parameters are provided, returns mappings for that category or site type instead.
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {Number} [categoryId] Optional category ID to get mappings for
+     * @param {Number} [sitetypeId] Optional site type ID to get mappings for
+     * @param {module:api/ThemeMappingsApi~getThemeMappingsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ThemeMapping>}
+     */
+    getThemeMappings(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getThemeMappingsByCategory operation.
+     * @callback module:api/ThemeMappingsApi~getThemeMappingsByCategoryCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ThemeMapping>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get theme mappings by category
+     * Get all theme mappings for a specific category
+     * @param {Number} categoryId The category ID
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/ThemeMappingsApi~getThemeMappingsByCategoryCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ThemeMapping>}
+     */
+    getThemeMappingsByCategory(categoryId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getThemeMappingsBySiteType operation.
+     * @callback module:api/ThemeMappingsApi~getThemeMappingsBySiteTypeCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ThemeMapping>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get theme mappings by site type
+     * Get all theme mappings for a specific site type
+     * @param {Number} sitetypeId The site type ID
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/ThemeMappingsApi~getThemeMappingsBySiteTypeCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ThemeMapping>}
+     */
+    getThemeMappingsBySiteType(sitetypeId: number, opts: any, callback: any): any;
 }