onehook-api-client 1.0.11 → 1.0.14

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

@@ -48,6 +48,120 @@ export declare class InternalServerError extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface DeletePushTokenRequest {
+    /**
+     * UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
+     * @public
+     */
+    deviceId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeletePushTokenResponse {
+    /**
+     * UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
+     * @public
+     */
+    deviceId: string | undefined;
+    /**
+     * True when a token row was removed; false when there was none. Safe to expose because this is the
+     * caller's OWN device.
+     * @public
+     */
+    deleted: boolean | undefined;
+}
+/**
+ * @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 GetChatSettingsRequest {
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const LastSeenVisibility: {
+    readonly EVERYONE: "EVERYONE";
+    readonly MATCHES: "MATCHES";
+    readonly NOBODY: "NOBODY";
+};
+/**
+ * @public
+ */
+export type LastSeenVisibility = typeof LastSeenVisibility[keyof typeof LastSeenVisibility];
+/**
+ * Per-user chat settings, synced across all of the user's devices. Members are individually
+ * optional so the same shape serves partial updates; a GET response always populates every member.
+ * @public
+ */
+export interface ChatSettings {
+    /**
+     * Whether new-message push notifications are delivered.
+     * @public
+     */
+    messageNotifications?: boolean | undefined;
+    /**
+     * Whether notifications include a message preview (vs. a generic "New message").
+     * @public
+     */
+    showPreviews?: boolean | undefined;
+    /**
+     * Whether reaction push notifications are delivered.
+     * @public
+     */
+    reactionNotifications?: boolean | undefined;
+    /**
+     * Whether the caller emits read receipts to peers. (Client/AppSync-enforced — see service docs.)
+     * @public
+     */
+    readReceipts?: boolean | undefined;
+    /**
+     * Whether the caller emits typing indicators to peers. (Client/AppSync-enforced.)
+     * @public
+     */
+    typingIndicators?: boolean | undefined;
+    /**
+     * Who may see the caller's last-seen presence.
+     * @public
+     */
+    lastSeenVisibility?: LastSeenVisibility | undefined;
+    /**
+     * Whether the client applies OS screenshot protection to chats.
+     * @public
+     */
+    screenshotProtection?: boolean | undefined;
+    /**
+     * Default disappearing-message timer in seconds for new conversations. 0 disables it.
+     * @public
+     */
+    defaultDisappearingSeconds?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface GetChatSettingsResponse {
+    /**
+     * Per-user chat settings, synced across all of the user's devices. Members are individually
+     * optional so the same shape serves partial updates; a GET response always populates every member.
+     * @public
+     */
+    settings: ChatSettings | undefined;
+}
 /**
  * @public
  */
@@ -141,18 +255,6 @@ export interface GetParticipantRegistryResponse {
      */
     accountHistoryKey?: AccountHistoryKey | undefined;
 }
-/**
- * @public
- */
-export declare class NotFoundError extends __BaseException {
-    readonly name: "NotFoundError";
-    readonly $fault: "client";
-    error: string | undefined;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<NotFoundError, __BaseException>);
-}
 /**
  * @public
  */
@@ -234,6 +336,44 @@ export interface RegisterDeviceResponse {
      */
     ownsAccountHistoryKey: boolean | undefined;
 }
+/**
+ * @public
+ */
+export interface RegisterPushTokenRequest {
+    /**
+     * UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
+     * @public
+     */
+    deviceId: string | undefined;
+    /**
+     * The APNs device token or FCM registration token, as issued by the platform.
+     * @public
+     */
+    token: string | undefined;
+    /**
+     * Which push service issued the token. Decides which SNS platform application the endpoint is
+     * created against, so a wrong value means the push silently never arrives.
+     * @public
+     */
+    platform: Platform | undefined;
+}
+/**
+ * @public
+ */
+export interface RegisterPushTokenResponse {
+    /**
+     * UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
+     * @public
+     */
+    deviceId: string | undefined;
+    /**
+     * True once the token is stored. Deliberately does NOT report whether an SNS endpoint was created:
+     * endpoint creation happens at delivery time, so claiming it here would assert something the
+     * registration call has not verified.
+     * @public
+     */
+    registered: boolean | undefined;
+}
 /**
  * @public
  */
@@ -255,6 +395,34 @@ export interface RevokeDeviceResponse {
     deviceId: string | undefined;
     revoked: boolean | undefined;
 }
+/**
+ * @public
+ */
+export interface UpdateChatSettingsRequest {
+    messageNotifications?: boolean | undefined;
+    showPreviews?: boolean | undefined;
+    reactionNotifications?: boolean | undefined;
+    readReceipts?: boolean | undefined;
+    typingIndicators?: boolean | undefined;
+    /**
+     * Who may see the caller's "last seen / online" presence.
+     * @public
+     */
+    lastSeenVisibility?: LastSeenVisibility | undefined;
+    screenshotProtection?: boolean | undefined;
+    defaultDisappearingSeconds?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateChatSettingsResponse {
+    /**
+     * Per-user chat settings, synced across all of the user's devices. Members are individually
+     * optional so the same shape serves partial updates; a GET response always populates every member.
+     * @public
+     */
+    settings: ChatSettings | undefined;
+}
 /**
  * @public
  */
@@ -285,6 +453,41 @@ export interface GenerateInviteResponse {
     expiresAt: number | undefined;
     maxUses: number | undefined;
 }
+/**
+ * @public
+ */
+export interface GetCredentialReadinessRequest {
+    userId: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CredentialGap: {
+    readonly NO_COGNITO_USERNAME_ON_PROFILE: "NO_COGNITO_USERNAME_ON_PROFILE";
+    readonly PHONE_NOT_VERIFIED: "PHONE_NOT_VERIFIED";
+    readonly USERNAME_MISMATCHED_IN_COGNITO: "USERNAME_MISMATCHED_IN_COGNITO";
+    readonly USERNAME_NOT_SYNCED_TO_COGNITO: "USERNAME_NOT_SYNCED_TO_COGNITO";
+};
+/**
+ * @public
+ */
+export type CredentialGap = typeof CredentialGap[keyof typeof CredentialGap];
+/**
+ * @public
+ */
+export interface GetCredentialReadinessResponse {
+    /**
+     * True only when EVERY portable credential the profile advertises is live in Cognito.
+     * @public
+     */
+    ready: boolean | undefined;
+    /**
+     * Empty when ready. Machine-readable so the caller can explain the specific gap.
+     * @public
+     */
+    gaps: (CredentialGap)[] | undefined;
+}
 /**
  * @public
  */
@@ -312,6 +515,18 @@ export interface UserResponse {
 export interface GetUserByEmailRequest {
     email: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetUserIdByUsernameRequest {
+    username: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetUserIdByUsernameResponse {
+    userId: string | undefined;
+}
 /**
  * @public
  */
@@ -513,6 +728,23 @@ export interface DiscoverResponse {
     count: number | undefined;
     algorithm: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetNotificationPreferencesRequest {
+    userId: string | undefined;
+}
+/**
+ * ONLY the notification toggles. See `GetNotificationPreferences` for why this is deliberately not the
+ * full preferences projection.
+ * @public
+ */
+export interface GetNotificationPreferencesResponse {
+    userId: string | undefined;
+    notifyMatches: boolean | undefined;
+    notifyLikes: boolean | undefined;
+    notifyDailyPicks: boolean | undefined;
+}
 /**
  * @public
  */
@@ -527,7 +759,52 @@ export interface UserPreferencesResponse {
     minAge?: number | undefined;
     maxAge?: number | undefined;
     maxDistanceKm?: number | undefined;
-    genders?: (string)[] | undefined;
+    /**
+     * Genders to show. CANONICAL name — what the service serialises.
+     * @public
+     */
+    interestedInGenders?: (string)[] | undefined;
+    relationshipType?: string | undefined;
+    wantsKids?: string | undefined;
+    familyPlans?: string | undefined;
+    verifiedOnly?: boolean | undefined;
+    smoking?: string | undefined;
+    drinking?: string | undefined;
+    cannabis?: string | undefined;
+    drugs?: string | undefined;
+    exercise?: string | undefined;
+    religion?: string | undefined;
+    educationLevel?: string | undefined;
+    politicalView?: string | undefined;
+    starSigns?: (string)[] | undefined;
+    preferredLanguages?: (string)[] | undefined;
+    interests?: (string)[] | undefined;
+    minHeight?: number | undefined;
+    maxHeight?: number | undefined;
+    /**
+     * Which filters are hard deal-breakers rather than soft preferences.
+     * @public
+     */
+    dealbreakers?: (string)[] | undefined;
+    requirePhoto?: boolean | undefined;
+    requireBio?: boolean | undefined;
+    requireRecentlyActive?: boolean | undefined;
+    /**
+     * Server-owned definition of "recently active", in days. Read-only: the client shows it,
+     * the server decides it.
+     * @public
+     */
+    recentlyActiveDays?: number | undefined;
+    discoverable?: boolean | undefined;
+    incognito?: boolean | undefined;
+    /**
+     * KM | MI. Display only — the API always speaks kilometres.
+     * @public
+     */
+    distanceUnit?: string | undefined;
+    notifyMatches?: boolean | undefined;
+    notifyLikes?: boolean | undefined;
+    notifyDailyPicks?: boolean | undefined;
 }
 /**
  * @public
@@ -569,6 +846,24 @@ export interface SwipeResponse {
      */
     matchId?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface SwipeByUsernameRequest {
+    /**
+     * The handle the user typed. Case/whitespace are normalised server-side.
+     * @public
+     */
+    username: string | undefined;
+}
+/**
+ * Intentionally minimal — see `SwipeByUsername`. One constant status, no target id, no `matched`
+ * flag, no "user not found": anything more would turn a handle into an oracle.
+ * @public
+ */
+export interface SwipeByUsernameResponse {
+    status: string | undefined;
+}
 /**
  * @public
  */
@@ -577,7 +872,155 @@ export interface UpdatePreferencesRequest {
     minAge?: number | undefined;
     maxAge?: number | undefined;
     maxDistanceKm?: number | undefined;
+    /**
+     * Genders to show. CANONICAL name — it is what the service actually binds.
+     * Values: MALE | FEMALE | NON_BINARY | OTHER | PREFER_NOT_TO_SAY.
+     * @public
+     */
+    interestedInGenders?: (string)[] | undefined;
+    /**
+     * DEPRECATED alias for `interestedInGenders`, accepted for already-shipped clients only.
+     * The service reads it via `@JsonAlias`; new clients must send `interestedInGenders`.
+     *
+     * @deprecated
+     * @public
+     */
     genders?: (string)[] | undefined;
+    /**
+     * MONOGAMOUS | POLYAMOROUS | OPEN | CASUAL | ETHICALLY_NON_MONOGAMOUS | NOT_SURE_YET
+     * @public
+     */
+    relationshipType?: string | undefined;
+    /**
+     * YES | NO | NOT_SURE | OPEN
+     * @public
+     */
+    wantsKids?: string | undefined;
+    /**
+     * STARTING_SOON | IN_FUTURE | NOT_INTERESTED | ALREADY_HAVE | OPEN
+     * @public
+     */
+    familyPlans?: string | undefined;
+    /**
+     * Only show candidates who passed the liveness/verification check.
+     * @public
+     */
+    verifiedOnly?: boolean | undefined;
+    /**
+     * NEVER | SOCIALLY | REGULARLY | TRYING_TO_QUIT
+     * @public
+     */
+    smoking?: string | undefined;
+    /**
+     * NEVER | SOCIALLY | REGULARLY | PREFER_NOT_TO_SAY
+     * @public
+     */
+    drinking?: string | undefined;
+    /**
+     * NEVER | SOCIALLY | REGULARLY | PREFER_NOT_TO_SAY
+     * @public
+     */
+    cannabis?: string | undefined;
+    /**
+     * NEVER | SOCIALLY | REGULARLY | PREFER_NOT_TO_SAY
+     * @public
+     */
+    drugs?: string | undefined;
+    /**
+     * ACTIVE | SOMETIMES | NEVER
+     * @public
+     */
+    exercise?: string | undefined;
+    /**
+     * AGNOSTIC | ATHEIST | BUDDHIST | CHRISTIAN | CATHOLIC | HINDU | JEWISH | MUSLIM |
+     * SIKH | SPIRITUAL | OTHER | PREFER_NOT_TO_SAY
+     * @public
+     */
+    religion?: string | undefined;
+    /**
+     * HIGH_SCHOOL | IN_COLLEGE | BACHELORS | MASTERS | PHD | OTHER
+     * @public
+     */
+    educationLevel?: string | undefined;
+    /**
+     * LIBERAL | MODERATE | CONSERVATIVE | APOLITICAL | OTHER
+     * @public
+     */
+    politicalView?: string | undefined;
+    /**
+     * Accepted star signs (ARIES … PISCES). A candidate matches on containment.
+     * @public
+     */
+    starSigns?: (string)[] | undefined;
+    /**
+     * Preferred spoken languages (ENGLISH, SPANISH, …). Matches on overlap.
+     * @public
+     */
+    preferredLanguages?: (string)[] | undefined;
+    /**
+     * Shared interests (TRAVEL, MUSIC, …). Matches on overlap.
+     * @public
+     */
+    interests?: (string)[] | undefined;
+    minHeight?: number | undefined;
+    maxHeight?: number | undefined;
+    /**
+     * Which of the filters above are DEAL-BREAKERS (hard) rather than nice-to-haves (soft).
+     *
+     * This is the switch that makes a filter exclude candidates instead of merely boosting them:
+     * a preference NOT listed here only contributes to the soft score. Use the field names above,
+     * e.g. `verifiedOnly`, `relationshipType`, `wantsKids`, `interestedInGenders`, `minAge`,
+     * `maxAge`, `age`, `gender`, `height`, `minHeight`, `maxHeight`, `smoking`, `drinking`,
+     * `cannabis`, `drugs`, `religion`, `familyPlans`, `exercise`, `educationLevel`,
+     * `politicalView`, `interests`, `starSigns`, `preferredLanguages`.
+     * @public
+     */
+    dealbreakers?: (string)[] | undefined;
+    /**
+     * Require at least one profile photo.
+     * @public
+     */
+    requirePhoto?: boolean | undefined;
+    /**
+     * Require a bio or at least one answered prompt.
+     * @public
+     */
+    requireBio?: boolean | undefined;
+    /**
+     * Require activity within the recent-activity window (see `recentlyActiveDays` in the response).
+     * @public
+     */
+    requireRecentlyActive?: boolean | undefined;
+    /**
+     * Show me on OneHook. When false you browse without appearing in anyone's feed.
+     * @public
+     */
+    discoverable?: boolean | undefined;
+    /**
+     * Incognito: only people you have already liked can see you.
+     * @public
+     */
+    incognito?: boolean | undefined;
+    /**
+     * Distance unit for display only — the API always speaks kilometres. KM | MI.
+     * @public
+     */
+    distanceUnit?: string | undefined;
+    /**
+     * Notify me about new matches.
+     * @public
+     */
+    notifyMatches?: boolean | undefined;
+    /**
+     * Notify me when someone likes me.
+     * @public
+     */
+    notifyLikes?: boolean | undefined;
+    /**
+     * Notify me about daily picks.
+     * @public
+     */
+    notifyDailyPicks?: boolean | undefined;
 }
 /**
  * @public
@@ -709,6 +1152,11 @@ export interface ProfileResponse {
     verified?: boolean | undefined;
     subscriptionTier?: string | undefined;
     pictures?: (string)[] | undefined;
+    /**
+     * Display-only preview transforms keyed by picture object key. Values use `v1:x,y,zoom`.
+     * @public
+     */
+    pictureTransforms?: Record<string, string> | undefined;
     videos?: (string)[] | undefined;
     audioPrompt?: string | undefined;
     /**
@@ -764,6 +1212,11 @@ export interface ProfileUpdateRequest {
     religion?: string | undefined;
     starSign?: string | undefined;
     pictures?: (string)[] | undefined;
+    /**
+     * Display-only preview transforms keyed by picture object key. Values use `v1:x,y,zoom`.
+     * @public
+     */
+    pictureTransforms?: Record<string, string> | undefined;
     videos?: (string)[] | undefined;
     audioPrompt?: string | undefined;
     causes?: (string)[] | undefined;