pipedrive 33.7.1 → 33.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/legacy-teams-api.d.ts +32 -32
- package/dist/esm/versions/v1/api/legacy-teams-api.js +32 -32
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/models/add-activity-request.d.ts +1 -6
- package/dist/esm/versions/v2/models/add-person-request.d.ts +5 -5
- package/dist/esm/versions/v2/models/update-person-request.d.ts +4 -4
- package/dist/versions/v1/api/legacy-teams-api.d.ts +32 -32
- package/dist/versions/v1/api/legacy-teams-api.js +32 -32
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/models/add-activity-request.d.ts +1 -6
- package/dist/versions/v2/models/add-person-request.d.ts +5 -5
- package/dist/versions/v2/models/update-person-request.d.ts +4 -4
- package/package.json +1 -1
|
@@ -28,7 +28,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
28
28
|
* Adds a new team to the company and returns the created object.
|
|
29
29
|
* @summary Add a new team
|
|
30
30
|
* @param {AddTeamRequest1} [AddTeamRequest1]
|
|
31
|
-
|
|
31
|
+
|
|
32
32
|
* @throws {RequiredError}
|
|
33
33
|
*/
|
|
34
34
|
addTeam: (AddTeamRequest1?: AddTeamRequest1) => Promise<RequestArgs>;
|
|
@@ -37,7 +37,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
37
37
|
* @summary Add users to a team
|
|
38
38
|
* @param {number} id The ID of the team
|
|
39
39
|
* @param {AddTeamUserRequest} [AddTeamUserRequest]
|
|
40
|
-
|
|
40
|
+
|
|
41
41
|
* @throws {RequiredError}
|
|
42
42
|
*/
|
|
43
43
|
addTeamUser: (id: number, AddTeamUserRequest?: AddTeamUserRequest) => Promise<RequestArgs>;
|
|
@@ -46,7 +46,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
46
46
|
* @summary Delete users from a team
|
|
47
47
|
* @param {number} id The ID of the team
|
|
48
48
|
* @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
|
|
49
|
-
|
|
49
|
+
|
|
50
50
|
* @throws {RequiredError}
|
|
51
51
|
*/
|
|
52
52
|
deleteTeamUser: (id: number, DeleteTeamUserRequest?: DeleteTeamUserRequest) => Promise<RequestArgs>;
|
|
@@ -55,7 +55,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
55
55
|
* @summary Get a single team
|
|
56
56
|
* @param {number} id The ID of the team
|
|
57
57
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
58
|
-
|
|
58
|
+
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
*/
|
|
61
61
|
getTeam: (id: number, skip_users?: 0 | 1) => Promise<RequestArgs>;
|
|
@@ -63,7 +63,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
63
63
|
* Returns a list of all user IDs within a team.
|
|
64
64
|
* @summary Get all users in a team
|
|
65
65
|
* @param {number} id The ID of the team
|
|
66
|
-
|
|
66
|
+
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
69
69
|
getTeamUsers: (id: number) => Promise<RequestArgs>;
|
|
@@ -72,7 +72,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
72
72
|
* @summary Get all teams
|
|
73
73
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
74
74
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
75
|
-
|
|
75
|
+
|
|
76
76
|
* @throws {RequiredError}
|
|
77
77
|
*/
|
|
78
78
|
getTeams: (order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1) => Promise<RequestArgs>;
|
|
@@ -82,7 +82,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
82
82
|
* @param {number} id The ID of the user
|
|
83
83
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
84
84
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
85
|
-
|
|
85
|
+
|
|
86
86
|
* @throws {RequiredError}
|
|
87
87
|
*/
|
|
88
88
|
getUserTeams: (id: number, order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1) => Promise<RequestArgs>;
|
|
@@ -91,7 +91,7 @@ export declare const LegacyTeamsApiAxiosParamCreator: (configuration?: Configura
|
|
|
91
91
|
* @summary Update a team
|
|
92
92
|
* @param {number} id The ID of the team
|
|
93
93
|
* @param {UpdateTeamRequest} [UpdateTeamRequest]
|
|
94
|
-
|
|
94
|
+
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
97
97
|
updateTeam: (id: number, UpdateTeamRequest?: UpdateTeamRequest) => Promise<RequestArgs>;
|
|
@@ -105,7 +105,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
105
105
|
* Adds a new team to the company and returns the created object.
|
|
106
106
|
* @summary Add a new team
|
|
107
107
|
* @param {AddTeamRequest1} [AddTeamRequest1]
|
|
108
|
-
|
|
108
|
+
|
|
109
109
|
* @throws {RequiredError}
|
|
110
110
|
*/
|
|
111
111
|
addTeam(AddTeamRequest1?: AddTeamRequest1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamResponse>>;
|
|
@@ -114,7 +114,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
114
114
|
* @summary Add users to a team
|
|
115
115
|
* @param {number} id The ID of the team
|
|
116
116
|
* @param {AddTeamUserRequest} [AddTeamUserRequest]
|
|
117
|
-
|
|
117
|
+
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
120
|
addTeamUser(id: number, AddTeamUserRequest?: AddTeamUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
|
|
@@ -123,7 +123,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
123
123
|
* @summary Delete users from a team
|
|
124
124
|
* @param {number} id The ID of the team
|
|
125
125
|
* @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
|
|
126
|
-
|
|
126
|
+
|
|
127
127
|
* @throws {RequiredError}
|
|
128
128
|
*/
|
|
129
129
|
deleteTeamUser(id: number, DeleteTeamUserRequest?: DeleteTeamUserRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
|
|
@@ -132,7 +132,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
132
132
|
* @summary Get a single team
|
|
133
133
|
* @param {number} id The ID of the team
|
|
134
134
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
135
|
-
|
|
135
|
+
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
138
138
|
getTeam(id: number, skip_users?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamResponse>>;
|
|
@@ -140,7 +140,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
140
140
|
* Returns a list of all user IDs within a team.
|
|
141
141
|
* @summary Get all users in a team
|
|
142
142
|
* @param {number} id The ID of the team
|
|
143
|
-
|
|
143
|
+
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
146
|
getTeamUsers(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UserIds>>;
|
|
@@ -149,7 +149,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
149
149
|
* @summary Get all teams
|
|
150
150
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
151
151
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
152
|
-
|
|
152
|
+
|
|
153
153
|
* @throws {RequiredError}
|
|
154
154
|
*/
|
|
155
155
|
getTeams(order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamsResponse>>;
|
|
@@ -159,7 +159,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
159
159
|
* @param {number} id The ID of the user
|
|
160
160
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
161
161
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
162
|
-
|
|
162
|
+
|
|
163
163
|
* @throws {RequiredError}
|
|
164
164
|
*/
|
|
165
165
|
getUserTeams(id: number, order_by?: 'id' | 'name' | 'manager_id' | 'active_flag', skip_users?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamsResponse>>;
|
|
@@ -168,7 +168,7 @@ export declare const LegacyTeamsApiFp: (configuration?: Configuration) => {
|
|
|
168
168
|
* @summary Update a team
|
|
169
169
|
* @param {number} id The ID of the team
|
|
170
170
|
* @param {UpdateTeamRequest} [UpdateTeamRequest]
|
|
171
|
-
|
|
171
|
+
|
|
172
172
|
* @throws {RequiredError}
|
|
173
173
|
*/
|
|
174
174
|
updateTeam(id: number, UpdateTeamRequest?: UpdateTeamRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetTeamResponse>>;
|
|
@@ -182,7 +182,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
182
182
|
* Adds a new team to the company and returns the created object.
|
|
183
183
|
* @summary Add a new team
|
|
184
184
|
* @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
|
|
185
|
-
|
|
185
|
+
|
|
186
186
|
* @throws {RequiredError}
|
|
187
187
|
*/
|
|
188
188
|
addTeam(requestParameters?: LegacyTeamsApiAddTeamRequest): Promise<GetTeamResponse>;
|
|
@@ -190,7 +190,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
190
190
|
* Adds users to an existing team.
|
|
191
191
|
* @summary Add users to a team
|
|
192
192
|
* @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
|
|
193
|
-
|
|
193
|
+
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
196
196
|
addTeamUser(requestParameters: LegacyTeamsApiAddTeamUserRequest): Promise<UserIds>;
|
|
@@ -198,7 +198,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
198
198
|
* Deletes users from an existing team.
|
|
199
199
|
* @summary Delete users from a team
|
|
200
200
|
* @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
|
|
201
|
-
|
|
201
|
+
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
*/
|
|
204
204
|
deleteTeamUser(requestParameters: LegacyTeamsApiDeleteTeamUserRequest): Promise<UserIds>;
|
|
@@ -206,7 +206,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
206
206
|
* Returns data about a specific team.
|
|
207
207
|
* @summary Get a single team
|
|
208
208
|
* @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
|
|
209
|
-
|
|
209
|
+
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
*/
|
|
212
212
|
getTeam(requestParameters: LegacyTeamsApiGetTeamRequest): Promise<GetTeamResponse>;
|
|
@@ -214,7 +214,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
214
214
|
* Returns a list of all user IDs within a team.
|
|
215
215
|
* @summary Get all users in a team
|
|
216
216
|
* @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
|
|
217
|
-
|
|
217
|
+
|
|
218
218
|
* @throws {RequiredError}
|
|
219
219
|
*/
|
|
220
220
|
getTeamUsers(requestParameters: LegacyTeamsApiGetTeamUsersRequest): Promise<UserIds>;
|
|
@@ -222,7 +222,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
222
222
|
* Returns data about teams within the company.
|
|
223
223
|
* @summary Get all teams
|
|
224
224
|
* @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
|
|
225
|
-
|
|
225
|
+
|
|
226
226
|
* @throws {RequiredError}
|
|
227
227
|
*/
|
|
228
228
|
getTeams(requestParameters?: LegacyTeamsApiGetTeamsRequest): Promise<GetTeamsResponse>;
|
|
@@ -230,7 +230,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
230
230
|
* Returns data about all teams which have the specified user as a member.
|
|
231
231
|
* @summary Get all teams of a user
|
|
232
232
|
* @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
|
|
233
|
-
|
|
233
|
+
|
|
234
234
|
* @throws {RequiredError}
|
|
235
235
|
*/
|
|
236
236
|
getUserTeams(requestParameters: LegacyTeamsApiGetUserTeamsRequest): Promise<GetTeamsResponse>;
|
|
@@ -238,7 +238,7 @@ export declare const LegacyTeamsApiFactory: (configuration?: Configuration, base
|
|
|
238
238
|
* Updates an existing team and returns the updated object.
|
|
239
239
|
* @summary Update a team
|
|
240
240
|
* @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
|
|
241
|
-
|
|
241
|
+
|
|
242
242
|
* @throws {RequiredError}
|
|
243
243
|
*/
|
|
244
244
|
updateTeam(requestParameters: LegacyTeamsApiUpdateTeamRequest): Promise<GetTeamResponse>;
|
|
@@ -400,7 +400,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
400
400
|
* Adds a new team to the company and returns the created object.
|
|
401
401
|
* @summary Add a new team
|
|
402
402
|
* @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
|
|
403
|
-
|
|
403
|
+
|
|
404
404
|
* @throws {RequiredError}
|
|
405
405
|
* @memberof LegacyTeamsApi
|
|
406
406
|
*/
|
|
@@ -409,7 +409,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
409
409
|
* Adds users to an existing team.
|
|
410
410
|
* @summary Add users to a team
|
|
411
411
|
* @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
|
|
412
|
-
|
|
412
|
+
|
|
413
413
|
* @throws {RequiredError}
|
|
414
414
|
* @memberof LegacyTeamsApi
|
|
415
415
|
*/
|
|
@@ -418,7 +418,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
418
418
|
* Deletes users from an existing team.
|
|
419
419
|
* @summary Delete users from a team
|
|
420
420
|
* @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
|
|
421
|
-
|
|
421
|
+
|
|
422
422
|
* @throws {RequiredError}
|
|
423
423
|
* @memberof LegacyTeamsApi
|
|
424
424
|
*/
|
|
@@ -427,7 +427,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
427
427
|
* Returns data about a specific team.
|
|
428
428
|
* @summary Get a single team
|
|
429
429
|
* @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
|
|
430
|
-
|
|
430
|
+
|
|
431
431
|
* @throws {RequiredError}
|
|
432
432
|
* @memberof LegacyTeamsApi
|
|
433
433
|
*/
|
|
@@ -436,7 +436,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
436
436
|
* Returns a list of all user IDs within a team.
|
|
437
437
|
* @summary Get all users in a team
|
|
438
438
|
* @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
|
|
439
|
-
|
|
439
|
+
|
|
440
440
|
* @throws {RequiredError}
|
|
441
441
|
* @memberof LegacyTeamsApi
|
|
442
442
|
*/
|
|
@@ -445,7 +445,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
445
445
|
* Returns data about teams within the company.
|
|
446
446
|
* @summary Get all teams
|
|
447
447
|
* @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
|
|
448
|
-
|
|
448
|
+
|
|
449
449
|
* @throws {RequiredError}
|
|
450
450
|
* @memberof LegacyTeamsApi
|
|
451
451
|
*/
|
|
@@ -454,7 +454,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
454
454
|
* Returns data about all teams which have the specified user as a member.
|
|
455
455
|
* @summary Get all teams of a user
|
|
456
456
|
* @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
|
|
457
|
-
|
|
457
|
+
|
|
458
458
|
* @throws {RequiredError}
|
|
459
459
|
* @memberof LegacyTeamsApi
|
|
460
460
|
*/
|
|
@@ -463,7 +463,7 @@ export declare class LegacyTeamsApi extends BaseAPI {
|
|
|
463
463
|
* Updates an existing team and returns the updated object.
|
|
464
464
|
* @summary Update a team
|
|
465
465
|
* @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
|
|
466
|
-
|
|
466
|
+
|
|
467
467
|
* @throws {RequiredError}
|
|
468
468
|
* @memberof LegacyTeamsApi
|
|
469
469
|
*/
|
|
@@ -36,7 +36,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
36
36
|
* Adds a new team to the company and returns the created object.
|
|
37
37
|
* @summary Add a new team
|
|
38
38
|
* @param {AddTeamRequest1} [AddTeamRequest1]
|
|
39
|
-
|
|
39
|
+
|
|
40
40
|
* @throws {RequiredError}
|
|
41
41
|
*/
|
|
42
42
|
addTeam: (AddTeamRequest1) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -70,7 +70,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
70
70
|
* @summary Add users to a team
|
|
71
71
|
* @param {number} id The ID of the team
|
|
72
72
|
* @param {AddTeamUserRequest} [AddTeamUserRequest]
|
|
73
|
-
|
|
73
|
+
|
|
74
74
|
* @throws {RequiredError}
|
|
75
75
|
*/
|
|
76
76
|
addTeamUser: (id, AddTeamUserRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -107,7 +107,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
107
107
|
* @summary Delete users from a team
|
|
108
108
|
* @param {number} id The ID of the team
|
|
109
109
|
* @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
|
|
110
|
-
|
|
110
|
+
|
|
111
111
|
* @throws {RequiredError}
|
|
112
112
|
*/
|
|
113
113
|
deleteTeamUser: (id, DeleteTeamUserRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -144,7 +144,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
144
144
|
* @summary Get a single team
|
|
145
145
|
* @param {number} id The ID of the team
|
|
146
146
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
147
|
-
|
|
147
|
+
|
|
148
148
|
* @throws {RequiredError}
|
|
149
149
|
*/
|
|
150
150
|
getTeam: (id, skip_users) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -181,7 +181,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
181
181
|
* Returns a list of all user IDs within a team.
|
|
182
182
|
* @summary Get all users in a team
|
|
183
183
|
* @param {number} id The ID of the team
|
|
184
|
-
|
|
184
|
+
|
|
185
185
|
* @throws {RequiredError}
|
|
186
186
|
*/
|
|
187
187
|
getTeamUsers: (id) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -216,7 +216,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
216
216
|
* @summary Get all teams
|
|
217
217
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
218
218
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
219
|
-
|
|
219
|
+
|
|
220
220
|
* @throws {RequiredError}
|
|
221
221
|
*/
|
|
222
222
|
getTeams: (order_by, skip_users) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -255,7 +255,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
* @param {number} id The ID of the user
|
|
256
256
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
257
257
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
258
|
-
|
|
258
|
+
|
|
259
259
|
* @throws {RequiredError}
|
|
260
260
|
*/
|
|
261
261
|
getUserTeams: (id, order_by, skip_users) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -296,7 +296,7 @@ export const LegacyTeamsApiAxiosParamCreator = function (configuration) {
|
|
|
296
296
|
* @summary Update a team
|
|
297
297
|
* @param {number} id The ID of the team
|
|
298
298
|
* @param {UpdateTeamRequest} [UpdateTeamRequest]
|
|
299
|
-
|
|
299
|
+
|
|
300
300
|
* @throws {RequiredError}
|
|
301
301
|
*/
|
|
302
302
|
updateTeam: (id, UpdateTeamRequest) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -341,7 +341,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
341
341
|
* Adds a new team to the company and returns the created object.
|
|
342
342
|
* @summary Add a new team
|
|
343
343
|
* @param {AddTeamRequest1} [AddTeamRequest1]
|
|
344
|
-
|
|
344
|
+
|
|
345
345
|
* @throws {RequiredError}
|
|
346
346
|
*/
|
|
347
347
|
addTeam(AddTeamRequest1) {
|
|
@@ -355,7 +355,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
355
355
|
* @summary Add users to a team
|
|
356
356
|
* @param {number} id The ID of the team
|
|
357
357
|
* @param {AddTeamUserRequest} [AddTeamUserRequest]
|
|
358
|
-
|
|
358
|
+
|
|
359
359
|
* @throws {RequiredError}
|
|
360
360
|
*/
|
|
361
361
|
addTeamUser(id, AddTeamUserRequest) {
|
|
@@ -369,7 +369,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
369
369
|
* @summary Delete users from a team
|
|
370
370
|
* @param {number} id The ID of the team
|
|
371
371
|
* @param {DeleteTeamUserRequest} [DeleteTeamUserRequest]
|
|
372
|
-
|
|
372
|
+
|
|
373
373
|
* @throws {RequiredError}
|
|
374
374
|
*/
|
|
375
375
|
deleteTeamUser(id, DeleteTeamUserRequest) {
|
|
@@ -383,7 +383,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
383
383
|
* @summary Get a single team
|
|
384
384
|
* @param {number} id The ID of the team
|
|
385
385
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
386
|
-
|
|
386
|
+
|
|
387
387
|
* @throws {RequiredError}
|
|
388
388
|
*/
|
|
389
389
|
getTeam(id, skip_users) {
|
|
@@ -396,7 +396,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
396
396
|
* Returns a list of all user IDs within a team.
|
|
397
397
|
* @summary Get all users in a team
|
|
398
398
|
* @param {number} id The ID of the team
|
|
399
|
-
|
|
399
|
+
|
|
400
400
|
* @throws {RequiredError}
|
|
401
401
|
*/
|
|
402
402
|
getTeamUsers(id) {
|
|
@@ -410,7 +410,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
410
410
|
* @summary Get all teams
|
|
411
411
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
412
412
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
413
|
-
|
|
413
|
+
|
|
414
414
|
* @throws {RequiredError}
|
|
415
415
|
*/
|
|
416
416
|
getTeams(order_by, skip_users) {
|
|
@@ -425,7 +425,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
425
425
|
* @param {number} id The ID of the user
|
|
426
426
|
* @param {'id' | 'name' | 'manager_id' | 'active_flag'} [order_by] The field name to sort returned teams by
|
|
427
427
|
* @param {0 | 1} [skip_users] When enabled, the teams will not include IDs of member users
|
|
428
|
-
|
|
428
|
+
|
|
429
429
|
* @throws {RequiredError}
|
|
430
430
|
*/
|
|
431
431
|
getUserTeams(id, order_by, skip_users) {
|
|
@@ -439,7 +439,7 @@ export const LegacyTeamsApiFp = function (configuration) {
|
|
|
439
439
|
* @summary Update a team
|
|
440
440
|
* @param {number} id The ID of the team
|
|
441
441
|
* @param {UpdateTeamRequest} [UpdateTeamRequest]
|
|
442
|
-
|
|
442
|
+
|
|
443
443
|
* @throws {RequiredError}
|
|
444
444
|
*/
|
|
445
445
|
updateTeam(id, UpdateTeamRequest) {
|
|
@@ -461,7 +461,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
461
461
|
* Adds a new team to the company and returns the created object.
|
|
462
462
|
* @summary Add a new team
|
|
463
463
|
* @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
|
|
464
|
-
|
|
464
|
+
|
|
465
465
|
* @throws {RequiredError}
|
|
466
466
|
*/
|
|
467
467
|
addTeam(requestParameters = {}) {
|
|
@@ -471,7 +471,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
471
471
|
* Adds users to an existing team.
|
|
472
472
|
* @summary Add users to a team
|
|
473
473
|
* @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
|
|
474
|
-
|
|
474
|
+
|
|
475
475
|
* @throws {RequiredError}
|
|
476
476
|
*/
|
|
477
477
|
addTeamUser(requestParameters) {
|
|
@@ -481,7 +481,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
481
481
|
* Deletes users from an existing team.
|
|
482
482
|
* @summary Delete users from a team
|
|
483
483
|
* @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
|
|
484
|
-
|
|
484
|
+
|
|
485
485
|
* @throws {RequiredError}
|
|
486
486
|
*/
|
|
487
487
|
deleteTeamUser(requestParameters) {
|
|
@@ -491,7 +491,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
491
491
|
* Returns data about a specific team.
|
|
492
492
|
* @summary Get a single team
|
|
493
493
|
* @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
|
|
494
|
-
|
|
494
|
+
|
|
495
495
|
* @throws {RequiredError}
|
|
496
496
|
*/
|
|
497
497
|
getTeam(requestParameters) {
|
|
@@ -501,7 +501,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
501
501
|
* Returns a list of all user IDs within a team.
|
|
502
502
|
* @summary Get all users in a team
|
|
503
503
|
* @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
|
|
504
|
-
|
|
504
|
+
|
|
505
505
|
* @throws {RequiredError}
|
|
506
506
|
*/
|
|
507
507
|
getTeamUsers(requestParameters) {
|
|
@@ -511,7 +511,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
511
511
|
* Returns data about teams within the company.
|
|
512
512
|
* @summary Get all teams
|
|
513
513
|
* @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
|
|
514
|
-
|
|
514
|
+
|
|
515
515
|
* @throws {RequiredError}
|
|
516
516
|
*/
|
|
517
517
|
getTeams(requestParameters = {}) {
|
|
@@ -521,7 +521,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
521
521
|
* Returns data about all teams which have the specified user as a member.
|
|
522
522
|
* @summary Get all teams of a user
|
|
523
523
|
* @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
|
|
524
|
-
|
|
524
|
+
|
|
525
525
|
* @throws {RequiredError}
|
|
526
526
|
*/
|
|
527
527
|
getUserTeams(requestParameters) {
|
|
@@ -531,7 +531,7 @@ export const LegacyTeamsApiFactory = function (configuration, basePath, axios) {
|
|
|
531
531
|
* Updates an existing team and returns the updated object.
|
|
532
532
|
* @summary Update a team
|
|
533
533
|
* @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
|
|
534
|
-
|
|
534
|
+
|
|
535
535
|
* @throws {RequiredError}
|
|
536
536
|
*/
|
|
537
537
|
updateTeam(requestParameters) {
|
|
@@ -550,7 +550,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
550
550
|
* Adds a new team to the company and returns the created object.
|
|
551
551
|
* @summary Add a new team
|
|
552
552
|
* @param {LegacyTeamsApiAddTeamRequest} requestParameters Request parameters.
|
|
553
|
-
|
|
553
|
+
|
|
554
554
|
* @throws {RequiredError}
|
|
555
555
|
* @memberof LegacyTeamsApi
|
|
556
556
|
*/
|
|
@@ -561,7 +561,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
561
561
|
* Adds users to an existing team.
|
|
562
562
|
* @summary Add users to a team
|
|
563
563
|
* @param {LegacyTeamsApiAddTeamUserRequest} requestParameters Request parameters.
|
|
564
|
-
|
|
564
|
+
|
|
565
565
|
* @throws {RequiredError}
|
|
566
566
|
* @memberof LegacyTeamsApi
|
|
567
567
|
*/
|
|
@@ -572,7 +572,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
572
572
|
* Deletes users from an existing team.
|
|
573
573
|
* @summary Delete users from a team
|
|
574
574
|
* @param {LegacyTeamsApiDeleteTeamUserRequest} requestParameters Request parameters.
|
|
575
|
-
|
|
575
|
+
|
|
576
576
|
* @throws {RequiredError}
|
|
577
577
|
* @memberof LegacyTeamsApi
|
|
578
578
|
*/
|
|
@@ -583,7 +583,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
583
583
|
* Returns data about a specific team.
|
|
584
584
|
* @summary Get a single team
|
|
585
585
|
* @param {LegacyTeamsApiGetTeamRequest} requestParameters Request parameters.
|
|
586
|
-
|
|
586
|
+
|
|
587
587
|
* @throws {RequiredError}
|
|
588
588
|
* @memberof LegacyTeamsApi
|
|
589
589
|
*/
|
|
@@ -594,7 +594,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
594
594
|
* Returns a list of all user IDs within a team.
|
|
595
595
|
* @summary Get all users in a team
|
|
596
596
|
* @param {LegacyTeamsApiGetTeamUsersRequest} requestParameters Request parameters.
|
|
597
|
-
|
|
597
|
+
|
|
598
598
|
* @throws {RequiredError}
|
|
599
599
|
* @memberof LegacyTeamsApi
|
|
600
600
|
*/
|
|
@@ -605,7 +605,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
605
605
|
* Returns data about teams within the company.
|
|
606
606
|
* @summary Get all teams
|
|
607
607
|
* @param {LegacyTeamsApiGetTeamsRequest} requestParameters Request parameters.
|
|
608
|
-
|
|
608
|
+
|
|
609
609
|
* @throws {RequiredError}
|
|
610
610
|
* @memberof LegacyTeamsApi
|
|
611
611
|
*/
|
|
@@ -616,7 +616,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
616
616
|
* Returns data about all teams which have the specified user as a member.
|
|
617
617
|
* @summary Get all teams of a user
|
|
618
618
|
* @param {LegacyTeamsApiGetUserTeamsRequest} requestParameters Request parameters.
|
|
619
|
-
|
|
619
|
+
|
|
620
620
|
* @throws {RequiredError}
|
|
621
621
|
* @memberof LegacyTeamsApi
|
|
622
622
|
*/
|
|
@@ -627,7 +627,7 @@ export class LegacyTeamsApi extends BaseAPI {
|
|
|
627
627
|
* Updates an existing team and returns the updated object.
|
|
628
628
|
* @summary Update a team
|
|
629
629
|
* @param {LegacyTeamsApiUpdateTeamRequest} requestParameters Request parameters.
|
|
630
|
-
|
|
630
|
+
|
|
631
631
|
* @throws {RequiredError}
|
|
632
632
|
* @memberof LegacyTeamsApi
|
|
633
633
|
*/
|
|
@@ -30,7 +30,7 @@ import { UpsertPersonResponse } from '../models';
|
|
|
30
30
|
*/
|
|
31
31
|
export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
32
|
/**
|
|
33
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
33
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
34
34
|
* @summary Add a new person
|
|
35
35
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
36
36
|
|
|
@@ -140,7 +140,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
140
140
|
*/
|
|
141
141
|
searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
142
142
|
/**
|
|
143
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
143
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
144
144
|
* @summary Update a person
|
|
145
145
|
* @param {number} id The ID of the person
|
|
146
146
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -155,7 +155,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
155
155
|
*/
|
|
156
156
|
export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
157
157
|
/**
|
|
158
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
158
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
159
159
|
* @summary Add a new person
|
|
160
160
|
* @param {AddPersonRequest} [AddPersonRequest]
|
|
161
161
|
|
|
@@ -265,7 +265,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
265
265
|
*/
|
|
266
266
|
searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
|
|
267
267
|
/**
|
|
268
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
268
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
269
269
|
* @summary Update a person
|
|
270
270
|
* @param {number} id The ID of the person
|
|
271
271
|
* @param {UpdatePersonRequest} [UpdatePersonRequest]
|
|
@@ -280,7 +280,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
280
280
|
*/
|
|
281
281
|
export declare const PersonsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
282
282
|
/**
|
|
283
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
283
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
284
284
|
* @summary Add a new person
|
|
285
285
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
286
286
|
|
|
@@ -360,7 +360,7 @@ export declare const PersonsApiFactory: (configuration?: Configuration, basePath
|
|
|
360
360
|
*/
|
|
361
361
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
362
362
|
/**
|
|
363
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
363
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
364
364
|
* @summary Update a person
|
|
365
365
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
366
366
|
|
|
@@ -705,7 +705,7 @@ export interface PersonsApiUpdatePersonRequest {
|
|
|
705
705
|
*/
|
|
706
706
|
export declare class PersonsApi extends BaseAPI {
|
|
707
707
|
/**
|
|
708
|
-
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
708
|
+
* Adds a new person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
709
709
|
* @summary Add a new person
|
|
710
710
|
* @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
|
|
711
711
|
|
|
@@ -795,7 +795,7 @@ export declare class PersonsApi extends BaseAPI {
|
|
|
795
795
|
*/
|
|
796
796
|
searchPersons(requestParameters: PersonsApiSearchPersonsRequest): Promise<GetPersonSearchResponse>;
|
|
797
797
|
/**
|
|
798
|
-
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don
|
|
798
|
+
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
799
799
|
* @summary Update a person
|
|
800
800
|
* @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
|
|
801
801
|
|