pipedrive 36.0.1 → 36.1.0

package/dist/esm/versions/v1/api/users-api.d.ts

@@ -11,7 +11,7 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
+import { RequestArgs, BaseAPI, ApiResponse } from '../base';
 import { AddUserRequest } from '../models';
 import { GetCurrentUserResponse } from '../models';
 import { GetRoleAssignmentsResponse } from '../models';
@@ -122,6 +122,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addUser(AddUserRequest?: AddUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetUserResponse>>;
+    /**
+     * Same as `addUser`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add a new user
+     * @param {AddUserRequest} [AddUserRequest]
+
+     * @throws {RequiredError}
+     */
+    addUserWithHttpInfo(AddUserRequest?: AddUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetUserResponse>>>;
     /**
      * Finds users by their name.
      * @summary Find users by name
@@ -131,6 +139,15 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     findUsersByName(term: string, search_by_email?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetUsersResponse>>;
+    /**
+     * Same as `findUsersByName`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Find users by name
+     * @param {string} term The search term to look for
+     * @param {0 | 1} [search_by_email] When enabled, the term will only be matched against email addresses of users. Default: &#x60;false&#x60;.
+
+     * @throws {RequiredError}
+     */
+    findUsersByNameWithHttpInfo(term: string, search_by_email?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetUsersResponse>>>;
     /**
      * Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means \'Date/number format\' in the Pipedrive account settings, not the chosen language.
      * @summary Get current user data
@@ -138,6 +155,13 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getCurrentUser(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetCurrentUserResponse>>;
+    /**
+     * Same as `getCurrentUser`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get current user data
+
+     * @throws {RequiredError}
+     */
+    getCurrentUserWithHttpInfo(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetCurrentUserResponse>>>;
     /**
      * Returns data about a specific user within the company.
      * @summary Get one user
@@ -146,6 +170,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUser(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetUserResponse>>;
+    /**
+     * Same as `getUser`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one user
+     * @param {number} id The ID of the user
+
+     * @throws {RequiredError}
+     */
+    getUserWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetUserResponse>>>;
     /**
      * Lists the followers of a specific user.
      * @summary List followers of a user
@@ -154,6 +186,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUserFollowers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
+    /**
+     * Same as `getUserFollowers`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List followers of a user
+     * @param {number} id The ID of the user
+
+     * @throws {RequiredError}
+     */
+    getUserFollowersWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UserIds>>>;
     /**
      * Lists aggregated permissions over all assigned permission sets for a user.
      * @summary List user permissions
@@ -162,6 +202,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUserPermissions(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetUserPermissionsResponse>>;
+    /**
+     * Same as `getUserPermissions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List user permissions
+     * @param {number} id The ID of the user
+
+     * @throws {RequiredError}
+     */
+    getUserPermissionsWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetUserPermissionsResponse>>>;
     /**
      * Lists role assignments for a user.
      * @summary List role assignments
@@ -172,6 +220,16 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUserRoleAssignments(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRoleAssignmentsResponse>>;
+    /**
+     * Same as `getUserRoleAssignments`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List role assignments
+     * @param {number} id The ID of the user
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getUserRoleAssignmentsWithHttpInfo(id: number, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRoleAssignmentsResponse>>>;
     /**
      * Lists the settings of user\'s assigned role.
      * @summary List user role settings
@@ -180,6 +238,14 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUserRoleSettings(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetRoleSettingsResponse>>;
+    /**
+     * Same as `getUserRoleSettings`, but resolves with the response body together with the HTTP status and headers.
+     * @summary List user role settings
+     * @param {number} id The ID of the user
+
+     * @throws {RequiredError}
+     */
+    getUserRoleSettingsWithHttpInfo(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetRoleSettingsResponse>>>;
     /**
      * Returns data about all users within the company.
      * @summary Get all users
@@ -187,6 +253,13 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUsers(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetUsersResponse>>;
+    /**
+     * Same as `getUsers`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all users
+
+     * @throws {RequiredError}
+     */
+    getUsersWithHttpInfo(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetUsersResponse>>>;
     /**
      * Updates the properties of a user. Currently, only `active_flag` can be updated.
      * @summary Update user details
@@ -196,6 +269,15 @@ export declare const UsersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateUser(id: number, UpdateUserRequest?: UpdateUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetUserResponse>>;
+    /**
+     * Same as `updateUser`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update user details
+     * @param {number} id The ID of the user
+     * @param {UpdateUserRequest} [UpdateUserRequest]
+
+     * @throws {RequiredError}
+     */
+    updateUserWithHttpInfo(id: number, UpdateUserRequest?: UpdateUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetUserResponse>>>;
 };
 /**
  * UsersApi - factory interface
@@ -210,6 +292,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addUser(requestParameters?: UsersApiAddUserRequest): Promise<GetUserResponse>;
+    addUserWithHttpInfo(requestParameters?: UsersApiAddUserRequest): Promise<ApiResponse<GetUserResponse>>;
     /**
      * Finds users by their name.
      * @summary Find users by name
@@ -218,6 +301,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     findUsersByName(requestParameters: UsersApiFindUsersByNameRequest): Promise<GetUsersResponse>;
+    findUsersByNameWithHttpInfo(requestParameters: UsersApiFindUsersByNameRequest): Promise<ApiResponse<GetUsersResponse>>;
     /**
      * Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means \'Date/number format\' in the Pipedrive account settings, not the chosen language.
      * @summary Get current user data
@@ -225,6 +309,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getCurrentUser(): Promise<GetCurrentUserResponse>;
+    getCurrentUserWithHttpInfo(): Promise<ApiResponse<GetCurrentUserResponse>>;
     /**
      * Returns data about a specific user within the company.
      * @summary Get one user
@@ -233,6 +318,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getUser(requestParameters: UsersApiGetUserRequest): Promise<GetUserResponse>;
+    getUserWithHttpInfo(requestParameters: UsersApiGetUserRequest): Promise<ApiResponse<GetUserResponse>>;
     /**
      * Lists the followers of a specific user.
      * @summary List followers of a user
@@ -241,6 +327,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getUserFollowers(requestParameters: UsersApiGetUserFollowersRequest): Promise<UserIds>;
+    getUserFollowersWithHttpInfo(requestParameters: UsersApiGetUserFollowersRequest): Promise<ApiResponse<UserIds>>;
     /**
      * Lists aggregated permissions over all assigned permission sets for a user.
      * @summary List user permissions
@@ -249,6 +336,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getUserPermissions(requestParameters: UsersApiGetUserPermissionsRequest): Promise<GetUserPermissionsResponse>;
+    getUserPermissionsWithHttpInfo(requestParameters: UsersApiGetUserPermissionsRequest): Promise<ApiResponse<GetUserPermissionsResponse>>;
     /**
      * Lists role assignments for a user.
      * @summary List role assignments
@@ -257,6 +345,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getUserRoleAssignments(requestParameters: UsersApiGetUserRoleAssignmentsRequest): Promise<GetRoleAssignmentsResponse>;
+    getUserRoleAssignmentsWithHttpInfo(requestParameters: UsersApiGetUserRoleAssignmentsRequest): Promise<ApiResponse<GetRoleAssignmentsResponse>>;
     /**
      * Lists the settings of user\'s assigned role.
      * @summary List user role settings
@@ -265,6 +354,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getUserRoleSettings(requestParameters: UsersApiGetUserRoleSettingsRequest): Promise<GetRoleSettingsResponse>;
+    getUserRoleSettingsWithHttpInfo(requestParameters: UsersApiGetUserRoleSettingsRequest): Promise<ApiResponse<GetRoleSettingsResponse>>;
     /**
      * Returns data about all users within the company.
      * @summary Get all users
@@ -272,6 +362,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getUsers(): Promise<GetUsersResponse>;
+    getUsersWithHttpInfo(): Promise<ApiResponse<GetUsersResponse>>;
     /**
      * Updates the properties of a user. Currently, only `active_flag` can be updated.
      * @summary Update user details
@@ -280,6 +371,7 @@ export declare const UsersApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     updateUser(requestParameters: UsersApiUpdateUserRequest): Promise<GetUserResponse>;
+    updateUserWithHttpInfo(requestParameters: UsersApiUpdateUserRequest): Promise<ApiResponse<GetUserResponse>>;
 };
 /**
  * Request parameters for addUser operation in UsersApi.
@@ -425,6 +517,15 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     addUser(requestParameters?: UsersApiAddUserRequest): Promise<GetUserResponse>;
+    /**
+     * Same as `addUser`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiAddUserRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    addUserWithHttpInfo(requestParameters?: UsersApiAddUserRequest): Promise<ApiResponse<GetUserResponse>>;
     /**
      * Finds users by their name.
      * @summary Find users by name
@@ -434,6 +535,15 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     findUsersByName(requestParameters: UsersApiFindUsersByNameRequest): Promise<GetUsersResponse>;
+    /**
+     * Same as `findUsersByName`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiFindUsersByNameRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    findUsersByNameWithHttpInfo(requestParameters: UsersApiFindUsersByNameRequest): Promise<ApiResponse<GetUsersResponse>>;
     /**
      * Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means \'Date/number format\' in the Pipedrive account settings, not the chosen language.
      * @summary Get current user data
@@ -442,6 +552,14 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     getCurrentUser(): Promise<GetCurrentUserResponse>;
+    /**
+     * Same as `getCurrentUser`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    getCurrentUserWithHttpInfo(): Promise<ApiResponse<GetCurrentUserResponse>>;
     /**
      * Returns data about a specific user within the company.
      * @summary Get one user
@@ -451,6 +569,15 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     getUser(requestParameters: UsersApiGetUserRequest): Promise<GetUserResponse>;
+    /**
+     * Same as `getUser`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiGetUserRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    getUserWithHttpInfo(requestParameters: UsersApiGetUserRequest): Promise<ApiResponse<GetUserResponse>>;
     /**
      * Lists the followers of a specific user.
      * @summary List followers of a user
@@ -460,6 +587,15 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     getUserFollowers(requestParameters: UsersApiGetUserFollowersRequest): Promise<UserIds>;
+    /**
+     * Same as `getUserFollowers`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiGetUserFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    getUserFollowersWithHttpInfo(requestParameters: UsersApiGetUserFollowersRequest): Promise<ApiResponse<UserIds>>;
     /**
      * Lists aggregated permissions over all assigned permission sets for a user.
      * @summary List user permissions
@@ -469,6 +605,15 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     getUserPermissions(requestParameters: UsersApiGetUserPermissionsRequest): Promise<GetUserPermissionsResponse>;
+    /**
+     * Same as `getUserPermissions`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiGetUserPermissionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    getUserPermissionsWithHttpInfo(requestParameters: UsersApiGetUserPermissionsRequest): Promise<ApiResponse<GetUserPermissionsResponse>>;
     /**
      * Lists role assignments for a user.
      * @summary List role assignments
@@ -478,6 +623,15 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     getUserRoleAssignments(requestParameters: UsersApiGetUserRoleAssignmentsRequest): Promise<GetRoleAssignmentsResponse>;
+    /**
+     * Same as `getUserRoleAssignments`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiGetUserRoleAssignmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    getUserRoleAssignmentsWithHttpInfo(requestParameters: UsersApiGetUserRoleAssignmentsRequest): Promise<ApiResponse<GetRoleAssignmentsResponse>>;
     /**
      * Lists the settings of user\'s assigned role.
      * @summary List user role settings
@@ -487,6 +641,15 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     getUserRoleSettings(requestParameters: UsersApiGetUserRoleSettingsRequest): Promise<GetRoleSettingsResponse>;
+    /**
+     * Same as `getUserRoleSettings`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiGetUserRoleSettingsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    getUserRoleSettingsWithHttpInfo(requestParameters: UsersApiGetUserRoleSettingsRequest): Promise<ApiResponse<GetRoleSettingsResponse>>;
     /**
      * Returns data about all users within the company.
      * @summary Get all users
@@ -495,6 +658,14 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     getUsers(): Promise<GetUsersResponse>;
+    /**
+     * Same as `getUsers`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    getUsersWithHttpInfo(): Promise<ApiResponse<GetUsersResponse>>;
     /**
      * Updates the properties of a user. Currently, only `active_flag` can be updated.
      * @summary Update user details
@@ -504,4 +675,13 @@ export declare class UsersApi extends BaseAPI {
      * @memberof UsersApi
      */
     updateUser(requestParameters: UsersApiUpdateUserRequest): Promise<GetUserResponse>;
+    /**
+     * Same as `updateUser`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {UsersApiUpdateUserRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof UsersApi
+     */
+    updateUserWithHttpInfo(requestParameters: UsersApiUpdateUserRequest): Promise<ApiResponse<GetUserResponse>>;
 }