prelude

type Client struct {
	Options                []option.RequestOption
	Lookup                 *LookupService
	Notify                 *NotifyService
	Transactional          *TransactionalService
	Verification           *VerificationService
	VerificationManagement *VerificationManagementService
	Watch                  *WatchService
}

type Error = apierror.Error

type LookupLookupParams struct {
	// Optional features. Possible values are:
	//
	//   - `cnam` - Retrieve CNAM (Caller ID Name) along with other information. Contact
	//     us if you need to use this functionality.
	Type param.Field[[]LookupLookupParamsType] `query:"type"`
}

type LookupLookupParamsType string

type LookupLookupResponse struct {
	// The CNAM (Caller ID Name) associated with the phone number. Contact us if you
	// need to use this functionality. Once enabled, put `cnam` option to `type` query
	// parameter.
	CallerName string `json:"caller_name"`
	// The country code of the phone number.
	CountryCode string `json:"country_code"`
	// A list of flags associated with the phone number.
	//
	//   - `ported` - Indicates the phone number has been transferred from one carrier to
	//     another.
	//   - `temporary` - Indicates the phone number is likely a temporary or virtual
	//     number, often used for verification services or burner phones.
	Flags []LookupLookupResponseFlag `json:"flags"`
	// The type of phone line.
	//
	//   - `calling_cards` - Numbers that are associated with providers of pre-paid
	//     domestic and international calling cards.
	//   - `fixed_line` - Landline phone numbers.
	//   - `isp` - Numbers reserved for Internet Service Providers.
	//   - `local_rate` - Numbers that can be assigned non-geographically.
	//   - `mobile` - Mobile phone numbers.
	//   - `other` - Other types of services.
	//   - `pager` - Number ranges specifically allocated to paging devices.
	//   - `payphone` - Allocated numbers for payphone kiosks in some countries.
	//   - `premium_rate` - Landline numbers where the calling party pays more than
	//     standard.
	//   - `satellite` - Satellite phone numbers.
	//   - `service` - Automated applications.
	//   - `shared_cost` - Specific landline ranges where the cost of making the call is
	//     shared between the calling and called party.
	//   - `short_codes_commercial` - Short codes are memorable, easy-to-use numbers,
	//     like the UK's NHS 111, often sold to businesses. Not available in all
	//     countries.
	//   - `toll_free` - Number where the called party pays for the cost of the call not
	//     the calling party.
	//   - `universal_access` - Number ranges reserved for Universal Access initiatives.
	//   - `unknown` - Unknown phone number type.
	//   - `vpn` - Numbers are used exclusively within a private telecommunications
	//     network, connecting the operator's terminals internally and not accessible via
	//     the public telephone network.
	//   - `voice_mail` - A specific category of Interactive Voice Response (IVR)
	//     services.
	//   - `voip` - Specific ranges for providers of VoIP services to allow incoming
	//     calls from the regular telephony network.
	LineType LookupLookupResponseLineType `json:"line_type"`
	// The current carrier information.
	NetworkInfo LookupLookupResponseNetworkInfo `json:"network_info"`
	// The original carrier information.
	OriginalNetworkInfo LookupLookupResponseOriginalNetworkInfo `json:"original_network_info"`
	// The phone number.
	PhoneNumber string                   `json:"phone_number"`
	JSON        lookupLookupResponseJSON `json:"-"`
}

type LookupLookupResponseFlag string

type LookupLookupResponseLineType string

type LookupLookupResponseNetworkInfo struct {
	// The name of the carrier.
	CarrierName string `json:"carrier_name"`
	// Mobile Country Code.
	Mcc string `json:"mcc"`
	// Mobile Network Code.
	Mnc  string                              `json:"mnc"`
	JSON lookupLookupResponseNetworkInfoJSON `json:"-"`
}

type LookupLookupResponseOriginalNetworkInfo struct {
	// The name of the original carrier.
	CarrierName string `json:"carrier_name"`
	// Mobile Country Code.
	Mcc string `json:"mcc"`
	// Mobile Network Code.
	Mnc  string                                      `json:"mnc"`
	JSON lookupLookupResponseOriginalNetworkInfoJSON `json:"-"`
}

type LookupService struct {
	Options []option.RequestOption
}

type NotifyGetSubscriptionConfigResponse struct {
	// The subscription configuration ID.
	ID string `json:"id,required"`
	// The URL to call when subscription status changes.
	CallbackURL string `json:"callback_url,required" format:"uri"`
	// The date and time when the configuration was created.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// The subscription messages configuration.
	Messages NotifyGetSubscriptionConfigResponseMessages `json:"messages,required"`
	// The human-readable name for the subscription configuration.
	Name string `json:"name,required"`
	// The date and time when the configuration was last updated.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// A list of phone numbers for receiving inbound messages.
	MoPhoneNumbers []NotifyGetSubscriptionConfigResponseMoPhoneNumber `json:"mo_phone_numbers"`
	JSON           notifyGetSubscriptionConfigResponseJSON            `json:"-"`
}

type NotifyGetSubscriptionConfigResponseMessages struct {
	// Message sent when user requests help.
	HelpMessage string `json:"help_message"`
	// Message sent when user subscribes.
	StartMessage string `json:"start_message"`
	// Message sent when user unsubscribes.
	StopMessage string                                          `json:"stop_message"`
	JSON        notifyGetSubscriptionConfigResponseMessagesJSON `json:"-"`
}

type NotifyGetSubscriptionConfigResponseMoPhoneNumber struct {
	// The ISO 3166-1 alpha-2 country code.
	CountryCode string `json:"country_code,required"`
	// The phone number in E.164 format for long codes, or short code format for short
	// codes.
	PhoneNumber string                                               `json:"phone_number,required"`
	JSON        notifyGetSubscriptionConfigResponseMoPhoneNumberJSON `json:"-"`
}

type NotifyGetSubscriptionPhoneNumberResponse struct {
	// The subscription configuration ID.
	ConfigID string `json:"config_id,required"`
	// The phone number in E.164 format.
	PhoneNumber string `json:"phone_number,required" format:"phone_number"`
	// How the subscription state was changed:
	//
	// - `MO_KEYWORD` - User sent a keyword (STOP/START)
	// - `API` - Changed via API
	// - `CSV_IMPORT` - Imported from CSV
	// - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
	Source NotifyGetSubscriptionPhoneNumberResponseSource `json:"source,required"`
	// The subscription state:
	//
	// - `SUB` - Subscribed (user can receive marketing messages)
	// - `UNSUB` - Unsubscribed (user has opted out)
	State NotifyGetSubscriptionPhoneNumberResponseState `json:"state,required"`
	// The date and time when the subscription status was last updated.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Additional context about the state change (e.g., the keyword that was sent).
	Reason string                                       `json:"reason"`
	JSON   notifyGetSubscriptionPhoneNumberResponseJSON `json:"-"`
}

type NotifyGetSubscriptionPhoneNumberResponseSource string

type NotifyGetSubscriptionPhoneNumberResponseState string

type NotifyListSubscriptionConfigsParams struct {
	// Pagination cursor from the previous response
	Cursor param.Field[string] `query:"cursor"`
	// Maximum number of configurations to return per page
	Limit param.Field[int64] `query:"limit"`
}

type NotifyListSubscriptionConfigsResponse struct {
	// A list of subscription management configurations.
	Configs []NotifyListSubscriptionConfigsResponseConfig `json:"configs,required"`
	// Pagination cursor for the next page of results. Omitted if there are no more
	// pages.
	NextCursor string                                    `json:"next_cursor"`
	JSON       notifyListSubscriptionConfigsResponseJSON `json:"-"`
}

type NotifyListSubscriptionConfigsResponseConfig struct {
	// The subscription configuration ID.
	ID string `json:"id,required"`
	// The URL to call when subscription status changes.
	CallbackURL string `json:"callback_url,required" format:"uri"`
	// The date and time when the configuration was created.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// The subscription messages configuration.
	Messages NotifyListSubscriptionConfigsResponseConfigsMessages `json:"messages,required"`
	// The human-readable name for the subscription configuration.
	Name string `json:"name,required"`
	// The date and time when the configuration was last updated.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// A list of phone numbers for receiving inbound messages.
	MoPhoneNumbers []NotifyListSubscriptionConfigsResponseConfigsMoPhoneNumber `json:"mo_phone_numbers"`
	JSON           notifyListSubscriptionConfigsResponseConfigJSON             `json:"-"`
}

type NotifyListSubscriptionConfigsResponseConfigsMessages struct {
	// Message sent when user requests help.
	HelpMessage string `json:"help_message"`
	// Message sent when user subscribes.
	StartMessage string `json:"start_message"`
	// Message sent when user unsubscribes.
	StopMessage string                                                   `json:"stop_message"`
	JSON        notifyListSubscriptionConfigsResponseConfigsMessagesJSON `json:"-"`
}

type NotifyListSubscriptionConfigsResponseConfigsMoPhoneNumber struct {
	// The ISO 3166-1 alpha-2 country code.
	CountryCode string `json:"country_code,required"`
	// The phone number in E.164 format for long codes, or short code format for short
	// codes.
	PhoneNumber string                                                        `json:"phone_number,required"`
	JSON        notifyListSubscriptionConfigsResponseConfigsMoPhoneNumberJSON `json:"-"`
}

type NotifyListSubscriptionPhoneNumberEventsParams struct {
	// Pagination cursor from the previous response
	Cursor param.Field[string] `query:"cursor"`
	// Maximum number of events to return per page
	Limit param.Field[int64] `query:"limit"`
}

type NotifyListSubscriptionPhoneNumberEventsResponse struct {
	// A list of subscription events (status changes) ordered by timestamp descending.
	Events []NotifyListSubscriptionPhoneNumberEventsResponseEvent `json:"events,required"`
	// Pagination cursor for the next page of results. Omitted if there are no more
	// pages.
	NextCursor string                                              `json:"next_cursor"`
	JSON       notifyListSubscriptionPhoneNumberEventsResponseJSON `json:"-"`
}

type NotifyListSubscriptionPhoneNumberEventsResponseEvent struct {
	// The subscription configuration ID.
	ConfigID string `json:"config_id,required"`
	// The phone number in E.164 format.
	PhoneNumber string `json:"phone_number,required" format:"phone_number"`
	// How the subscription state was changed:
	//
	// - `MO_KEYWORD` - User sent a keyword (STOP/START)
	// - `API` - Changed via API
	// - `CSV_IMPORT` - Imported from CSV
	// - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
	Source NotifyListSubscriptionPhoneNumberEventsResponseEventsSource `json:"source,required"`
	// The subscription state after this event:
	//
	// - `SUB` - Subscribed (user can receive marketing messages)
	// - `UNSUB` - Unsubscribed (user has opted out)
	State NotifyListSubscriptionPhoneNumberEventsResponseEventsState `json:"state,required"`
	// The date and time when the event occurred.
	Timestamp time.Time `json:"timestamp,required" format:"date-time"`
	// Additional context about the state change (e.g., the keyword that was sent).
	Reason string                                                   `json:"reason"`
	JSON   notifyListSubscriptionPhoneNumberEventsResponseEventJSON `json:"-"`
}

type NotifyListSubscriptionPhoneNumberEventsResponseEventsSource string

type NotifyListSubscriptionPhoneNumberEventsResponseEventsState string

type NotifyListSubscriptionPhoneNumbersParams struct {
	// Pagination cursor from the previous response
	Cursor param.Field[string] `query:"cursor"`
	// Maximum number of phone numbers to return per page
	Limit param.Field[int64] `query:"limit"`
	// Filter by subscription state
	State param.Field[NotifyListSubscriptionPhoneNumbersParamsState] `query:"state"`
}

type NotifyListSubscriptionPhoneNumbersParamsState string

type NotifyListSubscriptionPhoneNumbersResponse struct {
	// A list of phone numbers and their subscription statuses.
	PhoneNumbers []NotifyListSubscriptionPhoneNumbersResponsePhoneNumber `json:"phone_numbers,required"`
	// Pagination cursor for the next page of results. Omitted if there are no more
	// pages.
	NextCursor string                                         `json:"next_cursor"`
	JSON       notifyListSubscriptionPhoneNumbersResponseJSON `json:"-"`
}

type NotifyListSubscriptionPhoneNumbersResponsePhoneNumber struct {
	// The subscription configuration ID.
	ConfigID string `json:"config_id,required"`
	// The phone number in E.164 format.
	PhoneNumber string `json:"phone_number,required" format:"phone_number"`
	// How the subscription state was changed:
	//
	// - `MO_KEYWORD` - User sent a keyword (STOP/START)
	// - `API` - Changed via API
	// - `CSV_IMPORT` - Imported from CSV
	// - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
	Source NotifyListSubscriptionPhoneNumbersResponsePhoneNumbersSource `json:"source,required"`
	// The subscription state:
	//
	// - `SUB` - Subscribed (user can receive marketing messages)
	// - `UNSUB` - Unsubscribed (user has opted out)
	State NotifyListSubscriptionPhoneNumbersResponsePhoneNumbersState `json:"state,required"`
	// The date and time when the subscription status was last updated.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// Additional context about the state change (e.g., the keyword that was sent).
	Reason string                                                    `json:"reason"`
	JSON   notifyListSubscriptionPhoneNumbersResponsePhoneNumberJSON `json:"-"`
}

type NotifyListSubscriptionPhoneNumbersResponsePhoneNumbersSource string

type NotifyListSubscriptionPhoneNumbersResponsePhoneNumbersState string

type NotifySendBatchParams struct {
	// The template identifier configured by your Customer Success team.
	TemplateID param.Field[string] `json:"template_id,required"`
	// The list of recipients' phone numbers in E.164 format.
	To param.Field[[]string] `json:"to,required" format:"phone_number"`
	// The URL where webhooks will be sent for delivery events.
	CallbackURL param.Field[string] `json:"callback_url"`
	// A user-defined identifier to correlate this request with your internal systems.
	CorrelationID param.Field[string] `json:"correlation_id"`
	// The message expiration date in RFC3339 format. Messages will not be sent after
	// this time.
	ExpiresAt param.Field[time.Time] `json:"expires_at" format:"date-time"`
	// The Sender ID. Must be approved for your account.
	From param.Field[string] `json:"from"`
	// A BCP-47 formatted locale string.
	Locale param.Field[string] `json:"locale"`
	// Preferred channel for delivery. If unavailable, automatic fallback applies.
	PreferredChannel param.Field[NotifySendBatchParamsPreferredChannel] `json:"preferred_channel"`
	// Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply
	// with local time windows.
	ScheduleAt param.Field[time.Time] `json:"schedule_at" format:"date-time"`
	// The variables to be replaced in the template.
	Variables param.Field[map[string]string] `json:"variables"`
}

type NotifySendBatchParamsPreferredChannel string

type NotifySendBatchResponse struct {
	// Number of failed sends.
	ErrorCount int64 `json:"error_count,required"`
	// The per-recipient result of the bulk send.
	Results []NotifySendBatchResponseResult `json:"results,required"`
	// Number of successful sends.
	SuccessCount int64 `json:"success_count,required"`
	// Total number of recipients.
	TotalCount int64 `json:"total_count,required"`
	// The callback URL used for this bulk request, if any.
	CallbackURL string `json:"callback_url"`
	// A string that identifies this specific request.
	RequestID string `json:"request_id"`
	// The template identifier used for this bulk request.
	TemplateID string `json:"template_id"`
	// The variables used for this bulk request.
	Variables map[string]string           `json:"variables"`
	JSON      notifySendBatchResponseJSON `json:"-"`
}

type NotifySendBatchResponseResult struct {
	// The recipient's phone number in E.164 format.
	PhoneNumber string `json:"phone_number,required"`
	// Whether the message was accepted for delivery.
	Success bool `json:"success,required"`
	// Present only if success is false.
	Error NotifySendBatchResponseResultsError `json:"error"`
	// Present only if success is true.
	Message NotifySendBatchResponseResultsMessage `json:"message"`
	JSON    notifySendBatchResponseResultJSON     `json:"-"`
}

type NotifySendBatchResponseResultsError struct {
	// The error code.
	Code string `json:"code"`
	// A human-readable error message.
	Message string                                  `json:"message"`
	JSON    notifySendBatchResponseResultsErrorJSON `json:"-"`
}

type NotifySendBatchResponseResultsMessage struct {
	// The message identifier.
	ID string `json:"id"`
	// The correlation identifier for the message.
	CorrelationID string `json:"correlation_id"`
	// The message creation date in RFC3339 format.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The message expiration date in RFC3339 format.
	ExpiresAt time.Time `json:"expires_at" format:"date-time"`
	// The Sender ID used for this message.
	From string `json:"from"`
	// The locale used for the message, if any.
	Locale string `json:"locale"`
	// When the message will actually be sent in RFC3339 format with timezone offset.
	ScheduleAt time.Time `json:"schedule_at" format:"date-time"`
	// The recipient's phone number in E.164 format.
	To   string                                    `json:"to"`
	JSON notifySendBatchResponseResultsMessageJSON `json:"-"`
}

type NotifySendParams struct {
	// The template identifier configured by your Customer Success team.
	TemplateID param.Field[string] `json:"template_id,required"`
	// The recipient's phone number in E.164 format.
	To param.Field[string] `json:"to,required"`
	// The URL where webhooks will be sent for message delivery events.
	CallbackURL param.Field[string] `json:"callback_url"`
	// A user-defined identifier to correlate this message with your internal systems.
	// It is returned in the response and any webhook events that refer to this
	// message.
	CorrelationID param.Field[string] `json:"correlation_id"`
	// The message expiration date in RFC3339 format. The message will not be sent if
	// this time is reached.
	ExpiresAt param.Field[time.Time] `json:"expires_at" format:"date-time"`
	// The Sender ID. Must be approved for your account.
	From param.Field[string] `json:"from"`
	// A BCP-47 formatted locale string with the language the text message will be sent
	// to. If there's no locale set, the language will be determined by the country
	// code of the phone number. If the language specified doesn't exist, the default
	// set on the template will be used.
	Locale param.Field[string] `json:"locale"`
	// The preferred channel to be used in priority for message delivery. If the
	// channel is unavailable, the system will fallback to other available channels.
	PreferredChannel param.Field[NotifySendParamsPreferredChannel] `json:"preferred_channel"`
	// Schedule the message for future delivery in RFC3339 format. Marketing messages
	// can be scheduled up to 90 days in advance and will be automatically adjusted for
	// compliance with local time window restrictions.
	ScheduleAt param.Field[time.Time] `json:"schedule_at" format:"date-time"`
	// The variables to be replaced in the template.
	Variables param.Field[map[string]string] `json:"variables"`
}

type NotifySendParamsPreferredChannel string

type NotifySendResponse struct {
	// The message identifier.
	ID string `json:"id,required"`
	// The message creation date in RFC3339 format.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// The message expiration date in RFC3339 format.
	ExpiresAt time.Time `json:"expires_at,required" format:"date-time"`
	// The template identifier.
	TemplateID string `json:"template_id,required"`
	// The recipient's phone number in E.164 format.
	To string `json:"to,required"`
	// The variables to be replaced in the template.
	Variables map[string]string `json:"variables,required"`
	// The callback URL where webhooks will be sent.
	CallbackURL string `json:"callback_url"`
	// A user-defined identifier to correlate this message with your internal systems.
	CorrelationID string `json:"correlation_id"`
	// The Sender ID used for this message.
	From string `json:"from"`
	// When the message will actually be sent in RFC3339 format with timezone offset.
	// For marketing messages, this may differ from the requested schedule_at due to
	// automatic compliance adjustments.
	ScheduleAt time.Time              `json:"schedule_at" format:"date-time"`
	JSON       notifySendResponseJSON `json:"-"`
}

type NotifyService struct {
	Options []option.RequestOption
}

type TransactionalSendParams struct {
	// The template identifier.
	TemplateID param.Field[string] `json:"template_id,required"`
	// The recipient's phone number.
	To param.Field[string] `json:"to,required"`
	// The callback URL.
	CallbackURL param.Field[string] `json:"callback_url"`
	// A user-defined identifier to correlate this transactional message with. It is
	// returned in the response and any webhook events that refer to this
	// transactionalmessage.
	CorrelationID param.Field[string] `json:"correlation_id"`
	// The message expiration date.
	ExpiresAt param.Field[string] `json:"expires_at"`
	// The Sender ID.
	From param.Field[string] `json:"from"`
	// A BCP-47 formatted locale string with the language the text message will be sent
	// to. If there's no locale set, the language will be determined by the country
	// code of the phone number. If the language specified doesn't exist, the default
	// set on the template will be used.
	Locale param.Field[string] `json:"locale"`
	// The preferred delivery channel for the message. When specified, the system will
	// prioritize sending via the requested channel if the template is configured for
	// it.
	//
	// If not specified and the template is configured for WhatsApp, the message will
	// be sent via WhatsApp first, with automatic fallback to SMS if WhatsApp delivery
	// is unavailable.
	//
	// Supported channels: `sms`, `rcs`, `whatsapp`.
	PreferredChannel param.Field[TransactionalSendParamsPreferredChannel] `json:"preferred_channel"`
	// The variables to be replaced in the template.
	Variables param.Field[map[string]string] `json:"variables"`
}

type TransactionalSendParamsPreferredChannel string

type TransactionalSendResponse struct {
	// The message identifier.
	ID string `json:"id,required"`
	// The message creation date.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// The message expiration date.
	ExpiresAt time.Time `json:"expires_at,required" format:"date-time"`
	// The template identifier.
	TemplateID string `json:"template_id,required"`
	// The recipient's phone number.
	To string `json:"to,required"`
	// The variables to be replaced in the template.
	Variables map[string]string `json:"variables,required"`
	// The callback URL.
	CallbackURL string `json:"callback_url"`
	// A user-defined identifier to correlate this transactional message with. It is
	// returned in the response and any webhook events that refer to this transactional
	// message.
	CorrelationID string `json:"correlation_id"`
	// The Sender ID.
	From string                        `json:"from"`
	JSON transactionalSendResponseJSON `json:"-"`
}

type TransactionalService struct {
	Options []option.RequestOption
}

type VerificationCheckParams struct {
	// The OTP code to validate.
	Code param.Field[string] `json:"code,required"`
	// The verification target. Either a phone number or an email address. To use the
	// email verification feature contact us to discuss your use case.
	Target param.Field[VerificationCheckParamsTarget] `json:"target,required"`
}

type VerificationCheckParamsTarget struct {
	// The type of the target. Either "phone_number" or "email_address".
	Type param.Field[VerificationCheckParamsTargetType] `json:"type,required"`
	// An E.164 formatted phone number or an email address.
	Value param.Field[string] `json:"value,required"`
}

type VerificationCheckParamsTargetType string

type VerificationCheckResponse struct {
	// The status of the check.
	Status VerificationCheckResponseStatus `json:"status,required"`
	// The verification identifier.
	ID string `json:"id"`
	// The metadata for this verification.
	Metadata  VerificationCheckResponseMetadata `json:"metadata"`
	RequestID string                            `json:"request_id"`
	JSON      verificationCheckResponseJSON     `json:"-"`
}

type VerificationCheckResponseMetadata struct {
	// A user-defined identifier to correlate this verification with. It is returned in
	// the response and any webhook events that refer to this verification.
	CorrelationID string                                `json:"correlation_id"`
	JSON          verificationCheckResponseMetadataJSON `json:"-"`
}

type VerificationCheckResponseStatus string

type VerificationManagementDeletePhoneNumberParams struct {
	// An E.164 formatted phone number to remove from the list.
	PhoneNumber param.Field[string] `json:"phone_number,required" format:"phone_number"`
}

type VerificationManagementDeletePhoneNumberParamsAction string

type VerificationManagementDeletePhoneNumberResponse struct {
	// The E.164 formatted phone number that was removed from the list.
	PhoneNumber string                                              `json:"phone_number,required" format:"phone_number"`
	JSON        verificationManagementDeletePhoneNumberResponseJSON `json:"-"`
}

type VerificationManagementListPhoneNumbersParamsAction string

type VerificationManagementListPhoneNumbersResponse struct {
	// A list of phone numbers in the allow or block list.
	PhoneNumbers []VerificationManagementListPhoneNumbersResponsePhoneNumber `json:"phone_numbers,required"`
	JSON         verificationManagementListPhoneNumbersResponseJSON          `json:"-"`
}

type VerificationManagementListPhoneNumbersResponsePhoneNumber struct {
	// The date and time when the phone number was added to the list.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// An E.164 formatted phone number.
	PhoneNumber string                                                        `json:"phone_number,required" format:"phone_number"`
	JSON        verificationManagementListPhoneNumbersResponsePhoneNumberJSON `json:"-"`
}

type VerificationManagementListSenderIDsResponse struct {
	SenderIDs []VerificationManagementListSenderIDsResponseSenderID `json:"sender_ids"`
	JSON      verificationManagementListSenderIDsResponseJSON       `json:"-"`
}

type VerificationManagementListSenderIDsResponseSenderID struct {
	// Value that will be presented as Sender ID
	SenderID string `json:"sender_id"`
	// It indicates the status of the Sender ID. Possible values are:
	//
	// - `approved` - The Sender ID is approved.
	// - `pending` - The Sender ID is pending.
	// - `rejected` - The Sender ID is rejected.
	Status VerificationManagementListSenderIDsResponseSenderIDsStatus `json:"status"`
	JSON   verificationManagementListSenderIDsResponseSenderIDJSON    `json:"-"`
}

type VerificationManagementListSenderIDsResponseSenderIDsStatus string

type VerificationManagementService struct {
	Options []option.RequestOption
}

type VerificationManagementSetPhoneNumberParams struct {
	// An E.164 formatted phone number to add to the list.
	PhoneNumber param.Field[string] `json:"phone_number,required" format:"phone_number"`
}

type VerificationManagementSetPhoneNumberParamsAction string

type VerificationManagementSetPhoneNumberResponse struct {
	// The E.164 formatted phone number that was added to the list.
	PhoneNumber string                                           `json:"phone_number,required" format:"phone_number"`
	JSON        verificationManagementSetPhoneNumberResponseJSON `json:"-"`
}

type VerificationManagementSubmitSenderIDParams struct {
	// The sender ID to add.
	SenderID param.Field[string] `json:"sender_id,required"`
}

type VerificationManagementSubmitSenderIDResponse struct {
	// The sender ID that was added.
	SenderID string `json:"sender_id,required"`
	// It indicates the status of the sender ID. Possible values are:
	//
	// - `approved` - The sender ID is approved.
	// - `pending` - The sender ID is pending.
	// - `rejected` - The sender ID is rejected.
	Status VerificationManagementSubmitSenderIDResponseStatus `json:"status,required"`
	// The reason why the sender ID was rejected.
	Reason string                                           `json:"reason"`
	JSON   verificationManagementSubmitSenderIDResponseJSON `json:"-"`
}

type VerificationManagementSubmitSenderIDResponseStatus string

type VerificationNewParams struct {
	// The verification target. Either a phone number or an email address. To use the
	// email verification feature contact us to discuss your use case.
	Target param.Field[VerificationNewParamsTarget] `json:"target,required"`
	// The identifier of the dispatch that came from the front-end SDK.
	DispatchID param.Field[string] `json:"dispatch_id"`
	// The metadata for this verification. This object will be returned with every
	// response or webhook sent that refers to this verification.
	Metadata param.Field[VerificationNewParamsMetadata] `json:"metadata"`
	// Verification options
	Options param.Field[VerificationNewParamsOptions] `json:"options"`
	// The signals used for anti-fraud. For more details, refer to
	// [Signals](/verify/v2/documentation/prevent-fraud#signals).
	Signals param.Field[VerificationNewParamsSignals] `json:"signals"`
}

type VerificationNewParamsMetadata struct {
	// A user-defined identifier to correlate this verification with. It is returned in
	// the response and any webhook events that refer to this verification.
	CorrelationID param.Field[string] `json:"correlation_id"`
}

type VerificationNewParamsOptions struct {
	// This allows you to automatically retrieve and fill the OTP code on mobile apps.
	// Currently only Android devices are supported.
	AppRealm param.Field[VerificationNewParamsOptionsAppRealm] `json:"app_realm"`
	// The URL where webhooks will be sent when verification events occur, including
	// verification creation, attempt creation, and delivery status changes. For more
	// details, refer to [Webhook](/verify/v2/documentation/webhook).
	CallbackURL param.Field[string] `json:"callback_url"`
	// The size of the code generated. It should be between 4 and 8. Defaults to the
	// code size specified from the Dashboard.
	CodeSize param.Field[int64] `json:"code_size"`
	// The custom code to use for OTP verification. To use the custom code feature,
	// contact us to enable it for your account. For more details, refer to
	// [Custom Code](/verify/v2/documentation/custom-codes).
	CustomCode param.Field[string] `json:"custom_code"`
	// The integration that triggered the verification.
	Integration param.Field[VerificationNewParamsOptionsIntegration] `json:"integration"`
	// A BCP-47 formatted locale string with the language the text message will be sent
	// to. If there's no locale set, the language will be determined by the country
	// code of the phone number. If the language specified doesn't exist, it defaults
	// to US English.
	Locale param.Field[string] `json:"locale"`
	// The method used for verifying this phone number. The 'voice' option provides an
	// accessible alternative for visually impaired users by delivering the
	// verification code through a phone call rather than a text message. It also
	// allows verification of landline numbers that cannot receive SMS messages. The
	// 'message' option explicitly requests message delivery (SMS, WhatsApp ...) and
	// skips silent verification, useful for scenarios requiring direct user
	// interaction.
	Method param.Field[VerificationNewParamsOptionsMethod] `json:"method"`
	// The preferred channel to be used in priority for verification.
	PreferredChannel param.Field[VerificationNewParamsOptionsPreferredChannel] `json:"preferred_channel"`
	// The Sender ID to use for this message. The Sender ID needs to be enabled by
	// Prelude.
	SenderID param.Field[string] `json:"sender_id"`
	// The identifier of a verification template. It applies use case-specific
	// settings, such as the message content or certain verification parameters.
	TemplateID param.Field[string] `json:"template_id"`
	// The variables to be replaced in the template.
	Variables param.Field[map[string]string] `json:"variables"`
}

type VerificationNewParamsOptionsAppRealm struct {
	// The platform the SMS will be sent to. We are currently only supporting
	// "android".
	Platform param.Field[VerificationNewParamsOptionsAppRealmPlatform] `json:"platform,required"`
	// The Android SMS Retriever API hash code that identifies your app. For more
	// information, see
	// [Google documentation](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string).
	Value param.Field[string] `json:"value,required"`
}

type VerificationNewParamsOptionsAppRealmPlatform string

type VerificationNewParamsOptionsIntegration string

type VerificationNewParamsOptionsMethod string

type VerificationNewParamsOptionsPreferredChannel string

type VerificationNewParamsSignals struct {
	// The version of your application.
	AppVersion param.Field[string] `json:"app_version"`
	// The unique identifier for the user's device. For Android, this corresponds to
	// the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
	DeviceID param.Field[string] `json:"device_id"`
	// The model of the user's device.
	DeviceModel param.Field[string] `json:"device_model"`
	// The type of the user's device.
	DevicePlatform param.Field[VerificationNewParamsSignalsDevicePlatform] `json:"device_platform"`
	// The IP address of the user's device.
	IP param.Field[string] `json:"ip" format:"ipv4"`
	// This signal should provide a higher level of trust, indicating that the user is
	// genuine. Contact us to discuss your use case. For more details, refer to
	// [Signals](/verify/v2/documentation/prevent-fraud#signals).
	IsTrustedUser param.Field[bool] `json:"is_trusted_user"`
	// The JA4 fingerprint observed for the connection. Prelude will infer it
	// automatically when requests go through our client SDK (which uses Prelude's
	// edge), but you can also provide it explicitly if you terminate TLS yourself.
	Ja4Fingerprint param.Field[string] `json:"ja4_fingerprint"`
	// The version of the user's device operating system.
	OsVersion param.Field[string] `json:"os_version"`
	// The user agent of the user's device. If the individual fields (os_version,
	// device_platform, device_model) are provided, we will prioritize those values
	// instead of parsing them from the user agent string.
	UserAgent param.Field[string] `json:"user_agent"`
}

type VerificationNewParamsSignalsDevicePlatform string

type VerificationNewParamsTarget struct {
	// The type of the target. Either "phone_number" or "email_address".
	Type param.Field[VerificationNewParamsTargetType] `json:"type,required"`
	// An E.164 formatted phone number or an email address.
	Value param.Field[string] `json:"value,required"`
}

type VerificationNewParamsTargetType string

type VerificationNewResponse struct {
	// The verification identifier.
	ID string `json:"id,required"`
	// The method used for verifying this phone number.
	Method VerificationNewResponseMethod `json:"method,required"`
	// The status of the verification.
	Status VerificationNewResponseStatus `json:"status,required"`
	// The ordered sequence of channels to be used for verification
	Channels []VerificationNewResponseChannel `json:"channels"`
	// The metadata for this verification.
	Metadata VerificationNewResponseMetadata `json:"metadata"`
	// The reason why the verification was blocked. Only present when status is
	// "blocked".
	//
	//   - `expired_signature` - The signature of the SDK signals is expired. They should
	//     be sent within the hour following their collection.
	//   - `in_block_list` - The phone number is part of the configured block list.
	//   - `invalid_phone_line` - The phone number is not a valid line number (e.g.
	//     landline).
	//   - `invalid_phone_number` - The phone number is not a valid phone number (e.g.
	//     unallocated range).
	//   - `invalid_signature` - The signature of the SDK signals is invalid.
	//   - `repeated_attempts` - The phone number has made too many verification
	//     attempts.
	//   - `suspicious` - The verification attempt was deemed suspicious by the
	//     anti-fraud system.
	Reason    VerificationNewResponseReason `json:"reason"`
	RequestID string                        `json:"request_id"`
	// The silent verification specific properties.
	Silent VerificationNewResponseSilent `json:"silent"`
	JSON   verificationNewResponseJSON   `json:"-"`
}

type VerificationNewResponseChannel string

type VerificationNewResponseMetadata struct {
	// A user-defined identifier to correlate this verification with. It is returned in
	// the response and any webhook events that refer to this verification.
	CorrelationID string                              `json:"correlation_id"`
	JSON          verificationNewResponseMetadataJSON `json:"-"`
}

type VerificationNewResponseMethod string

type VerificationNewResponseReason string

type VerificationNewResponseSilent struct {
	// The URL to start the silent verification towards.
	RequestURL string                            `json:"request_url,required"`
	JSON       verificationNewResponseSilentJSON `json:"-"`
}

type VerificationNewResponseStatus string

type VerificationService struct {
	Options []option.RequestOption
}

type WatchPredictParams struct {
	// The prediction target. Only supports phone numbers for now.
	Target param.Field[WatchPredictParamsTarget] `json:"target,required"`
	// The identifier of the dispatch that came from the front-end SDK.
	DispatchID param.Field[string] `json:"dispatch_id"`
	// The metadata for this prediction.
	Metadata param.Field[WatchPredictParamsMetadata] `json:"metadata"`
	// The signals used for anti-fraud. For more details, refer to
	// [Signals](/verify/v2/documentation/prevent-fraud#signals).
	Signals param.Field[WatchPredictParamsSignals] `json:"signals"`
}

type WatchPredictParamsMetadata struct {
	// A user-defined identifier to correlate this prediction with. It is returned in
	// the response and any webhook events that refer to this prediction.
	CorrelationID param.Field[string] `json:"correlation_id"`
}

type WatchPredictParamsSignals struct {
	// The version of your application.
	AppVersion param.Field[string] `json:"app_version"`
	// The unique identifier for the user's device. For Android, this corresponds to
	// the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
	DeviceID param.Field[string] `json:"device_id"`
	// The model of the user's device.
	DeviceModel param.Field[string] `json:"device_model"`
	// The type of the user's device.
	DevicePlatform param.Field[WatchPredictParamsSignalsDevicePlatform] `json:"device_platform"`
	// The IP address of the user's device.
	IP param.Field[string] `json:"ip" format:"ipv4"`
	// This signal should provide a higher level of trust, indicating that the user is
	// genuine. Contact us to discuss your use case. For more details, refer to
	// [Signals](/verify/v2/documentation/prevent-fraud#signals).
	IsTrustedUser param.Field[bool] `json:"is_trusted_user"`
	// The JA4 fingerprint observed for the connection. Prelude will infer it
	// automatically when requests go through our client SDK (which uses Prelude's
	// edge), but you can also provide it explicitly if you terminate TLS yourself.
	Ja4Fingerprint param.Field[string] `json:"ja4_fingerprint"`
	// The version of the user's device operating system.
	OsVersion param.Field[string] `json:"os_version"`
	// The user agent of the user's device. If the individual fields (os_version,
	// device_platform, device_model) are provided, we will prioritize those values
	// instead of parsing them from the user agent string.
	UserAgent param.Field[string] `json:"user_agent"`
}

type WatchPredictParamsSignalsDevicePlatform string

type WatchPredictParamsTarget struct {
	// The type of the target. Either "phone_number" or "email_address".
	Type param.Field[WatchPredictParamsTargetType] `json:"type,required"`
	// An E.164 formatted phone number or an email address.
	Value param.Field[string] `json:"value,required"`
}

type WatchPredictParamsTargetType string

type WatchPredictResponse struct {
	// The prediction identifier.
	ID string `json:"id,required"`
	// The prediction outcome.
	Prediction WatchPredictResponsePrediction `json:"prediction,required"`
	// A string that identifies this specific request. Report it back to us to help us
	// diagnose your issues.
	RequestID string                   `json:"request_id,required"`
	JSON      watchPredictResponseJSON `json:"-"`
}

type WatchPredictResponsePrediction string

type WatchSendEventsParams struct {
	// A list of events to dispatch.
	Events param.Field[[]WatchSendEventsParamsEvent] `json:"events,required"`
}

type WatchSendEventsParamsEvent struct {
	// A confidence level you want to assign to the event.
	Confidence param.Field[WatchSendEventsParamsEventsConfidence] `json:"confidence,required"`
	// A label to describe what the event refers to.
	Label param.Field[string] `json:"label,required"`
	// The event target. Only supports phone numbers for now.
	Target param.Field[WatchSendEventsParamsEventsTarget] `json:"target,required"`
}

type WatchSendEventsParamsEventsConfidence string

type WatchSendEventsParamsEventsTarget struct {
	// The type of the target. Either "phone_number" or "email_address".
	Type param.Field[WatchSendEventsParamsEventsTargetType] `json:"type,required"`
	// An E.164 formatted phone number or an email address.
	Value param.Field[string] `json:"value,required"`
}

type WatchSendEventsParamsEventsTargetType string

type WatchSendEventsResponse struct {
	// A string that identifies this specific request. Report it back to us to help us
	// diagnose your issues.
	RequestID string `json:"request_id,required"`
	// The status of the events dispatch.
	Status WatchSendEventsResponseStatus `json:"status,required"`
	JSON   watchSendEventsResponseJSON   `json:"-"`
}

type WatchSendEventsResponseStatus string

type WatchSendFeedbacksParams struct {
	// A list of feedbacks to send.
	Feedbacks param.Field[[]WatchSendFeedbacksParamsFeedback] `json:"feedbacks,required"`
}

type WatchSendFeedbacksParamsFeedback struct {
	// The feedback target. Only supports phone numbers for now.
	Target param.Field[WatchSendFeedbacksParamsFeedbacksTarget] `json:"target,required"`
	// The type of feedback.
	Type param.Field[WatchSendFeedbacksParamsFeedbacksType] `json:"type,required"`
	// The identifier of the dispatch that came from the front-end SDK.
	DispatchID param.Field[string] `json:"dispatch_id"`
	// The metadata for this feedback.
	Metadata param.Field[WatchSendFeedbacksParamsFeedbacksMetadata] `json:"metadata"`
	// The signals used for anti-fraud. For more details, refer to
	// [Signals](/verify/v2/documentation/prevent-fraud#signals).
	Signals param.Field[WatchSendFeedbacksParamsFeedbacksSignals] `json:"signals"`
}

type WatchSendFeedbacksParamsFeedbacksMetadata struct {
	// A user-defined identifier to correlate this feedback with. It is returned in the
	// response and any webhook events that refer to this feedback.
	CorrelationID param.Field[string] `json:"correlation_id"`
}

type WatchSendFeedbacksParamsFeedbacksSignals struct {
	// The version of your application.
	AppVersion param.Field[string] `json:"app_version"`
	// The unique identifier for the user's device. For Android, this corresponds to
	// the `ANDROID_ID` and for iOS, this corresponds to the `identifierForVendor`.
	DeviceID param.Field[string] `json:"device_id"`
	// The model of the user's device.
	DeviceModel param.Field[string] `json:"device_model"`
	// The type of the user's device.
	DevicePlatform param.Field[WatchSendFeedbacksParamsFeedbacksSignalsDevicePlatform] `json:"device_platform"`
	// The IP address of the user's device.
	IP param.Field[string] `json:"ip" format:"ipv4"`
	// This signal should provide a higher level of trust, indicating that the user is
	// genuine. Contact us to discuss your use case. For more details, refer to
	// [Signals](/verify/v2/documentation/prevent-fraud#signals).
	IsTrustedUser param.Field[bool] `json:"is_trusted_user"`
	// The JA4 fingerprint observed for the connection. Prelude will infer it
	// automatically when requests go through our client SDK (which uses Prelude's
	// edge), but you can also provide it explicitly if you terminate TLS yourself.
	Ja4Fingerprint param.Field[string] `json:"ja4_fingerprint"`
	// The version of the user's device operating system.
	OsVersion param.Field[string] `json:"os_version"`
	// The user agent of the user's device. If the individual fields (os_version,
	// device_platform, device_model) are provided, we will prioritize those values
	// instead of parsing them from the user agent string.
	UserAgent param.Field[string] `json:"user_agent"`
}

type WatchSendFeedbacksParamsFeedbacksSignalsDevicePlatform string

type WatchSendFeedbacksParamsFeedbacksTarget struct {
	// The type of the target. Either "phone_number" or "email_address".
	Type param.Field[WatchSendFeedbacksParamsFeedbacksTargetType] `json:"type,required"`
	// An E.164 formatted phone number or an email address.
	Value param.Field[string] `json:"value,required"`
}

type WatchSendFeedbacksParamsFeedbacksTargetType string

type WatchSendFeedbacksParamsFeedbacksType string

type WatchSendFeedbacksResponse struct {
	// A string that identifies this specific request. Report it back to us to help us
	// diagnose your issues.
	RequestID string `json:"request_id,required"`
	// The status of the feedbacks sending.
	Status WatchSendFeedbacksResponseStatus `json:"status,required"`
	JSON   watchSendFeedbacksResponseJSON   `json:"-"`
}

type WatchSendFeedbacksResponseStatus string

type WatchService struct {
	Options []option.RequestOption
}