@zavudev/sdk 0.57.0 → 0.58.1

package/resources/phone-numbers.d.ts

@@ -1,281 +1,137 @@
 import { APIResource } from "../core/resource.js";
 import { APIPromise } from "../core/api-promise.js";
-import { Cursor, type CursorParams, PagePromise } from "../core/pagination.js";
+import { Cursor, PagePromise } from "../core/pagination.js";
 import { RequestOptions } from "../internal/request-options.js";
+import type * as T from "../types.js";
 export declare class PhoneNumbers extends APIResource {
     /**
+     * Get phone number
+     *
      * Get details of a specific phone number.
      *
-     * @example
-     * ```ts
-     * const phoneNumber = await client.phoneNumbers.retrieve(
-     *   'phoneNumberId',
-     * );
-     * ```
+     * `GET /v1/phone-numbers/{phoneNumberId}`
      */
     retrieve(phoneNumberID: string, options?: RequestOptions): APIPromise<PhoneNumberRetrieveResponse>;
     /**
+     * Update phone number
+     *
      * Update a phone number's name or sender assignment.
      *
-     * @example
-     * ```ts
-     * const phoneNumber = await client.phoneNumbers.update(
-     *   'phoneNumberId',
-     *   { name: 'Support Line' },
-     * );
-     * ```
+     * `PATCH /v1/phone-numbers/{phoneNumberId}`
      */
     update(phoneNumberID: string, body: PhoneNumberUpdateParams, options?: RequestOptions): APIPromise<PhoneNumberUpdateResponse>;
     /**
+     * List phone numbers
+     *
      * List all phone numbers owned by this project.
      *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const ownedPhoneNumber of client.phoneNumbers.list()) {
-     *   // ...
-     * }
-     * ```
+     * `GET /v1/phone-numbers`
      */
     list(query?: PhoneNumberListParams | null | undefined, options?: RequestOptions): PagePromise<OwnedPhoneNumbersCursor, OwnedPhoneNumber>;
     /**
+     * Purchase a phone number
+     *
      * Purchase an available phone number. Requires a paid plan: the Free plan cannot
-     * purchase phone numbers and receives `402` with code `paid_plan_required`. Paid
-     * plans include one US number at no charge. The included number is one per account
-     * and is granted once: claiming it spends the benefit for good, so releasing that
-     * number does not make another one free, and numbers the account already bought do
-     * not consume it.
+     * purchase phone numbers and receives `402` with code `paid_plan_required`.
+     *
+     * **The included number.** A paid plan includes one number at no charge, once per
+     * account: it must be a US or Canadian number (a +1 number) costing $20 a month or
+     * less. `isFreeEligible` in `GET /v1/phone-numbers/available` marks the numbers
+     * that qualify. Claiming it spends the benefit for good, across every team the
+     * account owner owns, so releasing that number does not make another one free.
      *
-     * @example
-     * ```ts
-     * const response = await client.phoneNumbers.purchase({
-     *   phoneNumber: '+15551234567',
-     *   name: 'Primary Line',
-     * });
-     * ```
+     * **Numbers with regulatory requirements.** Which numbers need regulatory
+     * information is decided per number, not by a fixed country list. The purchase
+     * looks the requirements up for the exact number before charging anything:
+     *
+     * 1. `GET /v1/phone-numbers/requirements?phoneNumber=...`. If `items` is empty,
+     * buy normally.
+     * 2. Create what it asks for: addresses with `POST /v1/addresses`, documents with
+     * `POST /v1/documents`.
+     * 3. Purchase with `type` and `regulatoryRequirements`. The number is bought and
+     * billed at once with `regulatoryStatus: pending_review`.
+     * 4. Poll `GET /v1/phone-numbers/{phoneNumberId}` until `regulatoryStatus` is
+     * `approved`. Assign it to a sender before or after approval; it starts carrying
+     * messages once approved.
+     *
+     * **Reuse.** Information you submitted is kept for your project, per country and
+     * `type`, and a later purchase there may omit `regulatoryRequirements`. Reuse only
+     * happens when what is kept still covers every requirement of the new number and
+     * every address and document in it belongs to the project. Otherwise, or when
+     * nothing is kept, the purchase returns `400 regulatory_compliance_required` with
+     * the missing requirements in `details`.
+     *
+     * Invalid values (a missing, unknown or repeated requirement id, an address or
+     * document from another project, or one rejected in review) return `400
+     * invalid_request`. If an address or document cannot be registered for review, the
+     * purchase returns `400 invalid_request` naming the requirement. If the
+     * requirements cannot be looked up, the purchase returns `502
+     * requirements_unavailable`, except for US and Canadian numbers, which are sold as
+     * numbers without requirements. None of these errors charge anything.
+     *
+     * `POST /v1/phone-numbers`
      */
     purchase(body: PhoneNumberPurchaseParams, options?: RequestOptions): APIPromise<PhoneNumberPurchaseResponse>;
     /**
+     * Release phone number
+     *
      * Release a phone number. The phone number must not be assigned to a sender.
      *
-     * @example
-     * ```ts
-     * await client.phoneNumbers.release('phoneNumberId');
-     * ```
+     * `DELETE /v1/phone-numbers/{phoneNumberId}`
      */
     release(phoneNumberID: string, options?: RequestOptions): APIPromise<void>;
     /**
-     * Get regulatory requirements for purchasing phone numbers in a specific country.
-     * Some countries require additional documentation (addresses, identity documents)
-     * before phone numbers can be activated.
+     * Get regulatory requirements
      *
-     * @example
-     * ```ts
-     * const response = await client.phoneNumbers.requirements({
-     *   countryCode: 'xx',
-     * });
-     * ```
+     * Get the regulatory information needed to buy a phone number, for one specific
+     * number or for a country and number type. Prefer `phoneNumber`: the response is
+     * then exactly the list the purchase of that number validates against. Pass each
+     * `requirementTypes[].id` back as `requirementType` in `regulatoryRequirements` on
+     * `POST /v1/phone-numbers`.
+     *
+     * For `phoneNumber`, the requirements of that exact number are returned. When they
+     * cannot be resolved for the number itself, the list for its country and `type` is
+     * returned instead, and the purchase uses the same list. An empty `items` array
+     * means the number needs no regulatory information. If the requirements cannot be
+     * retrieved at all, the response is `502 requirements_unavailable`, never an empty
+     * list.
+     *
+     * URL-encode the `+` of `phoneNumber` as `%2B`. An unencoded `+` is also accepted.
+     *
+     * `GET /v1/phone-numbers/requirements`
      */
     requirements(query: PhoneNumberRequirementsParams, options?: RequestOptions): APIPromise<PhoneNumberRequirementsResponse>;
     /**
+     * Search available phone numbers
+     *
      * Search for available phone numbers to purchase by country and type.
      *
-     * @example
-     * ```ts
-     * const response = await client.phoneNumbers.searchAvailable({
-     *   countryCode: 'xx',
-     * });
-     * ```
+     * `GET /v1/phone-numbers/available`
      */
     searchAvailable(query: PhoneNumberSearchAvailableParams, options?: RequestOptions): APIPromise<PhoneNumberSearchAvailableResponse>;
 }
-export type OwnedPhoneNumbersCursor = Cursor<OwnedPhoneNumber>;
-export interface AvailablePhoneNumber {
-    capabilities: PhoneNumberCapabilities;
-    phoneNumber: string;
-    pricing: PhoneNumberPricing;
-    friendlyName?: string;
-    locality?: string;
-    region?: string;
-}
-export interface OwnedPhoneNumber {
-    id: string;
-    capabilities: Array<string>;
-    createdAt: string;
-    phoneNumber: string;
-    pricing: OwnedPhoneNumberPricing;
-    status: PhoneNumberStatus;
-    /**
-     * Optional custom name for the phone number.
-     */
-    name?: string;
-    nextRenewalDate?: string;
-    /**
-     * Sender ID if the phone number is assigned to a sender.
-     */
-    senderId?: string;
-    updatedAt?: string;
-}
-export interface OwnedPhoneNumberPricing {
-    /**
-     * Whether this is a free number.
-     */
-    isFreeNumber?: boolean;
-    /**
-     * Monthly cost in cents.
-     */
-    monthlyCost?: number;
-    /**
-     * Monthly price in USD.
-     */
-    monthlyPrice?: number;
-    /**
-     * One-time purchase cost in cents.
-     */
-    upfrontCost?: number;
-}
-export interface PhoneNumberCapabilities {
-    mms?: boolean;
-    sms?: boolean;
-    voice?: boolean;
-}
-export interface PhoneNumberPricing {
-    /**
-     * Whether this number qualifies as the plan-included US number on paid plans. The
-     * benefit is one per account: it is never offered again once claimed, not even
-     * after the number is released.
-     */
-    isFreeEligible?: boolean;
-    /**
-     * Monthly price in USD.
-     */
-    monthlyPrice?: number;
-    /**
-     * One-time purchase price in USD.
-     */
-    upfrontPrice?: number;
-}
-export type PhoneNumberStatus = 'active' | 'suspended' | 'pending';
-/**
- * Type of phone number. `mobile` is stocked in countries where no geographic
- * (`local`) or non-geographic (`national`) inventory exists, and in several
- * markets it is the only type that can receive SMS.
- */
-export type PhoneNumberType = 'local' | 'national' | 'tollFree' | 'mobile';
-/**
- * A group of requirements for a specific country/phone type combination.
- */
-export interface Requirement {
-    id: string;
-    action: string;
-    countryCode: string;
-    phoneNumberType: string;
-    requirementTypes: Array<RequirementType>;
-}
-/**
- * Acceptance criteria for a requirement.
- */
-export interface RequirementAcceptanceCriteria {
-    allowedValues?: Array<string> | null;
-    maxLength?: number | null;
-    minLength?: number | null;
-    regexPattern?: string | null;
-}
-/**
- * Type of requirement field.
- */
-export type RequirementFieldType = 'textual' | 'address' | 'document' | 'action';
-/**
- * A specific requirement type within a requirement group.
- */
-export interface RequirementType {
-    id: string;
-    description: string;
-    name: string;
-    /**
-     * Type of requirement field.
-     */
-    type: RequirementFieldType;
-    /**
-     * Acceptance criteria for a requirement.
-     */
-    acceptanceCriteria?: RequirementAcceptanceCriteria;
-    example?: string | null;
-}
-export interface PhoneNumberRetrieveResponse {
-    phoneNumber: OwnedPhoneNumber;
-}
-export interface PhoneNumberUpdateResponse {
-    phoneNumber: OwnedPhoneNumber;
-}
-export interface PhoneNumberPurchaseResponse {
-    phoneNumber: OwnedPhoneNumber;
-}
-export interface PhoneNumberRequirementsResponse {
-    items: Array<Requirement>;
-}
-export interface PhoneNumberSearchAvailableResponse {
-    items: Array<AvailablePhoneNumber>;
-}
-export interface PhoneNumberUpdateParams {
-    /**
-     * Custom name for the phone number. Set to null to clear.
-     */
-    name?: string | null;
-    /**
-     * Sender ID to assign the phone number to. Set to null to unassign.
-     */
-    senderId?: string | null;
-}
-export interface PhoneNumberListParams extends CursorParams {
-    /**
-     * Filter by phone number status.
-     */
-    status?: PhoneNumberStatus;
-}
-export interface PhoneNumberPurchaseParams {
-    /**
-     * Phone number in E.164 format.
-     */
-    phoneNumber: string;
-    /**
-     * Optional custom name for the phone number.
-     */
-    name?: string;
-}
-export interface PhoneNumberRequirementsParams {
-    /**
-     * Two-letter ISO country code.
-     */
-    countryCode: string;
-    /**
-     * Type of phone number (local, mobile, tollFree).
-     */
-    type?: PhoneNumberType;
-}
-export interface PhoneNumberSearchAvailableParams {
-    /**
-     * Two-letter ISO country code.
-     */
-    countryCode: string;
-    /**
-     * Comma-separated capabilities the number must have: `sms`, `voice`, `mms`.
-     * Numbers missing any of them are dropped.
-     */
-    capabilities?: string;
-    /**
-     * Search for numbers containing this string.
-     */
-    contains?: string;
-    /**
-     * Maximum number of results to return.
-     */
-    limit?: number;
-    /**
-     * Type of phone number to search for.
-     */
-    type?: PhoneNumberType;
-}
+export type OwnedPhoneNumbersCursor = Cursor<T.OwnedPhoneNumber>;
+export type AvailablePhoneNumber = T.AvailablePhoneNumber;
+export type OwnedPhoneNumber = T.OwnedPhoneNumber;
+export type OwnedPhoneNumberPricing = T.OwnedPhoneNumberPricing;
+export type PhoneNumberCapabilities = T.PhoneNumberCapabilities;
+export type PhoneNumberPricing = T.PhoneNumberPricing;
+export type PhoneNumberStatus = T.PhoneNumberStatus;
+export type PhoneNumberType = T.PhoneNumberType;
+export type Requirement = T.Requirement;
+export type RequirementAcceptanceCriteria = T.RequirementAcceptanceCriteria;
+export type RequirementFieldType = T.RequirementFieldType;
+export type RequirementType = T.RequirementType;
+export type PhoneNumberRetrieveResponse = T.PhoneNumberResponse;
+export type PhoneNumberUpdateResponse = T.PhoneNumberResponse;
+export type PhoneNumberPurchaseResponse = T.PhoneNumberResponse;
+export type PhoneNumberRequirementsResponse = T.GetPhoneNumberRequirementsResponse;
+export type PhoneNumberSearchAvailableResponse = T.SearchAvailablePhoneNumbersResponse;
+export type PhoneNumberUpdateParams = T.PhoneNumbersUpdateParams;
+export type PhoneNumberListParams = T.PhoneNumbersListParams;
+export type PhoneNumberPurchaseParams = T.PhoneNumbersPurchaseParams;
+export type PhoneNumberRequirementsParams = T.PhoneNumbersRequirementsParams;
+export type PhoneNumberSearchAvailableParams = T.PhoneNumbersSearchAvailableParams;
 export declare namespace PhoneNumbers {
     export { type AvailablePhoneNumber as AvailablePhoneNumber, type OwnedPhoneNumber as OwnedPhoneNumber, type OwnedPhoneNumberPricing as OwnedPhoneNumberPricing, type PhoneNumberCapabilities as PhoneNumberCapabilities, type PhoneNumberPricing as PhoneNumberPricing, type PhoneNumberStatus as PhoneNumberStatus, type PhoneNumberType as PhoneNumberType, type Requirement as Requirement, type RequirementAcceptanceCriteria as RequirementAcceptanceCriteria, type RequirementFieldType as RequirementFieldType, type RequirementType as RequirementType, type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse, type PhoneNumberRequirementsResponse as PhoneNumberRequirementsResponse, type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse, type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams, type PhoneNumberRequirementsParams as PhoneNumberRequirementsParams, type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams, };
 }

package/resources/phone-numbers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,8BAA2B;AAE5E,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;IAIzD;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO1E;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,eAAe,CACb,KAAK,EAAE,gCAAgC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE/D,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,uBAAuB,CAAC;IAEtC,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,kBAAkB,CAAC;IAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,uBAAuB,CAAC;IAEjC,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;IAEpB,eAAe,EAAE,MAAM,CAAC;IAExB,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,6BAA6B,CAAC;IAEnD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,kCAAkC;IACjD,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
+{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,8BAA2B;AAEzD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,OAAO,KAAK,KAAK,CAAC,oBAAiB;AAEnC,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;OAMG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;IAIzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,QAAQ,CACN,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;OAMG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO1E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CACV,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;OAMG;IACH,eAAe,CACb,KAAK,EAAE,gCAAgC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAEjE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,oBAAoB,CAAC;AAE1D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;AAElD,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,uBAAuB,CAAC;AAEhE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,uBAAuB,CAAC;AAEhE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC;AAEtD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,iBAAiB,CAAC;AAEpD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,eAAe,CAAC;AAEhD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;AAExC,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,6BAA6B,CAAC;AAE5E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,oBAAoB,CAAC;AAE1D,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,eAAe,CAAC;AAEhD,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,mBAAmB,CAAC;AAEhE,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,mBAAmB,CAAC;AAE9D,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,mBAAmB,CAAC;AAEhE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,kCAAkC,CAAC;AAEnF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,mCAAmC,CAAC;AAEvF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,wBAAwB,CAAC;AAEjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,sBAAsB,CAAC;AAE7D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,0BAA0B,CAAC;AAErE,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,8BAA8B,CAAC;AAE7E,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,iCAAiC,CAAC;AAEnF,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}

package/resources/phone-numbers.js

@@ -1,5 +1,5 @@
 "use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PhoneNumbers = void 0;
 const resource_1 = require("../core/resource.js");
@@ -8,72 +8,87 @@ const headers_1 = require("../internal/headers.js");
 const path_1 = require("../internal/utils/path.js");
 class PhoneNumbers extends resource_1.APIResource {
     /**
+     * Get phone number
+     *
      * Get details of a specific phone number.
      *
-     * @example
-     * ```ts
-     * const phoneNumber = await client.phoneNumbers.retrieve(
-     *   'phoneNumberId',
-     * );
-     * ```
+     * `GET /v1/phone-numbers/{phoneNumberId}`
      */
     retrieve(phoneNumberID, options) {
         return this._client.get((0, path_1.path) `/v1/phone-numbers/${phoneNumberID}`, options);
     }
     /**
+     * Update phone number
+     *
      * Update a phone number's name or sender assignment.
      *
-     * @example
-     * ```ts
-     * const phoneNumber = await client.phoneNumbers.update(
-     *   'phoneNumberId',
-     *   { name: 'Support Line' },
-     * );
-     * ```
+     * `PATCH /v1/phone-numbers/{phoneNumberId}`
      */
     update(phoneNumberID, body, options) {
         return this._client.patch((0, path_1.path) `/v1/phone-numbers/${phoneNumberID}`, { body, ...options });
     }
     /**
+     * List phone numbers
+     *
      * List all phone numbers owned by this project.
      *
-     * @example
-     * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const ownedPhoneNumber of client.phoneNumbers.list()) {
-     *   // ...
-     * }
-     * ```
+     * `GET /v1/phone-numbers`
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/phone-numbers', (pagination_1.Cursor), { query, ...options });
     }
     /**
+     * Purchase a phone number
+     *
      * Purchase an available phone number. Requires a paid plan: the Free plan cannot
-     * purchase phone numbers and receives `402` with code `paid_plan_required`. Paid
-     * plans include one US number at no charge. The included number is one per account
-     * and is granted once: claiming it spends the benefit for good, so releasing that
-     * number does not make another one free, and numbers the account already bought do
-     * not consume it.
-     *
-     * @example
-     * ```ts
-     * const response = await client.phoneNumbers.purchase({
-     *   phoneNumber: '+15551234567',
-     *   name: 'Primary Line',
-     * });
-     * ```
+     * purchase phone numbers and receives `402` with code `paid_plan_required`.
+     *
+     * **The included number.** A paid plan includes one number at no charge, once per
+     * account: it must be a US or Canadian number (a +1 number) costing $20 a month or
+     * less. `isFreeEligible` in `GET /v1/phone-numbers/available` marks the numbers
+     * that qualify. Claiming it spends the benefit for good, across every team the
+     * account owner owns, so releasing that number does not make another one free.
+     *
+     * **Numbers with regulatory requirements.** Which numbers need regulatory
+     * information is decided per number, not by a fixed country list. The purchase
+     * looks the requirements up for the exact number before charging anything:
+     *
+     * 1. `GET /v1/phone-numbers/requirements?phoneNumber=...`. If `items` is empty,
+     * buy normally.
+     * 2. Create what it asks for: addresses with `POST /v1/addresses`, documents with
+     * `POST /v1/documents`.
+     * 3. Purchase with `type` and `regulatoryRequirements`. The number is bought and
+     * billed at once with `regulatoryStatus: pending_review`.
+     * 4. Poll `GET /v1/phone-numbers/{phoneNumberId}` until `regulatoryStatus` is
+     * `approved`. Assign it to a sender before or after approval; it starts carrying
+     * messages once approved.
+     *
+     * **Reuse.** Information you submitted is kept for your project, per country and
+     * `type`, and a later purchase there may omit `regulatoryRequirements`. Reuse only
+     * happens when what is kept still covers every requirement of the new number and
+     * every address and document in it belongs to the project. Otherwise, or when
+     * nothing is kept, the purchase returns `400 regulatory_compliance_required` with
+     * the missing requirements in `details`.
+     *
+     * Invalid values (a missing, unknown or repeated requirement id, an address or
+     * document from another project, or one rejected in review) return `400
+     * invalid_request`. If an address or document cannot be registered for review, the
+     * purchase returns `400 invalid_request` naming the requirement. If the
+     * requirements cannot be looked up, the purchase returns `502
+     * requirements_unavailable`, except for US and Canadian numbers, which are sold as
+     * numbers without requirements. None of these errors charge anything.
+     *
+     * `POST /v1/phone-numbers`
      */
     purchase(body, options) {
         return this._client.post('/v1/phone-numbers', { body, ...options });
     }
     /**
+     * Release phone number
+     *
      * Release a phone number. The phone number must not be assigned to a sender.
      *
-     * @example
-     * ```ts
-     * await client.phoneNumbers.release('phoneNumberId');
-     * ```
+     * `DELETE /v1/phone-numbers/{phoneNumberId}`
      */
     release(phoneNumberID, options) {
         return this._client.delete((0, path_1.path) `/v1/phone-numbers/${phoneNumberID}`, {
@@ -82,29 +97,34 @@ class PhoneNumbers extends resource_1.APIResource {
         });
     }
     /**
-     * Get regulatory requirements for purchasing phone numbers in a specific country.
-     * Some countries require additional documentation (addresses, identity documents)
-     * before phone numbers can be activated.
-     *
-     * @example
-     * ```ts
-     * const response = await client.phoneNumbers.requirements({
-     *   countryCode: 'xx',
-     * });
-     * ```
+     * Get regulatory requirements
+     *
+     * Get the regulatory information needed to buy a phone number, for one specific
+     * number or for a country and number type. Prefer `phoneNumber`: the response is
+     * then exactly the list the purchase of that number validates against. Pass each
+     * `requirementTypes[].id` back as `requirementType` in `regulatoryRequirements` on
+     * `POST /v1/phone-numbers`.
+     *
+     * For `phoneNumber`, the requirements of that exact number are returned. When they
+     * cannot be resolved for the number itself, the list for its country and `type` is
+     * returned instead, and the purchase uses the same list. An empty `items` array
+     * means the number needs no regulatory information. If the requirements cannot be
+     * retrieved at all, the response is `502 requirements_unavailable`, never an empty
+     * list.
+     *
+     * URL-encode the `+` of `phoneNumber` as `%2B`. An unencoded `+` is also accepted.
+     *
+     * `GET /v1/phone-numbers/requirements`
      */
     requirements(query, options) {
         return this._client.get('/v1/phone-numbers/requirements', { query, ...options });
     }
     /**
+     * Search available phone numbers
+     *
      * Search for available phone numbers to purchase by country and type.
      *
-     * @example
-     * ```ts
-     * const response = await client.phoneNumbers.searchAvailable({
-     *   countryCode: 'xx',
-     * });
-     * ```
+     * `GET /v1/phone-numbers/available`
      */
     searchAvailable(query, options) {
         return this._client.get('/v1/phone-numbers/available', { query, ...options });

package/resources/phone-numbers.js.map

@@ -1 +1 @@
-{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAC5E,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,mBAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,aAAqB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CACb,KAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AA7HD,oCA6HC"}
+{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,6FAA6F;;;AAE7F,kDAA+C;AAE/C,sDAAyD;AACzD,oDAAmD;AAEnD,oDAA8C;AAG9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;OAMG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,mBAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,QAAQ,CACN,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,aAAqB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CACV,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CACb,KAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAjJD,oCAiJC"}