@surgeapi/node 0.25.7 → 0.27.0

package/resources/users.mjs

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+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, body, options) {
+        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, options) {
+        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, body, options) {
+        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, body, options) {
+        return this._client.post(path `/users/${userID}/tokens`, { body, ...options });
+    }
+}
+//# sourceMappingURL=users.mjs.map

package/resources/users.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAsB,EAAE,OAAwB;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAsB,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,UAAU,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAc,EACd,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}

package/resources/verifications.d.mts

@@ -0,0 +1,78 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare 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>;
+    /**
+     * 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>;
+}
+/**
+ * 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;
+}
+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 VerificationCreateParams as VerificationCreateParams, type VerificationCheckParams as VerificationCheckParams, };
+}
+//# sourceMappingURL=verifications.d.mts.map

package/resources/verifications.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifications.d.mts","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAI1F;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG1G;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,GAAG,kBAAkB,CAAC;IAE3E;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/verifications.d.ts

@@ -0,0 +1,78 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare 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>;
+    /**
+     * 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>;
+}
+/**
+ * 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;
+}
+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 VerificationCreateParams as VerificationCreateParams, type VerificationCheckParams as VerificationCheckParams, };
+}
+//# sourceMappingURL=verifications.d.ts.map

package/resources/verifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifications.d.ts","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAI1F;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG1G;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,GAAG,kBAAkB,CAAC;IAE3E;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/verifications.js

@@ -0,0 +1,37 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Verifications = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class Verifications extends resource_1.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, options) {
+        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, body, options) {
+        return this._client.post((0, path_1.path) `/verifications/${id}/checks`, { body, ...options });
+    }
+}
+exports.Verifications = Verifications;
+//# sourceMappingURL=verifications.js.map

package/resources/verifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifications.js","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAU,EAAE,IAA6B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AA7BD,sCA6BC"}

package/resources/verifications.mjs

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+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, options) {
+        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, body, options) {
+        return this._client.post(path `/verifications/${id}/checks`, { body, ...options });
+    }
+}
+//# sourceMappingURL=verifications.mjs.map

package/resources/verifications.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifications.mjs","sourceRoot":"","sources":["../src/resources/verifications.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAU,EAAE,IAA6B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}