eve-esi-client-ts 1.0.1

package/docs/ClonesApi.md

@@ -0,0 +1,145 @@
+# ClonesApi
+
+All URIs are relative to *https://esi.evetech.net/latest*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getCharactersCharacterIdClones**](#getcharacterscharacteridclones) | **GET** /characters/{character_id}/clones/ | Get clones|
+|[**getCharactersCharacterIdImplants**](#getcharacterscharacteridimplants) | **GET** /characters/{character_id}/implants/ | Get active implants|
+
+# **getCharactersCharacterIdClones**
+> GetCharactersCharacterIdClonesOk getCharactersCharacterIdClones()
+
+A list of the character\'s clones  --- Alternate route: `/dev/characters/{character_id}/clones/`  Alternate route: `/legacy/characters/{character_id}/clones/`  Alternate route: `/v2/characters/{character_id}/clones/`  Alternate route: `/v3/characters/{character_id}/clones/`  Alternate route: `/v4/characters/{character_id}/clones/`  --- This route is cached for up to 120 seconds
+
+### Example
+
+```typescript
+import {
+    ClonesApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ClonesApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdClones(
+    characterId,
+    datasource,
+    ifNoneMatch,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetCharactersCharacterIdClonesOk**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Clone information for the given character |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+
+# **getCharactersCharacterIdImplants**
+> Array<number> getCharactersCharacterIdImplants()
+
+Return implants on the active clone of a character  --- Alternate route: `/dev/characters/{character_id}/implants/`  Alternate route: `/legacy/characters/{character_id}/implants/`  Alternate route: `/v1/characters/{character_id}/implants/`  Alternate route: `/v2/characters/{character_id}/implants/`  --- This route is cached for up to 120 seconds
+
+### Example
+
+```typescript
+import {
+    ClonesApi,
+    Configuration
+} from 'eve-esi-client-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ClonesApi(configuration);
+
+let characterId: number; //An EVE character ID (default to undefined)
+let datasource: 'tranquility'; //The server name you would like data from (optional) (default to 'tranquility')
+let ifNoneMatch: string; //ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) (default to undefined)
+let token: string; //Access token to use if unable to set a header (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getCharactersCharacterIdImplants(
+    characterId,
+    datasource,
+    ifNoneMatch,
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | [**number**] | An EVE character ID | defaults to undefined|
+| **datasource** | [**&#39;tranquility&#39;**]**Array<&#39;tranquility&#39;>** | The server name you would like data from | (optional) defaults to 'tranquility'|
+| **ifNoneMatch** | [**string**] | ETag from a previous request. A 304 will be returned if this matches the current ETag | (optional) defaults to undefined|
+| **token** | [**string**] | Access token to use if unable to set a header | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<number>**
+
+### Authorization
+
+[evesso](../README.md#evesso)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | A list of implant type ids |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**304** | Not modified |  * Cache-Control - The caching mechanism used <br>  * ETag - RFC7232 compliant entity tag <br>  * Expires - RFC7231 formatted datetime string <br>  * Last-Modified - RFC7231 formatted datetime string <br>  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**403** | Forbidden |  -  |
+|**420** | Error limited |  -  |
+|**500** | Internal server error |  -  |
+|**503** | Service unavailable |  -  |
+|**504** | Gateway timeout |  -  |
+
+[[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)
+