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

# \NotesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_note**](NotesApi.md#add_note) | **POST** /notes | Add a note
[**add_note_comment**](NotesApi.md#add_note_comment) | **POST** /notes/{id}/comments | Add a comment to a note
[**delete_comment**](NotesApi.md#delete_comment) | **DELETE** /notes/{id}/comments/{commentId} | Delete a comment related to a note
[**delete_note**](NotesApi.md#delete_note) | **DELETE** /notes/{id} | Delete a note
[**get_comment**](NotesApi.md#get_comment) | **GET** /notes/{id}/comments/{commentId} | Get one comment
[**get_note**](NotesApi.md#get_note) | **GET** /notes/{id} | Get one note
[**get_note_comments**](NotesApi.md#get_note_comments) | **GET** /notes/{id}/comments | Get all comments for a note
[**get_notes**](NotesApi.md#get_notes) | **GET** /notes | Get all notes
[**update_comment_for_note**](NotesApi.md#update_comment_for_note) | **PUT** /notes/{id}/comments/{commentId} | Update a comment related to a note
[**update_note**](NotesApi.md#update_note) | **PUT** /notes/{id} | Update a note



## add_note

> crate::models::OneNoteResponse200 add_note(add_note_request)
Add a note

Adds a new note.

### Parameters


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

### Return type

[**crate::models::OneNoteResponse200**](oneNoteResponse200.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_note_comment

> crate::models::OneCommentResponse200 add_note_comment(id, comment_post_put_object)
Add a comment to a note

Adds a new comment to a note.

### Parameters


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

### Return type

[**crate::models::OneCommentResponse200**](oneCommentResponse200.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_comment

> crate::models::DeleteCommentResponse200 delete_comment(id, comment_id)
Delete a comment related to a note

Deletes a comment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the note | [required] |
**comment_id** | **uuid::Uuid** | The ID of the comment | [required] |

### Return type

[**crate::models::DeleteCommentResponse200**](deleteCommentResponse200.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_note

> crate::models::DeleteNoteResponse200 delete_note(id)
Delete a note

Deletes a specific note.

### Parameters


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

### Return type

[**crate::models::DeleteNoteResponse200**](deleteNoteResponse200.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_comment

> crate::models::OneCommentResponse200 get_comment(id, comment_id)
Get one comment

Returns the details of a comment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the note | [required] |
**comment_id** | **uuid::Uuid** | The ID of the comment | [required] |

### Return type

[**crate::models::OneCommentResponse200**](oneCommentResponse200.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_note

> crate::models::OneNoteResponse200 get_note(id)
Get one note

Returns details about a specific note.

### Parameters


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

### Return type

[**crate::models::OneNoteResponse200**](oneNoteResponse200.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_note_comments

> crate::models::GetCommentsResponse200 get_note_comments(id, start, limit)
Get all comments for a note

Returns all comments associated with a note.

### Parameters


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

### Return type

[**crate::models::GetCommentsResponse200**](getCommentsResponse200.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_notes

> crate::models::GetNotesResponse200 get_notes(user_id, lead_id, deal_id, person_id, org_id, start, limit, sort, start_date, end_date, pinned_to_lead_flag, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag)
Get all notes

Returns all notes.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | Option<**i32**> | The ID of the user whose notes to fetch. If omitted, notes by all users will be returned. |  |
**lead_id** | Option<**uuid::Uuid**> | The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned. |  |
**deal_id** | Option<**i32**> | The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned. |  |
**person_id** | Option<**i32**> | The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned. |  |
**org_id** | Option<**i32**> | The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned. |  |
**start** | Option<**i32**> | Pagination start |  |[default to 0]
**limit** | Option<**i32**> | Items shown per page |  |
**sort** | Option<**String**> | The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`. |  |
**start_date** | Option<**String**> | The date in format of YYYY-MM-DD from which notes to fetch |  |
**end_date** | Option<**String**> | The date in format of YYYY-MM-DD until which notes to fetch to |  |
**pinned_to_lead_flag** | Option<**f32**> | If set, the results are filtered by note to lead pinning state |  |
**pinned_to_deal_flag** | Option<**f32**> | If set, the results are filtered by note to deal pinning state |  |
**pinned_to_organization_flag** | Option<**f32**> | If set, the results are filtered by note to organization pinning state |  |
**pinned_to_person_flag** | Option<**f32**> | If set, the results are filtered by note to person pinning state |  |

### Return type

[**crate::models::GetNotesResponse200**](getNotesResponse200.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_comment_for_note

> crate::models::OneCommentResponse200 update_comment_for_note(id, comment_id, comment_post_put_object)
Update a comment related to a note

Updates a comment related to a note.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the note | [required] |
**comment_id** | **uuid::Uuid** | The ID of the comment | [required] |
**comment_post_put_object** | Option<[**CommentPostPutObject**](CommentPostPutObject.md)> |  |  |

### Return type

[**crate::models::OneCommentResponse200**](oneCommentResponse200.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_note

> crate::models::OneNoteResponse200 update_note(id, note_request)
Update a note

Updates a note.

### Parameters


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

### Return type

[**crate::models::OneNoteResponse200**](oneNoteResponse200.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)