github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/CompanySettingsApi.md (about) 1 # \CompanySettingsApi 2 3 All URIs are relative to *https://platform.devtest.ringcentral.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**DeleteAccount**](CompanySettingsApi.md#DeleteAccount) | **Delete** /restapi/v1.0/account/{accountId} | Delete Account 8 [**ListDialingPlans**](CompanySettingsApi.md#ListDialingPlans) | **Get** /restapi/v1.0/account/{accountId}/dialing-plan | Get Available Dialing Plans 9 [**LoadAccount**](CompanySettingsApi.md#LoadAccount) | **Get** /restapi/v1.0/account/{accountId} | Get Company Info 10 [**LoadAccountBusinessAddress**](CompanySettingsApi.md#LoadAccountBusinessAddress) | **Get** /restapi/v1.0/account/{accountId}/business-address | Get Company Business Address 11 [**LoadServiceInfo**](CompanySettingsApi.md#LoadServiceInfo) | **Get** /restapi/v1.0/account/{accountId}/service-info | Get Account Service Info 12 [**ModifyAccount**](CompanySettingsApi.md#ModifyAccount) | **Put** /restapi/v1.0/account/{accountId} | Update Company 13 [**UpdateAccountBusinessAddress**](CompanySettingsApi.md#UpdateAccountBusinessAddress) | **Put** /restapi/v1.0/account/{accountId}/business-address | Update Company Business Address 14 [**UpdateServiceInfo**](CompanySettingsApi.md#UpdateServiceInfo) | **Put** /restapi/v1.0/account/{accountId}/service-info | Update Account Service Info [Beta] 15 16 17 # **DeleteAccount** 18 > DeleteAccount(ctx, accountId) 19 Delete Account 20 21 <p style='font-style:italic;'>Since 1.0.0</p><p>Updates account information.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 22 23 ### Required Parameters 24 25 Name | Type | Description | Notes 26 ------------- | ------------- | ------------- | ------------- 27 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 28 **accountId** | **string**| | 29 30 ### Return type 31 32 (empty response body) 33 34 ### Authorization 35 36 [OAuth2](../README.md#OAuth2) 37 38 ### HTTP request headers 39 40 - **Content-Type**: Not defined 41 - **Accept**: Not defined 42 43 [[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) 44 45 # **ListDialingPlans** 46 > GetDialingPlanInfo ListDialingPlans(ctx, accountId, optional) 47 Get Available Dialing Plans 48 49 <p style='font-style:italic;'></p><p>Returns list of countries which can be selected for a dialing plan (to call short numbers and special services).</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p> 50 51 ### Required Parameters 52 53 Name | Type | Description | Notes 54 ------------- | ------------- | ------------- | ------------- 55 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 56 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 57 **optional** | ***ListDialingPlansOpts** | optional parameters | nil if no parameters 58 59 ### Optional Parameters 60 Optional parameters are passed through a pointer to a ListDialingPlansOpts struct 61 62 Name | Type | Description | Notes 63 ------------- | ------------- | ------------- | ------------- 64 65 **page** | **optional.Int32**| Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' | 66 **perPage** | **optional.Int32**| Indicates the page size (number of items). If not specified, the value is '100' by default | 67 68 ### Return type 69 70 [**GetDialingPlanInfo**](GetDialingPlanInfo.md) 71 72 ### Authorization 73 74 [OAuth2](../README.md#OAuth2) 75 76 ### HTTP request headers 77 78 - **Content-Type**: Not defined 79 - **Accept**: application/json 80 81 [[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) 82 83 # **LoadAccount** 84 > GetAccountInfoResponse LoadAccount(ctx, accountId) 85 Get Company Info 86 87 <p style='font-style:italic;'>Since 1.0.0</p><p>Returns basic information about a particular RingCentral customer account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 88 89 ### Required Parameters 90 91 Name | Type | Description | Notes 92 ------------- | ------------- | ------------- | ------------- 93 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 94 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 95 96 ### Return type 97 98 [**GetAccountInfoResponse**](GetAccountInfoResponse.md) 99 100 ### Authorization 101 102 [OAuth2](../README.md#OAuth2) 103 104 ### HTTP request headers 105 106 - **Content-Type**: Not defined 107 - **Accept**: application/json 108 109 [[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) 110 111 # **LoadAccountBusinessAddress** 112 > GetAccountInfoResponse LoadAccountBusinessAddress(ctx, accountId) 113 Get Company Business Address 114 115 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 116 117 ### Required Parameters 118 119 Name | Type | Description | Notes 120 ------------- | ------------- | ------------- | ------------- 121 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 122 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 123 124 ### Return type 125 126 [**GetAccountInfoResponse**](GetAccountInfoResponse.md) 127 128 ### Authorization 129 130 [OAuth2](../README.md#OAuth2) 131 132 ### HTTP request headers 133 134 - **Content-Type**: Not defined 135 - **Accept**: application/json 136 137 [[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) 138 139 # **LoadServiceInfo** 140 > GetServiceInfoResponse LoadServiceInfo(ctx, accountId) 141 Get Account Service Info 142 143 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Light</p> 144 145 ### Required Parameters 146 147 Name | Type | Description | Notes 148 ------------- | ------------- | ------------- | ------------- 149 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 150 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 151 152 ### Return type 153 154 [**GetServiceInfoResponse**](GetServiceInfoResponse.md) 155 156 ### Authorization 157 158 [OAuth2](../README.md#OAuth2) 159 160 ### HTTP request headers 161 162 - **Content-Type**: Not defined 163 - **Accept**: application/json 164 165 [[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) 166 167 # **ModifyAccount** 168 > GetAccountInfoResponse ModifyAccount(ctx, accountId, updateAccountRequest) 169 Update Company 170 171 <p style='font-style:italic;'>Since 1.0.0</p><p>Updates account information.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 172 173 ### Required Parameters 174 175 Name | Type | Description | Notes 176 ------------- | ------------- | ------------- | ------------- 177 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 178 **accountId** | **string**| | 179 **updateAccountRequest** | [**UpdateAccountRequest**](UpdateAccountRequest.md)| JSON body | 180 181 ### Return type 182 183 [**GetAccountInfoResponse**](GetAccountInfoResponse.md) 184 185 ### Authorization 186 187 [OAuth2](../README.md#OAuth2) 188 189 ### HTTP request headers 190 191 - **Content-Type**: application/json 192 - **Accept**: application/json 193 194 [[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) 195 196 # **UpdateAccountBusinessAddress** 197 > AccountBusinessAddressResource UpdateAccountBusinessAddress(ctx, accountId, modifyAccountBusinessAddressRequest) 198 Update Company Business Address 199 200 <p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Medium</p> 201 202 ### Required Parameters 203 204 Name | Type | Description | Notes 205 ------------- | ------------- | ------------- | ------------- 206 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 207 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 208 **modifyAccountBusinessAddressRequest** | [**ModifyAccountBusinessAddressRequest**](ModifyAccountBusinessAddressRequest.md)| JSON body | 209 210 ### Return type 211 212 [**AccountBusinessAddressResource**](AccountBusinessAddressResource.md) 213 214 ### Authorization 215 216 [OAuth2](../README.md#OAuth2) 217 218 ### HTTP request headers 219 220 - **Content-Type**: application/json 221 - **Accept**: application/json 222 223 [[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) 224 225 # **UpdateServiceInfo** 226 > AccountServiceInfo UpdateServiceInfo(ctx, accountId, serviceInfoRequest) 227 Update Account Service Info [Beta] 228 229 <p style='font-style:italic;'>Since 1.0.29 (Release 9.0)</p><p>Updates limitations for a particular RingCentral customer account.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>Accounts</td><td>Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts</td></tr><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p> 230 231 ### Required Parameters 232 233 Name | Type | Description | Notes 234 ------------- | ------------- | ------------- | ------------- 235 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 236 **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~] 237 **serviceInfoRequest** | [**ServiceInfoRequest**](ServiceInfoRequest.md)| JSON body | 238 239 ### Return type 240 241 [**AccountServiceInfo**](AccountServiceInfo.md) 242 243 ### Authorization 244 245 [OAuth2](../README.md#OAuth2) 246 247 ### HTTP request headers 248 249 - **Content-Type**: application/json 250 - **Accept**: application/json 251 252 [[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) 253