@resolution/confluence-api-client 0.4.4 → 0.4.5

package/lib/openapi/v1/services/ContentWatchesService.d.ts

@@ -22,7 +22,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta write:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-content-contentid-post
      */
-    addContentWatcher({ contentId, key, username, accountId, }: {
+    addContentWatcher: ({ contentId, key, username, accountId, }: {
         /** The ID of the content to add the watcher to. */
         contentId: string;
         /**
@@ -35,7 +35,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -46,14 +46,14 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
-    }): Promise<void>;
+        accountId?: string | undefined;
+    }) => Promise<void>;
     /**
      * Adds a user as a watcher to a label. Choose the user by doing one of the
      * following:
@@ -74,7 +74,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta write:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-label-labelname-post
      */
-    addLabelWatcher({ labelName, key, username, accountId, xAtlassianToken, }: {
+    addLabelWatcher: ({ labelName, key, username, accountId, xAtlassianToken, }: {
         /** The name of the label to add the watcher to. */
         labelName: string;
         /**
@@ -87,7 +87,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -98,19 +98,19 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /**
          * Note, you must add header when making a
          * request, as this operation has XSRF protection.
          */
         xAtlassianToken: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Adds a user as a watcher to a space. Choose the user by doing one of the
      * following:
@@ -131,7 +131,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta write:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-space-spacekey-post
      */
-    addSpaceWatcher({ spaceKey, key, username, accountId, xAtlassianToken, }: {
+    addSpaceWatcher: ({ spaceKey, key, username, accountId, xAtlassianToken, }: {
         /** The key of the space to add the watcher to. */
         spaceKey: string;
         /**
@@ -144,7 +144,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -155,19 +155,19 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /**
          * Note, you must add header when making a
          * request, as this operation has XSRF protection.
          */
         xAtlassianToken: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Returns whether a user is watching a piece of content. Choose the user by
      * doing one of the following:
@@ -186,7 +186,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta read:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-content-contentid-get
      */
-    getContentWatchStatus({ contentId, key, username, accountId, }: {
+    getContentWatchStatus: ({ contentId, key, username, accountId, }: {
         /**
          * The ID of the content to be queried for whether the specified user is
          * watching it.
@@ -202,7 +202,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -213,14 +213,14 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
-    }): Promise<UserWatch>;
+        accountId?: string | undefined;
+    }) => Promise<UserWatch>;
     /**
      * Returns a list of watchers of a space
      *
@@ -229,17 +229,17 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-current read:watcher:confluence, read:user:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-space-spacekey-watch-get
      */
-    getWatchersForSpace({ spaceKey, start, limit, }: {
+    getWatchersForSpace: ({ spaceKey, start, limit, }: {
         /** The key of the space to get watchers. */
         spaceKey: string;
         /** The start point of the collection to return. */
-        start?: string;
+        start?: string | undefined;
         /**
          * The limit of the number of items to return, this may be restricted by fixed
          * system limits.
          */
-        limit?: string;
-    }): Promise<SpaceWatchArray>;
+        limit?: string | undefined;
+    }) => Promise<SpaceWatchArray>;
     /**
      * Returns the watches for a page. A user that watches a page will receive
      * receive notifications when the page is updated.
@@ -259,17 +259,17 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta read:watcher:confluence, read:user:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-content-id-notification-child-created-get
      */
-    getWatchesForPage({ id, start, limit, }: {
+    getWatchesForPage: ({ id, start, limit, }: {
         /** The ID of the content to be queried for its watches. */
         id: string;
         /** The starting index of the returned watches. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of watches to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<WatchArray>;
+        limit?: number | undefined;
+    }) => Promise<WatchArray>;
     /**
      * Returns all space watches for the space that the content is in. A user that
      * watches a space will receive receive notifications when any content in the
@@ -290,17 +290,17 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta read:watcher:confluence, read:user:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-content-id-notification-created-get
      */
-    getWatchesForSpace({ id, start, limit, }: {
+    getWatchesForSpace: ({ id, start, limit, }: {
         /** The ID of the content to be queried for its watches. */
         id: string;
         /** The starting index of the returned watches. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of watches to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<SpaceWatchArray>;
+        limit?: number | undefined;
+    }) => Promise<SpaceWatchArray>;
     /**
      * Returns whether a user is watching a label. Choose the user by doing one
      * of the following:
@@ -319,7 +319,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta read:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-label-labelname-get
      */
-    isWatchingLabel({ labelName, key, username, accountId, }: {
+    isWatchingLabel: ({ labelName, key, username, accountId, }: {
         /**
          * The name of the label to be queried for whether the specified user is
          * watching it.
@@ -335,7 +335,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -346,14 +346,14 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
-    }): Promise<UserWatch>;
+        accountId?: string | undefined;
+    }) => Promise<UserWatch>;
     /**
      * Returns whether a user is watching a space. Choose the user by
      * doing one of the following:
@@ -372,7 +372,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta read:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-space-spacekey-get
      */
-    isWatchingSpace({ spaceKey, key, username, accountId, }: {
+    isWatchingSpace: ({ spaceKey, key, username, accountId, }: {
         /**
          * The key of the space to be queried for whether the specified user is
          * watching it.
@@ -388,7 +388,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -399,14 +399,14 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
-    }): Promise<UserWatch>;
+        accountId?: string | undefined;
+    }) => Promise<UserWatch>;
     /**
      * Removes a user as a watcher from a piece of content. Choose the user by
      * doing one of the following:
@@ -424,7 +424,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta write:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-content-contentid-delete
      */
-    removeContentWatcher({ contentId, key, username, accountId, xAtlassianToken, }: {
+    removeContentWatcher: ({ contentId, key, username, accountId, xAtlassianToken, }: {
         /** The ID of the content to remove the watcher from. */
         contentId: string;
         /**
@@ -437,7 +437,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -448,19 +448,19 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
+        accountId?: string | undefined;
         /**
          * Note, you must add header when making a
          * request, as this operation has XSRF protection.
          */
         xAtlassianToken: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Removes a user as a watcher from a label. Choose the user by doing one of
      * the following:
@@ -478,7 +478,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta write:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-label-labelname-delete
      */
-    removeLabelWatcher({ labelName, key, username, accountId, }: {
+    removeLabelWatcher: ({ labelName, key, username, accountId, }: {
         /** The name of the label to remove the watcher from. */
         labelName: string;
         /**
@@ -491,7 +491,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -502,14 +502,14 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
-    }): Promise<void>;
+        accountId?: string | undefined;
+    }) => Promise<void>;
     /**
      * Removes a user as a watcher from a space. Choose the user by doing one of
      * the following:
@@ -527,7 +527,7 @@ export declare class ContentWatchesService extends CommonHttpService {
      * @scopes-beta write:watcher:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches#api-wiki-rest-api-user-watch-space-spacekey-delete
      */
-    removeSpaceWatch({ spaceKey, key, username, accountId, }: {
+    removeSpaceWatch: ({ spaceKey, key, username, accountId, }: {
         /** The key of the space to remove the watcher from. */
         spaceKey: string;
         /**
@@ -540,7 +540,7 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -551,13 +551,13 @@ export declare class ContentWatchesService extends CommonHttpService {
          *
          * @deprecated
          */
-        username?: string;
+        username?: string | undefined;
         /**
          * The account ID of the user. The accountId uniquely identifies the user across
          * all Atlassian products.
          * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
          */
-        accountId?: string;
-    }): Promise<void>;
+        accountId?: string | undefined;
+    }) => Promise<void>;
     static initialize(): void;
 }