@livekit/protocol 1.40.0 → 2.0.0

package/src/gen/livekit_phone_number_pb.d.ts

@@ -0,0 +1,577 @@
+// @generated by protoc-gen-es v1.10.1 with parameter "target=dts+js"
+// @generated from file livekit_phone_number.proto (package livekit, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage, Timestamp } from "@bufbuild/protobuf";
+import { Message, proto3 } from "@bufbuild/protobuf";
+import type { TokenPagination } from "./livekit_models_pb.js";
+import type { SIPDispatchRuleInfo } from "./livekit_sip_pb.js";
+
+/**
+ * Telephony cost type enumeration
+ *
+ * @generated from enum livekit.TelephonyCostType
+ */
+export declare enum TelephonyCostType {
+  /**
+   * Default value
+   *
+   * @generated from enum value: TELEPHONY_COST_TYPE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Monthly rental for the phone number
+   *
+   * @generated from enum value: TELEPHONY_COST_TYPE_NUMBER_RENTAL = 1;
+   */
+  NUMBER_RENTAL = 1,
+
+  /**
+   * Inbound voice calls
+   *
+   * @generated from enum value: TELEPHONY_COST_TYPE_VOICE_INBOUND = 2;
+   */
+  VOICE_INBOUND = 2,
+
+  /**
+   * Outbound voice calls
+   *
+   * @generated from enum value: TELEPHONY_COST_TYPE_VOICE_OUTBOUND = 3;
+   */
+  VOICE_OUTBOUND = 3,
+
+  /**
+   * Inbound SMS
+   *
+   * @generated from enum value: TELEPHONY_COST_TYPE_SMS_INBOUND = 4;
+   */
+  SMS_INBOUND = 4,
+
+  /**
+   * Outbound SMS
+   *
+   * @generated from enum value: TELEPHONY_COST_TYPE_SMS_OUTBOUND = 5;
+   */
+  SMS_OUTBOUND = 5,
+}
+
+/**
+ * Phone number status enumeration
+ *
+ * @generated from enum livekit.PhoneNumberStatus
+ */
+export declare enum PhoneNumberStatus {
+  /**
+   * Default value
+   *
+   * @generated from enum value: PHONE_NUMBER_STATUS_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Number is active and ready for use
+   *
+   * @generated from enum value: PHONE_NUMBER_STATUS_ACTIVE = 1;
+   */
+  ACTIVE = 1,
+
+  /**
+   * Number is being provisioned
+   *
+   * @generated from enum value: PHONE_NUMBER_STATUS_PENDING = 2;
+   */
+  PENDING = 2,
+
+  /**
+   * Number has been released
+   *
+   * @generated from enum value: PHONE_NUMBER_STATUS_RELEASED = 3;
+   */
+  RELEASED = 3,
+}
+
+/**
+ * ListPhoneNumberInventoryRequest - Request to list available phone numbers
+ *
+ * @generated from message livekit.ListPhoneNumberInventoryRequest
+ */
+export declare class ListPhoneNumberInventoryRequest extends Message<ListPhoneNumberInventoryRequest> {
+  /**
+   * Optional: Filter by country code (e.g., "US", "CA")
+   *
+   * @generated from field: string country_code = 1;
+   */
+  countryCode: string;
+
+  /**
+   * Optional: Filter by area code (e.g., "415")
+   *
+   * @generated from field: string area_code = 2;
+   */
+  areaCode: string;
+
+  /**
+   * Optional: Maximum number of results (default: 50)
+   *
+   * @generated from field: int32 limit = 3;
+   */
+  limit: number;
+
+  /**
+   * Optional: Token for pagination (empty for first page)
+   *
+   * @generated from field: livekit.TokenPagination page_token = 4;
+   */
+  pageToken?: TokenPagination;
+
+  constructor(data?: PartialMessage<ListPhoneNumberInventoryRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.ListPhoneNumberInventoryRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ListPhoneNumberInventoryRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ListPhoneNumberInventoryRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ListPhoneNumberInventoryRequest;
+
+  static equals(a: ListPhoneNumberInventoryRequest | PlainMessage<ListPhoneNumberInventoryRequest> | undefined, b: ListPhoneNumberInventoryRequest | PlainMessage<ListPhoneNumberInventoryRequest> | undefined): boolean;
+}
+
+/**
+ * ListPhoneNumberInventoryResponse - Response containing available phone numbers
+ *
+ * @generated from message livekit.ListPhoneNumberInventoryResponse
+ */
+export declare class ListPhoneNumberInventoryResponse extends Message<ListPhoneNumberInventoryResponse> {
+  /**
+   * List of available phone numbers
+   *
+   * @generated from field: repeated livekit.PhoneNumberInventoryItem items = 1;
+   */
+  items: PhoneNumberInventoryItem[];
+
+  /**
+   * Token for next page (empty if no more pages)
+   *
+   * @generated from field: livekit.TokenPagination next_page_token = 2;
+   */
+  nextPageToken?: TokenPagination;
+
+  constructor(data?: PartialMessage<ListPhoneNumberInventoryResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.ListPhoneNumberInventoryResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ListPhoneNumberInventoryResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ListPhoneNumberInventoryResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ListPhoneNumberInventoryResponse;
+
+  static equals(a: ListPhoneNumberInventoryResponse | PlainMessage<ListPhoneNumberInventoryResponse> | undefined, b: ListPhoneNumberInventoryResponse | PlainMessage<ListPhoneNumberInventoryResponse> | undefined): boolean;
+}
+
+/**
+ * PurchasePhoneNumberRequest - Request to purchase phone numbers
+ *
+ * @generated from message livekit.PurchasePhoneNumberRequest
+ */
+export declare class PurchasePhoneNumberRequest extends Message<PurchasePhoneNumberRequest> {
+  /**
+   * Phone numbers to purchase (e.g., ["+1234567890", "+1234567891"])
+   *
+   * @generated from field: repeated string phone_numbers = 1;
+   */
+  phoneNumbers: string[];
+
+  constructor(data?: PartialMessage<PurchasePhoneNumberRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.PurchasePhoneNumberRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PurchasePhoneNumberRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PurchasePhoneNumberRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PurchasePhoneNumberRequest;
+
+  static equals(a: PurchasePhoneNumberRequest | PlainMessage<PurchasePhoneNumberRequest> | undefined, b: PurchasePhoneNumberRequest | PlainMessage<PurchasePhoneNumberRequest> | undefined): boolean;
+}
+
+/**
+ * PurchasePhoneNumberResponse - Response containing the purchased phone numbers
+ *
+ * @generated from message livekit.PurchasePhoneNumberResponse
+ */
+export declare class PurchasePhoneNumberResponse extends Message<PurchasePhoneNumberResponse> {
+  /**
+   * Details of the purchased phone numbers
+   *
+   * @generated from field: repeated livekit.PurchasedPhoneNumber phone_numbers = 1;
+   */
+  phoneNumbers: PurchasedPhoneNumber[];
+
+  constructor(data?: PartialMessage<PurchasePhoneNumberResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.PurchasePhoneNumberResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PurchasePhoneNumberResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PurchasePhoneNumberResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PurchasePhoneNumberResponse;
+
+  static equals(a: PurchasePhoneNumberResponse | PlainMessage<PurchasePhoneNumberResponse> | undefined, b: PurchasePhoneNumberResponse | PlainMessage<PurchasePhoneNumberResponse> | undefined): boolean;
+}
+
+/**
+ * ListPurchasedPhoneNumbersRequest - Request to list purchased phone numbers
+ *
+ * @generated from message livekit.ListPurchasedPhoneNumbersRequest
+ */
+export declare class ListPurchasedPhoneNumbersRequest extends Message<ListPurchasedPhoneNumbersRequest> {
+  /**
+   * Optional: Maximum number of results (default: 50)
+   *
+   * @generated from field: int32 limit = 1;
+   */
+  limit: number;
+
+  /**
+   * Optional: Token for pagination (empty for first page)
+   *
+   * @generated from field: livekit.TokenPagination page_token = 2;
+   */
+  pageToken?: TokenPagination;
+
+  constructor(data?: PartialMessage<ListPurchasedPhoneNumbersRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.ListPurchasedPhoneNumbersRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ListPurchasedPhoneNumbersRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ListPurchasedPhoneNumbersRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ListPurchasedPhoneNumbersRequest;
+
+  static equals(a: ListPurchasedPhoneNumbersRequest | PlainMessage<ListPurchasedPhoneNumbersRequest> | undefined, b: ListPurchasedPhoneNumbersRequest | PlainMessage<ListPurchasedPhoneNumbersRequest> | undefined): boolean;
+}
+
+/**
+ * ListPurchasedPhoneNumbersResponse - Response containing purchased phone numbers
+ *
+ * @generated from message livekit.ListPurchasedPhoneNumbersResponse
+ */
+export declare class ListPurchasedPhoneNumbersResponse extends Message<ListPurchasedPhoneNumbersResponse> {
+  /**
+   * List of purchased phone numbers
+   *
+   * @generated from field: repeated livekit.PurchasedPhoneNumber items = 1;
+   */
+  items: PurchasedPhoneNumber[];
+
+  /**
+   * Token for next page (empty if no more pages)
+   *
+   * @generated from field: livekit.TokenPagination next_page_token = 2;
+   */
+  nextPageToken?: TokenPagination;
+
+  /**
+   * Total number of purchased phone numbers
+   *
+   * @generated from field: int32 total_count = 3;
+   */
+  totalCount: number;
+
+  constructor(data?: PartialMessage<ListPurchasedPhoneNumbersResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.ListPurchasedPhoneNumbersResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ListPurchasedPhoneNumbersResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ListPurchasedPhoneNumbersResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ListPurchasedPhoneNumbersResponse;
+
+  static equals(a: ListPurchasedPhoneNumbersResponse | PlainMessage<ListPurchasedPhoneNumbersResponse> | undefined, b: ListPurchasedPhoneNumbersResponse | PlainMessage<ListPurchasedPhoneNumbersResponse> | undefined): boolean;
+}
+
+/**
+ * ReleasePhoneNumberRequest - Request to release purchased phone numbers
+ *
+ * @generated from message livekit.ReleasePhoneNumberRequest
+ */
+export declare class ReleasePhoneNumberRequest extends Message<ReleasePhoneNumberRequest> {
+  /**
+   * Phone numbers to release (e.g., ["+1234567890", "+1234567891"])
+   *
+   * @generated from field: repeated string phone_numbers = 1;
+   */
+  phoneNumbers: string[];
+
+  constructor(data?: PartialMessage<ReleasePhoneNumberRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.ReleasePhoneNumberRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ReleasePhoneNumberRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ReleasePhoneNumberRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ReleasePhoneNumberRequest;
+
+  static equals(a: ReleasePhoneNumberRequest | PlainMessage<ReleasePhoneNumberRequest> | undefined, b: ReleasePhoneNumberRequest | PlainMessage<ReleasePhoneNumberRequest> | undefined): boolean;
+}
+
+/**
+ * GlobalPhoneNumber represents a phone number with standardized format
+ *
+ * @generated from message livekit.GlobalPhoneNumber
+ */
+export declare class GlobalPhoneNumber extends Message<GlobalPhoneNumber> {
+  /**
+   * unique identifier
+   *
+   * @generated from field: string id = 1;
+   */
+  id: string;
+
+  /**
+   * e.g., "+14155552671"
+   *
+   * @generated from field: string e164_format = 2;
+   */
+  e164Format: string;
+
+  /**
+   * e.g., "US"
+   *
+   * @generated from field: string country_code = 3;
+   */
+  countryCode: string;
+
+  /**
+   * e.g., "415"
+   *
+   * @generated from field: string area_code = 4;
+   */
+  areaCode: string;
+
+  /**
+   * e.g., local, toll-free, national, mobile
+   *
+   * @generated from field: string number_type = 5;
+   */
+  numberType: string;
+
+  /**
+   * City/locality (e.g., "San Francisco")
+   *
+   * @generated from field: string locality = 6;
+   */
+  locality: string;
+
+  /**
+   * State/region (e.g., "CA")
+   *
+   * @generated from field: string region = 7;
+   */
+  region: string;
+
+  /**
+   * can be used later for fraud detection
+   *
+   * @generated from field: double spam_score = 8;
+   */
+  spamScore: number;
+
+  /**
+   * timestamp when created
+   *
+   * @generated from field: google.protobuf.Timestamp created_at = 9;
+   */
+  createdAt?: Timestamp;
+
+  /**
+   * timestamp when updated
+   *
+   * @generated from field: google.protobuf.Timestamp updated_at = 10;
+   */
+  updatedAt?: Timestamp;
+
+  constructor(data?: PartialMessage<GlobalPhoneNumber>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.GlobalPhoneNumber";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GlobalPhoneNumber;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GlobalPhoneNumber;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GlobalPhoneNumber;
+
+  static equals(a: GlobalPhoneNumber | PlainMessage<GlobalPhoneNumber> | undefined, b: GlobalPhoneNumber | PlainMessage<GlobalPhoneNumber> | undefined): boolean;
+}
+
+/**
+ * TelephonyCost represents the pricing structure for a specific telephony service
+ *
+ * @generated from message livekit.TelephonyCost
+ */
+export declare class TelephonyCost extends Message<TelephonyCost> {
+  /**
+   * Type of telephony service
+   *
+   * @generated from field: livekit.TelephonyCostType resource = 1;
+   */
+  resource: TelephonyCostType;
+
+  /**
+   * Currency code (e.g., "USD", "EUR")
+   *
+   * @generated from field: string currency = 2;
+   */
+  currency: string;
+
+  /**
+   * Price for this service
+   *
+   * @generated from field: double price = 3;
+   */
+  price: number;
+
+  /**
+   * Billing unit (e.g., "month", "minute", "message", "call")
+   *
+   * @generated from field: string billing_unit = 4;
+   */
+  billingUnit: string;
+
+  constructor(data?: PartialMessage<TelephonyCost>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.TelephonyCost";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TelephonyCost;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TelephonyCost;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TelephonyCost;
+
+  static equals(a: TelephonyCost | PlainMessage<TelephonyCost> | undefined, b: TelephonyCost | PlainMessage<TelephonyCost> | undefined): boolean;
+}
+
+/**
+ * PhoneNumberInventoryItem - Represents an available phone number for purchase
+ *
+ * @generated from message livekit.PhoneNumberInventoryItem
+ */
+export declare class PhoneNumberInventoryItem extends Message<PhoneNumberInventoryItem> {
+  /**
+   * Common phone number fields
+   *
+   * @generated from field: livekit.GlobalPhoneNumber phone_number = 1;
+   */
+  phoneNumber?: GlobalPhoneNumber;
+
+  /**
+   * Comma-separated capabilities (e.g., "voice,sms")
+   *
+   * @generated from field: repeated string capabilities = 2;
+   */
+  capabilities: string[];
+
+  /**
+   * Array of costs for different services
+   *
+   * @generated from field: repeated livekit.TelephonyCost costs = 3;
+   */
+  costs: TelephonyCost[];
+
+  constructor(data?: PartialMessage<PhoneNumberInventoryItem>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.PhoneNumberInventoryItem";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PhoneNumberInventoryItem;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PhoneNumberInventoryItem;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PhoneNumberInventoryItem;
+
+  static equals(a: PhoneNumberInventoryItem | PlainMessage<PhoneNumberInventoryItem> | undefined, b: PhoneNumberInventoryItem | PlainMessage<PhoneNumberInventoryItem> | undefined): boolean;
+}
+
+/**
+ * PurchasedPhoneNumber - Represents a phone number owned by a LiveKit project
+ *
+ * @generated from message livekit.PurchasedPhoneNumber
+ */
+export declare class PurchasedPhoneNumber extends Message<PurchasedPhoneNumber> {
+  /**
+   * Common phone number fields
+   *
+   * @generated from field: livekit.GlobalPhoneNumber phone_number = 1;
+   */
+  phoneNumber?: GlobalPhoneNumber;
+
+  /**
+   * Current status of the phone number
+   *
+   * @generated from field: livekit.PhoneNumberStatus status = 2;
+   */
+  status: PhoneNumberStatus;
+
+  /**
+   * Timestamp when the number was assigned
+   *
+   * @generated from field: google.protobuf.Timestamp assigned_at = 3;
+   */
+  assignedAt?: Timestamp;
+
+  /**
+   * Timestamp when the number was released (if applicable)
+   *
+   * @generated from field: google.protobuf.Timestamp released_at = 4;
+   */
+  releasedAt?: Timestamp;
+
+  /**
+   * Optional: Associated SIP dispatch rule
+   *
+   * @generated from field: livekit.SIPDispatchRuleInfo sip_dispatch_rule = 5;
+   */
+  sipDispatchRule?: SIPDispatchRuleInfo;
+
+  constructor(data?: PartialMessage<PurchasedPhoneNumber>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.PurchasedPhoneNumber";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PurchasedPhoneNumber;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PurchasedPhoneNumber;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PurchasedPhoneNumber;
+
+  static equals(a: PurchasedPhoneNumber | PlainMessage<PurchasedPhoneNumber> | undefined, b: PurchasedPhoneNumber | PlainMessage<PurchasedPhoneNumber> | undefined): boolean;
+}
+