@resolution/confluence-api-client 0.4.4 → 0.4.6

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

@@ -22,12 +22,12 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta write:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-user-post
      */
-    addUserToGroup({ name, accountId, }: {
+    addUserToGroup: ({ name, accountId, }: {
         /** Name of the group whose membership is updated */
         name: string;
         /** AccountId of the user who needs to be added as member. */
         accountId: AccountId;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Adds a user as a member in a group represented by its groupId
      *
@@ -39,12 +39,12 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta write:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-post
      */
-    addUserToGroupByGroupId({ groupId, accountId, }: {
+    addUserToGroupByGroupId: ({ groupId, accountId, }: {
         /** GroupId of the group whose membership is updated */
         groupId: string;
         /** AccountId of the user who needs to be added as member. */
         accountId: AccountId;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Creates a new user group.
      *
@@ -57,10 +57,10 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta read:group:confluence, write:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-post
      */
-    createGroup({ groupName, }: {
+    createGroup: ({ groupName, }: {
         /** Name of the group that is to be created. */
         groupName: GroupName;
-    }): Promise<Group>;
+    }) => Promise<Group>;
     /**
      * Returns a user group for a given group id.
      *
@@ -73,10 +73,10 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta read:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-by-id-get
      */
-    getGroupByGroupId({ id, }: {
+    getGroupByGroupId: ({ id, }: {
         /** The id of the group. */
         id: string;
-    }): Promise<Group>;
+    }) => Promise<Group>;
     /**
      * Returns a user group for a given group name.
      *
@@ -90,13 +90,13 @@ export declare class GroupService extends CommonHttpService {
      * @path {GET} /wiki/rest/api/group/{groupName}
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-groupname-get
      */
-    getGroupByName({ groupName, }: {
+    getGroupByName: ({ groupName, }: {
         /**
          * The name of the group. This is the same as the group name shown in
          * the Confluence administration console.
          */
         groupName: string;
-    }): Promise<Group>;
+    }) => Promise<Group>;
     /**
      * Returns a user group for a given group name.
      *
@@ -110,13 +110,13 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta read:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-by-name-get
      */
-    getGroupByQueryParam({ name, }: {
+    getGroupByQueryParam: ({ name, }: {
         /**
          * The name of the group. This is the same as the group name shown in
          * the Confluence administration console.
          */
         name: string;
-    }): Promise<Group>;
+    }) => Promise<Group>;
     /**
      * Returns the users that are members of a group.
      *
@@ -130,17 +130,17 @@ export declare class GroupService extends CommonHttpService {
      * @path {GET} /wiki/rest/api/group/{groupName}/member
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-groupname-member-get
      */
-    getGroupMembers({ groupName, start, limit, }: {
+    getGroupMembers: ({ groupName, start, limit, }: {
         /** The name of the group to be queried for its members. */
         groupName: string;
         /** The starting index of the returned users. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of users to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<UserArray>;
+        limit?: number | undefined;
+    }) => Promise<UserArray>;
     /**
      * Returns the users that are members of a group.
      *
@@ -155,22 +155,22 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta read:group:confluence, read:user:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-groupid-membersbygroupid-get
      */
-    getGroupMembersByGroupId({ groupId, start, limit, shouldReturnTotalSize, expand, }: {
+    getGroupMembersByGroupId: ({ groupId, start, limit, shouldReturnTotalSize, expand, }: {
         /** The id of the group to be queried for its members. */
         groupId: string;
         /** The starting index of the returned users. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of users to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
+        limit?: number | undefined;
         /**
          * Whether to include total size parameter in the results.
          * Note, fetching total size property is an expensive operation; use it if your
          * use case needs this value.
          */
-        shouldReturnTotalSize?: boolean;
+        shouldReturnTotalSize?: boolean | undefined;
         /**
          * A multi-value parameter indicating which properties of the user to
          * expand.
@@ -180,8 +180,8 @@ export declare class GroupService extends CommonHttpService {
          *   - `isExternalCollaborator` returns whether the user is an external
          * collaborator user.
          */
-        expand?: ("operations" | "personalSpace" | "isExternalCollaborator")[];
-    }): Promise<UserArray>;
+        expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[] | undefined;
+    }) => Promise<UserArray>;
     /**
      * Returns all user groups. The returned groups are ordered alphabetically in
      * ascending order by group name.
@@ -195,17 +195,17 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta read:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-get
      */
-    getGroups({ start, limit, accessType, }?: {
+    getGroups: ({ start, limit, accessType, }?: {
         /** The starting index of the returned groups. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of groups to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
+        limit?: number | undefined;
         /** The group permission level for which to filter results. */
-        accessType?: "user" | "admin" | "site-admin";
-    }): Promise<GroupArrayWithLinks>;
+        accessType?: "user" | "admin" | "site-admin" | undefined;
+    }) => Promise<GroupArrayWithLinks>;
     /**
      * Returns the users that are members of a group.
      *
@@ -219,24 +219,24 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta read:group:confluence, read:user:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-member-get
      */
-    getMembersByQueryParam({ name, start, limit, shouldReturnTotalSize, expand, }: {
+    getMembersByQueryParam: ({ name, start, limit, shouldReturnTotalSize, expand, }: {
         /** The name of the group to be queried for its members. */
         name: string;
         /** The starting index of the returned users. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of users to return per page.
          * Note, this is restricted by fixed system limit of 200 which is to say if the
          * limit parameter
          * exceeds 200, this API will return a maximum of 200 users per page.
          */
-        limit?: number;
+        limit?: number | undefined;
         /**
          * Whether to include total size parameter in the results.
          * Note, fetching total size property is an expensive operation; use it if your
          * use case needs this value.
          */
-        shouldReturnTotalSize?: boolean;
+        shouldReturnTotalSize?: boolean | undefined;
         /**
          * A multi-value parameter indicating which properties of the user to
          * expand.
@@ -246,8 +246,8 @@ export declare class GroupService extends CommonHttpService {
          *   - `isExternalCollaborator` returns whether the user is an external
          * collaborator user.
          */
-        expand?: ("operations" | "personalSpace" | "isExternalCollaborator")[];
-    }): Promise<UserArray>;
+        expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[] | undefined;
+    }) => Promise<UserArray>;
     /**
      * Delete user group.
      *
@@ -260,10 +260,10 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta write:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-delete
      */
-    removeGroup({ name, }: {
+    removeGroup: ({ name, }: {
         /** Name of the group to delete. */
         name: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Delete user group.
      *
@@ -275,10 +275,10 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta write:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-by-id-delete
      */
-    removeGroupById({ id, }: {
+    removeGroupById: ({ id, }: {
         /** Id of the group to delete. */
         id: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Remove user as a member from a group.
      *
@@ -291,7 +291,7 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta write:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-user-delete
      */
-    removeMemberFromGroup({ name, key, username, accountId, }: {
+    removeMemberFromGroup: ({ name, key, username, accountId, }: {
         /** Name of the group whose membership is updated. */
         name: string;
         /**
@@ -304,7 +304,7 @@ export declare class GroupService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -315,14 +315,14 @@ export declare class GroupService 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>;
     /**
      * Remove user as a member from a group.
      *
@@ -334,7 +334,7 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta write:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-delete
      */
-    removeMemberFromGroupByGroupId({ groupId, key, username, accountId, }: {
+    removeMemberFromGroupByGroupId: ({ groupId, key, username, accountId, }: {
         /** Id of the group whose membership is updated. */
         groupId: string;
         /**
@@ -347,7 +347,7 @@ export declare class GroupService extends CommonHttpService {
          *
          * @deprecated
          */
-        key?: string;
+        key?: string | undefined;
         /**
          * This parameter is no longer available and will be removed from the
          * documentation soon.
@@ -358,14 +358,14 @@ export declare class GroupService 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>;
     /**
      * Get search results of groups by partial query provided.
      *
@@ -375,22 +375,22 @@ export declare class GroupService extends CommonHttpService {
      * @scopes-beta read:group:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-picker-get
      */
-    searchGroups({ query, start, limit, shouldReturnTotalSize, }: {
+    searchGroups: ({ query, start, limit, shouldReturnTotalSize, }: {
         /** the search term used to query results. */
         query: string;
         /** The starting index of the returned groups. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of groups to return per page.
          * Note, this is restricted to a maximum limit of 200 groups.
          */
-        limit?: number;
+        limit?: number | undefined;
         /**
          * Whether to include total size parameter in the results.
          * Note, fetching total size property is an expensive operation; use it if your
          * use case needs this value.
          */
-        shouldReturnTotalSize?: boolean;
-    }): Promise<GroupArrayWithLinks>;
+        shouldReturnTotalSize?: boolean | undefined;
+    }) => Promise<GroupArrayWithLinks>;
     static initialize(): void;
 }