github.com/antihax/goesi@v0.0.0-20240126031043-6c54d0cb7f95/esi/docs/ContactsApi.md (about) 1 # \ContactsApi 2 3 All URIs are relative to *https://esi.evetech.net* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**DeleteCharactersCharacterIdContacts**](ContactsApi.md#DeleteCharactersCharacterIdContacts) | **Delete** /v2/characters/{character_id}/contacts/ | Delete contacts 8 [**GetAlliancesAllianceIdContacts**](ContactsApi.md#GetAlliancesAllianceIdContacts) | **Get** /v2/alliances/{alliance_id}/contacts/ | Get alliance contacts 9 [**GetAlliancesAllianceIdContactsLabels**](ContactsApi.md#GetAlliancesAllianceIdContactsLabels) | **Get** /v1/alliances/{alliance_id}/contacts/labels/ | Get alliance contact labels 10 [**GetCharactersCharacterIdContacts**](ContactsApi.md#GetCharactersCharacterIdContacts) | **Get** /v2/characters/{character_id}/contacts/ | Get contacts 11 [**GetCharactersCharacterIdContactsLabels**](ContactsApi.md#GetCharactersCharacterIdContactsLabels) | **Get** /v1/characters/{character_id}/contacts/labels/ | Get contact labels 12 [**GetCorporationsCorporationIdContacts**](ContactsApi.md#GetCorporationsCorporationIdContacts) | **Get** /v2/corporations/{corporation_id}/contacts/ | Get corporation contacts 13 [**GetCorporationsCorporationIdContactsLabels**](ContactsApi.md#GetCorporationsCorporationIdContactsLabels) | **Get** /v1/corporations/{corporation_id}/contacts/labels/ | Get corporation contact labels 14 [**PostCharactersCharacterIdContacts**](ContactsApi.md#PostCharactersCharacterIdContacts) | **Post** /v2/characters/{character_id}/contacts/ | Add contacts 15 [**PutCharactersCharacterIdContacts**](ContactsApi.md#PutCharactersCharacterIdContacts) | **Put** /v2/characters/{character_id}/contacts/ | Edit contacts 16 17 18 # **DeleteCharactersCharacterIdContacts** 19 > DeleteCharactersCharacterIdContacts(ctx, characterId, contactIds, optional) 20 Delete contacts 21 22 Bulk delete contacts --- 23 24 ### Required Parameters 25 26 Name | Type | Description | Notes 27 ------------- | ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 29 **characterId** | **int32**| An EVE character ID | 30 **contactIds** | [**[]int32**](int32.md)| A list of contacts to delete | 31 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 32 33 ### Optional Parameters 34 Optional parameters are passed through a map[string]interface{}. 35 36 Name | Type | Description | Notes 37 ------------- | ------------- | ------------- | ------------- 38 **characterId** | **int32**| An EVE character ID | 39 **contactIds** | [**[]int32**](int32.md)| A list of contacts to delete | 40 **datasource** | **string**| The server name you would like data from | [default to tranquility] 41 **token** | **string**| Access token to use if unable to set a header | 42 43 ### Return type 44 45 (empty response body) 46 47 ### Authorization 48 49 [evesso](../README.md#evesso) 50 51 ### HTTP request headers 52 53 - **Content-Type**: application/json 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 # **GetAlliancesAllianceIdContacts** 59 > []GetAlliancesAllianceIdContacts200Ok GetAlliancesAllianceIdContacts(ctx, allianceId, optional) 60 Get alliance contacts 61 62 Return contacts of an alliance --- This route is cached for up to 300 seconds 63 64 ### Required Parameters 65 66 Name | Type | Description | Notes 67 ------------- | ------------- | ------------- | ------------- 68 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 69 **allianceId** | **int32**| An EVE alliance ID | 70 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 71 72 ### Optional Parameters 73 Optional parameters are passed through a map[string]interface{}. 74 75 Name | Type | Description | Notes 76 ------------- | ------------- | ------------- | ------------- 77 **allianceId** | **int32**| An EVE alliance ID | 78 **datasource** | **string**| The server name you would like data from | [default to tranquility] 79 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 80 **page** | **int32**| Which page of results to return | [default to 1] 81 **token** | **string**| Access token to use if unable to set a header | 82 83 ### Return type 84 85 [**[]GetAlliancesAllianceIdContacts200Ok**](get_alliances_alliance_id_contacts_200_ok.md) 86 87 ### Authorization 88 89 [evesso](../README.md#evesso) 90 91 ### HTTP request headers 92 93 - **Content-Type**: application/json 94 - **Accept**: application/json 95 96 [[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) 97 98 # **GetAlliancesAllianceIdContactsLabels** 99 > []GetAlliancesAllianceIdContactsLabels200Ok GetAlliancesAllianceIdContactsLabels(ctx, allianceId, optional) 100 Get alliance contact labels 101 102 Return custom labels for an alliance's contacts --- This route is cached for up to 300 seconds 103 104 ### Required Parameters 105 106 Name | Type | Description | Notes 107 ------------- | ------------- | ------------- | ------------- 108 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 109 **allianceId** | **int32**| An EVE alliance ID | 110 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 111 112 ### Optional Parameters 113 Optional parameters are passed through a map[string]interface{}. 114 115 Name | Type | Description | Notes 116 ------------- | ------------- | ------------- | ------------- 117 **allianceId** | **int32**| An EVE alliance ID | 118 **datasource** | **string**| The server name you would like data from | [default to tranquility] 119 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 120 **token** | **string**| Access token to use if unable to set a header | 121 122 ### Return type 123 124 [**[]GetAlliancesAllianceIdContactsLabels200Ok**](get_alliances_alliance_id_contacts_labels_200_ok.md) 125 126 ### Authorization 127 128 [evesso](../README.md#evesso) 129 130 ### HTTP request headers 131 132 - **Content-Type**: application/json 133 - **Accept**: application/json 134 135 [[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) 136 137 # **GetCharactersCharacterIdContacts** 138 > []GetCharactersCharacterIdContacts200Ok GetCharactersCharacterIdContacts(ctx, characterId, optional) 139 Get contacts 140 141 Return contacts of a character --- This route is cached for up to 300 seconds 142 143 ### Required Parameters 144 145 Name | Type | Description | Notes 146 ------------- | ------------- | ------------- | ------------- 147 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 148 **characterId** | **int32**| An EVE character ID | 149 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 150 151 ### Optional Parameters 152 Optional parameters are passed through a map[string]interface{}. 153 154 Name | Type | Description | Notes 155 ------------- | ------------- | ------------- | ------------- 156 **characterId** | **int32**| An EVE character ID | 157 **datasource** | **string**| The server name you would like data from | [default to tranquility] 158 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 159 **page** | **int32**| Which page of results to return | [default to 1] 160 **token** | **string**| Access token to use if unable to set a header | 161 162 ### Return type 163 164 [**[]GetCharactersCharacterIdContacts200Ok**](get_characters_character_id_contacts_200_ok.md) 165 166 ### Authorization 167 168 [evesso](../README.md#evesso) 169 170 ### HTTP request headers 171 172 - **Content-Type**: application/json 173 - **Accept**: application/json 174 175 [[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) 176 177 # **GetCharactersCharacterIdContactsLabels** 178 > []GetCharactersCharacterIdContactsLabels200Ok GetCharactersCharacterIdContactsLabels(ctx, characterId, optional) 179 Get contact labels 180 181 Return custom labels for a character's contacts --- This route is cached for up to 300 seconds 182 183 ### Required Parameters 184 185 Name | Type | Description | Notes 186 ------------- | ------------- | ------------- | ------------- 187 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 188 **characterId** | **int32**| An EVE character ID | 189 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 190 191 ### Optional Parameters 192 Optional parameters are passed through a map[string]interface{}. 193 194 Name | Type | Description | Notes 195 ------------- | ------------- | ------------- | ------------- 196 **characterId** | **int32**| An EVE character ID | 197 **datasource** | **string**| The server name you would like data from | [default to tranquility] 198 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 199 **token** | **string**| Access token to use if unable to set a header | 200 201 ### Return type 202 203 [**[]GetCharactersCharacterIdContactsLabels200Ok**](get_characters_character_id_contacts_labels_200_ok.md) 204 205 ### Authorization 206 207 [evesso](../README.md#evesso) 208 209 ### HTTP request headers 210 211 - **Content-Type**: application/json 212 - **Accept**: application/json 213 214 [[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) 215 216 # **GetCorporationsCorporationIdContacts** 217 > []GetCorporationsCorporationIdContacts200Ok GetCorporationsCorporationIdContacts(ctx, corporationId, optional) 218 Get corporation contacts 219 220 Return contacts of a corporation --- This route is cached for up to 300 seconds 221 222 ### Required Parameters 223 224 Name | Type | Description | Notes 225 ------------- | ------------- | ------------- | ------------- 226 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 227 **corporationId** | **int32**| An EVE corporation ID | 228 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 229 230 ### Optional Parameters 231 Optional parameters are passed through a map[string]interface{}. 232 233 Name | Type | Description | Notes 234 ------------- | ------------- | ------------- | ------------- 235 **corporationId** | **int32**| An EVE corporation ID | 236 **datasource** | **string**| The server name you would like data from | [default to tranquility] 237 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 238 **page** | **int32**| Which page of results to return | [default to 1] 239 **token** | **string**| Access token to use if unable to set a header | 240 241 ### Return type 242 243 [**[]GetCorporationsCorporationIdContacts200Ok**](get_corporations_corporation_id_contacts_200_ok.md) 244 245 ### Authorization 246 247 [evesso](../README.md#evesso) 248 249 ### HTTP request headers 250 251 - **Content-Type**: application/json 252 - **Accept**: application/json 253 254 [[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) 255 256 # **GetCorporationsCorporationIdContactsLabels** 257 > []GetCorporationsCorporationIdContactsLabels200Ok GetCorporationsCorporationIdContactsLabels(ctx, corporationId, optional) 258 Get corporation contact labels 259 260 Return custom labels for a corporation's contacts --- This route is cached for up to 300 seconds 261 262 ### Required Parameters 263 264 Name | Type | Description | Notes 265 ------------- | ------------- | ------------- | ------------- 266 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 267 **corporationId** | **int32**| An EVE corporation ID | 268 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 269 270 ### Optional Parameters 271 Optional parameters are passed through a map[string]interface{}. 272 273 Name | Type | Description | Notes 274 ------------- | ------------- | ------------- | ------------- 275 **corporationId** | **int32**| An EVE corporation ID | 276 **datasource** | **string**| The server name you would like data from | [default to tranquility] 277 **ifNoneMatch** | **string**| ETag from a previous request. A 304 will be returned if this matches the current ETag | 278 **token** | **string**| Access token to use if unable to set a header | 279 280 ### Return type 281 282 [**[]GetCorporationsCorporationIdContactsLabels200Ok**](get_corporations_corporation_id_contacts_labels_200_ok.md) 283 284 ### Authorization 285 286 [evesso](../README.md#evesso) 287 288 ### HTTP request headers 289 290 - **Content-Type**: application/json 291 - **Accept**: application/json 292 293 [[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) 294 295 # **PostCharactersCharacterIdContacts** 296 > []int32 PostCharactersCharacterIdContacts(ctx, characterId, contactIds, standing, optional) 297 Add contacts 298 299 Bulk add contacts with same settings --- 300 301 ### Required Parameters 302 303 Name | Type | Description | Notes 304 ------------- | ------------- | ------------- | ------------- 305 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 306 **characterId** | **int32**| An EVE character ID | 307 **contactIds** | **[]int32**| A list of contacts | 308 **standing** | **float32**| Standing for the contact | 309 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 310 311 ### Optional Parameters 312 Optional parameters are passed through a map[string]interface{}. 313 314 Name | Type | Description | Notes 315 ------------- | ------------- | ------------- | ------------- 316 **characterId** | **int32**| An EVE character ID | 317 **contactIds** | **[]int32**| A list of contacts | 318 **standing** | **float32**| Standing for the contact | 319 **datasource** | **string**| The server name you would like data from | [default to tranquility] 320 **labelIds** | [**[]int64**](int64.md)| Add custom labels to the new contact | 321 **token** | **string**| Access token to use if unable to set a header | 322 **watched** | **bool**| Whether the contact should be watched, note this is only effective on characters | [default to false] 323 324 ### Return type 325 326 **[]int32** 327 328 ### Authorization 329 330 [evesso](../README.md#evesso) 331 332 ### HTTP request headers 333 334 - **Content-Type**: application/json 335 - **Accept**: application/json 336 337 [[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) 338 339 # **PutCharactersCharacterIdContacts** 340 > PutCharactersCharacterIdContacts(ctx, characterId, contactIds, standing, optional) 341 Edit contacts 342 343 Bulk edit contacts with same settings --- 344 345 ### Required Parameters 346 347 Name | Type | Description | Notes 348 ------------- | ------------- | ------------- | ------------- 349 **ctx** | **context.Context** | pass through context (authentication, logging, tracing) 350 **characterId** | **int32**| An EVE character ID | 351 **contactIds** | **[]int32**| A list of contacts | 352 **standing** | **float32**| Standing for the contact | 353 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters 354 355 ### Optional Parameters 356 Optional parameters are passed through a map[string]interface{}. 357 358 Name | Type | Description | Notes 359 ------------- | ------------- | ------------- | ------------- 360 **characterId** | **int32**| An EVE character ID | 361 **contactIds** | **[]int32**| A list of contacts | 362 **standing** | **float32**| Standing for the contact | 363 **datasource** | **string**| The server name you would like data from | [default to tranquility] 364 **labelIds** | [**[]int64**](int64.md)| Add custom labels to the contact | 365 **token** | **string**| Access token to use if unable to set a header | 366 **watched** | **bool**| Whether the contact should be watched, note this is only effective on characters | [default to false] 367 368 ### Return type 369 370 (empty response body) 371 372 ### Authorization 373 374 [evesso](../README.md#evesso) 375 376 ### HTTP request headers 377 378 - **Content-Type**: application/json 379 - **Accept**: application/json 380 381 [[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) 382