zernio-sdk 0.0.537 → 0.0.539

data/lib/zernio-sdk/models/verification.rb

@@ -0,0 +1,287 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # A managed OTP verification. The code itself is never returned or stored (hash only).
+  class Verification < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :status
+
+    attr_accessor :channel
+
+    attr_accessor :to
+
+    attr_accessor :expires_at
+
+    attr_accessor :attempts
+
+    attr_accessor :max_attempts
+
+    # Accepted deliveries (initial send + resends); each bills one verification fee.
+    attr_accessor :send_count
+
+    attr_accessor :last_sent_at
+
+    attr_accessor :created_at
+
+    # Present on create responses: true when an active verification was resent instead of created.
+    attr_accessor :resend
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'status' => :'status',
+        :'channel' => :'channel',
+        :'to' => :'to',
+        :'expires_at' => :'expiresAt',
+        :'attempts' => :'attempts',
+        :'max_attempts' => :'maxAttempts',
+        :'send_count' => :'sendCount',
+        :'last_sent_at' => :'lastSentAt',
+        :'created_at' => :'createdAt',
+        :'resend' => :'resend'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'status' => :'String',
+        :'channel' => :'String',
+        :'to' => :'String',
+        :'expires_at' => :'Time',
+        :'attempts' => :'Integer',
+        :'max_attempts' => :'Integer',
+        :'send_count' => :'Integer',
+        :'last_sent_at' => :'Time',
+        :'created_at' => :'Time',
+        :'resend' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'last_sent_at',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::Verification` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::Verification`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'attempts')
+        self.attempts = attributes[:'attempts']
+      end
+
+      if attributes.key?(:'max_attempts')
+        self.max_attempts = attributes[:'max_attempts']
+      end
+
+      if attributes.key?(:'send_count')
+        self.send_count = attributes[:'send_count']
+      end
+
+      if attributes.key?(:'last_sent_at')
+        self.last_sent_at = attributes[:'last_sent_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'resend')
+        self.resend = attributes[:'resend']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "expired", "max_attempts_reached", "canceled", "delivery_failed"])
+      return false unless status_validator.valid?(@status)
+      channel_validator = EnumAttributeValidator.new('String', ["sms"])
+      return false unless channel_validator.valid?(@channel)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["pending", "approved", "expired", "max_attempts_reached", "canceled", "delivery_failed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["sms"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          status == o.status &&
+          channel == o.channel &&
+          to == o.to &&
+          expires_at == o.expires_at &&
+          attempts == o.attempts &&
+          max_attempts == o.max_attempts &&
+          send_count == o.send_count &&
+          last_sent_at == o.last_sent_at &&
+          created_at == o.created_at &&
+          resend == o.resend
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, status, channel, to, expires_at, attempts, max_attempts, send_count, last_sent_at, created_at, resend].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/zernio-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.537'
+  VERSION = '0.0.539'
 end

data/lib/zernio-sdk.rb

@@ -125,6 +125,8 @@ require 'zernio-sdk/models/check_phone_number_availability200_response'
 require 'zernio-sdk/models/check_phone_number_portability200_response'
 require 'zernio-sdk/models/check_phone_number_portability200_response_results_inner'
 require 'zernio-sdk/models/check_phone_number_portability_request'
+require 'zernio-sdk/models/check_verification200_response'
+require 'zernio-sdk/models/check_verification_request'
 require 'zernio-sdk/models/complete_google_business_verification_request'
 require 'zernio-sdk/models/complete_telegram_connect200_response'
 require 'zernio-sdk/models/complete_whats_app_phone_selection200_response'
@@ -273,6 +275,7 @@ require 'zernio-sdk/models/create_test_lead_request'
 require 'zernio-sdk/models/create_test_lead_request_field_data_inner'
 require 'zernio-sdk/models/create_tracking_tag201_response'
 require 'zernio-sdk/models/create_tracking_tag_request'
+require 'zernio-sdk/models/create_verification_request'
 require 'zernio-sdk/models/create_voice_call200_response'
 require 'zernio-sdk/models/create_voice_call_request'
 require 'zernio-sdk/models/create_voice_web_session200_response'
@@ -929,6 +932,10 @@ require 'zernio-sdk/models/money'
 require 'zernio-sdk/models/money_amount'
 require 'zernio-sdk/models/move_account_to_profile200_response'
 require 'zernio-sdk/models/move_account_to_profile_request'
+require 'zernio-sdk/models/on_verification_approved_request'
+require 'zernio-sdk/models/on_verification_approved_request_verification'
+require 'zernio-sdk/models/on_verification_failed_request'
+require 'zernio-sdk/models/on_verification_failed_request_verification'
 require 'zernio-sdk/models/on_whats_app_automatic_event_request'
 require 'zernio-sdk/models/on_whats_app_automatic_event_request_custom_data'
 require 'zernio-sdk/models/on_whats_app_number_action_required_request'
@@ -1380,6 +1387,7 @@ require 'zernio-sdk/models/validate_subreddit200_response'
 require 'zernio-sdk/models/validate_subreddit200_response_one_of'
 require 'zernio-sdk/models/validate_subreddit200_response_one_of1'
 require 'zernio-sdk/models/validate_subreddit200_response_one_of_subreddit'
+require 'zernio-sdk/models/verification'
 require 'zernio-sdk/models/verify_sms_registration_otp200_response'
 require 'zernio-sdk/models/verify_sms_registration_otp_request'
 require 'zernio-sdk/models/vote_reddit_thing_request'
@@ -1531,6 +1539,7 @@ require 'zernio-sdk/api/twitter_engagement_api'
 require 'zernio-sdk/api/usage_api'
 require 'zernio-sdk/api/users_api'
 require 'zernio-sdk/api/validate_api'
+require 'zernio-sdk/api/verify_api'
 require 'zernio-sdk/api/voice_api'
 require 'zernio-sdk/api/webhooks_api'
 require 'zernio-sdk/api/whats_app_api'

data/openapi.yaml

@@ -177,6 +177,8 @@ x-documentation:
     - `whatsapp.number.suspended` - An active number was suspended (e.g. failed payment); carries a `reason`
     - `whatsapp.number.reactivated` - A suspended number is usable again
     - `whatsapp.number.released` - A number was released and is no longer usable (terminal); carries a `reason`
+    - `verification.approved` - A managed-OTP verification was approved (the user submitted the correct code)
+    - `verification.failed` - A managed-OTP verification was exhausted after too many wrong code attempts
     - `webhook.test` - Test event sent when verifying a webhook endpoint
 
     Webhook payloads are signed with HMAC-SHA256 via the `X-Zernio-Signature` header.
@@ -363,7 +365,7 @@ tags:
   - name: Webhooks
     description: |
       Configure webhooks for real-time notifications. Webhooks can be created from the dashboard (Settings → Webhooks) or via this API.
-      Events: post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted, webhook.test.
+      Events: post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted, verification.approved, verification.failed, webhook.test.
       Security: optional HMAC-SHA256 signature in X-Zernio-Signature header. Configure a secret key to enable verification. Custom headers supported.
   - name: Webhook Events
     description: |
@@ -398,6 +400,13 @@ tags:
       inventory, complete country KYC, and release numbers here; turn features on
       via the per-number sub-resources (`/v1/phone-numbers/{id}/voice`, `/sms`,
       `/whatsapp/...`). Requires a paid plan.
+  - name: Verify
+    description: |
+      Managed one-time passcodes (OTP) for phone verification. Two calls
+      handle the whole lifecycle: create a verification (we generate the
+      code, deliver it by SMS from a phone number on your account, and store
+      only its hash) and check the code the user typed. Usage-based billing
+      only.
   - name: WhatsApp Phone Numbers
     description: |
       Deprecated namespace: phone numbers moved to `/v1/phone-numbers` (a number is
@@ -605,6 +614,21 @@ components:
                   effective_account_limit: 2000
                   current_account_count: 2000
   schemas:
+    Verification:
+      type: object
+      description: 'A managed OTP verification. The code itself is never returned or stored (hash only).'
+      properties:
+        id: { type: string }
+        status: { type: string, enum: [pending, approved, expired, max_attempts_reached, canceled, delivery_failed] }
+        channel: { type: string, enum: [sms] }
+        to: { type: string }
+        expiresAt: { type: string, format: date-time }
+        attempts: { type: integer }
+        maxAttempts: { type: integer }
+        sendCount: { type: integer, description: 'Accepted deliveries (initial send + resends); each bills one verification fee.' }
+        lastSentAt: { type: [string, "null"], format: date-time }
+        createdAt: { type: string, format: date-time }
+        resend: { type: boolean, description: 'Present on create responses: true when an active verification was resent instead of created.' }
     RfPrediction:
       type: object
       description: A Meta Reach & Frequency prediction. Money values in whole units of the ad account currency.
@@ -1864,7 +1888,7 @@ components:
           type: array
           items:
             type: string
-            enum: [post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted]
+            enum: [post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted, verification.approved, verification.failed]
           description: Events subscribed to
         isActive:
           type: boolean
@@ -7910,7 +7934,7 @@ webhooks:
               type: object
               properties:
                 id: { type: string }
-                event: { type: string, enum: [whatsapp.number.kyc_submitted] }
+                event: { type: string, enum: [whatsapp.number.kyc_submitted, verification.approved, verification.failed] }
                 timestamp: { type: string, format: date-time }
                 number:
                   type: object
@@ -7922,6 +7946,61 @@ webhooks:
       responses:
         '200':
           description: Webhook received successfully
+  verification.approved:
+    post:
+      operationId: onVerificationApproved
+      summary: Verification approved event
+      description: |
+        Fired when a managed-OTP verification is approved (the user submitted
+        the correct code to POST /v1/verify/verifications/{verificationId}/check).
+      tags: [Webhook Events]
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                id: { type: string }
+                event: { type: string, enum: [verification.approved] }
+                timestamp: { type: string, format: date-time }
+                verification:
+                  type: object
+                  properties:
+                    verificationId: { type: string }
+                    channel: { type: string, enum: [sms] }
+                    to: { type: string }
+      responses:
+        '200':
+          description: Webhook received successfully
+  verification.failed:
+    post:
+      operationId: onVerificationFailed
+      summary: Verification failed event
+      description: |
+        Fired when a managed-OTP verification is exhausted (the maximum number
+        of wrong code attempts was reached).
+      tags: [Webhook Events]
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                id: { type: string }
+                event: { type: string, enum: [verification.failed] }
+                timestamp: { type: string, format: date-time }
+                verification:
+                  type: object
+                  properties:
+                    verificationId: { type: string }
+                    channel: { type: string, enum: [sms] }
+                    to: { type: string }
+                reason: { type: string, enum: [max_attempts_reached] }
+      responses:
+        '200':
+          description: Webhook received successfully
   webhook.test:
     post:
       operationId: onWebhookTest
@@ -20818,7 +20897,7 @@ paths:
                   minItems: 1
                   items:
                     type: string
-                    enum: [post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted]
+                    enum: [post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted, verification.approved, verification.failed]
                   description: Events to subscribe to (at least one required)
                 isActive:
                   type: boolean
@@ -20892,7 +20971,7 @@ paths:
                   minItems: 1
                   items:
                     type: string
-                    enum: [post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted]
+                    enum: [post.scheduled, post.published, post.failed, post.partial, post.cancelled, post.recycled, post.platform.published, post.platform.failed, post.tiktok.url_resolved, post.external.created, post.external.updated, post.external.deleted, account.connected, account.disconnected, account.ads.initial_sync_completed, message.received, conversation.started, call.received, call.ended, call.failed, call.permission_request, message.sent, message.edited, message.deleted, message.delivered, message.read, message.failed, reaction.received, comment.received, review.new, review.updated, lead.received, ad.status_changed, whatsapp.template.status_updated, whatsapp.automatic_event, whatsapp.number.activated, whatsapp.number.declined, whatsapp.number.action_required, whatsapp.number.verification_required, whatsapp.number.suspended, whatsapp.number.reactivated, whatsapp.number.released, whatsapp.number.kyc_submitted, verification.approved, verification.failed]
                   description: Events to subscribe to. Must contain at least one event if provided.
                 isActive:
                   type: boolean
@@ -38810,3 +38889,124 @@ paths:
         '403': { description: 'Ads access required (Ads add-on on legacy plans, included on usage-based plans), or the Meta token lacks ads permissions (reconnect required).' }
         '404': { description: Account or tracking tag not found. }
         '405': { description: Platform does not support tracking-tag stats. }
+
+  /v1/verify/verifications:
+    post:
+      operationId: createVerification
+      tags: [Verify]
+      summary: Send a verification code
+      description: |
+        Generate a one-time code, deliver it to the recipient, and store only
+        its hash. Check the user-typed code with
+        POST /v1/verify/verifications/{verificationId}/check.
+
+        Re-POSTing for the same (channel, to) while a verification is active
+        RESENDS a fresh code on the existing verification (200 with
+        `resend: true`) instead of creating a new one; resends are limited to
+        one per 60 seconds (429 with `retryAfterSeconds` inside the cooldown).
+        The stored brandName/codeLength/ttlMinutes win on a resend.
+
+        Codes deliver by SMS from a phone number on your account (`from`
+        optional when you own exactly one SMS-enabled number) and the message
+        uses a fixed template. Each accepted send bills one verification fee
+        plus the standard message rate.
+      security:
+        - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [channel, to]
+              properties:
+                channel: { type: string, enum: [sms], description: 'SMS-only for now.' }
+                to: { type: string, description: "E.164 phone number." }
+                from: { type: string, description: "The SMS-enabled number on your account to send from. Defaults to your only SMS number." }
+                brandName: { type: string, maxLength: 30, description: "Your app or business name, rendered in the message. Defaults to your account name. Letters, numbers, and basic punctuation only." }
+                codeLength: { type: integer, minimum: 4, maximum: 8, default: 6 }
+                ttlMinutes: { type: integer, minimum: 1, maximum: 15, default: 10 }
+      responses:
+        '201':
+          description: Verification created and the code sent.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Verification'
+        '200':
+          description: 'Active verification found: a fresh code was resent (`resend: true`).'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Verification'
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '403': { description: Verifications require usage-based billing. }
+        '404': { description: "The 'from' number is not an SMS-enabled number on this account." }
+        '409': { description: The recipient has opted out of messages from your number. }
+        '422': { description: "Verifications need an SMS-enabled number on your account; add one first." }
+        '429': { description: 'Resend cooldown or a send cap was hit; `retryAfterSeconds` says when to retry.' }
+
+  /v1/verify/verifications/{verificationId}:
+    get:
+      operationId: getVerification
+      tags: [Verify]
+      summary: Get a verification
+      description: |
+        Current state of a verification. `status` is effective (a pending code
+        past its expiry reads as `expired`). Verification records are deleted
+        24 hours after creation, after which this returns 404.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: verificationId, in: path, required: true, schema: { type: string } }
+      responses:
+        '200':
+          description: The verification.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Verification'
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { description: Verification not found (or already reaped). }
+
+  /v1/verify/verifications/{verificationId}/check:
+    post:
+      operationId: checkVerification
+      tags: [Verify]
+      summary: Check a verification code
+      description: |
+        Verify the code the user typed. Wrong, expired, and exhausted codes
+        answer 200 with `valid: false` and the settled `status` — only an
+        unknown id is a 404. A correct code consumes the verification
+        (single-use, `status: approved`) and fires the `verification.approved`
+        webhook; the 5th wrong attempt settles it as `max_attempts_reached`
+        and fires `verification.failed`.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: verificationId, in: path, required: true, schema: { type: string } }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [code]
+              properties:
+                code: { type: string, pattern: '^\d{4,8}$' }
+      responses:
+        '200':
+          description: 'Check result: the verification plus `valid`.'
+          content:
+            application/json:
+              schema:
+                allOf:
+                  - $ref: '#/components/schemas/Verification'
+                  - type: object
+                    properties:
+                      valid: { type: boolean }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { description: Verification not found (or already reaped). }