|
| 1 | +# OrderCloud.ImpersonationConfigs |
| 2 | + |
| 3 | +All URIs are relative to *https://api.ordercloud.io/v1* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**Create**](ImpersonationConfigs.md#Create) | **POST** /impersonationconfig | |
| 8 | +[**Delete**](ImpersonationConfigs.md#Delete) | **DELETE** /impersonationconfig/{impersonationConfigID} | |
| 9 | +[**Get**](ImpersonationConfigs.md#Get) | **GET** /impersonationconfig/{impersonationConfigID} | |
| 10 | +[**List**](ImpersonationConfigs.md#List) | **GET** /impersonationconfig | |
| 11 | +[**Patch**](ImpersonationConfigs.md#Patch) | **PATCH** /impersonationconfig/{impersonationConfigID} | |
| 12 | +[**Update**](ImpersonationConfigs.md#Update) | **PUT** /impersonationconfig/{impersonationConfigID} | |
| 13 | + |
| 14 | + |
| 15 | +<a name="Create"></a> |
| 16 | +# **Create** |
| 17 | +> ImpersonationConfig Create(impersonationConfig) |
| 18 | +
|
| 19 | + |
| 20 | + |
| 21 | +### Example |
| 22 | +```javascript |
| 23 | +var OrderCloud = require('OrderCloud'); |
| 24 | +var defaultClient = OrderCloud.ApiClient.default; |
| 25 | + |
| 26 | +// Configure OAuth2 access token for authorization: oauth2 |
| 27 | +var oauth2 = defaultClient.authentications['oauth2']; |
| 28 | +oauth2.accessToken = 'YOUR ACCESS TOKEN'; |
| 29 | + |
| 30 | +var apiInstance = new OrderCloud.ImpersonationConfigs(); |
| 31 | + |
| 32 | +var impersonationConfig = new OrderCloud.ImpersonationConfig(); // ImpersonationConfig | |
| 33 | + |
| 34 | +apiInstance.Create(impersonationConfig).then(function(data) { |
| 35 | + console.log('API called successfully. Returned data: ' + data); |
| 36 | +}, function(error) { |
| 37 | + console.error(error); |
| 38 | +}); |
| 39 | + |
| 40 | +``` |
| 41 | + |
| 42 | +### Parameters |
| 43 | + |
| 44 | +Name | Type | Description | Notes |
| 45 | +------------- | ------------- | ------------- | ------------- |
| 46 | + **impersonationConfig** | [**ImpersonationConfig**](ImpersonationConfig.md)| | |
| 47 | + |
| 48 | +### Return type |
| 49 | + |
| 50 | +[**ImpersonationConfig**](ImpersonationConfig.md) |
| 51 | + |
| 52 | +### Authorization |
| 53 | + |
| 54 | +[oauth2](../README.md#oauth2) |
| 55 | + |
| 56 | +### HTTP request headers |
| 57 | + |
| 58 | + - **Content-Type**: application/json, text/plain; charset=utf-8 |
| 59 | + - **Accept**: application/json |
| 60 | + |
| 61 | +<a name="Delete"></a> |
| 62 | +# **Delete** |
| 63 | +> Delete(impersonationConfigID) |
| 64 | +
|
| 65 | + |
| 66 | + |
| 67 | +### Example |
| 68 | +```javascript |
| 69 | +var OrderCloud = require('OrderCloud'); |
| 70 | +var defaultClient = OrderCloud.ApiClient.default; |
| 71 | + |
| 72 | +// Configure OAuth2 access token for authorization: oauth2 |
| 73 | +var oauth2 = defaultClient.authentications['oauth2']; |
| 74 | +oauth2.accessToken = 'YOUR ACCESS TOKEN'; |
| 75 | + |
| 76 | +var apiInstance = new OrderCloud.ImpersonationConfigs(); |
| 77 | + |
| 78 | +var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config. |
| 79 | + |
| 80 | +apiInstance.Delete(impersonationConfigID).then(function() { |
| 81 | + console.log('API called successfully.'); |
| 82 | +}, function(error) { |
| 83 | + console.error(error); |
| 84 | +}); |
| 85 | + |
| 86 | +``` |
| 87 | + |
| 88 | +### Parameters |
| 89 | + |
| 90 | +Name | Type | Description | Notes |
| 91 | +------------- | ------------- | ------------- | ------------- |
| 92 | + **impersonationConfigID** | **String**| ID of the impersonation config. | |
| 93 | + |
| 94 | +### Return type |
| 95 | + |
| 96 | +null (empty response body) |
| 97 | + |
| 98 | +### Authorization |
| 99 | + |
| 100 | +[oauth2](../README.md#oauth2) |
| 101 | + |
| 102 | +### HTTP request headers |
| 103 | + |
| 104 | + - **Content-Type**: application/json, text/plain; charset=utf-8 |
| 105 | + - **Accept**: application/json |
| 106 | + |
| 107 | +<a name="Get"></a> |
| 108 | +# **Get** |
| 109 | +> ImpersonationConfig Get(impersonationConfigID) |
| 110 | +
|
| 111 | + |
| 112 | + |
| 113 | +### Example |
| 114 | +```javascript |
| 115 | +var OrderCloud = require('OrderCloud'); |
| 116 | +var defaultClient = OrderCloud.ApiClient.default; |
| 117 | + |
| 118 | +// Configure OAuth2 access token for authorization: oauth2 |
| 119 | +var oauth2 = defaultClient.authentications['oauth2']; |
| 120 | +oauth2.accessToken = 'YOUR ACCESS TOKEN'; |
| 121 | + |
| 122 | +var apiInstance = new OrderCloud.ImpersonationConfigs(); |
| 123 | + |
| 124 | +var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config. |
| 125 | + |
| 126 | +apiInstance.Get(impersonationConfigID).then(function(data) { |
| 127 | + console.log('API called successfully. Returned data: ' + data); |
| 128 | +}, function(error) { |
| 129 | + console.error(error); |
| 130 | +}); |
| 131 | + |
| 132 | +``` |
| 133 | + |
| 134 | +### Parameters |
| 135 | + |
| 136 | +Name | Type | Description | Notes |
| 137 | +------------- | ------------- | ------------- | ------------- |
| 138 | + **impersonationConfigID** | **String**| ID of the impersonation config. | |
| 139 | + |
| 140 | +### Return type |
| 141 | + |
| 142 | +[**ImpersonationConfig**](ImpersonationConfig.md) |
| 143 | + |
| 144 | +### Authorization |
| 145 | + |
| 146 | +[oauth2](../README.md#oauth2) |
| 147 | + |
| 148 | +### HTTP request headers |
| 149 | + |
| 150 | + - **Content-Type**: application/json, text/plain; charset=utf-8 |
| 151 | + - **Accept**: application/json |
| 152 | + |
| 153 | +<a name="List"></a> |
| 154 | +# **List** |
| 155 | +> ListImpersonationConfig List(opts) |
| 156 | +
|
| 157 | + |
| 158 | + |
| 159 | +### Example |
| 160 | +```javascript |
| 161 | +var OrderCloud = require('OrderCloud'); |
| 162 | +var defaultClient = OrderCloud.ApiClient.default; |
| 163 | + |
| 164 | +// Configure OAuth2 access token for authorization: oauth2 |
| 165 | +var oauth2 = defaultClient.authentications['oauth2']; |
| 166 | +oauth2.accessToken = 'YOUR ACCESS TOKEN'; |
| 167 | + |
| 168 | +var apiInstance = new OrderCloud.ImpersonationConfigs(); |
| 169 | + |
| 170 | +var opts = { |
| 171 | + 'search': "search_example", // String | Word or phrase to search for. |
| 172 | + 'searchOn': "searchOn_example", // String | Comma-delimited list of fields to search on. |
| 173 | + 'sortBy': "sortBy_example", // String | Comma-delimited list of fields to sort by. |
| 174 | + 'page': 56, // Number | Page of results to return. Default: 1 |
| 175 | + 'pageSize': 56, // Number | Number of results to return per page. Default: 20, max: 100. |
| 176 | + 'filters': {key: "filters_example"} // {String: String} | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' |
| 177 | +}; |
| 178 | +apiInstance.List(opts).then(function(data) { |
| 179 | + console.log('API called successfully. Returned data: ' + data); |
| 180 | +}, function(error) { |
| 181 | + console.error(error); |
| 182 | +}); |
| 183 | + |
| 184 | +``` |
| 185 | + |
| 186 | +### Parameters |
| 187 | + |
| 188 | +Name | Type | Description | Notes |
| 189 | +------------- | ------------- | ------------- | ------------- |
| 190 | + **search** | **String**| Word or phrase to search for. | [optional] |
| 191 | + **searchOn** | **String**| Comma-delimited list of fields to search on. | [optional] |
| 192 | + **sortBy** | **String**| Comma-delimited list of fields to sort by. | [optional] |
| 193 | + **page** | **Number**| Page of results to return. Default: 1 | [optional] |
| 194 | + **pageSize** | **Number**| Number of results to return per page. Default: 20, max: 100. | [optional] |
| 195 | + **filters** | [**{String: String}**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' | [optional] |
| 196 | + |
| 197 | +### Return type |
| 198 | + |
| 199 | +[**ListImpersonationConfig**](ListImpersonationConfig.md) |
| 200 | + |
| 201 | +### Authorization |
| 202 | + |
| 203 | +[oauth2](../README.md#oauth2) |
| 204 | + |
| 205 | +### HTTP request headers |
| 206 | + |
| 207 | + - **Content-Type**: application/json, text/plain; charset=utf-8 |
| 208 | + - **Accept**: application/json |
| 209 | + |
| 210 | +<a name="Patch"></a> |
| 211 | +# **Patch** |
| 212 | +> ImpersonationConfig Patch(impersonationConfigID, impersonationConfig) |
| 213 | +
|
| 214 | + |
| 215 | + |
| 216 | +### Example |
| 217 | +```javascript |
| 218 | +var OrderCloud = require('OrderCloud'); |
| 219 | +var defaultClient = OrderCloud.ApiClient.default; |
| 220 | + |
| 221 | +// Configure OAuth2 access token for authorization: oauth2 |
| 222 | +var oauth2 = defaultClient.authentications['oauth2']; |
| 223 | +oauth2.accessToken = 'YOUR ACCESS TOKEN'; |
| 224 | + |
| 225 | +var apiInstance = new OrderCloud.ImpersonationConfigs(); |
| 226 | + |
| 227 | +var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config. |
| 228 | + |
| 229 | +var impersonationConfig = new OrderCloud.ImpersonationConfig(); // ImpersonationConfig | |
| 230 | + |
| 231 | +apiInstance.Patch(impersonationConfigID, impersonationConfig).then(function(data) { |
| 232 | + console.log('API called successfully. Returned data: ' + data); |
| 233 | +}, function(error) { |
| 234 | + console.error(error); |
| 235 | +}); |
| 236 | + |
| 237 | +``` |
| 238 | + |
| 239 | +### Parameters |
| 240 | + |
| 241 | +Name | Type | Description | Notes |
| 242 | +------------- | ------------- | ------------- | ------------- |
| 243 | + **impersonationConfigID** | **String**| ID of the impersonation config. | |
| 244 | + **impersonationConfig** | [**ImpersonationConfig**](ImpersonationConfig.md)| | |
| 245 | + |
| 246 | +### Return type |
| 247 | + |
| 248 | +[**ImpersonationConfig**](ImpersonationConfig.md) |
| 249 | + |
| 250 | +### Authorization |
| 251 | + |
| 252 | +[oauth2](../README.md#oauth2) |
| 253 | + |
| 254 | +### HTTP request headers |
| 255 | + |
| 256 | + - **Content-Type**: application/json, text/plain; charset=utf-8 |
| 257 | + - **Accept**: application/json |
| 258 | + |
| 259 | +<a name="Update"></a> |
| 260 | +# **Update** |
| 261 | +> ImpersonationConfig Update(impersonationConfigID, impersonationConfig) |
| 262 | +
|
| 263 | + |
| 264 | + |
| 265 | +### Example |
| 266 | +```javascript |
| 267 | +var OrderCloud = require('OrderCloud'); |
| 268 | +var defaultClient = OrderCloud.ApiClient.default; |
| 269 | + |
| 270 | +// Configure OAuth2 access token for authorization: oauth2 |
| 271 | +var oauth2 = defaultClient.authentications['oauth2']; |
| 272 | +oauth2.accessToken = 'YOUR ACCESS TOKEN'; |
| 273 | + |
| 274 | +var apiInstance = new OrderCloud.ImpersonationConfigs(); |
| 275 | + |
| 276 | +var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config. |
| 277 | + |
| 278 | +var impersonationConfig = new OrderCloud.ImpersonationConfig(); // ImpersonationConfig | |
| 279 | + |
| 280 | +apiInstance.Update(impersonationConfigID, impersonationConfig).then(function(data) { |
| 281 | + console.log('API called successfully. Returned data: ' + data); |
| 282 | +}, function(error) { |
| 283 | + console.error(error); |
| 284 | +}); |
| 285 | + |
| 286 | +``` |
| 287 | + |
| 288 | +### Parameters |
| 289 | + |
| 290 | +Name | Type | Description | Notes |
| 291 | +------------- | ------------- | ------------- | ------------- |
| 292 | + **impersonationConfigID** | **String**| ID of the impersonation config. | |
| 293 | + **impersonationConfig** | [**ImpersonationConfig**](ImpersonationConfig.md)| | |
| 294 | + |
| 295 | +### Return type |
| 296 | + |
| 297 | +[**ImpersonationConfig**](ImpersonationConfig.md) |
| 298 | + |
| 299 | +### Authorization |
| 300 | + |
| 301 | +[oauth2](../README.md#oauth2) |
| 302 | + |
| 303 | +### HTTP request headers |
| 304 | + |
| 305 | + - **Content-Type**: application/json, text/plain; charset=utf-8 |
| 306 | + - **Accept**: application/json |
| 307 | + |
0 commit comments