@resolution/organizations-api-client 0.16.1 → 0.16.4

package/lib/openapi/organizations/services/UsersService.d.ts

@@ -8,6 +8,30 @@ import { type UserProductAccessActivityPage, type UserPage, type OrganizationLev
  * @category Services
  */
 export declare class UsersService extends CommonHttpService {
+    /**
+     * Assign an organization-level role to a user. These are roles that have
+     * organization-wide privileges, like organization admin.
+     *
+     * This operation follows eventual consistency. Changes may take up to 30 seconds
+     * to be reflected after the operation is performed.
+     *
+     * @path POST `/v1/orgs/{orgId}/users/{userId}/role-assignments/assign`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-userid-role-assignments-assign-post
+     * @param params
+     */
+    assignOrganizationLevelRole: ({ orgId, userId, organizationLevelRoleApiRequest }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * Every user has a unique ID. Find a user’s account ID by using the [Get users
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-get).
+         */
+        userId: string;
+        organizationLevelRoleApiRequest: OrganizationLevelRoleApiRequest;
+    }) => Promise<void>;
     /**
      * **The API is available for customers using the [new user management experience
      * only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**.
@@ -82,36 +106,6 @@ export declare class UsersService extends CommonHttpService {
          */
         accountId: string;
     }) => Promise<void>;
-    /**
-     * Remove a user from a directory if you don’t want them to appear in your
-     * directory or have access to your apps anymore. You’re not billed for a user
-     * once they’re removed.
-     * You must invite the user to your organization again if you want to reinstate
-     * their access to your apps. You’ll need to assign their roles and group
-     * memberships again.
-     *
-     * @path DELETE `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}`
-     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-delete
-     * @param params
-     */
-    deleteV2OrgsOrgIdDirectoriesDirectoryIdUsersAccountId: ({ orgId, directoryId, accountId }: {
-        /**
-         * Your organization has a unique ID. Find this ID in your Atlassian
-         * Administration URL or when you create your API key.
-         */
-        orgId: string;
-        /**
-         * A directory has a unique ID. Use the [Get directories
-         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
-         * to find the directory ID.
-         */
-        directoryId: string;
-        /**
-         * Every user has a unique ID. Find a user’s account ID by using the [Get users
-         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-get).
-         */
-        accountId: string;
-    }) => Promise<void>;
     /**
      * Return a page of users in your organization that match the supplied parameters.
      * By default, users in all your directories and all your managed accounts are
@@ -394,6 +388,49 @@ export declare class UsersService extends CommonHttpService {
     } & {
         [key: string]: unknown;
     }>;
+    /**
+     * **Additional response parameters of the API (for e.g., `added_to_org`) are
+     * available only to customers using the new user management experience.** Learn
+     * more about the [new user management
+     * experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).
+     *
+     * Specifications:
+     * - Return a user’s last active date for each product listed in Atlassian
+     * Administration.
+     * - Active is defined as viewing a product's page for a minimum of 2 seconds.
+     * - The data for the last activity may be delayed by up to 24 hours.
+     * - If the user has not accessed a product, the `product_access` response field
+     * will be empty.
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/user-last-active-dates/).
+     *
+     * @returns Successful operation
+     * @path GET `/v1/orgs/{orgId}/directory/users/{accountId}/last-active-dates`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-directory-users-accountid-last-active-dates-get
+     * @param params
+     */
+    getUserLastActiveDates: ({ orgId, accountId, cursor }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * Unique ID of the user's account.
+         * Use the [Jira User Search
+         * API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get)
+         * to get the accountId (if Jira is available for your Organization). **Jira APIs
+         * use a different [authentication method
+         * ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**
+         * If you don’t have Jira, export a .csv of the user list. Learn how to [export
+         * users from a
+         * site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).
+         */
+        accountId: string;
+        /** Cursor to fetch the next page */
+        cursor?: string | undefined;
+    }) => Promise<UserProductAccessActivityPage>;
     /**
      * Returns a page of role assignments for a user that match the supplied
      * parameters.
@@ -519,48 +556,41 @@ export declare class UsersService extends CommonHttpService {
         directoryId: string;
     }) => Promise<MultiDirectoryUserStats>;
     /**
-     * **Additional response parameters of the API (for e.g., `added_to_org`) are
-     * available only to customers using the new user management experience.** Learn
-     * more about the [new user management
-     * experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).
+     * Invite people to your organization. When you invite someone:
+     * - they’re given app roles according to your invitation.
+     * - they’re added to directories based on apps in your invitation.
+     * - they’re added to groups according to your invitation.
+     * - they receive an email invitation if the `sendNotification` field is set to
+     * `true` and the `notificationText` field contains a message to include in the
+     * email invitation.
      *
-     * Specifications:
-     * - Return a user’s last active date for each product listed in Atlassian
-     * Administration.
-     * - Active is defined as viewing a product's page for a minimum of 2 seconds.
-     * - The data for the last activity may be delayed by up to 24 hours.
-     * - If the user has not accessed a product, the `product_access` response field
-     * will be empty.
+     * **This API is only available to customers who have at least one paid
+     * subscription in their organization.**
      *
-     * Learn the fastest way to call the API with a detailed
-     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/user-last-active-dates/).
+     * @returns
+     *  * status: 200, mediaType: application/json
      *
-     * @returns Successful operation
-     * @path GET `/v1/orgs/{orgId}/directory/users/{accountId}/last-active-dates`
-     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-directory-users-accountid-last-active-dates-get
+     *    Success
+     *
+     *  * status: 206, mediaType: application/json
+     *
+     *    At least one invitation failed
+     * @path POST `/v2/orgs/{orgId}/users/invite`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-users-invite-post
      * @param params
      */
-    getV1OrgsOrgIdDirectoryUsersAccountIdLastActiveDates: ({ orgId, accountId, cursor }: {
+    inviteUsersToOrganization: ({ orgId, multidirectoryInviteApiRequest }: {
         /**
          * Your organization has a unique ID. Find this ID in your Atlassian
          * Administration URL or when you create your API key.
          */
         orgId: string;
-        /**
-         * Unique ID of the user's account.
-         * Use the [Jira User Search
-         * API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get)
-         * to get the accountId (if Jira is available for your Organization). **Jira APIs
-         * use a different [authentication method
-         * ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**
-         * If you don’t have Jira, export a .csv of the user list. Learn how to [export
-         * users from a
-         * site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).
-         */
-        accountId: string;
-        /** Cursor to fetch the next page */
-        cursor?: string | undefined;
-    }) => Promise<UserProductAccessActivityPage>;
+        multidirectoryInviteApiRequest: MultidirectoryInviteApiRequest;
+    }) => Promise<commonHttpClient.WithResponse<{
+        status: 200 | 206;
+        mediaType: "application/json";
+        body: MultidirectoryInviteSuccessResponse;
+    }>>;
     /**
      * **This API is deprecated and will no longer work after June 30, 2026.** Use the
      * [Restore user access in directory
@@ -718,30 +748,6 @@ export declare class UsersService extends CommonHttpService {
         orgId: string;
         inviteApiRequest: InviteApiRequest;
     }) => Promise<string[]>;
-    /**
-     * Assign an organization-level role to a user. These are roles that have
-     * organization-wide privileges, like organization admin.
-     *
-     * This operation follows eventual consistency. Changes may take up to 30 seconds
-     * to be reflected after the operation is performed.
-     *
-     * @path POST `/v1/orgs/{orgId}/users/{userId}/role-assignments/assign`
-     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-userid-role-assignments-assign-post
-     * @param params
-     */
-    postV1OrgsOrgIdUsersUserIdRoleAssignmentsAssign: ({ orgId, userId, organizationLevelRoleApiRequest }: {
-        /**
-         * Your organization has a unique ID. Find this ID in your Atlassian
-         * Administration URL or when you create your API key.
-         */
-        orgId: string;
-        /**
-         * Every user has a unique ID. Find a user’s account ID by using the [Get users
-         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-get).
-         */
-        userId: string;
-        organizationLevelRoleApiRequest: OrganizationLevelRoleApiRequest;
-    }) => Promise<void>;
     /**
      * Remove an organization-level role from a user. These are roles that have
      * organization-wide privileges, like organization admin.
@@ -753,7 +759,7 @@ export declare class UsersService extends CommonHttpService {
      * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-userid-role-assignments-revoke-post
      * @param params
      */
-    postV1OrgsOrgIdUsersUserIdRoleAssignmentsRevoke: ({ orgId, userId, organizationLevelRoleApiRequest }: {
+    removeOrganizationLevelRole: ({ orgId, userId, organizationLevelRoleApiRequest }: {
         /**
          * Your organization has a unique ID. Find this ID in your Atlassian
          * Administration URL or when you create your API key.
@@ -767,15 +773,18 @@ export declare class UsersService extends CommonHttpService {
         organizationLevelRoleApiRequest: OrganizationLevelRoleApiRequest;
     }) => Promise<void>;
     /**
-     * Restore a user’s access in a directory to let them access apps again. They
-     * regain their roles and group memberships from before their access was
-     * suspended. We resume billing you for this user.
+     * Remove a user from a directory if you don’t want them to appear in your
+     * directory or have access to your apps anymore. You’re not billed for a user
+     * once they’re removed.
+     * You must invite the user to your organization again if you want to reinstate
+     * their access to your apps. You’ll need to assign their roles and group
+     * memberships again.
      *
-     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/restore`
-     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-restore-post
+     * @path DELETE `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-delete
      * @param params
      */
-    postV2OrgsOrgIdDirectoriesDirectoryIdUsersAccountIdRestore: ({ orgId, directoryId, accountId }: {
+    removeUserFromDirectory: ({ orgId, directoryId, accountId }: {
         /**
          * Your organization has a unique ID. Find this ID in your Atlassian
          * Administration URL or when you create your API key.
@@ -794,15 +803,15 @@ export declare class UsersService extends CommonHttpService {
         accountId: string;
     }) => Promise<void>;
     /**
-     * Suspend a user’s access in a directory to remove their access to apps
-     * temporarily. You’re not billed for a user when their access is suspended. They
-     * regain their roles and group memberships when you restore their access.
+     * Restore a user’s access in a directory to let them access apps again. They
+     * regain their roles and group memberships from before their access was
+     * suspended. We resume billing you for this user.
      *
-     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/suspend`
-     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-suspend-post
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/restore`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-restore-post
      * @param params
      */
-    postV2OrgsOrgIdDirectoriesDirectoryIdUsersAccountIdSuspend: ({ orgId, directoryId, accountId }: {
+    restoreUserAccessInDirectory: ({ orgId, directoryId, accountId }: {
         /**
          * Your organization has a unique ID. Find this ID in your Atlassian
          * Administration URL or when you create your API key.
@@ -820,42 +829,6 @@ export declare class UsersService extends CommonHttpService {
          */
         accountId: string;
     }) => Promise<void>;
-    /**
-     * Invite people to your organization. When you invite someone:
-     * - they’re given app roles according to your invitation.
-     * - they’re added to directories based on apps in your invitation.
-     * - they’re added to groups according to your invitation.
-     * - they receive an email invitation if the `sendNotification` field is set to
-     * `true` and the `notificationText` field contains a message to include in the
-     * email invitation.
-     *
-     * **This API is only available to customers who have at least one paid
-     * subscription in their organization.**
-     *
-     * @returns
-     *  * status: 200, mediaType: application/json
-     *
-     *    Success
-     *
-     *  * status: 206, mediaType: application/json
-     *
-     *    At least one invitation failed
-     * @path POST `/v2/orgs/{orgId}/users/invite`
-     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-users-invite-post
-     * @param params
-     */
-    postV2OrgsOrgIdUsersInvite: ({ orgId, multidirectoryInviteApiRequest }: {
-        /**
-         * Your organization has a unique ID. Find this ID in your Atlassian
-         * Administration URL or when you create your API key.
-         */
-        orgId: string;
-        multidirectoryInviteApiRequest: MultidirectoryInviteApiRequest;
-    }) => Promise<commonHttpClient.WithResponse<{
-        status: 200 | 206;
-        mediaType: "application/json";
-        body: MultidirectoryInviteSuccessResponse;
-    }>>;
     /**
      * **The API is available for customers using the [new user management experience
      * only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**.
@@ -933,5 +906,32 @@ export declare class UsersService extends CommonHttpService {
          */
         usersSearchRequest: UsersSearchRequest;
     }) => Promise<UsersSearchPage>;
+    /**
+     * Suspend a user’s access in a directory to remove their access to apps
+     * temporarily. You’re not billed for a user when their access is suspended. They
+     * regain their roles and group memberships when you restore their access.
+     *
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/suspend`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-suspend-post
+     * @param params
+     */
+    suspendUserAccessInDirectory: ({ orgId, directoryId, accountId }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * A directory has a unique ID. Use the [Get directories
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
+         * to find the directory ID.
+         */
+        directoryId: string;
+        /**
+         * Every user has a unique ID. Find a user’s account ID by using the [Get users
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-get).
+         */
+        accountId: string;
+    }) => Promise<void>;
     protected static initialize(): void;
 }