esisl_genoa_client 0.1.0

package/docs/CalendarApi.md

@@ -0,0 +1,363 @@
+# CalendarApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getCharactersCharacterIdCalendar**](CalendarApi.md#getcharacterscharacteridcalendar) | **GET** /characters/{character_id}/calendar | List calendar event summaries |
+| [**getCharactersCharacterIdCalendarEventId**](CalendarApi.md#getcharacterscharacteridcalendareventid) | **GET** /characters/{character_id}/calendar/{event_id} | Get an event |
+| [**getCharactersCharacterIdCalendarEventIdAttendees**](CalendarApi.md#getcharacterscharacteridcalendareventidattendees) | **GET** /characters/{character_id}/calendar/{event_id}/attendees | Get attendees |
+| [**putCharactersCharacterIdCalendarEventId**](CalendarApi.md#putcharacterscharacteridcalendareventidoperation) | **PUT** /characters/{character_id}/calendar/{event_id} | Respond to an event |
+
+
+
+## getCharactersCharacterIdCalendar
+
+> Array<CharactersCharacterIdCalendarGetInner> getCharactersCharacterIdCalendar(characterId, xCompatibilityDate, fromEvent, acceptLanguage, ifNoneMatch, xTenant)
+
+List calendar event summaries
+
+Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CalendarApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdCalendarRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new CalendarApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // number (optional)
+    fromEvent: 789,
+    // 'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es' | The language to use for the response. (optional)
+    acceptLanguage: acceptLanguage_example,
+    // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag. (optional)
+    ifNoneMatch: ifNoneMatch_example,
+    // string | The tenant ID for the request. (optional)
+    xTenant: ,
+  } satisfies GetCharactersCharacterIdCalendarRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdCalendar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [Defaults to `undefined`] |
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **fromEvent** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **acceptLanguage** | `en`, `de`, `fr`, `ja`, `ru`, `zh`, `ko`, `es` | The language to use for the response. | [Optional] [Defaults to `'en'`] [Enum: en, de, fr, ja, ru, zh, ko, es] |
+| **ifNoneMatch** | `string` | The ETag of the previous request. A 304 will be returned if this matches the current ETag. | [Optional] [Defaults to `undefined`] |
+| **xTenant** | `string` | The tenant ID for the request. | [Optional] [Defaults to `'tranquility'`] |
+
+### Return type
+
+[**Array<CharactersCharacterIdCalendarGetInner>**](CharactersCharacterIdCalendarGetInner.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  * Cache-Control -  <br>  * ETag -  <br>  * Last-Modified -  <br>  |
+| **0** | Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCharactersCharacterIdCalendarEventId
+
+> CharactersCharacterIdCalendarEventIdGet getCharactersCharacterIdCalendarEventId(characterId, eventId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get an event
+
+Get all the information for a specific event
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CalendarApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdCalendarEventIdRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new CalendarApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 789,
+    // number
+    eventId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // 'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es' | The language to use for the response. (optional)
+    acceptLanguage: acceptLanguage_example,
+    // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag. (optional)
+    ifNoneMatch: ifNoneMatch_example,
+    // string | The tenant ID for the request. (optional)
+    xTenant: ,
+  } satisfies GetCharactersCharacterIdCalendarEventIdRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdCalendarEventId(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [Defaults to `undefined`] |
+| **eventId** | `number` |  | [Defaults to `undefined`] |
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **acceptLanguage** | `en`, `de`, `fr`, `ja`, `ru`, `zh`, `ko`, `es` | The language to use for the response. | [Optional] [Defaults to `&#39;en&#39;`] [Enum: en, de, fr, ja, ru, zh, ko, es] |
+| **ifNoneMatch** | `string` | The ETag of the previous request. A 304 will be returned if this matches the current ETag. | [Optional] [Defaults to `undefined`] |
+| **xTenant** | `string` | The tenant ID for the request. | [Optional] [Defaults to `&#39;tranquility&#39;`] |
+
+### Return type
+
+[**CharactersCharacterIdCalendarEventIdGet**](CharactersCharacterIdCalendarEventIdGet.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  * Cache-Control -  <br>  * ETag -  <br>  * Last-Modified -  <br>  |
+| **0** | Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCharactersCharacterIdCalendarEventIdAttendees
+
+> Array&lt;CharactersCharacterIdCalendarEventIdAttendeesGetInner&gt; getCharactersCharacterIdCalendarEventIdAttendees(characterId, eventId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get attendees
+
+Get all invited attendees for a given event
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CalendarApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdCalendarEventIdAttendeesRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new CalendarApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 789,
+    // number
+    eventId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // 'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es' | The language to use for the response. (optional)
+    acceptLanguage: acceptLanguage_example,
+    // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag. (optional)
+    ifNoneMatch: ifNoneMatch_example,
+    // string | The tenant ID for the request. (optional)
+    xTenant: ,
+  } satisfies GetCharactersCharacterIdCalendarEventIdAttendeesRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdCalendarEventIdAttendees(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [Defaults to `undefined`] |
+| **eventId** | `number` |  | [Defaults to `undefined`] |
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **acceptLanguage** | `en`, `de`, `fr`, `ja`, `ru`, `zh`, `ko`, `es` | The language to use for the response. | [Optional] [Defaults to `&#39;en&#39;`] [Enum: en, de, fr, ja, ru, zh, ko, es] |
+| **ifNoneMatch** | `string` | The ETag of the previous request. A 304 will be returned if this matches the current ETag. | [Optional] [Defaults to `undefined`] |
+| **xTenant** | `string` | The tenant ID for the request. | [Optional] [Defaults to `&#39;tranquility&#39;`] |
+
+### Return type
+
+[**Array&lt;CharactersCharacterIdCalendarEventIdAttendeesGetInner&gt;**](CharactersCharacterIdCalendarEventIdAttendeesGetInner.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  * Cache-Control -  <br>  * ETag -  <br>  * Last-Modified -  <br>  |
+| **0** | Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putCharactersCharacterIdCalendarEventId
+
+> putCharactersCharacterIdCalendarEventId(characterId, eventId, xCompatibilityDate, putCharactersCharacterIdCalendarEventIdRequest, acceptLanguage, ifNoneMatch, xTenant)
+
+Respond to an event
+
+Set your response status to an event
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CalendarApi,
+} from 'esisl_genoa_client';
+import type { PutCharactersCharacterIdCalendarEventIdOperationRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new CalendarApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 789,
+    // number
+    eventId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // PutCharactersCharacterIdCalendarEventIdRequest
+    putCharactersCharacterIdCalendarEventIdRequest: ...,
+    // 'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es' | The language to use for the response. (optional)
+    acceptLanguage: acceptLanguage_example,
+    // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag. (optional)
+    ifNoneMatch: ifNoneMatch_example,
+    // string | The tenant ID for the request. (optional)
+    xTenant: ,
+  } satisfies PutCharactersCharacterIdCalendarEventIdOperationRequest;
+
+  try {
+    const data = await api.putCharactersCharacterIdCalendarEventId(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [Defaults to `undefined`] |
+| **eventId** | `number` |  | [Defaults to `undefined`] |
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **putCharactersCharacterIdCalendarEventIdRequest** | [PutCharactersCharacterIdCalendarEventIdRequest](PutCharactersCharacterIdCalendarEventIdRequest.md) |  | |
+| **acceptLanguage** | `en`, `de`, `fr`, `ja`, `ru`, `zh`, `ko`, `es` | The language to use for the response. | [Optional] [Defaults to `&#39;en&#39;`] [Enum: en, de, fr, ja, ru, zh, ko, es] |
+| **ifNoneMatch** | `string` | The ETag of the previous request. A 304 will be returned if this matches the current ETag. | [Optional] [Defaults to `undefined`] |
+| **xTenant** | `string` | The tenant ID for the request. | [Optional] [Defaults to `&#39;tranquility&#39;`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Event updated |  * Cache-Control -  <br>  * ETag -  <br>  * Last-Modified -  <br>  |
+| **0** | Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+