twilio-rust-openapi 1.0.0

This is the public Twilio REST API.
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

# \Api20100401TriggerApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_usage_trigger**](Api20100401TriggerApi.md#create_usage_trigger) | **POST** /2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json | 
[**delete_usage_trigger**](Api20100401TriggerApi.md#delete_usage_trigger) | **DELETE** /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json | 
[**fetch_usage_trigger**](Api20100401TriggerApi.md#fetch_usage_trigger) | **GET** /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json | 
[**list_usage_trigger**](Api20100401TriggerApi.md#list_usage_trigger) | **GET** /2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json | 
[**update_usage_trigger**](Api20100401TriggerApi.md#update_usage_trigger) | **POST** /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json | 



## create_usage_trigger

> models::ApiPeriodV2010PeriodAccountPeriodUsagePeriodUsageTrigger create_usage_trigger(account_sid, callback_url, trigger_value, usage_category, callback_method, friendly_name, recurring, trigger_by)


Create a new UsageTrigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. | [required] |
**callback_url** | **String** | The URL we should call using `callback_method` when the trigger fires. | [required] |
**trigger_value** | **String** | The usage value at which the trigger should fire.  For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`. | [required] |
**usage_category** | **models::UsageTriggerEnumUsageCategory** |  | [required] |
**callback_method** | Option<**String**> | The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`. |  |
**friendly_name** | Option<**String**> | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |  |
**recurring** | Option<**models::UsageTriggerEnumRecurring**> |  |  |
**trigger_by** | Option<**models::UsageTriggerEnumTriggerField**> |  |  |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodUsagePeriodUsageTrigger**](api.v2010.account.usage.usage_trigger.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded
- **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_usage_trigger

> delete_usage_trigger(account_sid, sid)




### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to delete. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete. | [required] |

### Return type

 (empty response body)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## fetch_usage_trigger

> models::ApiPeriodV2010PeriodAccountPeriodUsagePeriodUsageTrigger fetch_usage_trigger(account_sid, sid)


Fetch and instance of a usage-trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resource to fetch. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch. | [required] |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodUsagePeriodUsageTrigger**](api.v2010.account.usage.usage_trigger.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### 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)


## list_usage_trigger

> models::ListUsageTriggerResponse list_usage_trigger(account_sid, recurring, trigger_by, usage_category, page_size, page, page_token)


Retrieve a list of usage-triggers belonging to the account used to make the request

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to read. | [required] |
**recurring** | Option<**UsageTriggerEnumRecurring**> | The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers. |  |
**trigger_by** | Option<**UsageTriggerEnumTriggerField**> | The trigger field of the UsageTriggers to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). |  |
**usage_category** | Option<**UsageTriggerEnumUsageCategory**> | The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). |  |
**page_size** | Option<**i32**> | How many resources to return in each list page. The default is 50, and the maximum is 1000. |  |
**page** | Option<**i32**> | The page index. This value is simply for client state. |  |
**page_token** | Option<**String**> | The page token. This is provided by the API. |  |

### Return type

[**models::ListUsageTriggerResponse**](ListUsageTriggerResponse.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### 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_usage_trigger

> models::ApiPeriodV2010PeriodAccountPeriodUsagePeriodUsageTrigger update_usage_trigger(account_sid, sid, callback_method, callback_url, friendly_name)


Update an instance of a usage trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**account_sid** | **String** | The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to update. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the UsageTrigger resource to update. | [required] |
**callback_method** | Option<**String**> | The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`. |  |
**callback_url** | Option<**String**> | The URL we should call using `callback_method` when the trigger fires. |  |
**friendly_name** | Option<**String**> | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |  |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodUsagePeriodUsageTrigger**](api.v2010.account.usage.usage_trigger.md)

### Authorization

[accountSid_authToken](../README.md#accountSid_authToken)

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded
- **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)