@gobodo/gobodo-api 0.1.112 → 0.1.113

package/dist/api/LinksApi.d.ts

@@ -0,0 +1,266 @@
+/**
+* Links service.
+* @module api/LinksApi
+* @version 0.1.113
+*/
+export default class LinksApi {
+    /**
+    * Constructs a new LinksApi.
+    * @alias module:api/LinksApi
+    * @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 createLink operation.
+     * @callback module:api/LinksApi~createLinkCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/LinkResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a new standalone link
+     * Creates a standalone link. If url is provided, automatically fetches metadata (title, description, thumbnail) from the URL using embed.ly. Manual properties can override auto-fetched values.
+     * @param {module:model/LinkInput} linkInput
+     * @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/LinksApi~createLinkCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/LinkResponse}
+     */
+    createLink(linkInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createLinkForParent operation.
+     * @callback module:api/LinksApi~createLinkForParentCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/LinkResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a new link attached to a parent object
+     * Creates a new link attached to the specified parent object (e.g., Post, Project, Organization). If url is provided, automatically fetches metadata (title, description, thumbnail) using embed.ly. Manual properties can override auto-fetched values. The link will be associated with the parent object.
+     * @param {Number} parentObjectId ID of the parent object to attach the link to
+     * @param {module:model/LinkInput} linkInput
+     * @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/LinksApi~createLinkForParentCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/LinkResponse}
+     */
+    createLinkForParent(parentObjectId: number, linkInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteLink operation.
+     * @callback module:api/LinksApi~deleteLinkCallback
+     * @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 link
+     * @param {Number} linkId
+     * @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/LinksApi~deleteLinkCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteLink(linkId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getAllLinks operation.
+     * @callback module:api/LinksApi~getAllLinksCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/LinkResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get all links
+     * @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} [pagenum]
+     * @param {Number} [pagesize]
+     * @param {module:api/LinksApi~getAllLinksCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/LinkResponse>}
+     */
+    getAllLinks(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getLinkById operation.
+     * @callback module:api/LinksApi~getLinkByIdCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/LinkResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get a link by id
+     * @param {Number} linkId
+     * @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/LinksApi~getLinkByIdCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/LinkResponse}
+     */
+    getLinkById(linkId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getLinksByParentObject operation.
+     * @callback module:api/LinksApi~getLinksByParentObjectCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/LinkResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get links by parent object
+     * @param {Number} parentObjectId
+     * @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} [pagenum]
+     * @param {Number} [pagesize]
+     * @param {module:api/LinksApi~getLinksByParentObjectCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/LinkResponse>}
+     */
+    getLinksByParentObject(parentObjectId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the linkExists operation.
+     * @callback module:api/LinksApi~linkExistsCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Check if a link exists
+     * @param {Number} linkId
+     * @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/LinksApi~linkExistsCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    linkExists(linkId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the searchLinks operation.
+     * @callback module:api/LinksApi~searchLinksCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/LinkResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Search links by URL, title, or description
+     * @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} [q]
+     * @param {Number} [pagenum]
+     * @param {Number} [pagesize]
+     * @param {module:api/LinksApi~searchLinksCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/LinkResponse>}
+     */
+    searchLinks(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateLink operation.
+     * @callback module:api/LinksApi~updateLinkCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/LinkResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update a link
+     * @param {Number} linkId
+     * @param {module:model/LinkInput} linkInput
+     * @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/LinksApi~updateLinkCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/LinkResponse}
+     */
+    updateLink(linkId: number, linkInput: any, opts: any, callback: any): any;
+}