Something went wrong. Try again.
TypeScript client for accessing TLE Community.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267import type { components } from './schema';
export type MessageTag = | 'Alert' | 'Alliance' | 'Attack' | 'Colonization' | 'Complaint' | 'Correspondence' | 'Excavator' | 'Intelligence' | 'Medal' | 'Mission' | 'Parliament' | 'Probe' | 'Spies' | 'Trade' | 'Tutorial';
export interface ViewInboxParams { options?: { page_number?: number; tags?: Array<MessageTag>; empire?: string; };}
export interface ViewInboxResponse { messages: Array<{ id: number; subject: string; date: string; from: string; from_id: number; to: string; to_id: number; has_read: 1 | 0; has_replied: 1 | 0; body_preview: string; tags: MessageTag[]; }>; message_count: number; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface ViewArchivedParams { options?: { page_number?: number; tags?: Array<MessageTag>; empire?: string; };}
export interface ViewArchivedResponse { messages: Array<{ id: number; subject: string; date: string; from: string; from_id: number; to: string; to_id: number; has_read: 1 | 0; has_replied: 1 | 0; body_preview: string; tags: MessageTag[]; }>; message_count: number; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface ViewTrashedParams { options?: { page_number?: number; tags?: Array<MessageTag>; empire?: string; };}
export interface ViewTrashedResponse { messages: Array<{ id: number; subject: string; date: string; from: string; from_id: number; to: string; to_id: number; has_read: 1 | 0; has_replied: 1 | 0; body_preview: string; tags: MessageTag[]; }>; message_count: number; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface ViewSentParams { options?: { page_number?: number; tags?: Array<MessageTag>; empire?: string; };}
export interface ViewSentResponse { messages: Array<{ id: number; subject: string; date: string; from: string; from_id: number; to: string; to_id: number; has_read: 1 | 0; has_replied: 1 | 0; body_preview: string; tags: MessageTag[]; }>; message_count: number; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface ViewUnreadParams { options?: { page_number?: number; tags?: Array<MessageTag>; empire?: string; };}
export interface ViewUnreadResponse { messages: Array<{ id: number; subject: string; date: string; from: string; from_id: number; to: string; to_id: number; has_read: 1 | 0; has_replied: 1 | 0; body_preview: string; tags: MessageTag[]; }>; message_count: number; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface ReadMessageParams { message_id: number;}
export interface ReadMessageResponse { message: { id: number; from: string; from_id: number; to: string; to_id: number; subject: string; body: string; date: string; has_read: 1 | 0; has_replied: 1 | 0; has_archived: 1 | 0; has_trashed: 1 | 0; in_reply_to: string; recipients: Array<string>; tags: Array<MessageTag>; attachments?: { image?: { url: string; title: string; link?: string }; link?: { url: string; label: string }; table?: Array<Array<string>>; map?: { surface: string; buildings: Array<{ x: number; y: number; image: string }> }; }; }; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface ArchiveMessagesParams { message_ids: Array<number>;}
export interface ArchiveMessagesResponse { success: Array<string>; failure: Array<string>; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface TrashMessagesParams { message_ids: Array<number>;}
export interface TrashMessagesResponse { success: Array<string>; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface TrashMessagesWhereParams { spec: Array<{ tags?: Array<MessageTag>; subject?: string | Array<string>; from?: Array<string>; }>; /** Gather the trashed message ids into `deleted`. Off by default. */ save_ids?: boolean;}
export interface TrashMessagesWhereResponse { /** Only present when `save_ids` is true. */ deleted?: Array<number>; deleted_count: number; status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}
export interface SendMessageParams { recipients: string; subject: string; body: string; options?: { in_reply_to?: string; forward?: string };}
export interface SendMessageResponse { status: { server: components['schemas']['server_status']; empire?: components['schemas']['empire_status']; body?: components['schemas']['body_status']; };}