pipedrive-rs 0.1.0

Rust PipedriveClient
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389

# \RolesApi

All URIs are relative to *https://api.pipedrive.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_or_update_role_setting**](RolesApi.md#add_or_update_role_setting) | **POST** /roles/{id}/settings | Add or update role setting
[**add_role**](RolesApi.md#add_role) | **POST** /roles | Add a role
[**add_role_assignment**](RolesApi.md#add_role_assignment) | **POST** /roles/{id}/assignments | Add role assignment
[**delete_role**](RolesApi.md#delete_role) | **DELETE** /roles/{id} | Delete a role
[**delete_role_assignment**](RolesApi.md#delete_role_assignment) | **DELETE** /roles/{id}/assignments | Delete a role assignment
[**get_role**](RolesApi.md#get_role) | **GET** /roles/{id} | Get one role
[**get_role_assignments**](RolesApi.md#get_role_assignments) | **GET** /roles/{id}/assignments | List role assignments
[**get_role_pipelines**](RolesApi.md#get_role_pipelines) | **GET** /roles/{id}/pipelines | List pipeline visibility for a role
[**get_role_settings**](RolesApi.md#get_role_settings) | **GET** /roles/{id}/settings | List role settings
[**get_roles**](RolesApi.md#get_roles) | **GET** /roles | Get all roles
[**update_role**](RolesApi.md#update_role) | **PUT** /roles/{id} | Update role details
[**update_role_pipelines**](RolesApi.md#update_role_pipelines) | **PUT** /roles/{id}/pipelines | Update pipeline visibility for a role



## add_or_update_role_setting

> crate::models::AddOrUpdateRoleSettingResponse200 add_or_update_role_setting(id, add_or_update_role_setting_request)
Add or update role setting

Adds or updates the visibility setting for a role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |
**add_or_update_role_setting_request** | Option<[**AddOrUpdateRoleSettingRequest**](AddOrUpdateRoleSettingRequest.md)> |  |  |

### Return type

[**crate::models::AddOrUpdateRoleSettingResponse200**](addOrUpdateRoleSettingResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## add_role

> crate::models::AddRoleResponse200 add_role(add_role_request)
Add a role

Adds a new role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**add_role_request** | Option<[**AddRoleRequest**](AddRoleRequest.md)> |  |  |

### Return type

[**crate::models::AddRoleResponse200**](addRoleResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## add_role_assignment

> crate::models::AddRoleAssignmentResponse200 add_role_assignment(id, add_role_assignment_request)
Add role assignment

Assigns a user to a role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |
**add_role_assignment_request** | Option<[**AddRoleAssignmentRequest**](AddRoleAssignmentRequest.md)> |  |  |

### Return type

[**crate::models::AddRoleAssignmentResponse200**](addRoleAssignmentResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_role

> crate::models::DeleteRoleResponse200 delete_role(id)
Delete a role

Marks a role as deleted.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |

### Return type

[**crate::models::DeleteRoleResponse200**](deleteRoleResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_role_assignment

> crate::models::DeleteRoleAssignmentResponse200 delete_role_assignment(id, delete_role_assignment_request)
Delete a role assignment

Removes the assigned user from a role and adds to the default role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |
**delete_role_assignment_request** | Option<[**DeleteRoleAssignmentRequest**](DeleteRoleAssignmentRequest.md)> |  |  |

### Return type

[**crate::models::DeleteRoleAssignmentResponse200**](deleteRoleAssignmentResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_role

> crate::models::GetRoleResponse200 get_role(id)
Get one role

Returns the details of a specific role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |

### Return type

[**crate::models::GetRoleResponse200**](getRoleResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_role_assignments

> crate::models::GetUserRoleAssignmentsResponse200 get_role_assignments(id, start, limit)
List role assignments

Returns all users assigned to a role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |
**start** | Option<**i32**> | Pagination start |  |[default to 0]
**limit** | Option<**i32**> | Items shown per page |  |

### Return type

[**crate::models::GetUserRoleAssignmentsResponse200**](getUserRoleAssignmentsResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_role_pipelines

> crate::models::GetRolePipelines200 get_role_pipelines(id, visible)
List pipeline visibility for a role

Returns the list of either visible or hidden pipeline IDs for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |
**visible** | Option<**bool**> | Whether to return the visible or hidden pipelines for the role |  |[default to true]

### Return type

[**crate::models::GetRolePipelines200**](getRolePipelines200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_role_settings

> crate::models::GetRoleSettingsResponse200 get_role_settings(id)
List role settings

Returns the visibility settings of a specific role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |

### Return type

[**crate::models::GetRoleSettingsResponse200**](getRoleSettingsResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_roles

> crate::models::GetRolesResponse200 get_roles(start, limit)
Get all roles

Returns all the roles within the company.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start** | Option<**i32**> | Pagination start |  |[default to 0]
**limit** | Option<**i32**> | Items shown per page |  |

### Return type

[**crate::models::GetRolesResponse200**](getRolesResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_role

> crate::models::UpdateRoleResponse200 update_role(id, base_role_request)
Update role details

Updates the parent role and/or the name of a specific role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |
**base_role_request** | Option<[**BaseRoleRequest**](BaseRoleRequest.md)> |  |  |

### Return type

[**crate::models::UpdateRoleResponse200**](updateRoleResponse200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_role_pipelines

> crate::models::GetRolePipelines200 update_role_pipelines(id, put_role_pipelines_body)
Update pipeline visibility for a role

Updates the specified pipelines to be visible and/or hidden for a specific role. For more information on pipeline visibility, please refer to the <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">Visibility groups article</a>.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the role | [required] |
**put_role_pipelines_body** | Option<[**PutRolePipelinesBody**](PutRolePipelinesBody.md)> |  |  |

### Return type

[**crate::models::GetRolePipelines200**](getRolePipelines200.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)