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

# \CallLogsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_call_log**](CallLogsApi.md#add_call_log) | **POST** /callLogs | Add a call log
[**add_call_log_audio_file**](CallLogsApi.md#add_call_log_audio_file) | **POST** /callLogs/{id}/recordings | Attach an audio file to the call log
[**delete_call_log**](CallLogsApi.md#delete_call_log) | **DELETE** /callLogs/{id} | Delete a call log
[**get_call_log**](CallLogsApi.md#get_call_log) | **GET** /callLogs/{id} | Get details of a call log
[**get_user_call_logs**](CallLogsApi.md#get_user_call_logs) | **GET** /callLogs | Get all call logs assigned to a particular user



## add_call_log

> crate::models::CallLogResponse200 add_call_log(add_call_log_request)
Add a call log

Adds a new call log.

### Parameters


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

### Return type

[**crate::models::CallLogResponse200**](callLogResponse200.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_call_log_audio_file

> crate::models::BaseResponse add_call_log_audio_file(id, file)
Attach an audio file to the call log

Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The ID received when you create the call log | [required] |
**file** | **std::path::PathBuf** | Audio file supported by the HTML5 specification | [required] |

### Return type

[**crate::models::BaseResponse**](baseResponse.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: multipart/form-data
- **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_call_log

> crate::models::BaseResponse delete_call_log(id)
Delete a call log

Deletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The ID received when you create the call log | [required] |

### Return type

[**crate::models::BaseResponse**](baseResponse.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_call_log

> crate::models::CallLogResponse200 get_call_log(id)
Get details of a call log

Returns details of a specific call log.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The ID received when you create the call log | [required] |

### Return type

[**crate::models::CallLogResponse200**](callLogResponse200.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_user_call_logs

> crate::models::CallLogsResponse get_user_call_logs(start, limit)
Get all call logs assigned to a particular user

Returns all call logs assigned to a particular user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start** | Option<**i32**> | Pagination start |  |[default to 0]
**limit** | Option<**i32**> | For pagination, the limit of entries to be returned. The upper limit is 50. |  |

### Return type

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