@surgeapi/node 0.25.7 → 0.27.0

package/dist/api/resources/verifications/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./client"), exports);

package/dist/api/types/AccountResponse.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Response containing account information
- */
-export interface AccountResponse {
-    /** The account ID */
-    id: string;
-    /** The name of the account */
-    name: string;
-    /** The time zone for the account */
-    time_zone?: string;
-}

package/dist/api/types/AccountResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/AttachmentParams.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Params for creating an attachment
- */
-export interface AttachmentParams {
-    /** The URL of the attachment. */
-    url: string;
-}

package/dist/api/types/AttachmentParams.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/AttachmentResponse.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Response schema for single attachment
- */
-export interface AttachmentResponse {
-    /** Unique identifier for the object. */
-    id?: string;
-    /** The type of attachment. */
-    type?: string;
-    /** The URL of the attachment. */
-    url?: string;
-}

package/dist/api/types/AttachmentResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/BlastResponse.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * Response schema for single blast
- */
-export interface BlastResponse {
-    attachments?: Surge.BlastResponseAttachmentsItem[];
-    /** The message body. */
-    body?: string;
-    /** Unique identifier for the object. */
-    id?: string;
-    /** Optional name for the blast. */
-    name?: string;
-    /** When the blast will be or was sent. */
-    send_at?: string;
-}

package/dist/api/types/BlastResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/BlastResponseAttachmentsItem.d.ts

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface BlastResponseAttachmentsItem {
-    /** The URL of the attachment. */
-    url?: string;
-}

package/dist/api/types/BlastResponseAttachmentsItem.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/Contact.d.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * A contact who has consented to receive messages
- */
-export interface Contact {
-    /** The contact's first name. */
-    first_name?: string;
-    /** Unique identifier for the object. */
-    id: string;
-    /** The contact's last name. */
-    last_name?: string;
-    /** The contact's phone number in E.164 format. */
-    phone_number: string;
-}

package/dist/api/types/Contact.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContactRequest.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * POST body for creating a contact
- */
-export interface ContactRequest {
-    /** The contact's email address. */
-    email?: string;
-    /** The contact's first name. */
-    first_name?: string;
-    /** The contact's last name. */
-    last_name?: string;
-    /** Additional metadata about the contact. */
-    metadata?: Record<string, unknown>;
-    /** The contact's phone number in E.164 format. */
-    phone_number: string;
-}

package/dist/api/types/ContactRequest.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ContactResponse.d.ts

@@ -1,20 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Response schema for single contact
- */
-export interface ContactResponse {
-    /** The contact's email address. */
-    email?: string;
-    /** The contact's first name. */
-    first_name?: string;
-    /** Unique identifier for the object. */
-    id?: string;
-    /** The contact's last name. */
-    last_name?: string;
-    /** Additional metadata about the contact. */
-    metadata?: Record<string, unknown>;
-    /** The contact's phone number in E.164 format. */
-    phone_number?: string;
-}

package/dist/api/types/ContactResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/Conversation.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * A conversation with a Contact
- */
-export interface Conversation {
-    contact: Surge.Contact;
-    /** Unique identifier for the object. */
-    id: string;
-    phone_number?: Surge.ConversationPhoneNumber;
-}

package/dist/api/types/Conversation.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ConversationPhoneNumber.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * This is the phone number tied to the Surge account.
- */
-export interface ConversationPhoneNumber {
-    /** Unique identifier for the phone number */
-    id: string;
-    /** The canonical format of the phone number. */
-    number: string;
-    /** Whether the phone number is local, toll-free, or short code */
-    type: Surge.ConversationPhoneNumberType;
-}

package/dist/api/types/ConversationPhoneNumber.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/ConversationPhoneNumberType.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Whether the phone number is local, toll-free, or short code
- */
-export type ConversationPhoneNumberType = "local" | "toll_free" | "short_code" | "demo";
-export declare const ConversationPhoneNumberType: {
-    readonly Local: "local";
-    readonly TollFree: "toll_free";
-    readonly ShortCode: "short_code";
-    readonly Demo: "demo";
-};

package/dist/api/types/ConversationPhoneNumberType.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationPhoneNumberType = void 0;
-exports.ConversationPhoneNumberType = {
-    Local: "local",
-    TollFree: "toll_free",
-    ShortCode: "short_code",
-    Demo: "demo",
-};

package/dist/api/types/MessageConversationContactParams.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Params for selecting or creating a new contact for sending a message. Either the id or the phone number must be given.
- */
-export interface MessageConversationContactParams {
-    /** The contact's first name in case a new contact is created. */
-    first_name?: string;
-    /** The message's last name in case a new contact is created. */
-    last_name?: string;
-    /** The contact's phone number in E.164 format. */
-    phone_number?: string;
-}

package/dist/api/types/MessageConversationContactParams.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MessageConversationParams.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * Params for selecting or creating a new conversation. Either the id or the Contact must be given.
- */
-export interface MessageConversationParams {
-    contact: Surge.MessageConversationContactParams;
-    /** The phone number from which to send the message. This can be either the phone number in E.164 format or a Surge phone number id. */
-    phone_number?: string;
-}

package/dist/api/types/MessageConversationParams.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MessageResponse.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * Response schema for single message
- */
-export interface MessageResponse {
-    attachments?: Surge.AttachmentResponse[];
-    /** The message body. */
-    body?: string;
-    conversation?: Surge.Conversation;
-    /** Unique identifier for the object. */
-    id?: string;
-}

package/dist/api/types/MessageResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/PhoneNumber.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * A phone number that can be used to send and receive messages and calls
- */
-export interface PhoneNumber {
-    /** Unique identifier for the phone number */
-    id: string;
-    /** The phone number in E.164 format */
-    number: string;
-    /** Whether the phone number is local, toll-free, or short code */
-    type: Surge.PhoneNumberType;
-}

package/dist/api/types/PhoneNumber.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/PhoneNumberType.d.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Whether the phone number is local, toll-free, or short code
- */
-export type PhoneNumberType = "local" | "toll_free";
-export declare const PhoneNumberType: {
-    readonly Local: "local";
-    readonly TollFree: "toll_free";
-};

package/dist/api/types/PhoneNumberType.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PhoneNumberType = void 0;
-exports.PhoneNumberType = {
-    Local: "local",
-    TollFree: "toll_free",
-};

package/dist/api/types/UserResponse.d.ts

@@ -1,18 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Response schema for single user
- */
-export interface UserResponse {
-    /** 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 user. */
-    metadata?: Record<string, unknown>;
-    /** URL of a photo to be used as the user's avatar. */
-    photo_url?: string;
-}

package/dist/api/types/UserResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/Verification.d.ts

@@ -1,17 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * A phone number verification
- */
-export interface Verification {
-    /** The number of times the code has been attempted. */
-    attempt_count: number;
-    /** Unique identifier for the object. */
-    id: string;
-    /** The phone number being verified. In E.164 format. */
-    phone_number: string;
-    /** The current status of the verification. */
-    status: Surge.VerificationStatus;
-}

package/dist/api/types/Verification.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/VerificationCheckAlreadyVerifiedResponse.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * The response returned from checking a Verification code
- */
-export interface VerificationCheckAlreadyVerifiedResponse {
-    /** The result of the code check. */
-    result?: Surge.VerificationCheckAlreadyVerifiedResponseResult;
-    verification?: Surge.Verification;
-}

package/dist/api/types/VerificationCheckAlreadyVerifiedResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/VerificationCheckAlreadyVerifiedResponseResult.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The result of the code check.
- */
-export type VerificationCheckAlreadyVerifiedResponseResult = "ok" | "incorrect" | "exhausted" | "expired" | "already_verified";
-export declare const VerificationCheckAlreadyVerifiedResponseResult: {
-    readonly Ok: "ok";
-    readonly Incorrect: "incorrect";
-    readonly Exhausted: "exhausted";
-    readonly Expired: "expired";
-    readonly AlreadyVerified: "already_verified";
-};

package/dist/api/types/VerificationCheckAlreadyVerifiedResponseResult.js

@@ -1,13 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VerificationCheckAlreadyVerifiedResponseResult = void 0;
-exports.VerificationCheckAlreadyVerifiedResponseResult = {
-    Ok: "ok",
-    Incorrect: "incorrect",
-    Exhausted: "exhausted",
-    Expired: "expired",
-    AlreadyVerified: "already_verified",
-};

package/dist/api/types/VerificationCheckIncorrectResponse.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * The response returned from checking a Verification code
- */
-export interface VerificationCheckIncorrectResponse {
-    /** The result of the code check. */
-    result?: Surge.VerificationCheckIncorrectResponseResult;
-    verification?: Surge.Verification;
-}

package/dist/api/types/VerificationCheckIncorrectResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/VerificationCheckIncorrectResponseResult.d.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The result of the code check.
- */
-export type VerificationCheckIncorrectResponseResult = "incorrect" | "exhausted" | "expired";
-export declare const VerificationCheckIncorrectResponseResult: {
-    readonly Incorrect: "incorrect";
-    readonly Exhausted: "exhausted";
-    readonly Expired: "expired";
-};

package/dist/api/types/VerificationCheckIncorrectResponseResult.js

@@ -1,11 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VerificationCheckIncorrectResponseResult = void 0;
-exports.VerificationCheckIncorrectResponseResult = {
-    Incorrect: "incorrect",
-    Exhausted: "exhausted",
-    Expired: "expired",
-};

package/dist/api/types/VerificationCheckOkResponse.d.ts

@@ -1,21 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Surge from "../index";
-/**
- * The response returned from checking a Verification code
- */
-export interface VerificationCheckOkResponse {
-    /**
-     * The result of the code check.
-     *
-     * This result will affect the status code of the response:
-     * - ok: 200
-     * - incorrect: 422
-     * - exhausted: 422
-     * - expired: 422
-     * - already_verified: 409
-     */
-    result?: Surge.VerificationCheckOkResponseResult;
-    verification?: Surge.Verification;
-}

package/dist/api/types/VerificationCheckOkResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/VerificationCheckOkResponseResult.d.ts

@@ -1,21 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The result of the code check.
- *
- * This result will affect the status code of the response:
- * - ok: 200
- * - incorrect: 422
- * - exhausted: 422
- * - expired: 422
- * - already_verified: 409
- */
-export type VerificationCheckOkResponseResult = "ok" | "incorrect" | "exhausted" | "expired" | "already_verified";
-export declare const VerificationCheckOkResponseResult: {
-    readonly Ok: "ok";
-    readonly Incorrect: "incorrect";
-    readonly Exhausted: "exhausted";
-    readonly Expired: "expired";
-    readonly AlreadyVerified: "already_verified";
-};

package/dist/api/types/VerificationCheckOkResponseResult.js

@@ -1,13 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VerificationCheckOkResponseResult = void 0;
-exports.VerificationCheckOkResponseResult = {
-    Ok: "ok",
-    Incorrect: "incorrect",
-    Exhausted: "exhausted",
-    Expired: "expired",
-    AlreadyVerified: "already_verified",
-};

package/dist/api/types/VerificationStatus.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The current status of the verification.
- */
-export type VerificationStatus = "pending" | "verified" | "exhausted" | "expired";
-export declare const VerificationStatus: {
-    readonly Pending: "pending";
-    readonly Verified: "verified";
-    readonly Exhausted: "exhausted";
-    readonly Expired: "expired";
-};

package/dist/api/types/VerificationStatus.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VerificationStatus = void 0;
-exports.VerificationStatus = {
-    Pending: "pending",
-    Verified: "verified",
-    Exhausted: "exhausted",
-    Expired: "expired",
-};