@beepbox.net/gofetch-client 0.2.5 → 0.2.6

package/dist/index.d.ts

@@ -12,8 +12,30 @@ export type ReqOpts = { headers?: Record<string, string> }
 
 export type GofetchFetcher = { raw: GofetchClient; beep: { list: (query?: QueryOf<((options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: { [x: string]: unknown; } | undefined; query?: { songType?: (SongType) | undefined; state?: (BeepState) | undefined; userId?: string | undefined; platformId?: string | undefined; limit?: string | number | undefined; sort?: string | undefined; cursor?: string | false | undefined; isGuided?: boolean | "false" | "true" | undefined; expand?: (BeepExpandOption) | (BeepExpandOption)[] | undefined; } | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; get: (id: string, query?: QueryOf<BeepItem["get"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; description: string; isGuided: boolean; songType: (SongType); state: (BeepState); albumArt?: string | undefined; url?: string | undefined; shortUrl?: string | undefined; authors?: string[] | undefined; platforms?: string[] | undefined; links?: string[] | undefined; forks?: string[] | undefined; forkedFrom?: string[] | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; forks: (id: string, query?: QueryOf<BeepItem["forks"]["get"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: (string | { id: string; title: string; description: string; isGuided: boolean; songType: (SongType); state: (BeepState); albumArt?: string | undefined; url?: string | undefined; shortUrl?: string | undefined; authors?: string[] | undefined; platforms?: string[] | undefined; links?: string[] | undefined; forks?: string[] | undefined; forkedFrom?: string[] | undefined; })[]; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; original: (id: string, query?: QueryOf<BeepItem["original"]["get"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: string | { id: string; title: string; description: string; isGuided: boolean; songType: (SongType); state: (BeepState); albumArt?: string | undefined; url?: string | undefined; shortUrl?: string | undefined; authors?: string[] | undefined; platforms?: string[] | undefined; links?: string[] | undefined; forks?: string[] | undefined; forkedFrom?: string[] | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; authors: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; create: (body: BodyOf<((body: { title: string; description: string; url: string; isGuided: boolean | "false" | "true"; songType: (SongType); state: (BeepState); shortUrl?: string | undefined; albumArt?: string | undefined; basedOn?: string | undefined; madeIn?: string | undefined; sources?: string[] | undefined; }, options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: { [x: string]: unknown; } | undefined; query?: { [x: string]: unknown; } | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; description: string; url: string; isGuided: boolean; songType: (SongType); state: (BeepState); shortUrl?: string | undefined; albumArt?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; description: string; url: string; isGuided: boolean; songType: (SongType); state: (BeepState); shortUrl?: string | undefined; albumArt?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<BeepItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; description: string; url: string; isGuided: boolean; songType: (SongType); state: (BeepState); shortUrl?: string | undefined; albumArt?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; delete: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; event: { list: (query?: QueryOf<((options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: {} | undefined; query?: { state?: (EventState) | (EventState)[] | undefined; hostId?: string | undefined; startAfter?: string | Date | undefined; startBefore?: string | Date | undefined; limit?: string | number | undefined; sort?: string | undefined; cursor?: string | false | undefined; expand?: (EventExpandOption) | (EventExpandOption)[] | undefined; } | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; get: (id: string, query?: QueryOf<EventItem["get"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; state: (EventState); config: { allowSelfRegistration: boolean; allowPostStartRegistration: boolean; visibility: (EventVisibility); maxParticipants?: number | undefined; }; startDate?: Date | (DateTime) | null | undefined; endDate?: Date | (DateTime) | null | undefined; hosts?: string[] | undefined; participants?: string[] | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; create: (body: BodyOf<((body: { title: string; startDate?: string | Date | { equals: {}; toJSON: {}; toString: {}; toCompact: {}; toISOString: {}; toDate: {}; add: {}; sub: {}; diff: {}; compare: {}; readonly nanoseconds: string | bigint; readonly microseconds: string | bigint; readonly milliseconds: string | number; readonly seconds: string | number; } | null | undefined; endDate?: string | Date | { equals: {}; toJSON: {}; toString: {}; toCompact: {}; toISOString: {}; toDate: {}; add: {}; sub: {}; diff: {}; compare: {}; readonly nanoseconds: string | bigint; readonly microseconds: string | bigint; readonly milliseconds: string | number; readonly seconds: string | number; } | null | undefined; hostedBy: string[]; config?: { allowSelfRegistration: boolean | "false" | "true"; allowPostStartRegistration: boolean | "false" | "true"; visibility: (EventVisibility); maxParticipants?: string | number | undefined; } | undefined; state?: (EventState) | undefined; }, options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: {} | undefined; query?: {} | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; state: (EventState); config: { allowSelfRegistration: boolean; allowPostStartRegistration: boolean; visibility: (EventVisibility); maxParticipants?: number | undefined; }; startDate?: Date | (DateTime) | null | undefined; endDate?: Date | (DateTime) | null | undefined; hosts?: string[] | undefined; participants?: string[] | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; state: (EventState); config: { allowSelfRegistration: boolean; allowPostStartRegistration: boolean; visibility: (EventVisibility); maxParticipants?: number | undefined; }; startDate?: Date | (DateTime) | null | undefined; endDate?: Date | (DateTime) | null | undefined; hosts?: string[] | undefined; participants?: string[] | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<EventItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; delete: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; hosts: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; addHosts: (id: string, body: BodyOf<EventItem["hosts"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; removeHost: (id: string, userId: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; participants: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; addParticipants: (id: string, body: BodyOf<EventItem["participants"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; removeParticipant: (id: string, userId: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: unknown; }>>; join: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; participantId: string; eventId: string; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; leave: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; openRegistration: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; start: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; close: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; archive: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; }; platform: { list: (query?: QueryOf<((options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: { [x: string]: unknown; } | undefined; query?: { limit?: string | number | undefined; sort?: string | undefined; cursor?: string | false | undefined; expand?: (PlatformExpandOption) | (PlatformExpandOption)[] | undefined; } | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; get: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; name: string; description: string; url: string; alternateVersions: { url: string; name: string; }[]; logo?: string | undefined; wikiUrl?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; beeps: (id: string, query?: QueryOf<PlatformItem["beeps"]["get"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; tree: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; name: string; description: string; url: string; alternateVersions: { url: string; name: string; }[]; forks: any[]; logo?: string | undefined; wikiUrl?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; create: (body: BodyOf<((body: { name: string; description: string; url: string; alternateVersions: { url: string; name: string; }[]; logo?: string | undefined; wikiUrl?: string | undefined; forks?: string[] | undefined; }, options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: {} | undefined; query?: {} | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { id: string; name: string; description: string; url: string; alternateVersions: { url: string; name: string; }[]; logo?: string | undefined; wikiUrl?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; name: string; description: string; url: string; alternateVersions: { url: string; name: string; }[]; logo?: string | undefined; wikiUrl?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<PlatformItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; name: string; description: string; url: string; alternateVersions: { url: string; name: string; }[]; logo?: string | undefined; wikiUrl?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; source: { list: (query?: QueryOf<((options: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: { [x: string]: unknown; } | undefined; query: { type: SourceType.YOUTUBE | SourceType.YT_MUSIC | SourceType.SOUND_CLOUD | SourceType.SPOTIFY | SourceType.APPLE_MUSIC | SourceType.FILE_GARDEN | SourceType.NEWGROUNDS | SourceType.BANDCAMP; limit?: string | number | undefined; sort?: string | undefined; cursor?: string | false | undefined; } | { type: SourceType.OTHER; label: string; limit?: string | number | undefined; sort?: string | undefined; cursor?: string | false | undefined; }; }) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; get: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; type: SourceType.YOUTUBE | SourceType.YT_MUSIC | SourceType.SOUND_CLOUD | SourceType.SPOTIFY | SourceType.APPLE_MUSIC | SourceType.FILE_GARDEN | SourceType.NEWGROUNDS | SourceType.BANDCAMP; url: string; } | { id: string; type: SourceType.OTHER; label: string; url: string; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; beeps: (id: string, query?: QueryOf<SourceItem["beeps"]["get"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; create: (body: BodyOf<((body: { type: SourceType.YOUTUBE | SourceType.YT_MUSIC | SourceType.SOUND_CLOUD | SourceType.SPOTIFY | SourceType.APPLE_MUSIC | SourceType.FILE_GARDEN | SourceType.NEWGROUNDS | SourceType.BANDCAMP; url: string; } | { type: SourceType.OTHER; label: string; url: string; }, options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: { [x: string]: unknown; } | undefined; query?: { [x: string]: unknown; } | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { id: string; type: SourceType.YOUTUBE | SourceType.YT_MUSIC | SourceType.SOUND_CLOUD | SourceType.SPOTIFY | SourceType.APPLE_MUSIC | SourceType.FILE_GARDEN | SourceType.NEWGROUNDS | SourceType.BANDCAMP; url: string; } | { id: string; type: SourceType.OTHER; label: string; url: string; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; type: SourceType.YOUTUBE | SourceType.YT_MUSIC | SourceType.SOUND_CLOUD | SourceType.SPOTIFY | SourceType.APPLE_MUSIC | SourceType.FILE_GARDEN | SourceType.NEWGROUNDS | SourceType.BANDCAMP; url: string; } | { id: string; type: SourceType.OTHER; label: string; url: string; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<SourceItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; type: SourceType.YOUTUBE | SourceType.YT_MUSIC | SourceType.SOUND_CLOUD | SourceType.SPOTIFY | SourceType.APPLE_MUSIC | SourceType.FILE_GARDEN | SourceType.NEWGROUNDS | SourceType.BANDCAMP; url: string; } | { id: string; type: SourceType.OTHER; label: string; url: string; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; delete: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; forum: { listForEvent: (eventId: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; createForEvent: (eventId: string, body: BodyOf<ForumEventItem["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; forumData: ({ key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; })[]; submissionFields: ({ key: string; required: boolean; label?: string | undefined; type: FieldType.TEXT; config?: { minLength?: number | undefined; maxLength?: number | undefined; pattern?: string | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.INT | FieldType.FLOAT; config?: { min?: number | undefined; max?: number | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.URL; config?: { allowedDomains?: string[] | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.USER | FieldType.BEEP | FieldType.BOOLEAN; config?: Map<unknown, unknown> | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.CHOICE; config?: { options: string[]; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.DATE; config?: { min?: Date | undefined; max?: Date | undefined; } | undefined; })[]; archived: boolean; submissionsOpen: boolean; submissionsPublic: boolean; scoresOpen: boolean; scoresPublic: boolean; scoringConfig?: { fields: ({ key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.NUMBER; config: { min: number; max: number; }; } | { key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.ENUM; options: { label: string; value: number; }[]; })[]; overallNoteConfig: (NoteConfig); aggregationMethod: (AggregationMethod); skippedBehavior: (SkippedBehavior); } | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; get: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; forumData: ({ key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; })[]; submissionFields: ({ key: string; required: boolean; label?: string | undefined; type: FieldType.TEXT; config?: { minLength?: number | undefined; maxLength?: number | undefined; pattern?: string | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.INT | FieldType.FLOAT; config?: { min?: number | undefined; max?: number | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.URL; config?: { allowedDomains?: string[] | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.USER | FieldType.BEEP | FieldType.BOOLEAN; config?: Map<unknown, unknown> | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.CHOICE; config?: { options: string[]; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.DATE; config?: { min?: Date | undefined; max?: Date | undefined; } | undefined; })[]; archived: boolean; submissionsOpen: boolean; submissionsPublic: boolean; scoresOpen: boolean; scoresPublic: boolean; scoringConfig?: { fields: ({ key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.NUMBER; config: { min: number; max: number; }; } | { key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.ENUM; options: { label: string; value: number; }[]; })[]; overallNoteConfig: (NoteConfig); aggregationMethod: (AggregationMethod); skippedBehavior: (SkippedBehavior); } | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<ForumItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; forumData: ({ key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; })[]; submissionFields: ({ key: string; required: boolean; label?: string | undefined; type: FieldType.TEXT; config?: { minLength?: number | undefined; maxLength?: number | undefined; pattern?: string | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.INT | FieldType.FLOAT; config?: { min?: number | undefined; max?: number | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.URL; config?: { allowedDomains?: string[] | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.USER | FieldType.BEEP | FieldType.BOOLEAN; config?: Map<unknown, unknown> | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.CHOICE; config?: { options: string[]; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.DATE; config?: { min?: Date | undefined; max?: Date | undefined; } | undefined; })[]; archived: boolean; submissionsOpen: boolean; submissionsPublic: boolean; scoresOpen: boolean; scoresPublic: boolean; scoringConfig?: { fields: ({ key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.NUMBER; config: { min: number; max: number; }; } | { key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.ENUM; options: { label: string; value: number; }[]; })[]; overallNoteConfig: (NoteConfig); aggregationMethod: (AggregationMethod); skippedBehavior: (SkippedBehavior); } | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; delete: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; archive: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; forumData: ({ key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; })[]; submissionFields: ({ key: string; required: boolean; label?: string | undefined; type: FieldType.TEXT; config?: { minLength?: number | undefined; maxLength?: number | undefined; pattern?: string | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.INT | FieldType.FLOAT; config?: { min?: number | undefined; max?: number | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.URL; config?: { allowedDomains?: string[] | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.USER | FieldType.BEEP | FieldType.BOOLEAN; config?: Map<unknown, unknown> | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.CHOICE; config?: { options: string[]; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.DATE; config?: { min?: Date | undefined; max?: Date | undefined; } | undefined; })[]; archived: boolean; submissionsOpen: boolean; submissionsPublic: boolean; scoresOpen: boolean; scoresPublic: boolean; scoringConfig?: { fields: ({ key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.NUMBER; config: { min: number; max: number; }; } | { key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.ENUM; options: { label: string; value: number; }[]; })[]; overallNoteConfig: (NoteConfig); aggregationMethod: (AggregationMethod); skippedBehavior: (SkippedBehavior); } | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; unarchive: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; title: string; forumData: ({ key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; } | { key: string; type: FieldType.TEXT | FieldType.USER | FieldType.BEEP; value: string; } | { key: string; type: FieldType.INT | FieldType.FLOAT; value: number; } | { key: string; type: FieldType.URL; value: string; } | { key: string; type: FieldType.BOOLEAN; value: boolean; } | { key: string; type: FieldType.DATE; value: Date; })[]; submissionFields: ({ key: string; required: boolean; label?: string | undefined; type: FieldType.TEXT; config?: { minLength?: number | undefined; maxLength?: number | undefined; pattern?: string | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.INT | FieldType.FLOAT; config?: { min?: number | undefined; max?: number | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.URL; config?: { allowedDomains?: string[] | undefined; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.USER | FieldType.BEEP | FieldType.BOOLEAN; config?: Map<unknown, unknown> | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.CHOICE; config?: { options: string[]; } | undefined; } | { key: string; required: boolean; label?: string | undefined; type: FieldType.DATE; config?: { min?: Date | undefined; max?: Date | undefined; } | undefined; })[]; archived: boolean; submissionsOpen: boolean; submissionsPublic: boolean; scoresOpen: boolean; scoresPublic: boolean; scoringConfig?: { fields: ({ key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.NUMBER; config: { min: number; max: number; }; } | { key: string; required: boolean; label?: string | undefined; weight: number; noteConfig: (NoteConfig); inputType: ScoreComponentType.ENUM; options: { label: string; value: number; }[]; })[]; overallNoteConfig: (NoteConfig); aggregationMethod: (AggregationMethod); skippedBehavior: (SkippedBehavior); } | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; submission: { listForForum: (forumId: string, query?: QueryOf<SubForumItem["get"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; createForForum: (forumId: string, body: BodyOf<SubForumItem["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; state: (SubmissionState); fieldValues: { [x: string]: string | number | boolean | Date; }; url?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; get: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; state: (SubmissionState); fieldValues: { [x: string]: string | number | boolean | Date; }; url?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<SubItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; state: (SubmissionState); fieldValues: { [x: string]: string | number | boolean | Date; }; url?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; delete: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; setState: (id: string, body: BodyOf<SubItem["state"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; state: (SubmissionState); fieldValues: { [x: string]: string | number | boolean | Date; }; url?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; myScore: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; judgeId: string; overallNote?: string | undefined; components: { [x: string]: { value: number; note?: string | undefined; }; }; } | null; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; computeScore: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { raw: number; adjusted: number; groups: { id: string; name: string; weight: number; judgeScores: { judge: string; total: number; dropped: boolean; }[]; average?: number | undefined; }[]; adjustments: { id: string; value: number; type: (ScoreAdjustmentType); reason?: string | undefined; }[]; meta: { droppedWorst: number; missingJudges: { name: string; group: string; }[]; }; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; scores: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; submitScore: (id: string, body: BodyOf<SubItem["scores"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: RecordId<string, (string | number | bigint | unknown[] | Record<string, unknown> | Uuid)>; in: RecordId<string, (string | number | bigint | unknown[] | Record<string, unknown> | Uuid)>; out: RecordId<string, (string | number | bigint | unknown[] | Record<string, unknown> | Uuid)>; components: { [x: string]: { value: number; note?: string | undefined; }; }; overallNote?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; deleteMyScore: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; adjustments: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; createAdjustment: (id: string, body: BodyOf<SubItem["adjustments"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; value: number; type: (ScoreAdjustmentType); reason?: string | undefined; createdAt?: Date | (DateTime) | null | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; deleteAdjustment: (adjustmentId: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; forBeep: (beepId: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; weightGroup: { listForEvent: (eventId: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; createForEvent: (eventId: string, body: BodyOf<WgEventItem["weightGroup"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; get: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; name: string; weight: number; isDefault: boolean; users?: string[] | undefined; event?: string[] | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<WgItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: any; }>>; delete: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: unknown; }>>; members: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; addMembers: (id: string, body: BodyOf<WgItem["members"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: unknown; }>>; removeMember: (id: string, userId: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ [x: string]: unknown; }>>; }; xp: { list: (query?: QueryOf<((options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: {} | undefined; query?: { source?: string | undefined; sourceType?: "event" | "user" | "submission_forum" | "submission" | undefined; retracted?: boolean | "false" | "true" | undefined; userId?: string | undefined; amountRange?: { min: string | number; max: string | number; } | undefined; limit?: string | number | undefined; sort?: string | undefined; cursor?: string | false | undefined; } | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; mine: (opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; grant: (body: BodyOf<((body: { amount: string | number; reason?: string | undefined; key: string; toUser: string; fromUser: string; } | { amount: string | number; reason?: string | undefined; key: string; toUser: string; fromSubmission: string; } | { amount: string | number; reason?: string | undefined; key: string; toUser: string; fromEvent: string; } | { amount: string | number; reason?: string | undefined; key: string; toUser: string; fromForum: string; }, options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: {} | undefined; query?: {} | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { id: string; amount: number; source: string; retracted: boolean; reason?: string | undefined; retractedReason?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; amount: number; source: string; retracted: boolean; reason?: string | undefined; retractedReason?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; retract: (id: string, body?: BodyOf<XpItem["retract"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; amount: number; source: string; retracted: boolean; reason?: string | undefined; retractedReason?: string | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; user: { me: (opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; avatar: string | null; displayName: string; role: (Role); disabled: boolean; portalAccess: (PortalAccess); }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; list: (query?: QueryOf<((options?: { fetch?: { body?: string | { readonly locked: boolean | "false" | "true"; cancel: {}; getReader: {}; pipeThrough: {}; pipeTo: {}; tee: {}; values: {}; [Symbol.asyncIterator]: {}; } | { append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; } | { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; } | { readonly buffer: { readonly byteLength: string | number; slice: {}; readonly maxByteLength: string | number; readonly resizable: boolean | "false" | "true"; resize: {}; readonly detached: boolean | "false" | "true"; transfer: {}; transferToFixedLength: {}; readonly [Symbol.toStringTag]: "ArrayBuffer"; }; readonly byteLength: string | number; readonly byteOffset: string | number; } | { readonly size: string | number; readonly type: string; arrayBuffer: {}; bytes: {}; slice: {}; stream: {}; text: {}; json: {}; image: {}; formData: {}; } | { readonly size: string | number; append: {}; delete: {}; get: {}; getAll: {}; has: {}; set: {}; sort: {}; toString: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; } | null | undefined; cache?: RequestCache | undefined; credentials?: RequestCredentials | undefined; headers?: string[][] | { [x: string]: string; } | { append: {}; delete: {}; get: {}; getSetCookie: {}; has: {}; set: {}; forEach: {}; entries: {}; keys: {}; values: {}; [Symbol.iterator]: {}; toJSON: {}; readonly count: string | number; getAll: {}; } | undefined; integrity?: string | undefined; keepalive?: boolean | "false" | "true" | undefined; method?: string | undefined; mode?: RequestMode | undefined; priority?: RequestPriority | undefined; redirect?: RequestRedirect | undefined; referrer?: string | undefined; referrerPolicy?: ReferrerPolicy | undefined; signal?: { readonly aborted: boolean | "false" | "true"; onabort: {} | null; readonly reason: any; throwIfAborted: {}; addEventListener: {}; removeEventListener: {}; dispatchEvent: {}; } | null | undefined; window?: null | undefined; } | undefined; throwHttpError?: boolean | "false" | "true" | {} | undefined; headers?: {} | undefined; query?: { displayName?: string | undefined; role?: (Role) | undefined; limit?: string | number | undefined; sort?: string | undefined; cursor?: string | false | undefined; disabled?: boolean | "false" | "true" | undefined; } | undefined; } | undefined) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>) & { '~path': string; }>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { data: unknown[]; nextCursor: string | null; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; get: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; avatar: string | null; displayName: string; role: (Role); disabled: boolean; portalAccess: (PortalAccess); }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; update: (id: string, body: BodyOf<UserItem["patch"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; avatar: string | null; displayName: string; role: (Role); disabled: boolean; portalAccess: (PortalAccess); }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; setRole: (id: string, body: BodyOf<UserItem["role"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; avatar: string | null; displayName: string; role: (Role); disabled: boolean; portalAccess: (PortalAccess); }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; disable: (id: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; avatar: string | null; displayName: string; role: (Role); disabled: boolean; portalAccess: (PortalAccess); }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; setAccess: (id: string, body: BodyOf<UserItem["portal-access"]["post"]>, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { id: string; avatar: string | null; displayName: string; role: (Role); disabled: boolean; portalAccess: (PortalAccess); }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; util: { resolveShortUrl: (url: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { resolvedUrl: string; modName: string; modId: string; steps?: { url: string; via: "redirect" | "meta-refresh" | "canonical" | "body-link"; status?: number | undefined; }[] | undefined; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; resolvePlatform: (url: string, opts?: ReqOpts) => Promise<any.TreatyResponse<{ 200: { platform: { id: string; name: string; description: string; url: string; alternateVersions: { url: string; name: string; }[]; logo?: string | undefined; wikiUrl?: string | undefined; forkedBy: string[]; forks: string[]; }; matchedOn: string; matchedName: string; confidence: "prefix" | "exact"; }; 422: { type: "validation"; on: string; summary?: string; message?: string; found?: unknown; property?: string; expected?: string; }; }>>; }; }
 
+export type OAuthCallbackUser = {
+	id: string
+	displayName: string
+	avatar: string | null
+	role: string
+	disabled: boolean
+	portalAccess: string
+}
+
+export type OAuthCallbackResult =
+	| { ok: true; accessToken: string; user: OAuthCallbackUser }
+	| { ok: false; error: string; errorDescription?: string }
+
 export declare const defaultBaseUrl: string
 
+export declare function buildLoginUrl(options: {
+	baseUrl?: string
+	returnTo: string
+}): string
+
+export declare function parseOAuthCallback(hash?: string): OAuthCallbackResult | null
+
+export declare function clearOAuthCallbackHash(): void
+
 export declare function createClient(options?: {
 	baseUrl?: string
 	token?: string

package/dist/index.js

@@ -151,6 +151,46 @@ function createFetcher(options = {}) {
     util: makeUtil(api)
   };
 }
+// src/auth.ts
+function currentHash() {
+  if (typeof window === "undefined")
+    return "";
+  return window.location.hash;
+}
+function buildLoginUrl(options) {
+  const base = (options.baseUrl ?? defaultBaseUrl).replace(/\/$/, "");
+  const url = new URL(`${base}/v0/auth/discord`);
+  url.searchParams.set("returnTo", options.returnTo);
+  return url.toString();
+}
+function parseOAuthCallback(hash = currentHash()) {
+  const raw = hash.startsWith("#") ? hash.slice(1) : hash;
+  if (!raw)
+    return null;
+  const params = new URLSearchParams(raw);
+  if (params.has("error")) {
+    return {
+      ok: false,
+      error: params.get("error") ?? "unknown",
+      errorDescription: params.get("error_description") ?? undefined
+    };
+  }
+  const accessToken = params.get("accessToken");
+  const userRaw = params.get("user");
+  if (!accessToken || !userRaw)
+    return null;
+  try {
+    const user = JSON.parse(userRaw);
+    return { ok: true, accessToken, user };
+  } catch {
+    return null;
+  }
+}
+function clearOAuthCallbackHash() {
+  if (typeof window === "undefined" || !window.location.hash)
+    return;
+  window.history.replaceState(null, "", window.location.pathname + window.location.search);
+}
 
 // src/runtime.ts
 var defaultBaseUrl = "https://gofetch.blaqat.net";
@@ -161,7 +201,10 @@ function createClient(options = {}) {
 }
 export {
   treaty,
+  parseOAuthCallback,
   defaultBaseUrl,
   createFetcher,
-  createClient
+  createClient,
+  clearOAuthCallbackHash,
+  buildLoginUrl
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@beepbox.net/gofetch-client",
-	"version": "0.2.5",
+	"version": "0.2.6",
 	"description": "Typesafe Eden treaty client for the gofetch API",
 	"license": "UNLICENSED",
 	"files": [