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

# \Api20100401QueueApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_queue**](Api20100401QueueApi.md#create_queue) | **POST** /2010-04-01/Accounts/{AccountSid}/Queues.json | 
[**delete_queue**](Api20100401QueueApi.md#delete_queue) | **DELETE** /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json | 
[**fetch_queue**](Api20100401QueueApi.md#fetch_queue) | **GET** /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json | 
[**list_queue**](Api20100401QueueApi.md#list_queue) | **GET** /2010-04-01/Accounts/{AccountSid}/Queues.json | 
[**update_queue**](Api20100401QueueApi.md#update_queue) | **POST** /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json | 



## create_queue

> models::ApiPeriodV2010PeriodAccountPeriodQueue create_queue(account_sid, friendly_name, max_size)


Create a queue

### 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] |
**friendly_name** | **String** | A descriptive string that you created to describe this resource. It can be up to 64 characters long. | [required] |
**max_size** | Option<**i32**> | The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000. |  |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodQueue**](api.v2010.account.queue.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_queue

> delete_queue(account_sid, sid)


Remove an empty queue

### 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 Queue resource to delete. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the Queue 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_queue

> models::ApiPeriodV2010PeriodAccountPeriodQueue fetch_queue(account_sid, sid)


Fetch an instance of a queue identified by the QueueSid

### 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 Queue resource to fetch. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the Queue resource to fetch | [required] |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodQueue**](api.v2010.account.queue.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_queue

> models::ListQueueResponse list_queue(account_sid, page_size, page, page_token)


Retrieve a list of queues 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 Queue resources to read. | [required] |
**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::ListQueueResponse**](ListQueueResponse.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_queue

> models::ApiPeriodV2010PeriodAccountPeriodQueue update_queue(account_sid, sid, friendly_name, max_size)


Update the queue with the new parameters

### 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 Queue resource to update. | [required] |
**sid** | **String** | The Twilio-provided string that uniquely identifies the Queue resource to update | [required] |
**friendly_name** | Option<**String**> | A descriptive string that you created to describe this resource. It can be up to 64 characters long. |  |
**max_size** | Option<**i32**> | The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000. |  |

### Return type

[**models::ApiPeriodV2010PeriodAccountPeriodQueue**](api.v2010.account.queue.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)