onehook-api-client 1.0.0

package/dist-types/models/models_0.d.ts

@@ -0,0 +1,614 @@
+import { OneHookServiceServiceException as __BaseException } from "./OneHookServiceServiceException";
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+/**
+ * @public
+ */
+export interface ClaimPreKeyBundleRequest {
+    userId: string | undefined;
+    /**
+     * The match the caller shares with the target user; used to authorize the claim.
+     * @public
+     */
+    matchId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ClaimPreKeyBundleResponse {
+    identityKey: string | undefined;
+    signedPreKey: string | undefined;
+    /**
+     * Omitted when the target user has exhausted their one-time pre-keys.
+     * @public
+     */
+    oneTimePreKey?: string | undefined;
+}
+/**
+ * @public
+ */
+export declare class ForbiddenError extends __BaseException {
+    readonly name: "ForbiddenError";
+    readonly $fault: "client";
+    error: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenError, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class BadRequestError extends __BaseException {
+    readonly name: "BadRequestError";
+    readonly $fault: "client";
+    error: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<BadRequestError, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class InternalServerError extends __BaseException {
+    readonly name: "InternalServerError";
+    readonly $fault: "server";
+    error: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class NotFoundError extends __BaseException {
+    readonly name: "NotFoundError";
+    readonly $fault: "client";
+    error: string | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotFoundError, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface DeleteMatchMessagesRequest {
+    matchId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteMatchMessagesResponse {
+    deleted: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UploadPreKeysRequest {
+    identityKey: string | undefined;
+    signedPreKey: string | undefined;
+    oneTimePreKeys: (string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface StatusResponse {
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface AuthSocialRequest {
+    provider: string | undefined;
+    token: string | undefined;
+}
+/**
+ * @public
+ */
+export interface AuthSocialResponse {
+    status: string | undefined;
+    userId?: string | undefined;
+    isNewUser?: boolean | undefined;
+}
+/**
+ * @public
+ */
+export interface GenerateInviteRequest {
+    referrerId: string | undefined;
+    maxUses?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface GenerateInviteResponse {
+    inviteCode: string | undefined;
+    expiresAt: number | undefined;
+    maxUses: number | undefined;
+}
+/**
+ * @public
+ */
+export interface GetUserRequest {
+    userId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UserResponse {
+    userId: string | undefined;
+    email?: string | undefined;
+    phoneNumber?: string | undefined;
+    displayName?: string | undefined;
+    appleId?: string | undefined;
+    appleEmail?: string | undefined;
+    googleId?: string | undefined;
+    googleEmail?: string | undefined;
+    userState?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetUserByEmailRequest {
+    email: string | undefined;
+}
+/**
+ * @public
+ */
+export interface LinkEmailRequest {
+    email: string | undefined;
+    otp: string | undefined;
+}
+/**
+ * @public
+ */
+export interface LinkEmailResponse {
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface LinkSocialRequest {
+    identityToken: string | undefined;
+    provider: string | undefined;
+}
+/**
+ * @public
+ */
+export interface LinkSocialResponse {
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RegisterPhoneRequest {
+    phoneNumber: string | undefined;
+    otp: string | undefined;
+    inviteCode: string | undefined;
+    displayName?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RegisterPhoneResponse {
+    userId: string | undefined;
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RequestEmailOtpRequest {
+    email: string | undefined;
+    password?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RequestEmailOtpResponse {
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RequestPhoneOtpRequest {
+    phoneNumber: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RequestPhoneOtpResponse {
+    status: string | undefined;
+}
+/**
+ * Requests an OTP to be sent to a new phone number to prove ownership before updating a user's phone number.
+ * This is step 1 of the 2-step phone number update process.
+ * @public
+ */
+export interface RequestPhoneUpdateOtpRequest {
+    phoneNumber: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RequestPhoneUpdateOtpResponse {
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UnlinkSocialRequest {
+    provider: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UnlinkSocialResponse {
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateEntitlementsRequest {
+    userId: string | undefined;
+    subscriptionTier: string | undefined;
+    /**
+     * Provenance of the entitlement decision (e.g. stripe / apple / google / sync). Advisory/audit.
+     * @public
+     */
+    source?: string | undefined;
+    /**
+     * Provider transaction/subscription id for audit + cross-service idempotency correlation.
+     * @public
+     */
+    purchaseRef?: string | undefined;
+    /**
+     * Source event time (epoch seconds); lets Identity ignore an out-of-order write if it tracks one.
+     * @public
+     */
+    effectiveAt?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateEntitlementsResponse {
+    status: string | undefined;
+    subscriptionTier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface PhoneResponse {
+    status: string | undefined;
+    phoneNumber: string | undefined;
+}
+/**
+ * Updates a user's phone number. This is step 2 of the 2-step phone number update process.
+ * The `otp` field must match the OTP sent to the new phone number in step 1.
+ * @public
+ */
+export interface UpdatePhoneNumberRequest {
+    phoneNumber: string | undefined;
+    otp: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ValidateInviteRequest {
+    inviteCode: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ValidateInviteResponse {
+    status: string | undefined;
+    referrerId?: string | undefined;
+    usedCount: number | undefined;
+    maxUses: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DiscoverRequest {
+    lat: number | undefined;
+    lon: number | undefined;
+}
+/**
+ * @public
+ */
+export interface CandidateDto {
+    userId: string | undefined;
+    distanceKm: number | undefined;
+    score: number | undefined;
+}
+/**
+ * @public
+ */
+export interface DiscoverResponse {
+    candidates: (CandidateDto)[] | undefined;
+    count: number | undefined;
+    algorithm: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetPreferencesRequest {
+    userId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UserPreferencesResponse {
+    userId: string | undefined;
+    minAge?: number | undefined;
+    maxAge?: number | undefined;
+    maxDistanceKm?: number | undefined;
+    genders?: (string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface LocationRequest {
+    lat: number | undefined;
+    lon: number | undefined;
+}
+/**
+ * @public
+ */
+export interface SwipeRequest {
+    targetId: string | undefined;
+    direction: string | undefined;
+    /**
+     * The profile section the swiper was viewing at swipe time (e.g. PHOTOS, BIO, PROMPTS,
+     * BASICS, LIFESTYLE, INTENT, INTERESTS, BACKGROUND). Persisted with the swipe so a LEFT
+     * swipe can later be cleared when exactly that section of the target's profile changes.
+     * Optional; primarily meaningful for LEFT swipes.
+     * @public
+     */
+    viewedSection?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface SwipeResponse {
+    status: string | undefined;
+    matched: boolean | undefined;
+    /**
+     * The match id if this was a mutual match
+     * @public
+     */
+    matchId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdatePreferencesRequest {
+    userId: string | undefined;
+    minAge?: number | undefined;
+    maxAge?: number | undefined;
+    maxDistanceKm?: number | undefined;
+    genders?: (string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface CompleteLivenessSessionRequest {
+    sessionId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CompleteLivenessSessionResponse {
+    /**
+     * Acknowledgement status, e.g. "PROCESSING". The verification verdict is applied
+     * asynchronously and surfaced later via the profile's `verified` field.
+     * @public
+     */
+    status: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateLivenessSessionRequest {
+}
+/**
+ * @public
+ */
+export interface CreateLivenessSessionResponse {
+    sessionId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteProfileRequest {
+    userId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface MediaUploadUrlRequest {
+    contentType: string | undefined;
+    contentLength: number | undefined;
+}
+/**
+ * @public
+ */
+export interface MediaUploadUrlResponse {
+    uploadUrl: string | undefined;
+    objectKey: string | undefined;
+    formData: Record<string, string> | undefined;
+}
+/**
+ * A user-authored conversation opener: free text plus an optional image.
+ * The image (if present) is moderated by the same async decency flow as profile pictures
+ * and prompt images before it becomes visible to other users.
+ * @public
+ */
+export interface Opener {
+    text: string | undefined;
+    imageKey?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ProfilePrompt {
+    promptId: string | undefined;
+    answer: string | undefined;
+    imageKey?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ProfileResponse {
+    userId: string | undefined;
+    displayName?: string | undefined;
+    bio?: string | undefined;
+    age?: number | undefined;
+    gender?: string | undefined;
+    interestedIn?: (string)[] | undefined;
+    relationshipType?: string | undefined;
+    wantsKids?: string | undefined;
+    familyPlans?: string | undefined;
+    smokingStatus?: string | undefined;
+    drinkingStatus?: string | undefined;
+    cannabisStatus?: string | undefined;
+    drugsStatus?: string | undefined;
+    religion?: string | undefined;
+    interests?: (string)[] | undefined;
+    starSign?: string | undefined;
+    /**
+     * Internal trust badge set only by the Face Liveness verification flow — never client-settable.
+     * Present on the response so clients can render a verified badge.
+     * @public
+     */
+    verified?: boolean | undefined;
+    subscriptionTier?: string | undefined;
+    pictures?: (string)[] | undefined;
+    videos?: (string)[] | undefined;
+    audioPrompt?: string | undefined;
+    /**
+     * Current moderation status. Absent for legacy profiles.
+     * Clients should treat absent as "APPROVED" for backward compatibility.
+     * @public
+     */
+    moderationStatus?: string | undefined;
+    causes?: (string)[] | undefined;
+    communities?: (string)[] | undefined;
+    qualities?: (string)[] | undefined;
+    prompts?: (ProfilePrompt)[] | undefined;
+    socialLinks?: Record<string, string> | undefined;
+    openers?: (Opener)[] | undefined;
+    work?: string | undefined;
+    education?: string | undefined;
+    hometown?: string | undefined;
+    currentLocation?: string | undefined;
+    height?: number | undefined;
+    exercise?: string | undefined;
+    educationLevel?: string | undefined;
+    politicalView?: string | undefined;
+    languages?: (string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface GetProfileRequest {
+    userId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ProfileUpdateRequest {
+    displayName?: string | undefined;
+    bio?: string | undefined;
+    age?: number | undefined;
+    gender?: string | undefined;
+    interestedIn?: (string)[] | undefined;
+    interests?: (string)[] | undefined;
+    relationshipType?: string | undefined;
+    wantsKids?: string | undefined;
+    familyPlans?: string | undefined;
+    smokingStatus?: string | undefined;
+    drinkingStatus?: string | undefined;
+    cannabisStatus?: string | undefined;
+    drugsStatus?: string | undefined;
+    religion?: string | undefined;
+    starSign?: string | undefined;
+    pictures?: (string)[] | undefined;
+    videos?: (string)[] | undefined;
+    audioPrompt?: string | undefined;
+    causes?: (string)[] | undefined;
+    communities?: (string)[] | undefined;
+    qualities?: (string)[] | undefined;
+    prompts?: (ProfilePrompt)[] | undefined;
+    socialLinks?: Record<string, string> | undefined;
+    openers?: (Opener)[] | undefined;
+    work?: string | undefined;
+    education?: string | undefined;
+    hometown?: string | undefined;
+    currentLocation?: string | undefined;
+    height?: number | undefined;
+    exercise?: string | undefined;
+    educationLevel?: string | undefined;
+    politicalView?: string | undefined;
+    languages?: (string)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface CompleteOnboardingRequest {
+}
+/**
+ * @public
+ */
+export interface GetMatchRequest {
+    matchId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface MatchRecord {
+    matchId: string | undefined;
+    userA: string | undefined;
+    userB: string | undefined;
+    status: string | undefined;
+    createdAt: number | undefined;
+    updatedAt: number | undefined;
+    endedAt?: number | undefined;
+    latestMessageSenderId?: string | undefined;
+    latestMessageTimestamp?: number | undefined;
+    endedBy?: string | undefined;
+    endReason?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetStateRequest {
+    userId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UserStateResponse {
+    userId: string | undefined;
+    state: string | undefined;
+    activeConnections: number | undefined;
+    matchIds: (string)[] | undefined;
+    subscriptionTier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface InitUserRequest {
+}
+/**
+ * @public
+ */
+export interface UnhookRequest {
+    matchId: string | undefined;
+    reason?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpgradeUserRequest {
+}