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

# \Api20100401AccountApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_account**](Api20100401AccountApi.md#create_account) | **POST** /2010-04-01/Accounts.json | 
[**fetch_account**](Api20100401AccountApi.md#fetch_account) | **GET** /2010-04-01/Accounts/{Sid}.json | 
[**list_account**](Api20100401AccountApi.md#list_account) | **GET** /2010-04-01/Accounts.json | 
[**update_account**](Api20100401AccountApi.md#update_account) | **POST** /2010-04-01/Accounts/{Sid}.json | 



## create_account

> models::ApiPeriodV2010PeriodAccount create_account(friendly_name)


Create a new Twilio Subaccount from the account making the request

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**friendly_name** | Option<**String**> | A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}` |  |

### Return type

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


## fetch_account

> models::ApiPeriodV2010PeriodAccount fetch_account(sid)


Fetch the account specified by the provided Account Sid

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sid** | **String** | The Account Sid that uniquely identifies the account to fetch | [required] |

### Return type

[**models::ApiPeriodV2010PeriodAccount**](api.v2010.account.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_account

> models::ListAccountResponse list_account(friendly_name, status, page_size, page, page_token)


Retrieves a collection of Accounts belonging to the account used to make the request

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**friendly_name** | Option<**String**> | Only return the Account resources with friendly names that exactly match this name. |  |
**status** | Option<**AccountEnumStatus**> | Only return Account resources with the given status. Can be `closed`, `suspended` or `active`. |  |
**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::ListAccountResponse**](ListAccountResponse.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_account

> models::ApiPeriodV2010PeriodAccount update_account(sid, friendly_name, status)


Modify the properties of a given Account

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sid** | **String** | The Account Sid that uniquely identifies the account to update | [required] |
**friendly_name** | Option<**String**> | Update the human-readable description of this Account |  |
**status** | Option<**models::AccountEnumStatus**> |  |  |

### Return type

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