@privy-io/node 0.10.1 → 0.11.0

package/src/resources/apps/apps.ts

@@ -0,0 +1,391 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ClientAuthAPI from '../client-auth';
+import * as AllowlistAPI from './allowlist';
+import { Allowlist, AllowlistCreateParams, AllowlistDeleteParams, AllowlistListResponse } from './allowlist';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Operations related to app settings and allowlist management
+ */
+export class Apps extends APIResource {
+  allowlist: AllowlistAPI.Allowlist = new AllowlistAPI.Allowlist(this._client);
+
+  /**
+   * Get the settings and configuration for an app.
+   *
+   * @example
+   * ```ts
+   * const appResponse = await client.apps.get('app_id');
+   * ```
+   */
+  get(appID: string, options?: RequestOptions): APIPromise<AppResponse> {
+    return this._client.get(path`/v1/apps/${appID}`, options);
+  }
+
+  /**
+   * Get the test accounts and credentials for an app.
+   *
+   * @example
+   * ```ts
+   * const testAccountsResponse =
+   *   await client.apps.getTestCredentials('app_id');
+   * ```
+   */
+  getTestCredentials(appID: string, options?: RequestOptions): APIPromise<TestAccountsResponse> {
+    return this._client.get(path`/v1/apps/${appID}/test_credentials`, options);
+  }
+}
+
+/**
+ * The response for getting an app.
+ */
+export interface AppResponse {
+  id: string;
+
+  accent_color: string | null;
+
+  allowed_domains: Array<string>;
+
+  allowed_native_app_ids: Array<string>;
+
+  allowed_native_app_url_schemes: Array<string>;
+
+  allowlist_config: AppResponse.AllowlistConfig;
+
+  allowlist_enabled: boolean;
+
+  apple_oauth: boolean;
+
+  captcha_enabled: boolean;
+
+  custom_api_url: string | null;
+
+  custom_jwt_auth: boolean;
+
+  custom_oauth_providers: Array<AppResponse.CustomOAuthProvider>;
+
+  disable_plus_emails: boolean;
+
+  discord_oauth: boolean;
+
+  email_auth: boolean;
+
+  embedded_wallet_config: AppResponse.EmbeddedWalletConfig;
+
+  enabled_captcha_provider: 'turnstile' | 'hcaptcha' | null;
+
+  enforce_wallet_uis: boolean;
+
+  farcaster_auth: boolean;
+
+  farcaster_link_wallets_enabled: boolean;
+
+  fiat_on_ramp_enabled: boolean;
+
+  github_oauth: boolean;
+
+  google_oauth: boolean;
+
+  guest_auth: boolean;
+
+  icon_url: string | null;
+
+  instagram_oauth: boolean;
+
+  legacy_wallet_ui_config: boolean;
+
+  line_oauth: boolean;
+
+  linkedin_oauth: boolean;
+
+  logo_url: string | null;
+
+  max_linked_wallets_per_user: number | null;
+
+  mfa_methods: Array<'sms' | 'totp' | 'passkey'>;
+
+  name: string;
+
+  passkey_auth: boolean;
+
+  passkeys_for_signup_enabled: boolean;
+
+  privacy_policy_url: string | null;
+
+  require_users_accept_terms: boolean | null;
+
+  show_wallet_login_first: boolean;
+
+  smart_wallet_config: AppResponse.Enabled | AppResponse.UnionMember1;
+
+  sms_auth: boolean;
+
+  solana_wallet_auth: boolean;
+
+  spotify_oauth: boolean;
+
+  telegram_auth: boolean;
+
+  terms_and_conditions_url: string | null;
+
+  theme: string;
+
+  tiktok_oauth: boolean;
+
+  twitch_oauth: boolean;
+
+  twitter_oauth: boolean;
+
+  twitter_oauth_on_mobile_enabled: boolean;
+
+  verification_key: string;
+
+  wallet_auth: boolean;
+
+  wallet_connect_cloud_project_id: string | null;
+
+  whatsapp_enabled: boolean;
+
+  captcha_site_key?: string;
+
+  funding_config?: AppResponse.FundingConfig;
+
+  telegram_auth_config?: AppResponse.TelegramAuthConfig;
+}
+
+export namespace AppResponse {
+  export interface AllowlistConfig {
+    cta_link: string | null;
+
+    cta_text: string | null;
+
+    error_detail: string | null;
+
+    error_title: string | null;
+  }
+
+  export interface CustomOAuthProvider {
+    enabled: boolean;
+
+    /**
+     * The ID of a custom OAuth provider, set up for this app. Must start with
+     * "custom:".
+     */
+    provider: ClientAuthAPI.CustomOAuthProviderID;
+
+    provider_display_name: string;
+
+    provider_icon_url: string;
+  }
+
+  export interface EmbeddedWalletConfig {
+    create_on_login: 'users-without-wallets' | 'all-users' | 'off';
+
+    ethereum: EmbeddedWalletConfig.Ethereum;
+
+    mode: 'legacy-embedded-wallets-only' | 'user-controlled-server-wallets-only';
+
+    solana: EmbeddedWalletConfig.Solana;
+
+    user_owned_recovery_options: Array<'user-passcode' | 'google-drive' | 'icloud'>;
+
+    require_user_owned_recovery_on_create?: boolean;
+
+    require_user_password_on_create?: boolean;
+  }
+
+  export namespace EmbeddedWalletConfig {
+    export interface Ethereum {
+      create_on_login: 'users-without-wallets' | 'all-users' | 'off';
+    }
+
+    export interface Solana {
+      create_on_login: 'users-without-wallets' | 'all-users' | 'off';
+    }
+  }
+
+  export interface Enabled {
+    enabled: false;
+  }
+
+  export interface UnionMember1 {
+    configured_networks: Array<UnionMember1.ConfiguredNetwork>;
+
+    enabled: true;
+
+    smart_wallet_type:
+      | 'safe'
+      | 'kernel'
+      | 'light_account'
+      | 'biconomy'
+      | 'coinbase_smart_wallet'
+      | 'thirdweb';
+
+    smart_wallet_version?: string;
+  }
+
+  export namespace UnionMember1 {
+    export interface ConfiguredNetwork {
+      bundler_url: string;
+
+      chain_id: string;
+
+      chain_name?: string;
+
+      paymaster_context?: ConfiguredNetwork.PaymasterContext;
+
+      paymaster_url?: string;
+
+      rpc_url?: string;
+    }
+
+    export namespace ConfiguredNetwork {
+      export interface PaymasterContext {
+        policy_id: string;
+      }
+    }
+  }
+
+  export interface FundingConfig {
+    cross_chain_bridging_enabled: boolean;
+
+    default_recommended_amount: string;
+
+    default_recommended_currency: FundingConfig.DefaultRecommendedCurrency;
+
+    methods: Array<'moonpay' | 'coinbase-onramp' | 'external'>;
+
+    options: Array<FundingConfig.Option>;
+
+    prompt_funding_on_wallet_creation: boolean;
+  }
+
+  export namespace FundingConfig {
+    export interface DefaultRecommendedCurrency {
+      chain: string;
+
+      asset?: 'native-currency' | 'USDC';
+    }
+
+    export interface Option {
+      method: string;
+
+      provider: string;
+    }
+  }
+
+  export interface TelegramAuthConfig {
+    bot_id: string;
+
+    bot_name: string;
+
+    link_enabled: boolean;
+
+    seamless_auth_enabled: boolean;
+  }
+}
+
+/**
+ * Allowlist invite input for an email address.
+ */
+export interface EmailInviteInput {
+  type: 'email';
+
+  value: string;
+}
+
+/**
+ * Allowlist invite input for a wallet address.
+ */
+export interface WalletInviteInput {
+  type: 'wallet';
+
+  value: string;
+}
+
+/**
+ * Allowlist invite input for a phone number.
+ */
+export interface PhoneInviteInput {
+  type: 'phone';
+
+  value: string;
+}
+
+/**
+ * Input for adding or removing an allowlist entry. Discriminated by type.
+ */
+export type UserInviteInput = EmailInviteInput | WalletInviteInput | PhoneInviteInput;
+
+/**
+ * An allowlist entry for an app.
+ */
+export interface AllowlistEntry {
+  id: string;
+
+  acceptedAt: number | null;
+
+  appId: string;
+
+  type: string;
+
+  value: string;
+}
+
+/**
+ * Confirmation response for deleting an allowlist entry.
+ */
+export interface AllowlistDeletionResponse {
+  message: string;
+}
+
+/**
+ * A test account for an app.
+ */
+export interface TestAccount {
+  id: string;
+
+  created_at: string;
+
+  email: string;
+
+  otp_code: string;
+
+  phone_number: string;
+
+  updated_at: string;
+}
+
+/**
+ * Response for listing test accounts for an app.
+ */
+export interface TestAccountsResponse {
+  data: Array<TestAccount>;
+}
+
+Apps.Allowlist = Allowlist;
+
+export declare namespace Apps {
+  export {
+    type AppResponse as AppResponse,
+    type EmailInviteInput as EmailInviteInput,
+    type WalletInviteInput as WalletInviteInput,
+    type PhoneInviteInput as PhoneInviteInput,
+    type UserInviteInput as UserInviteInput,
+    type AllowlistEntry as AllowlistEntry,
+    type AllowlistDeletionResponse as AllowlistDeletionResponse,
+    type TestAccount as TestAccount,
+    type TestAccountsResponse as TestAccountsResponse,
+  };
+
+  export {
+    Allowlist as Allowlist,
+    type AllowlistListResponse as AllowlistListResponse,
+    type AllowlistCreateParams as AllowlistCreateParams,
+    type AllowlistDeleteParams as AllowlistDeleteParams,
+  };
+}

package/src/resources/apps/index.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Allowlist,
+  type AllowlistListResponse,
+  type AllowlistCreateParams,
+  type AllowlistDeleteParams,
+} from './allowlist';
+export {
+  Apps,
+  type AppResponse,
+  type EmailInviteInput,
+  type WalletInviteInput,
+  type PhoneInviteInput,
+  type UserInviteInput,
+  type AllowlistEntry,
+  type AllowlistDeletionResponse,
+  type TestAccount,
+  type TestAccountsResponse,
+} from './apps';

package/src/resources/apps.ts

@@ -1,259 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import * as ClientAuthAPI from './client-auth';
-
-export class Apps extends APIResource {}
-
-/**
- * The response for getting an app.
- */
-export interface AppResponse {
-  id: string;
-
-  accent_color: string | null;
-
-  allowed_domains: Array<string>;
-
-  allowed_native_app_ids: Array<string>;
-
-  allowed_native_app_url_schemes: Array<string>;
-
-  allowlist_config: AppResponse.AllowlistConfig;
-
-  allowlist_enabled: boolean;
-
-  apple_oauth: boolean;
-
-  captcha_enabled: boolean;
-
-  custom_api_url: string | null;
-
-  custom_jwt_auth: boolean;
-
-  custom_oauth_providers: Array<AppResponse.CustomOAuthProvider>;
-
-  disable_plus_emails: boolean;
-
-  discord_oauth: boolean;
-
-  email_auth: boolean;
-
-  embedded_wallet_config: AppResponse.EmbeddedWalletConfig;
-
-  enabled_captcha_provider: 'turnstile' | 'hcaptcha' | null;
-
-  enforce_wallet_uis: boolean;
-
-  farcaster_auth: boolean;
-
-  farcaster_link_wallets_enabled: boolean;
-
-  fiat_on_ramp_enabled: boolean;
-
-  github_oauth: boolean;
-
-  google_oauth: boolean;
-
-  guest_auth: boolean;
-
-  icon_url: string | null;
-
-  instagram_oauth: boolean;
-
-  legacy_wallet_ui_config: boolean;
-
-  line_oauth: boolean;
-
-  linkedin_oauth: boolean;
-
-  logo_url: string | null;
-
-  max_linked_wallets_per_user: number | null;
-
-  mfa_methods: Array<'sms' | 'totp' | 'passkey'>;
-
-  name: string;
-
-  passkey_auth: boolean;
-
-  passkeys_for_signup_enabled: boolean;
-
-  privacy_policy_url: string | null;
-
-  require_users_accept_terms: boolean | null;
-
-  show_wallet_login_first: boolean;
-
-  smart_wallet_config: AppResponse.Enabled | AppResponse.UnionMember1;
-
-  sms_auth: boolean;
-
-  solana_wallet_auth: boolean;
-
-  spotify_oauth: boolean;
-
-  telegram_auth: boolean;
-
-  terms_and_conditions_url: string | null;
-
-  theme: string;
-
-  tiktok_oauth: boolean;
-
-  twitch_oauth: boolean;
-
-  twitter_oauth: boolean;
-
-  twitter_oauth_on_mobile_enabled: boolean;
-
-  verification_key: string;
-
-  wallet_auth: boolean;
-
-  wallet_connect_cloud_project_id: string | null;
-
-  whatsapp_enabled: boolean;
-
-  captcha_site_key?: string;
-
-  funding_config?: AppResponse.FundingConfig;
-
-  telegram_auth_config?: AppResponse.TelegramAuthConfig;
-}
-
-export namespace AppResponse {
-  export interface AllowlistConfig {
-    cta_link: string | null;
-
-    cta_text: string | null;
-
-    error_detail: string | null;
-
-    error_title: string | null;
-  }
-
-  export interface CustomOAuthProvider {
-    enabled: boolean;
-
-    /**
-     * The ID of a custom OAuth provider, set up for this app. Must start with
-     * "custom:".
-     */
-    provider: ClientAuthAPI.CustomOAuthProviderID;
-
-    provider_display_name: string;
-
-    provider_icon_url: string;
-  }
-
-  export interface EmbeddedWalletConfig {
-    create_on_login: 'users-without-wallets' | 'all-users' | 'off';
-
-    ethereum: EmbeddedWalletConfig.Ethereum;
-
-    mode: 'legacy-embedded-wallets-only' | 'user-controlled-server-wallets-only';
-
-    solana: EmbeddedWalletConfig.Solana;
-
-    user_owned_recovery_options: Array<'user-passcode' | 'google-drive' | 'icloud'>;
-
-    require_user_owned_recovery_on_create?: boolean;
-
-    require_user_password_on_create?: boolean;
-  }
-
-  export namespace EmbeddedWalletConfig {
-    export interface Ethereum {
-      create_on_login: 'users-without-wallets' | 'all-users' | 'off';
-    }
-
-    export interface Solana {
-      create_on_login: 'users-without-wallets' | 'all-users' | 'off';
-    }
-  }
-
-  export interface Enabled {
-    enabled: false;
-  }
-
-  export interface UnionMember1 {
-    configured_networks: Array<UnionMember1.ConfiguredNetwork>;
-
-    enabled: true;
-
-    smart_wallet_type:
-      | 'safe'
-      | 'kernel'
-      | 'light_account'
-      | 'biconomy'
-      | 'coinbase_smart_wallet'
-      | 'thirdweb';
-
-    smart_wallet_version?: string;
-  }
-
-  export namespace UnionMember1 {
-    export interface ConfiguredNetwork {
-      bundler_url: string;
-
-      chain_id: string;
-
-      chain_name?: string;
-
-      paymaster_context?: ConfiguredNetwork.PaymasterContext;
-
-      paymaster_url?: string;
-
-      rpc_url?: string;
-    }
-
-    export namespace ConfiguredNetwork {
-      export interface PaymasterContext {
-        policy_id: string;
-      }
-    }
-  }
-
-  export interface FundingConfig {
-    cross_chain_bridging_enabled: boolean;
-
-    default_recommended_amount: string;
-
-    default_recommended_currency: FundingConfig.DefaultRecommendedCurrency;
-
-    methods: Array<'moonpay' | 'coinbase-onramp' | 'external'>;
-
-    options: Array<FundingConfig.Option>;
-
-    prompt_funding_on_wallet_creation: boolean;
-  }
-
-  export namespace FundingConfig {
-    export interface DefaultRecommendedCurrency {
-      chain: string;
-
-      asset?: 'native-currency' | 'USDC';
-    }
-
-    export interface Option {
-      method: string;
-
-      provider: string;
-    }
-  }
-
-  export interface TelegramAuthConfig {
-    bot_id: string;
-
-    bot_name: string;
-
-    link_enabled: boolean;
-
-    seamless_auth_enabled: boolean;
-  }
-}
-
-export declare namespace Apps {
-  export { type AppResponse as AppResponse };
-}
+export * from './apps/index';