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

# \LeadLabelsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_lead_label**](LeadLabelsApi.md#add_lead_label) | **POST** /leadLabels | Add a lead label
[**delete_lead_label**](LeadLabelsApi.md#delete_lead_label) | **DELETE** /leadLabels/{id} | Delete a lead label
[**get_lead_labels**](LeadLabelsApi.md#get_lead_labels) | **GET** /leadLabels | Get all lead labels
[**update_lead_label**](LeadLabelsApi.md#update_lead_label) | **PATCH** /leadLabels/{id} | Update a lead label



## add_lead_label

> crate::models::AddOrUpdateLeadLabelResponse200 add_lead_label(add_lead_label_request)
Add a lead label

Creates a lead label.

### Parameters


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

### Return type

[**crate::models::AddOrUpdateLeadLabelResponse200**](addOrUpdateLeadLabelResponse200.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_lead_label

> crate::models::LeadIdResponse200 delete_lead_label(id)
Delete a lead label

Deletes a specific lead label.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | The ID of the lead label | [required] |

### Return type

[**crate::models::LeadIdResponse200**](leadIdResponse200.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_lead_labels

> crate::models::GetLeadLabelsResponse200 get_lead_labels()
Get all lead labels

Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.

### Parameters

This endpoint does not need any parameter.

### Return type

[**crate::models::GetLeadLabelsResponse200**](getLeadLabelsResponse200.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_lead_label

> crate::models::AddOrUpdateLeadLabelResponse200 update_lead_label(id, update_lead_label_request)
Update a lead label

Updates one or more properties of a lead label. Only properties included in the request will be updated. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | The ID of the lead label | [required] |
**update_lead_label_request** | Option<[**UpdateLeadLabelRequest**](UpdateLeadLabelRequest.md)> |  |  |

### Return type

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