late-sdk 0.0.532 → 0.0.534

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

@@ -0,0 +1,177 @@
+=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
+  class GetPhoneNumberPortInRequirements200Response < ApiModelBase
+    attr_accessor :country
+
+    attr_accessor :number_type
+
+    # false when the combination includes a step that can't be completed through the API (e.g. an in-person identity verification) — porting it needs support.
+    attr_accessor :supported
+
+    attr_accessor :fields
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'country' => :'country',
+        :'number_type' => :'numberType',
+        :'supported' => :'supported',
+        :'fields' => :'fields'
+      }
+    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
+      {
+        :'country' => :'String',
+        :'number_type' => :'String',
+        :'supported' => :'Boolean',
+        :'fields' => :'Array<GetPhoneNumberPortInRequirements200ResponseFieldsInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::GetPhoneNumberPortInRequirements200Response` 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::GetPhoneNumberPortInRequirements200Response`. 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?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'number_type')
+        self.number_type = attributes[:'number_type']
+      end
+
+      if attributes.key?(:'supported')
+        self.supported = attributes[:'supported']
+      end
+
+      if attributes.key?(:'fields')
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
+        end
+      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'
+      true
+    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 &&
+          country == o.country &&
+          number_type == o.number_type &&
+          supported == o.supported &&
+          fields == o.fields
+    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
+      [country, number_type, supported, fields].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/models/get_phone_number_port_in_requirements200_response_fields_inner.rb

@@ -0,0 +1,231 @@
+=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
+  class GetPhoneNumberPortInRequirements200ResponseFieldsInner < ApiModelBase
+    # Pass back as requirements[].requirementTypeId.
+    attr_accessor :requirement_id
+
+    attr_accessor :label
+
+    # text/date take a string value; file takes a documentId from the documents endpoint; address is satisfied automatically from the end-user service address.
+    attr_accessor :kind
+
+    attr_accessor :description
+
+    attr_accessor :example
+
+    # When present, the value must be one of these.
+    attr_accessor :acceptable_values
+
+    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
+      {
+        :'requirement_id' => :'requirementId',
+        :'label' => :'label',
+        :'kind' => :'kind',
+        :'description' => :'description',
+        :'example' => :'example',
+        :'acceptable_values' => :'acceptableValues'
+      }
+    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
+      {
+        :'requirement_id' => :'String',
+        :'label' => :'String',
+        :'kind' => :'String',
+        :'description' => :'String',
+        :'example' => :'String',
+        :'acceptable_values' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::GetPhoneNumberPortInRequirements200ResponseFieldsInner` 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::GetPhoneNumberPortInRequirements200ResponseFieldsInner`. 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?(:'requirement_id')
+        self.requirement_id = attributes[:'requirement_id']
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'example')
+        self.example = attributes[:'example']
+      end
+
+      if attributes.key?(:'acceptable_values')
+        if (value = attributes[:'acceptable_values']).is_a?(Array)
+          self.acceptable_values = value
+        end
+      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'
+      kind_validator = EnumAttributeValidator.new('String', ["text", "date", "address", "file", "action"])
+      return false unless kind_validator.valid?(@kind)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] kind Object to be assigned
+    def kind=(kind)
+      validator = EnumAttributeValidator.new('String', ["text", "date", "address", "file", "action"])
+      unless validator.valid?(kind)
+        fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
+      end
+      @kind = kind
+    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 &&
+          requirement_id == o.requirement_id &&
+          label == o.label &&
+          kind == o.kind &&
+          description == o.description &&
+          example == o.example &&
+          acceptable_values == o.acceptable_values
+    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
+      [requirement_id, label, kind, description, example, acceptable_values].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.532'
+  VERSION = '0.0.534'
 end

data/lib/zernio-sdk.rb

@@ -216,6 +216,7 @@ require 'zernio-sdk/models/create_phone_number_port_in201_response'
 require 'zernio-sdk/models/create_phone_number_port_in201_response_orders_inner'
 require 'zernio-sdk/models/create_phone_number_port_in_request'
 require 'zernio-sdk/models/create_phone_number_port_in_request_end_user'
+require 'zernio-sdk/models/create_phone_number_port_in_request_requirements_inner'
 require 'zernio-sdk/models/create_pinterest_board201_response'
 require 'zernio-sdk/models/create_pinterest_board201_response_board'
 require 'zernio-sdk/models/create_pinterest_board_request'
@@ -587,6 +588,10 @@ require 'zernio-sdk/models/get_phone_number_kyc_form200_response_fields_inner'
 require 'zernio-sdk/models/get_phone_number_kyc_form200_response_reusable'
 require 'zernio-sdk/models/get_phone_number_kyc_form200_response_reusable_details_inner'
 require 'zernio-sdk/models/get_phone_number_kyc_form200_response_reusable_options_inner'
+require 'zernio-sdk/models/get_phone_number_port_in_order_requirements200_response'
+require 'zernio-sdk/models/get_phone_number_port_in_order_requirements200_response_requirements_inner'
+require 'zernio-sdk/models/get_phone_number_port_in_requirements200_response'
+require 'zernio-sdk/models/get_phone_number_port_in_requirements200_response_fields_inner'
 require 'zernio-sdk/models/get_phone_number_remediation200_response'
 require 'zernio-sdk/models/get_pinterest_boards200_response'
 require 'zernio-sdk/models/get_pinterest_boards200_response_boards_inner'

data/openapi.yaml

@@ -9176,9 +9176,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  error: { type: string }
+                $ref: '#/components/schemas/ErrorResponse'
               examples:
                 invalidMetric:
                   value:
@@ -28201,10 +28199,18 @@ paths:
 
         Run the portability check (POST /v1/phone-numbers/port-in/check) and
         upload the two documents (POST /v1/phone-numbers/port-in/documents)
-        first. The carrier may split the numbers into several orders (by
-        country, number type, losing carrier); `orders` carries per-order
-        results, and a partial failure still returns 201 with the failed
-        orders' `error` set (they stay as cancellable drafts).
+        first — uploaded documents must be attached to an order within 30
+        minutes or the carrier deletes them, so upload right before this call.
+        The carrier may split the numbers into several orders (by country,
+        number type, losing carrier); `orders` carries per-order results, and a
+        partial failure still returns 201 with the failed orders' `error` set
+        (they stay as cancellable drafts).
+
+        Non-US/CA numbers additionally need the country-specific values from
+        GET /v1/phone-numbers/port-in/requirements, passed via `requirements`,
+        and must be submitted one country per request. When required
+        information is still missing after submission, the order is kept as a
+        resumable draft whose `error` / `declineReason` names the gaps.
       security:
         - bearerAuth: []
       requestBody:
@@ -28228,24 +28234,42 @@ paths:
                     losing carrier matches every field against its records and rejects the
                     whole port on a mismatch — enter values exactly as they appear on the
                     carrier bill.
-                  required: [entityName, authPersonName, accountNumber, streetAddress, locality, administrativeArea, postalCode, countryCode]
+                  required: [entityName, authPersonName, accountNumber, streetAddress, locality, postalCode, countryCode]
                   properties:
                     entityName: { type: string, description: "Account holder / business name, as on the carrier account." }
                     authPersonName: { type: string, description: "Full name (first + last) of the person authorizing the port — must match the LOA signature." }
                     billingPhoneNumber: { type: string, description: "Phone number on the losing carrier's bill. Defaults to the ported number itself on single-number orders. Validated as a real phone number when present." }
                     accountNumber: { type: string, description: "Account number with the losing carrier — required (carriers reject ports without it; on prepaid mobile plans it is often the phone number itself)." }
-                    pinPasscode: { type: string, description: "Transfer PIN. Required for mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored." }
+                    pinPasscode: { type: string, description: "Transfer PIN. Required for US/CA mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored. International porting codes (e.g. the UK PAC) go through `requirements` instead." }
+                    taxIdentifier: { type: string, maxLength: 50, description: "Company tax id on the carrier account (EU ports, e.g. Spanish CIF)." }
+                    businessIdentifier: { type: string, maxLength: 50, description: "Business registration id on the carrier account (EU ports)." }
                     streetAddress: { type: string }
                     extendedAddress: { type: string }
                     locality: { type: string }
-                    administrativeArea: { type: string, description: "2-letter US state / CA province code (full names are accepted and normalized)." }
-                    postalCode: { type: string, description: "US ZIP (5 digits) or Canadian postal code, matching countryCode." }
-                    countryCode: { type: string, minLength: 2, maxLength: 2, enum: [US, CA] }
+                    administrativeArea: { type: string, description: "Region. Required for US/CA as the 2-letter state/province code (full names are accepted and normalized); optional elsewhere." }
+                    postalCode: { type: string, description: "Postal code. Validated as a US ZIP / Canadian postal code for US/CA; free-form elsewhere." }
+                    countryCode: { type: string, minLength: 2, maxLength: 2, enum: [US, CA, GB, ES, DE, FR, NL, AU], description: "Service-address country (a supported port-in country)." }
                 loaDocumentId: { type: string, description: Document id from POST /v1/phone-numbers/port-in/documents (kind=loa). }
                 invoiceDocumentId: { type: string, description: Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice). }
-                focDatetimeRequested: { type: string, format: date-time, description: "Requested port date; the carrier confirms the actual FOC later. Defaults to one week out (shifted off weekends) when omitted." }
+                focDatetimeRequested: { type: string, format: date-time, description: "Requested port date; the carrier confirms the actual FOC later. US/CA default is one week out (shifted off weekends); international orders are scheduled into the carrier's next allowed porting window at or after this date." }
                 customerReference: { type: string, maxLength: 100 }
                 portType: { type: string, enum: [full, partial], default: full, description: "Whether the losing account ports all its numbers (full) or keeps some (partial)." }
+                requirements:
+                  type: array
+                  maxItems: 30
+                  description: >-
+                    Country-specific requirement values for international ports
+                    (from GET /v1/phone-numbers/port-in/requirements). Not
+                    needed for US/CA. The LOA and invoice requirements are
+                    satisfied automatically by loaDocumentId/invoiceDocumentId,
+                    and address-type requirements by the endUser service
+                    address.
+                  items:
+                    type: object
+                    required: [requirementTypeId, fieldValue]
+                    properties:
+                      requirementTypeId: { type: string, description: "The requirement's id, from the requirements endpoint." }
+                      fieldValue: { type: string, maxLength: 1000, description: "Text value, ISO datetime, or a documentId from POST /v1/phone-numbers/port-in/documents, per the requirement's kind." }
       responses:
         '201':
           description: Port submitted. Top-level fields mirror the first successfully submitted order; per-order truth (including failures) is in `orders`.
@@ -28268,9 +28292,10 @@ paths:
                         status: { type: string }
                         phoneNumbers: { type: array, items: { type: string } }
                         error: { type: string, description: Present when this split order failed to submit (it stays as a cancellable draft). }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '409': { description: "A number is already provisioned, or already in an in-flight port" }
-        '422': { description: "A number is not portable (reason included), or every split order failed to submit" }
+        '422': { description: "A number is not portable (reason included), numbers span multiple non-US/CA countries, or every split order failed to submit" }
     get:
       operationId: listPhoneNumberPortIns
       tags: [Phone Numbers]
@@ -28348,7 +28373,9 @@ paths:
                         phoneNumber: { type: string }
                         portable: { type: boolean }
                         fastPortable: { type: boolean, description: Qualifies for the carrier's accelerated FastPort lane. }
-                        lineType: { type: [string, "null"], description: "Line type when known (mobile, landline, voip…). A mobile number requires the transfer PIN at submit." }
+                        lineType: { type: [string, "null"], description: "Line type when known (mobile, landline, voip…). A US/CA mobile number requires the transfer PIN at submit." }
+                        countryCode: { type: [string, "null"], description: "ISO country of the number — pass it to GET /v1/phone-numbers/port-in/requirements for international numbers." }
+                        phoneNumberType: { type: [string, "null"], description: "Carrier number-type classification (local, mobile, national, toll_free…) — the numberType for the requirements endpoint." }
                         notPortableReason: { type: [string, "null"], description: Carrier reason when not portable; null when portable. }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
@@ -28358,9 +28385,13 @@ paths:
       tags: [Phone Numbers]
       summary: Upload a porting document
       description: |
-        Upload ONE porting document (the signed LOA or a recent carrier invoice)
-        and get back its `documentId`, which the port-in create request takes as
-        `loaDocumentId` / `invoiceDocumentId`. PDF, JPEG, or PNG, 10MB max.
+        Upload ONE porting document and get back its `documentId`. For the
+        signed LOA / carrier invoice the id goes to `loaDocumentId` /
+        `invoiceDocumentId`; for a country-specific document requirement
+        (international ports) it becomes that requirement's `fieldValue`.
+        Requirement documents are normalized to PDF automatically (regulators
+        reject raw images). PDF, JPEG, or PNG, 10MB max. Uploads must be
+        attached to an order within 30 minutes or the carrier deletes them.
       security:
         - bearerAuth: []
       requestBody:
@@ -28372,7 +28403,7 @@ paths:
               required: [file]
               properties:
                 file: { type: string, format: binary, description: "The document (PDF/JPEG/PNG, 10MB max)." }
-                kind: { type: string, enum: [loa, invoice], description: Informational; used for the stored filename. }
+                kind: { type: string, description: "'loa', 'invoice', or any short slug for requirement documents. Informational; used for the stored filename." }
       responses:
         '200':
           description: Document uploaded.
@@ -28385,6 +28416,90 @@ paths:
         '400': { description: "Missing file, file too large, or unsupported type" }
         '401': { $ref: '#/components/responses/Unauthorized' }
 
+  /v1/phone-numbers/port-in/requirements:
+    get:
+      operationId: getPhoneNumberPortInRequirements
+      tags: [Phone Numbers]
+      summary: Country porting requirements
+      description: |
+        The country-specific information a port-in needs BEYOND the LOA,
+        invoice, and account/address details — e.g. an ID copy, proof of
+        address, a tax id, or a porting code. Call it after the portability
+        check (which returns each number's `countryCode` and
+        `phoneNumberType`), render the fields, and pass the collected values as
+        the create request's `requirements`. US/CA return an empty list.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: country, in: query, required: true, schema: { type: string, minLength: 2, maxLength: 2 }, description: "ISO country of the numbers being ported (a supported port-in country)." }
+        - { name: numberType, in: query, required: false, schema: { type: string, enum: [local, mobile, national, toll_free], default: local }, description: "The portability check's phoneNumberType — requirements differ by type." }
+      responses:
+        '200':
+          description: Requirement fields for the country/type combination.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  country: { type: string }
+                  numberType: { type: string }
+                  supported: { type: boolean, description: "false when the combination includes a step that can't be completed through the API (e.g. an in-person identity verification) — porting it needs support." }
+                  fields:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        requirementId: { type: string, description: "Pass back as requirements[].requirementTypeId." }
+                        label: { type: string }
+                        kind: { type: string, enum: [text, date, address, file, action], description: "text/date take a string value; file takes a documentId from the documents endpoint; address is satisfied automatically from the end-user service address." }
+                        description: { type: string }
+                        example: { type: string }
+                        acceptableValues: { type: array, items: { type: string }, description: "When present, the value must be one of these." }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '422': { description: "Country not supported for port-in" }
+
+  /v1/phone-numbers/port-in/{id}/requirements:
+    get:
+      operationId: getPhoneNumberPortInOrderRequirements
+      tags: [Phone Numbers]
+      summary: A port-in order's pending requirements
+      description: |
+        The live requirements on an EXISTING porting order: which are filled,
+        which are still pending, and which bounced on review
+        (`requirement-info-exception`). Use it to fix and resubmit a rejected
+        international port. Same field shape as the country-level requirements
+        endpoint, plus per-requirement status.
+      security:
+        - bearerAuth: []
+      parameters:
+        - { name: id, in: path, required: true, schema: { type: string }, description: Porting order ID (from the port-in list). }
+      responses:
+        '200':
+          description: The order's requirements with statuses.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  country: { type: string }
+                  requirements:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        requirementId: { type: string }
+                        label: { type: string }
+                        kind: { type: string, enum: [text, date, address, file, action] }
+                        description: { type: string }
+                        example: { type: string }
+                        acceptableValues: { type: array, items: { type: string } }
+                        status: { type: string, description: "requirement-info-pending | requirement-info-under-review | requirement-info-exception | approved" }
+                        filled: { type: boolean }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { description: Porting order not found }
+
   /v1/phone-numbers/port-in/{id}:
     delete:
       operationId: cancelPhoneNumberPortIn