@surgeapi/node 0.25.6 → 0.26.0

package/src/resources/users.ts

@@ -0,0 +1,209 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Users extends APIResource {
+  /**
+   * Creates a new User object.
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.create(
+   *   'acct_01j9a43avnfqzbjfch6pygv1td',
+   *   { first_name: 'Brian' },
+   * );
+   * ```
+   */
+  create(accountID: string, body: UserCreateParams, options?: RequestOptions): APIPromise<User> {
+    return this._client.post(path`/accounts/${accountID}/users`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a User object.
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.retrieve(
+   *   'usr_01j9dwavghe1ttppewekjjkfrx',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<User> {
+    return this._client.get(path`/users/${id}`, options);
+  }
+
+  /**
+   * Updates an existing User object.
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.update(
+   *   'usr_01j9dwavghe1ttppewekjjkfrx',
+   *   { first_name: 'Brian' },
+   * );
+   * ```
+   */
+  update(id: string, body: UserUpdateParams, options?: RequestOptions): APIPromise<User> {
+    return this._client.patch(path`/users/${id}`, { body, ...options });
+  }
+
+  /**
+   * Provides a mechanism for having Surge create a signed token for embeds instead
+   * of signing with your own signing key.
+   *
+   * @example
+   * ```ts
+   * const userTokenResponse = await client.users.createToken(
+   *   'usr_01jymgdfrpec2asc5m0z3a6fr9',
+   * );
+   * ```
+   */
+  createToken(
+    userID: string,
+    body: UserCreateTokenParams,
+    options?: RequestOptions,
+  ): APIPromise<UserTokenResponse> {
+    return this._client.post(path`/users/${userID}/tokens`, { body, ...options });
+  }
+}
+
+/**
+ * A user of the app
+ */
+export interface User {
+  /**
+   * The user's first name.
+   */
+  first_name: string;
+
+  /**
+   * Unique identifier for the object.
+   */
+  id?: string;
+
+  /**
+   * The user's last name.
+   */
+  last_name?: string;
+
+  /**
+   * Set of key-value pairs that will be stored with the object.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * URL of a photo to be used as the user's avatar.
+   */
+  photo_url?: string;
+}
+
+/**
+ * POST body for creating a user
+ */
+export interface UserParams {
+  /**
+   * The user's first name.
+   */
+  first_name: string;
+
+  /**
+   * The user's last name.
+   */
+  last_name?: string;
+
+  /**
+   * Set of key-value pairs that will be stored with the object.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * URL of a photo to be used as the user's avatar.
+   */
+  photo_url?: string;
+}
+
+/**
+ * A request to create a token
+ */
+export interface UserTokenParams {
+  /**
+   * For how many seconds the token should be accepted. Defaults to 15 minutes.
+   */
+  duration_seconds?: number;
+}
+
+/**
+ * Response when token has been created successfully
+ */
+export interface UserTokenResponse {
+  /**
+   * The created token.
+   */
+  token?: string;
+}
+
+export interface UserCreateParams {
+  /**
+   * The user's first name.
+   */
+  first_name: string;
+
+  /**
+   * The user's last name.
+   */
+  last_name?: string;
+
+  /**
+   * Set of key-value pairs that will be stored with the object.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * URL of a photo to be used as the user's avatar.
+   */
+  photo_url?: string;
+}
+
+export interface UserUpdateParams {
+  /**
+   * The user's first name.
+   */
+  first_name: string;
+
+  /**
+   * The user's last name.
+   */
+  last_name?: string;
+
+  /**
+   * Set of key-value pairs that will be stored with the object.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * URL of a photo to be used as the user's avatar.
+   */
+  photo_url?: string;
+}
+
+export interface UserCreateTokenParams {
+  /**
+   * For how many seconds the token should be accepted. Defaults to 15 minutes.
+   */
+  duration_seconds?: number;
+}
+
+export declare namespace Users {
+  export {
+    type User as User,
+    type UserParams as UserParams,
+    type UserTokenParams as UserTokenParams,
+    type UserTokenResponse as UserTokenResponse,
+    type UserCreateParams as UserCreateParams,
+    type UserUpdateParams as UserUpdateParams,
+    type UserCreateTokenParams as UserCreateTokenParams,
+  };
+}

package/src/resources/verifications.ts

@@ -0,0 +1,121 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Verifications extends APIResource {
+  /**
+   * Creates a new Verification and sends the code to the given phone number.
+   *
+   * @example
+   * ```ts
+   * const verification = await client.verifications.create({
+   *   phone_number: '+18015551234',
+   * });
+   * ```
+   */
+  create(body: VerificationCreateParams, options?: RequestOptions): APIPromise<Verification> {
+    return this._client.post('/verifications', { body, ...options });
+  }
+
+  /**
+   * Checks the code against a verification.
+   *
+   * @example
+   * ```ts
+   * const verificationCheck = await client.verifications.check(
+   *   'vfn_01jayh15c2f2xamftg0xpyq1nj',
+   *   { code: '123456' },
+   * );
+   * ```
+   */
+  check(id: string, body: VerificationCheckParams, options?: RequestOptions): APIPromise<VerificationCheck> {
+    return this._client.post(path`/verifications/${id}/checks`, { body, ...options });
+  }
+}
+
+/**
+ * A phone number verification
+ */
+export interface Verification {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * The number of times the code has been attempted.
+   */
+  attempt_count: number;
+
+  /**
+   * The phone number being verified. In E.164 format.
+   */
+  phone_number: string;
+
+  /**
+   * The current status of the verification.
+   */
+  status: 'pending' | 'verified' | 'exhausted' | 'expired';
+}
+
+/**
+ * The result of checking a Verification code
+ */
+export interface VerificationCheck {
+  /**
+   * The result of the code check.
+   */
+  result?: 'ok' | 'incorrect' | 'exhausted' | 'expired' | 'already_verified';
+
+  /**
+   * A phone number verification
+   */
+  verification?: Verification;
+}
+
+/**
+ * Parameters for checking a Verification code
+ */
+export interface VerificationCheckParams {
+  /**
+   * The Verification code that was received.
+   */
+  code: string;
+}
+
+/**
+ * Parameters for creating a Verification
+ */
+export interface VerificationParams {
+  /**
+   * The phone number to be verified. In E.164 format.
+   */
+  phone_number: string;
+}
+
+export interface VerificationCreateParams {
+  /**
+   * The phone number to be verified. In E.164 format.
+   */
+  phone_number: string;
+}
+
+export interface VerificationCheckParams {
+  /**
+   * The Verification code that was received.
+   */
+  code: string;
+}
+
+export declare namespace Verifications {
+  export {
+    type Verification as Verification,
+    type VerificationCheck as VerificationCheck,
+    type VerificationCheckParams as VerificationCheckParams,
+    type VerificationParams as VerificationParams,
+    type VerificationCreateParams as VerificationCreateParams,
+  };
+}