@surgeapi/node 0.26.0 → 0.27.1

package/src/resources/accounts.ts

@@ -89,38 +89,6 @@ export interface Account {
   time_zone: string | null;
 }
 
-/**
- * Parameters for creating a new account.
- */
-export interface AccountParams {
-  /**
-   * The name of the account that will be visible for your internal organizational
-   * purposes. This will also be the default public-facing brand name unless you also
-   * set a `brand_name`, but otherwise the account name will never be displayed
-   * anywhere outside of Surge HQ, and may include your ID for the account or
-   * anything else that may help you.
-   */
-  name: string;
-
-  /**
-   * The name by which the people this account communicates with know it. If not
-   * provided, this will match the name field.
-   */
-  brand_name?: string | null;
-
-  /**
-   * Parameters describing the legal entity on whose behalf the account will be
-   * operated.
-   */
-  organization?: OrganizationParams;
-
-  /**
-   * This is the time zone in which the account is headquartered. This time zone may
-   * be used for compliance with TCPA restrictions on when messages may be sent.
-   */
-  time_zone?: string;
-}
-
 /**
  * Response containing account status information
  */
@@ -175,37 +143,6 @@ export namespace AccountStatus {
   }
 }
 
-/**
- * Parameters for updating an existing account.
- */
-export interface AccountUpdateParams {
-  /**
-   * The name by which the people this account communicates with know it. If not
-   * provided, this will match the name field.
-   */
-  brand_name?: string;
-
-  /**
-   * The name of the account that will be visible for your internal organizational
-   * purposes. This will also be the default public-facing brand name unless you also
-   * set a `brand_name`, but otherwise the account name will never be displayed
-   * anywhere outside of Surge HQ, and may include your ID for the account or
-   * anything else that may help you.
-   */
-  name?: string;
-
-  /**
-   * Parameters describing the legal entity on whose behalf the account will be
-   * operated.
-   */
-  organization?: OrganizationParams;
-
-  /**
-   * The time zone for the account
-   */
-  time_zone?: string | null;
-}
-
 /**
  * The legal entity on whose behalf the account will be operated.
  */
@@ -454,282 +391,291 @@ export namespace Organization {
   }
 }
 
-/**
- * Parameters describing the legal entity on whose behalf the account will be
- * operated.
- */
-export interface OrganizationParams {
-  /**
-   * The address of the organization's headquarters.
-   */
-  address?: OrganizationParams.Address;
-
-  /**
-   * An object representing an individual who can be contacted if the carriers have
-   * any questions about the business.
-   */
-  contact?: OrganizationParams.Contact | null;
-
-  /**
-   * The two character ISO 3166 country code for the country in which the
-   * organization is headquartered.
-   */
-  country?: string | null;
-
-  /**
-   * For publicly traded companies, an email for a representative of the company to
-   * whom a verification email will be sent. This must be an email on the same domain
-   * as the company's website (e.g. with a website domain of
-   * `https://dtprecisionauto.com`, the email must use the same
-   * `@dtprecisionauto.com`)
-   */
-  email?: string | null;
-
-  /**
-   * The value of the identifier whose type is specified in the identifier_type
-   * field. Typically this will be an EIN, and can be formatted with or without the
-   * hyphen.
-   */
-  identifier?: string | null;
-
-  /**
-   * The type of identifier being provided for the organization. Support for more
-   * values will be added in the future.
-   */
-  identifier_type?: 'ein' | null;
-
-  /**
-   * The industry in which the organization operates.
-   */
-  industry?:
-    | 'agriculture'
-    | 'automotive'
-    | 'banking'
-    | 'construction'
-    | 'consumer'
-    | 'education'
-    | 'electronics'
-    | 'energy'
-    | 'engineering'
-    | 'fast_moving_consumer_goods'
-    | 'financial'
-    | 'fintech'
-    | 'food_and_beverage'
-    | 'government'
-    | 'healthcare'
-    | 'hospitality'
-    | 'insurance'
-    | 'jewelry'
-    | 'legal'
-    | 'manufacturing'
-    | 'media'
-    | 'not_for_profit'
-    | 'oil_and_gas'
-    | 'online'
-    | 'professional_services'
-    | 'raw_materials'
-    | 'real_estate'
-    | 'religion'
-    | 'retail'
-    | 'technology'
-    | 'telecommunications'
-    | 'transportation'
-    | 'travel'
-    | null;
-
-  /**
-   * For sole proprietors, this must be a valid US mobile phone number to which a
-   * verification text message will be sent. (E.164 format)
-   */
-  mobile_number?: string | null;
-
+export interface AccountCreateParams {
   /**
-   * An array of regions in which the organization operates.
+   * The name of the account that will be visible for your internal organizational
+   * purposes. This will also be the default public-facing brand name unless you also
+   * set a `brand_name`, but otherwise the account name will never be displayed
+   * anywhere outside of Surge HQ, and may include your ID for the account or
+   * anything else that may help you.
    */
-  regions_of_operation?: Array<
-    'africa' | 'asia' | 'australia' | 'europe' | 'latin_america' | 'usa_and_canada'
-  > | null;
+  name: string;
 
   /**
-   * The legal name of the organization as registered with the IRS or other relevant
-   * authorities. For some applications, this will be matched against government
-   * records and should include all punctuation and everything else as well.
+   * The name by which the people this account communicates with know it. If not
+   * provided, this will match the name field.
    */
-  registered_name?: string | null;
+  brand_name?: string | null;
 
   /**
-   * For publicly traded companies, this is the exchange on which the company's stock
-   * is traded.
+   * Parameters describing the legal entity on whose behalf the account will be
+   * operated.
    */
-  stock_exchange?:
-    | 'amex'
-    | 'amx'
-    | 'asx'
-    | 'b3'
-    | 'bme'
-    | 'bse'
-    | 'fra'
-    | 'icex'
-    | 'jpx'
-    | 'jse'
-    | 'krx'
-    | 'lon'
-    | 'nasdaq'
-    | 'none'
-    | 'nyse'
-    | 'nse'
-    | 'omx'
-    | 'other'
-    | 'sehk'
-    | 'sgx'
-    | 'sse'
-    | 'sto'
-    | 'swx'
-    | 'szse'
-    | 'tsx'
-    | 'twse'
-    | 'vse'
-    | null;
+  organization?: AccountCreateParams.Organization;
 
   /**
-   * For publicly traded companies, the ticker symbol for the company's stock
+   * This is the time zone in which the account is headquartered. This time zone may
+   * be used for compliance with TCPA restrictions on when messages may be sent.
    */
-  stock_symbol?: string | null;
+  time_zone?: string;
+}
 
+export namespace AccountCreateParams {
   /**
-   * The type of organization
+   * Parameters describing the legal entity on whose behalf the account will be
+   * operated.
    */
-  type?:
-    | 'co_op'
-    | 'government'
-    | 'llc'
-    | 'non_profit'
-    | 'partnership'
-    | 'private_corporation'
-    | 'public_corporation'
-    | 'sole_proprietor'
-    | null;
+  export interface Organization {
+    /**
+     * The address of the organization's headquarters.
+     */
+    address?: Organization.Address;
 
-  /**
-   * The URL of the website for this organization. The website should be publicly
-   * available, clearly reflect the organization's purpose, and the URL should start
-   * with `https://`
-   */
-  website?: string | null;
-}
+    /**
+     * An object representing an individual who can be contacted if Surge or our
+     * carrier partners have any questions about the business. If you are registering
+     * on behalf of your customer, this must be a contact from your customer's company
+     * rather than your own. The individual will likely never be contacted unless there
+     * are issues with spam.
+     */
+    contact?: Organization.Contact | null;
 
-export namespace OrganizationParams {
-  /**
-   * The address of the organization's headquarters.
-   */
-  export interface Address {
     /**
-     * The two character ISO 3166 country code. If none is provided, the organization's
-     * country code will be used.
+     * The two character ISO 3166 country code for the country in which the
+     * organization is headquartered.
      */
     country?: string | null;
 
     /**
-     * The first line of the address, typically the number and street name
+     * For publicly traded companies, an email for a representative of the company to
+     * whom a verification email will be sent. This must be an email on the same domain
+     * as the company's website (e.g. with a website domain of
+     * `https://dtprecisionauto.com`, the email must use the same
+     * `@dtprecisionauto.com`)
      */
-    line1?: string | null;
+    email?: string | null;
 
     /**
-     * The second line of the address if needed, typically an apartment or suite number
+     * The value of the identifier whose type is specified in the identifier_type
+     * field. Typically this will be an EIN, and can be formatted with or without the
+     * hyphen.
      */
-    line2?: string | null;
+    identifier?: string | null;
 
     /**
-     * The city or locality
+     * The type of identifier being provided for the organization. Support for more
+     * values will be added in the future.
      */
-    locality?: string | null;
+    identifier_type?: 'ein' | null;
 
     /**
-     * The name to which any mail should be addressed. If none is provided, this will
-     * default to the organization's registered_name
+     * The industry in which the organization operates.
      */
-    name?: string | null;
+    industry?:
+      | 'agriculture'
+      | 'automotive'
+      | 'banking'
+      | 'construction'
+      | 'consumer'
+      | 'education'
+      | 'electronics'
+      | 'energy'
+      | 'engineering'
+      | 'fast_moving_consumer_goods'
+      | 'financial'
+      | 'fintech'
+      | 'food_and_beverage'
+      | 'government'
+      | 'healthcare'
+      | 'hospitality'
+      | 'insurance'
+      | 'jewelry'
+      | 'legal'
+      | 'manufacturing'
+      | 'media'
+      | 'not_for_profit'
+      | 'oil_and_gas'
+      | 'online'
+      | 'professional_services'
+      | 'raw_materials'
+      | 'real_estate'
+      | 'religion'
+      | 'retail'
+      | 'technology'
+      | 'telecommunications'
+      | 'transportation'
+      | 'travel'
+      | null;
 
     /**
-     * The postal code
+     * For sole proprietors, this must be a valid US mobile phone number to which a
+     * verification text message will be sent. (E.164 format)
      */
-    postal_code?: string | null;
+    mobile_number?: string | null;
 
     /**
-     * The state or region
+     * An array of regions in which the organization operates.
      */
-    region?: string | null;
-  }
+    regions_of_operation?: Array<
+      'africa' | 'asia' | 'australia' | 'europe' | 'latin_america' | 'usa_and_canada'
+    > | null;
 
-  /**
-   * An object representing an individual who can be contacted if the carriers have
-   * any questions about the business.
-   */
-  export interface Contact {
     /**
-     * An email address at which the individual can be reached. Typically an email
-     * using the same domain name as the website URL will be preferred (e.g. with a
-     * website domain of `https://dtprecisionauto.com`, an email like
-     * `dom@dtprecisionauto.com` will be preferred over one like
-     * `dom@anothergarage.com` or `dom.toretto@gmail.com`)
+     * The legal name of the organization as registered with the IRS or other relevant
+     * authorities. For some applications, this will be matched against government
+     * records and should include all punctuation and everything else as well.
      */
-    email?: string | null;
+    registered_name?: string | null;
 
     /**
-     * The first name (or given name) of the individual
+     * For publicly traded companies, this is the exchange on which the company's stock
+     * is traded.
      */
-    first_name?: string | null;
+    stock_exchange?:
+      | 'amex'
+      | 'amx'
+      | 'asx'
+      | 'b3'
+      | 'bme'
+      | 'bse'
+      | 'fra'
+      | 'icex'
+      | 'jpx'
+      | 'jse'
+      | 'krx'
+      | 'lon'
+      | 'nasdaq'
+      | 'none'
+      | 'nyse'
+      | 'nse'
+      | 'omx'
+      | 'other'
+      | 'sehk'
+      | 'sgx'
+      | 'sse'
+      | 'sto'
+      | 'swx'
+      | 'szse'
+      | 'tsx'
+      | 'twse'
+      | 'vse'
+      | null;
 
     /**
-     * The last name (or family name) of the individual
+     * For publicly traded companies, the ticker symbol for the company's stock
      */
-    last_name?: string | null;
+    stock_symbol?: string | null;
 
     /**
-     * A phone number at which the individual can be reached (E.164 format)
+     * The type of organization
      */
-    phone_number?: string | null;
+    type?:
+      | 'co_op'
+      | 'government'
+      | 'llc'
+      | 'non_profit'
+      | 'partnership'
+      | 'private_corporation'
+      | 'public_corporation'
+      | 'sole_proprietor'
+      | null;
 
     /**
-     * The job title of the individual.
+     * The URL of the website for this organization. The website should be publicly
+     * available, clearly reflect the organization's purpose, and the URL should start
+     * with `https://`
      */
-    title?: 'ceo' | 'cfo' | 'director' | 'gm' | 'vp' | 'general_counsel' | 'other' | null;
+    website?: string | null;
+  }
 
+  export namespace Organization {
     /**
-     * If `other` is provided for the `title` field, this field should be used to
-     * provide the title of the individual
+     * The address of the organization's headquarters.
      */
-    title_other?: string | null;
-  }
-}
+    export interface Address {
+      /**
+       * The two character ISO 3166 country code. If none is provided, the organization's
+       * country code will be used.
+       */
+      country?: string | null;
 
-export interface AccountCreateParams {
-  /**
-   * The name of the account that will be visible for your internal organizational
-   * purposes. This will also be the default public-facing brand name unless you also
-   * set a `brand_name`, but otherwise the account name will never be displayed
-   * anywhere outside of Surge HQ, and may include your ID for the account or
-   * anything else that may help you.
-   */
-  name: string;
+      /**
+       * The first line of the address, typically the number and street name
+       */
+      line1?: string | null;
 
-  /**
-   * The name by which the people this account communicates with know it. If not
-   * provided, this will match the name field.
-   */
-  brand_name?: string | null;
+      /**
+       * The second line of the address if needed, typically an apartment or suite number
+       */
+      line2?: string | null;
 
-  /**
-   * Parameters describing the legal entity on whose behalf the account will be
-   * operated.
-   */
-  organization?: OrganizationParams;
+      /**
+       * The city or locality
+       */
+      locality?: string | null;
 
-  /**
-   * This is the time zone in which the account is headquartered. This time zone may
-   * be used for compliance with TCPA restrictions on when messages may be sent.
-   */
-  time_zone?: string;
+      /**
+       * The name to which any mail should be addressed. If none is provided, this will
+       * default to the organization's registered_name
+       */
+      name?: string | null;
+
+      /**
+       * The postal code
+       */
+      postal_code?: string | null;
+
+      /**
+       * The state or region
+       */
+      region?: string | null;
+    }
+
+    /**
+     * An object representing an individual who can be contacted if Surge or our
+     * carrier partners have any questions about the business. If you are registering
+     * on behalf of your customer, this must be a contact from your customer's company
+     * rather than your own. The individual will likely never be contacted unless there
+     * are issues with spam.
+     */
+    export interface Contact {
+      /**
+       * An email address at which the individual can be reached. Typically an email
+       * using the same domain name as the website URL will be preferred (e.g. with a
+       * website domain of `https://dtprecisionauto.com`, an email like
+       * `dom@dtprecisionauto.com` will be preferred over one like
+       * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
+       * would also be acceptable, but not preferred)
+       */
+      email?: string | null;
+
+      /**
+       * The first name (or given name) of the individual
+       */
+      first_name?: string | null;
+
+      /**
+       * The last name (or family name) of the individual
+       */
+      last_name?: string | null;
+
+      /**
+       * A phone number at which the individual can be reached (E.164 format)
+       */
+      phone_number?: string | null;
+
+      /**
+       * The job title of the individual.
+       */
+      title?: 'ceo' | 'cfo' | 'director' | 'gm' | 'vp' | 'general_counsel' | 'other' | null;
+
+      /**
+       * If `other` is provided for the `title` field, this field should be used to
+       * provide the title of the individual
+       */
+      title_other?: string | null;
+    }
+  }
 }
 
 export interface AccountUpdateParams {
@@ -752,7 +698,7 @@ export interface AccountUpdateParams {
    * Parameters describing the legal entity on whose behalf the account will be
    * operated.
    */
-  organization?: OrganizationParams;
+  organization?: AccountUpdateParams.Organization;
 
   /**
    * The time zone for the account
@@ -760,19 +706,278 @@ export interface AccountUpdateParams {
   time_zone?: string | null;
 }
 
+export namespace AccountUpdateParams {
+  /**
+   * Parameters describing the legal entity on whose behalf the account will be
+   * operated.
+   */
+  export interface Organization {
+    /**
+     * The address of the organization's headquarters.
+     */
+    address?: Organization.Address;
+
+    /**
+     * An object representing an individual who can be contacted if Surge or our
+     * carrier partners have any questions about the business. If you are registering
+     * on behalf of your customer, this must be a contact from your customer's company
+     * rather than your own. The individual will likely never be contacted unless there
+     * are issues with spam.
+     */
+    contact?: Organization.Contact | null;
+
+    /**
+     * The two character ISO 3166 country code for the country in which the
+     * organization is headquartered.
+     */
+    country?: string | null;
+
+    /**
+     * For publicly traded companies, an email for a representative of the company to
+     * whom a verification email will be sent. This must be an email on the same domain
+     * as the company's website (e.g. with a website domain of
+     * `https://dtprecisionauto.com`, the email must use the same
+     * `@dtprecisionauto.com`)
+     */
+    email?: string | null;
+
+    /**
+     * The value of the identifier whose type is specified in the identifier_type
+     * field. Typically this will be an EIN, and can be formatted with or without the
+     * hyphen.
+     */
+    identifier?: string | null;
+
+    /**
+     * The type of identifier being provided for the organization. Support for more
+     * values will be added in the future.
+     */
+    identifier_type?: 'ein' | null;
+
+    /**
+     * The industry in which the organization operates.
+     */
+    industry?:
+      | 'agriculture'
+      | 'automotive'
+      | 'banking'
+      | 'construction'
+      | 'consumer'
+      | 'education'
+      | 'electronics'
+      | 'energy'
+      | 'engineering'
+      | 'fast_moving_consumer_goods'
+      | 'financial'
+      | 'fintech'
+      | 'food_and_beverage'
+      | 'government'
+      | 'healthcare'
+      | 'hospitality'
+      | 'insurance'
+      | 'jewelry'
+      | 'legal'
+      | 'manufacturing'
+      | 'media'
+      | 'not_for_profit'
+      | 'oil_and_gas'
+      | 'online'
+      | 'professional_services'
+      | 'raw_materials'
+      | 'real_estate'
+      | 'religion'
+      | 'retail'
+      | 'technology'
+      | 'telecommunications'
+      | 'transportation'
+      | 'travel'
+      | null;
+
+    /**
+     * For sole proprietors, this must be a valid US mobile phone number to which a
+     * verification text message will be sent. (E.164 format)
+     */
+    mobile_number?: string | null;
+
+    /**
+     * An array of regions in which the organization operates.
+     */
+    regions_of_operation?: Array<
+      'africa' | 'asia' | 'australia' | 'europe' | 'latin_america' | 'usa_and_canada'
+    > | null;
+
+    /**
+     * The legal name of the organization as registered with the IRS or other relevant
+     * authorities. For some applications, this will be matched against government
+     * records and should include all punctuation and everything else as well.
+     */
+    registered_name?: string | null;
+
+    /**
+     * For publicly traded companies, this is the exchange on which the company's stock
+     * is traded.
+     */
+    stock_exchange?:
+      | 'amex'
+      | 'amx'
+      | 'asx'
+      | 'b3'
+      | 'bme'
+      | 'bse'
+      | 'fra'
+      | 'icex'
+      | 'jpx'
+      | 'jse'
+      | 'krx'
+      | 'lon'
+      | 'nasdaq'
+      | 'none'
+      | 'nyse'
+      | 'nse'
+      | 'omx'
+      | 'other'
+      | 'sehk'
+      | 'sgx'
+      | 'sse'
+      | 'sto'
+      | 'swx'
+      | 'szse'
+      | 'tsx'
+      | 'twse'
+      | 'vse'
+      | null;
+
+    /**
+     * For publicly traded companies, the ticker symbol for the company's stock
+     */
+    stock_symbol?: string | null;
+
+    /**
+     * The type of organization
+     */
+    type?:
+      | 'co_op'
+      | 'government'
+      | 'llc'
+      | 'non_profit'
+      | 'partnership'
+      | 'private_corporation'
+      | 'public_corporation'
+      | 'sole_proprietor'
+      | null;
+
+    /**
+     * The URL of the website for this organization. The website should be publicly
+     * available, clearly reflect the organization's purpose, and the URL should start
+     * with `https://`
+     */
+    website?: string | null;
+  }
+
+  export namespace Organization {
+    /**
+     * The address of the organization's headquarters.
+     */
+    export interface Address {
+      /**
+       * The two character ISO 3166 country code. If none is provided, the organization's
+       * country code will be used.
+       */
+      country?: string | null;
+
+      /**
+       * The first line of the address, typically the number and street name
+       */
+      line1?: string | null;
+
+      /**
+       * The second line of the address if needed, typically an apartment or suite number
+       */
+      line2?: string | null;
+
+      /**
+       * The city or locality
+       */
+      locality?: string | null;
+
+      /**
+       * The name to which any mail should be addressed. If none is provided, this will
+       * default to the organization's registered_name
+       */
+      name?: string | null;
+
+      /**
+       * The postal code
+       */
+      postal_code?: string | null;
+
+      /**
+       * The state or region
+       */
+      region?: string | null;
+    }
+
+    /**
+     * An object representing an individual who can be contacted if Surge or our
+     * carrier partners have any questions about the business. If you are registering
+     * on behalf of your customer, this must be a contact from your customer's company
+     * rather than your own. The individual will likely never be contacted unless there
+     * are issues with spam.
+     */
+    export interface Contact {
+      /**
+       * An email address at which the individual can be reached. Typically an email
+       * using the same domain name as the website URL will be preferred (e.g. with a
+       * website domain of `https://dtprecisionauto.com`, an email like
+       * `dom@dtprecisionauto.com` will be preferred over one like
+       * `dom@anothergarage.com` or `dom.toretto@gmail.com`. `dtprecisionauto@gmail.com`
+       * would also be acceptable, but not preferred)
+       */
+      email?: string | null;
+
+      /**
+       * The first name (or given name) of the individual
+       */
+      first_name?: string | null;
+
+      /**
+       * The last name (or family name) of the individual
+       */
+      last_name?: string | null;
+
+      /**
+       * A phone number at which the individual can be reached (E.164 format)
+       */
+      phone_number?: string | null;
+
+      /**
+       * The job title of the individual.
+       */
+      title?: 'ceo' | 'cfo' | 'director' | 'gm' | 'vp' | 'general_counsel' | 'other' | null;
+
+      /**
+       * If `other` is provided for the `title` field, this field should be used to
+       * provide the title of the individual
+       */
+      title_other?: string | null;
+    }
+  }
+}
+
 export interface AccountRetrieveStatusParams {
+  /**
+   * capabilities about which to check the status
+   */
   capabilities?: Array<'local_messaging'>;
 }
 
 export declare namespace Accounts {
   export {
     type Account as Account,
-    type AccountParams as AccountParams,
     type AccountStatus as AccountStatus,
-    type AccountUpdateParams as AccountUpdateParams,
     type Organization as Organization,
-    type OrganizationParams as OrganizationParams,
     type AccountCreateParams as AccountCreateParams,
+    type AccountUpdateParams as AccountUpdateParams,
     type AccountRetrieveStatusParams as AccountRetrieveStatusParams,
   };
 }