@mikle7/litty-api-client
Version:
TypeScript client for Litty API with clean, semantic type definitions
116 lines (115 loc) • 6.22 kB
TypeScript
/**
* Litty API
* Complete API documentation for the Litty platform. ## Authentication Most endpoints require authentication via Supabase JWT tokens. Include the token in the Authorization header: `Bearer <token>` ## API Structure - **Contests**: Create and manage contests, entries, and settlements - **Markets**: Manage prediction markets within contests - **Transactions**: Handle financial transactions for contest entries and rewards - **Wallet**: Manage user wallet balances (cashable, points, tickets) - **Users**: User management and profiles - **Leaderboards**: Competition rankings and scoring - **Uploads**: File upload management - **Shows**: TV show and episode management (admin only) ## Response Formats All endpoints return JSON responses with consistent error handling. Error responses include `statusCode`, `message`, and `error` fields.
*
* The version of the OpenAPI document: 1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type { CreateUser201Response, GetAllUsers200Response, GetMe200Response, GetOnboardingStatus200Response, GetReferrals200Response, SubmitOnboarding200Response, UpdateEmailVerification200Response, ValidateNickname200Response } from '../models/index';
export interface CreateUserRequest {
body: object;
}
export interface GetAllUsersRequest {
page?: number;
limit?: number;
search?: string;
}
export interface SubmitOnboardingRequest {
body: object;
}
export interface UpdateEmailVerificationRequest {
body: object;
}
export interface ValidateNicknameRequest {
nickname: string;
}
/**
*
*/
export declare class UsersApi extends runtime.BaseAPI {
/**
* Create a new user account in the system
* Create a new user
*/
createUserRaw(requestParameters: CreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateUser201Response>>;
/**
* Create a new user account in the system
* Create a new user
*/
createUser(requestParameters: CreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateUser201Response>;
/**
* Retrieve a paginated list of all users with their wallet information. Admin access required.
* Get all users
*/
getAllUsersRaw(requestParameters: GetAllUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllUsers200Response>>;
/**
* Retrieve a paginated list of all users with their wallet information. Admin access required.
* Get all users
*/
getAllUsers(requestParameters?: GetAllUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllUsers200Response>;
/**
* Retrieve the authenticated user\'s profile information
* Get current user information
*/
getMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetMe200Response>>;
/**
* Retrieve the authenticated user\'s profile information
* Get current user information
*/
getMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetMe200Response>;
/**
* Check if the authenticated user has completed onboarding
* Get user onboarding status
*/
getOnboardingStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOnboardingStatus200Response>>;
/**
* Check if the authenticated user has completed onboarding
* Get user onboarding status
*/
getOnboardingStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOnboardingStatus200Response>;
/**
* Retrieve the authenticated user\'s referral information
* Get user referrals
*/
getReferralsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReferrals200Response>>;
/**
* Retrieve the authenticated user\'s referral information
* Get user referrals
*/
getReferrals(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReferrals200Response>;
/**
* Complete the user onboarding process with required information
* Submit user onboarding information
*/
submitOnboardingRaw(requestParameters: SubmitOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubmitOnboarding200Response>>;
/**
* Complete the user onboarding process with required information
* Submit user onboarding information
*/
submitOnboarding(requestParameters: SubmitOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubmitOnboarding200Response>;
/**
* Update the email verification status for a user
* Update email verification status
*/
updateEmailVerificationRaw(requestParameters: UpdateEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateEmailVerification200Response>>;
/**
* Update the email verification status for a user
* Update email verification status
*/
updateEmailVerification(requestParameters: UpdateEmailVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateEmailVerification200Response>;
/**
* Check if a nickname is available and meets format requirements
* Validate nickname availability
*/
validateNicknameRaw(requestParameters: ValidateNicknameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValidateNickname200Response>>;
/**
* Check if a nickname is available and meets format requirements
* Validate nickname availability
*/
validateNickname(requestParameters: ValidateNicknameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValidateNickname200Response>;
}