github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/RegionalSettingsApi.md (about) 1 # \RegionalSettingsApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**ListCountries**](RegionalSettingsApi.md#ListCountries) | **Get** /restapi/v1.0/dictionary/country | Get Country List 8 [**ListLanguages**](RegionalSettingsApi.md#ListLanguages) | **Get** /restapi/v1.0/dictionary/language | Get Language List 9 [**ListLocations**](RegionalSettingsApi.md#ListLocations) | **Get** /restapi/v1.0/dictionary/location | Get Location List 10 [**ListTimezones**](RegionalSettingsApi.md#ListTimezones) | **Get** /restapi/v1.0/dictionary/timezone | Get Timezone List 11 [**LoadCountry**](RegionalSettingsApi.md#LoadCountry) | **Get** /restapi/v1.0/dictionary/country/{countryId} | Get Country 12 [**LoadLanguage**](RegionalSettingsApi.md#LoadLanguage) | **Get** /restapi/v1.0/dictionary/language/{languageId} | Get Language 13 [**LoadState**](RegionalSettingsApi.md#LoadState) | **Get** /restapi/v1.0/dictionary/state/{stateId} | Get State 14 [**LoadTimezone**](RegionalSettingsApi.md#LoadTimezone) | **Get** /restapi/v1.0/dictionary/timezone/{timezoneId} | Get Timezone 15 [**LoadlistStates**](RegionalSettingsApi.md#LoadlistStates) | **Get** /restapi/v1.0/dictionary/state | Get State List 16 17 18 # **ListCountries** 19 > GetCountryListResponse ListCountries(ctx, optional) 20 Get Country List 21 22 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all the countries available for calling.</p><h4>Usage Plan Group</h4><p>Light</p> 23 24 ### Required Parameters 25 26 Name | Type | Description | Notes 27 ------------- | ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **optional** | ***ListCountriesOpts** | optional parameters | nil if no parameters 30 31 ### Optional Parameters 32 Optional parameters are passed through a pointer to a ListCountriesOpts struct 33 34 Name | Type | Description | Notes 35 ------------- | ------------- | ------------- | ------------- 36 **loginAllowed** | **optional.Bool**| Specifies whether login with the phone numbers of this country is enabled or not | 37 **signupAllowed** | **optional.Bool**| Indicates whether signup/billing is allowed for a country. If not specified all countries are returned (according to other filters specified if any) | 38 **numberSelling** | **optional.Bool**| Specifies if RingCentral sells phone numbers of this country | 39 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 40 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 41 **freeSoftphoneLine** | **optional.Bool**| Specifies if free phone line for softphone is available for a country or not | 42 43 ### Return type 44 45 [**GetCountryListResponse**](GetCountryListResponse.md) 46 47 ### Authorization 48 49 [OAuth2](../README.md#OAuth2) 50 51 ### HTTP request headers 52 53 - **Content-Type**: Not defined 54 - **Accept**: application/json 55 56 [[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) 57 58 # **ListLanguages** 59 > LanguageList ListLanguages(ctx, ) 60 Get Language List 61 62 <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Returns the information about supported languages.</p><h4>Usage Plan Group</h4><p>Light</p> 63 64 ### Required Parameters 65 This endpoint does not need any parameter. 66 67 ### Return type 68 69 [**LanguageList**](LanguageList.md) 70 71 ### Authorization 72 73 [OAuth2](../README.md#OAuth2) 74 75 ### HTTP request headers 76 77 - **Content-Type**: Not defined 78 - **Accept**: application/json 79 80 [[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) 81 82 # **ListLocations** 83 > GetLocationListResponse ListLocations(ctx, optional) 84 Get Location List 85 86 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all the available locations for the certain state.</p><h4>Usage Plan Group</h4><p>Light</p> 87 88 ### Required Parameters 89 90 Name | Type | Description | Notes 91 ------------- | ------------- | ------------- | ------------- 92 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 93 **optional** | ***ListLocationsOpts** | optional parameters | nil if no parameters 94 95 ### Optional Parameters 96 Optional parameters are passed through a pointer to a ListLocationsOpts struct 97 98 Name | Type | Description | Notes 99 ------------- | ------------- | ------------- | ------------- 100 **orderBy** | [**optional.Interface of []string**](string.md)| Sorts results by the specified property. The default value is 'City' | 101 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'. | 102 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default. | 103 **stateId** | **optional.String**| Internal identifier of a state | 104 **withNxx** | **optional.Bool**| Specifies if nxx codes are returned | 105 106 ### Return type 107 108 [**GetLocationListResponse**](GetLocationListResponse.md) 109 110 ### Authorization 111 112 [OAuth2](../README.md#OAuth2) 113 114 ### HTTP request headers 115 116 - **Content-Type**: Not defined 117 - **Accept**: application/json 118 119 [[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) 120 121 # **ListTimezones** 122 > GetTimezoneListResponse ListTimezones(ctx, optional) 123 Get Timezone List 124 125 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all available timezones.</p><h4>Usage Plan Group</h4><p>Light</p> 126 127 ### Required Parameters 128 129 Name | Type | Description | Notes 130 ------------- | ------------- | ------------- | ------------- 131 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 132 **optional** | ***ListTimezonesOpts** | optional parameters | nil if no parameters 133 134 ### Optional Parameters 135 Optional parameters are passed through a pointer to a ListTimezonesOpts struct 136 137 Name | Type | Description | Notes 138 ------------- | ------------- | ------------- | ------------- 139 **page** | **optional.String**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 140 **perPage** | **optional.String**| Indicates the page size (number of items). If not specified, the value is '100' by default | 141 142 ### Return type 143 144 [**GetTimezoneListResponse**](GetTimezoneListResponse.md) 145 146 ### Authorization 147 148 [OAuth2](../README.md#OAuth2) 149 150 ### HTTP request headers 151 152 - **Content-Type**: Not defined 153 - **Accept**: application/json 154 155 [[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) 156 157 # **LoadCountry** 158 > GetCountryInfoDictionaryResponse LoadCountry(ctx, countryId) 159 Get Country 160 161 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on the required country.</p><h4>Usage Plan Group</h4><p>Light</p> 162 163 ### Required Parameters 164 165 Name | Type | Description | Notes 166 ------------- | ------------- | ------------- | ------------- 167 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 168 **countryId** | **int32**| Internal identifier of a country | 169 170 ### Return type 171 172 [**GetCountryInfoDictionaryResponse**](GetCountryInfoDictionaryResponse.md) 173 174 ### Authorization 175 176 [OAuth2](../README.md#OAuth2) 177 178 ### HTTP request headers 179 180 - **Content-Type**: Not defined 181 - **Accept**: application/json 182 183 [[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) 184 185 # **LoadLanguage** 186 > LanguageInfo LoadLanguage(ctx, languageId) 187 Get Language 188 189 <p style='font-style:italic;'>Since 1.0.14 (Release 6.6)</p><p>Returns language by its respective ID.</p><h4>Usage Plan Group</h4><p>Light</p> 190 191 ### Required Parameters 192 193 Name | Type | Description | Notes 194 ------------- | ------------- | ------------- | ------------- 195 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 196 **languageId** | **int32**| Internal identifier of a language | 197 198 ### Return type 199 200 [**LanguageInfo**](LanguageInfo.md) 201 202 ### Authorization 203 204 [OAuth2](../README.md#OAuth2) 205 206 ### HTTP request headers 207 208 - **Content-Type**: Not defined 209 - **Accept**: application/json 210 211 [[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) 212 213 # **LoadState** 214 > GetStateInfoResponse LoadState(ctx, stateId) 215 Get State 216 217 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on the required state.</p><h4>Usage Plan Group</h4><p>Light</p> 218 219 ### Required Parameters 220 221 Name | Type | Description | Notes 222 ------------- | ------------- | ------------- | ------------- 223 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 224 **stateId** | **int32**| Internal identifier of a state | 225 226 ### Return type 227 228 [**GetStateInfoResponse**](GetStateInfoResponse.md) 229 230 ### Authorization 231 232 [OAuth2](../README.md#OAuth2) 233 234 ### HTTP request headers 235 236 - **Content-Type**: Not defined 237 - **Accept**: application/json 238 239 [[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) 240 241 # **LoadTimezone** 242 > GetTimezoneInfoResponse LoadTimezone(ctx, timezoneId, optional) 243 Get Timezone 244 245 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns the information on a certain timezone.</p><h4>Usage Plan Group</h4><p>Light</p> 246 247 ### Required Parameters 248 249 Name | Type | Description | Notes 250 ------------- | ------------- | ------------- | ------------- 251 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 252 **timezoneId** | **int32**| Internal identifier of a timezone | 253 **optional** | ***LoadTimezoneOpts** | optional parameters | nil if no parameters 254 255 ### Optional Parameters 256 Optional parameters are passed through a pointer to a LoadTimezoneOpts struct 257 258 Name | Type | Description | Notes 259 ------------- | ------------- | ------------- | ------------- 260 261 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 262 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 263 264 ### Return type 265 266 [**GetTimezoneInfoResponse**](GetTimezoneInfoResponse.md) 267 268 ### Authorization 269 270 [OAuth2](../README.md#OAuth2) 271 272 ### HTTP request headers 273 274 - **Content-Type**: Not defined 275 - **Accept**: application/json 276 277 [[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) 278 279 # **LoadlistStates** 280 > GetStateListResponse LoadlistStates(ctx, optional) 281 Get State List 282 283 <p style='font-style:italic;'>Since 1.0.10 (Release 6.2)</p><p>Returns all the states for a certain country.</p><h4>Usage Plan Group</h4><p>Light</p> 284 285 ### Required Parameters 286 287 Name | Type | Description | Notes 288 ------------- | ------------- | ------------- | ------------- 289 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 290 **optional** | ***LoadlistStatesOpts** | optional parameters | nil if no parameters 291 292 ### Optional Parameters 293 Optional parameters are passed through a pointer to a LoadlistStatesOpts struct 294 295 Name | Type | Description | Notes 296 ------------- | ------------- | ------------- | ------------- 297 **countryId** | **optional.Int32**| Internal identifier of a country | 298 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'. | 299 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 300 **withPhoneNumbers** | **optional.Bool**| If 'True', the list of states with phone numbers available for buying is returned. The default value is 'False' | 301 302 ### Return type 303 304 [**GetStateListResponse**](GetStateListResponse.md) 305 306 ### Authorization 307 308 [OAuth2](../README.md#OAuth2) 309 310 ### HTTP request headers 311 312 - **Content-Type**: Not defined 313 - **Accept**: application/json 314 315 [[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) 316