@gobodo/gobodo-api 0.1.115 → 0.1.117

package/dist/api/URLMappingsApi.d.ts

@@ -0,0 +1,205 @@
+/**
+* URLMappings service.
+* @module api/URLMappingsApi
+* @version 0.1.117
+*/
+export default class URLMappingsApi {
+    /**
+    * Constructs a new URLMappingsApi.
+    * @alias module:api/URLMappingsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Callback function to receive the result of the createURLMapping operation.
+     * @callback module:api/URLMappingsApi~createURLMappingCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/URLMappingResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a new URL mapping
+     * Creates a new URL mapping that associates a path with a target object in the system.
+     * @param {module:model/URLMappingInput} uRLMappingInput
+     * @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/URLMappingsApi~createURLMappingCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/URLMappingResponse}
+     */
+    createURLMapping(uRLMappingInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteURLMapping operation.
+     * @callback module:api/URLMappingsApi~deleteURLMappingCallback
+     * @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 URL mapping
+     * @param {Number} mappingId
+     * @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/URLMappingsApi~deleteURLMappingCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteURLMapping(mappingId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteURLMappings operation.
+     * @callback module:api/URLMappingsApi~deleteURLMappingsCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Delete multiple URL mappings
+     * @param {Array.<Number>} requestBody
+     * @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/URLMappingsApi~deleteURLMappingsCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteURLMappings(requestBody: Array<number>, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getURLMapping operation.
+     * @callback module:api/URLMappingsApi~getURLMappingCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/URLMappingResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get a URL mapping by id
+     * @param {Number} mappingId
+     * @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/URLMappingsApi~getURLMappingCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/URLMappingResponse}
+     */
+    getURLMapping(mappingId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getURLMappingByPath operation.
+     * @callback module:api/URLMappingsApi~getURLMappingByPathCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/URLMappingResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get a URL mapping by site and path
+     * @param {Number} siteId
+     * @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 {String} [path] The path to look up
+     * @param {module:api/URLMappingsApi~getURLMappingByPathCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/URLMappingResponse}
+     */
+    getURLMappingByPath(siteId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getURLMappingsByObject operation.
+     * @callback module:api/URLMappingsApi~getURLMappingsByObjectCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/URLMappingResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get all URL mappings for a target object
+     * @param {Number} objectId
+     * @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/URLMappingsApi~getURLMappingsByObjectCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/URLMappingResponse>}
+     */
+    getURLMappingsByObject(objectId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getURLMappingsBySite operation.
+     * @callback module:api/URLMappingsApi~getURLMappingsBySiteCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/URLMappingResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get all URL mappings for a site
+     * @param {Number} siteId
+     * @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/URLMappingsApi~getURLMappingsBySiteCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/URLMappingResponse>}
+     */
+    getURLMappingsBySite(siteId: number, opts: any, callback: any): any;
+}