zernio-sdk 0.0.847 → 0.0.848

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deb8cb0b62db94067d13a886b2d79b120d4678ef8c6d130f96462c32fb7f9510
-  data.tar.gz: da3babb7d65a56bee7e04d62eb8ce74a064a46ae11f4a4785aec4a31f32e4537
+  metadata.gz: f8bae5f1c84fdec763ef43f93d2ac74de874a656369e398bf5198433a08848e4
+  data.tar.gz: 6ad3b2aec91a9bdcf7ded38410d06cf3d9cf5e2d82ccb86e59fc441f41641050
 SHA512:
-  metadata.gz: 9afaf0f56491092294b7cf881f51dc8d4cde5a7e0a10b62cdef0466ee41695fd83c836178a623303d0e1e645dc835d1ff7446f14650c260f6b35644ed94a6c54
-  data.tar.gz: 68ce229127fe3c05262359f7caea37cfd364371e50ec243dc20cd1d47d36b4fef8443db687bc3b7fd8b154e45c9d0ec4687bcf9356c60179ed53f99599b7823d
+  metadata.gz: 424648936bb7436db8b8d66655347bbd71100915773bd1ab2f5f4180097215a488bf4cef238c8331c14b738678787f506d21917da12b82776339637da68ecf3c
+  data.tar.gz: b9a1c4555a35505382c0d2f54af4157567dc9fcf57ed7158833a558d06dec9f5b6cc4b1fca2b15566836c232842744fa410a864cff9cff8a844f924acaa5f7e8

data/docs/CreatePhoneNumberStockWatchRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **country** | **String** | ISO 3166-1 alpha-2 code of a country listed by GET /v1/phone-numbers/countries. |  |
+| **number_type** | **String** | Narrow the watch to one number type. Omit to be notified when any type in the country is back. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'zernio-sdk'
 
 instance = Zernio::CreatePhoneNumberStockWatchRequest.new(
-  country: null
+  country: null,
+  number_type: null
 )
 ```
 

data/docs/PhoneNumberStockWatch.md

@@ -7,6 +7,7 @@
 | **id** | **String** |  |  |
 | **country** | **String** | ISO 3166-1 alpha-2. |  |
 | **country_name** | **String** |  |  |
+| **number_type** | **String** | The watched number type, or null when the watch covers every type in the country. |  |
 | **created_at** | **Time** |  |  |
 
 ## Example
@@ -18,6 +19,7 @@ instance = Zernio::PhoneNumberStockWatch.new(
   id: null,
   country: null,
   country_name: null,
+  number_type: null,
   created_at: null
 )
 ```

data/docs/PhoneNumbersApi.md

@@ -391,7 +391,7 @@ end
 
 Watch an out-of-stock country
 
-Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 countries can be watched at once. 
+Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once.  Countries and types marked `fulfilment: request` by GET /v1/phone-numbers/countries can also be watched. Those are sourced by a carrier request rather than held in stock, so a watch records interest and no date is implied. 
 
 ### Examples
 

data/lib/zernio-sdk/api/phone_numbers_api.rb

@@ -361,7 +361,7 @@ module Zernio
     end
 
     # Watch an out-of-stock country
-    # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 countries can be watched at once. 
+    # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once.  Countries and types marked `fulfilment: request` by GET /v1/phone-numbers/countries can also be watched. Those are sourced by a carrier request rather than held in stock, so a watch records interest and no date is implied. 
     # @param create_phone_number_stock_watch_request [CreatePhoneNumberStockWatchRequest] 
     # @param [Hash] opts the optional parameters
     # @return [PhoneNumberStockWatch]
@@ -371,7 +371,7 @@ module Zernio
     end
 
     # Watch an out-of-stock country
-    # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 countries can be watched at once. 
+    # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once.  Countries and types marked `fulfilment: request` by GET /v1/phone-numbers/countries can also be watched. Those are sourced by a carrier request rather than held in stock, so a watch records interest and no date is implied. 
     # @param create_phone_number_stock_watch_request [CreatePhoneNumberStockWatchRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PhoneNumberStockWatch, Integer, Hash)>] PhoneNumberStockWatch data, response status code and response headers

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

@@ -18,10 +18,36 @@ module Zernio
     # ISO 3166-1 alpha-2 code of a country listed by GET /v1/phone-numbers/countries.
     attr_accessor :country
 
+    # Narrow the watch to one number type. Omit to be notified when any type in the country is back.
+    attr_accessor :number_type
+
+    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
       {
-        :'country' => :'country'
+        :'country' => :'country',
+        :'number_type' => :'numberType'
       }
     end
 
@@ -38,7 +64,8 @@ module Zernio
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'country' => :'String'
+        :'country' => :'String',
+        :'number_type' => :'String'
       }
     end
 
@@ -69,6 +96,10 @@ module Zernio
       else
         self.country = nil
       end
+
+      if attributes.key?(:'number_type')
+        self.number_type = attributes[:'number_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -98,6 +129,8 @@ module Zernio
       return false if @country.nil?
       return false if @country.to_s.length > 2
       return false if @country.to_s.length < 2
+      number_type_validator = EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
+      return false unless number_type_validator.valid?(@number_type)
       true
     end
 
@@ -119,12 +152,23 @@ module Zernio
       @country = country
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] number_type Object to be assigned
+    def number_type=(number_type)
+      validator = EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
+      unless validator.valid?(number_type)
+        fail ArgumentError, "invalid value for \"number_type\", must be one of #{validator.allowable_values}."
+      end
+      @number_type = number_type
+    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
+          country == o.country &&
+          number_type == o.number_type
     end
 
     # @see the `==` method
@@ -136,7 +180,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [country].hash
+      [country, number_type].hash
     end
 
     # Builds the object from hash

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

@@ -22,14 +22,40 @@ module Zernio
 
     attr_accessor :country_name
 
+    # The watched number type, or null when the watch covers every type in the country.
+    attr_accessor :number_type
+
     attr_accessor :created_at
 
+    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',
         :'country' => :'country',
         :'country_name' => :'countryName',
+        :'number_type' => :'numberType',
         :'created_at' => :'createdAt'
       }
     end
@@ -50,6 +76,7 @@ module Zernio
         :'id' => :'String',
         :'country' => :'String',
         :'country_name' => :'String',
+        :'number_type' => :'String',
         :'created_at' => :'Time'
       }
     end
@@ -57,6 +84,7 @@ module Zernio
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'number_type',
       ])
     end
 
@@ -94,6 +122,12 @@ module Zernio
         self.country_name = nil
       end
 
+      if attributes.key?(:'number_type')
+        self.number_type = attributes[:'number_type']
+      else
+        self.number_type = nil
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
@@ -132,6 +166,8 @@ module Zernio
       return false if @id.nil?
       return false if @country.nil?
       return false if @country_name.nil?
+      number_type_validator = EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
+      return false unless number_type_validator.valid?(@number_type)
       return false if @created_at.nil?
       true
     end
@@ -166,6 +202,16 @@ module Zernio
       @country_name = country_name
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] number_type Object to be assigned
+    def number_type=(number_type)
+      validator = EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
+      unless validator.valid?(number_type)
+        fail ArgumentError, "invalid value for \"number_type\", must be one of #{validator.allowable_values}."
+      end
+      @number_type = number_type
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] created_at Value to be assigned
     def created_at=(created_at)
@@ -184,6 +230,7 @@ module Zernio
           id == o.id &&
           country == o.country &&
           country_name == o.country_name &&
+          number_type == o.number_type &&
           created_at == o.created_at
     end
 
@@ -196,7 +243,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, country, country_name, created_at].hash
+      [id, country, country_name, number_type, created_at].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/version.rb

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

data/openapi.yaml

@@ -2724,11 +2724,15 @@ components:
           description: 'UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.'
     PhoneNumberStockWatch:
       type: object
-      required: [id, country, countryName, createdAt]
+      required: [id, country, countryName, numberType, createdAt]
       properties:
         id: { type: string }
         country: { type: string, description: 'ISO 3166-1 alpha-2.' }
         countryName: { type: string }
+        numberType:
+          type: [string, "null"]
+          enum: [local, mobile, national, toll_free, null]
+          description: 'The watched number type, or null when the watch covers every type in the country.'
         createdAt: { type: string, format: date-time }
     WebhookPayloadPhoneNumberStockAvailable:
       type: object
@@ -36619,9 +36623,14 @@ paths:
         Get notified the first time an out-of-stock country has deliverable
         numbers again: an email to the account holder plus the
         `phone_number.stock_available` webhook. Stock is re-checked every 6h.
-        One watch per country; a repeat request returns the existing watch
-        (200). The watch is consumed when it fires, so re-create it if you
-        miss the stock. Up to 20 countries can be watched at once.
+        One watch per country and number type; a repeat request returns the
+        existing watch (200). The watch is consumed when it fires, so re-create
+        it if you miss the stock. Up to 20 watches at once.
+
+        Countries and types marked `fulfilment: request` by
+        GET /v1/phone-numbers/countries can also be watched. Those are sourced
+        by a carrier request rather than held in stock, so a watch records
+        interest and no date is implied.
       security:
         - bearerAuth: []
       requestBody:
@@ -36633,6 +36642,10 @@ paths:
               required: [country]
               properties:
                 country: { type: string, minLength: 2, maxLength: 2, description: 'ISO 3166-1 alpha-2 code of a country listed by GET /v1/phone-numbers/countries.' }
+                numberType:
+                  type: string
+                  enum: [local, mobile, national, toll_free]
+                  description: 'Narrow the watch to one number type. Omit to be notified when any type in the country is back.'
       responses:
         '201':
           description: Watch created.
@@ -36641,7 +36654,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/PhoneNumberStockWatch'
         '200':
-          description: A watch for this country already existed; returned unchanged.
+          description: 'A watch for this country and type already existed; returned unchanged.'
           content:
             application/json:
               schema:

data/spec/api/phone_numbers_api_spec.rb

@@ -96,7 +96,7 @@ describe 'PhoneNumbersApi' do
 
   # unit tests for create_phone_number_stock_watch
   # Watch an out-of-stock country
-  # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 countries can be watched at once. 
+  # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the `phone_number.stock_available` webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once.  Countries and types marked `fulfilment: request` by GET /v1/phone-numbers/countries can also be watched. Those are sourced by a carrier request rather than held in stock, so a watch records interest and no date is implied. 
   # @param create_phone_number_stock_watch_request 
   # @param [Hash] opts the optional parameters
   # @return [PhoneNumberStockWatch]

data/spec/models/create_phone_number_stock_watch_request_spec.rb

@@ -33,4 +33,14 @@ describe Zernio::CreatePhoneNumberStockWatchRequest do
     end
   end
 
+  describe 'test attribute "number_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.number_type = value }.not_to raise_error
+      # end
+    end
+  end
+
 end

data/spec/models/phone_number_stock_watch_spec.rb

@@ -45,6 +45,16 @@ describe Zernio::PhoneNumberStockWatch do
     end
   end
 
+  describe 'test attribute "number_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["local", "mobile", "national", "toll_free"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.number_type = value }.not_to raise_error
+      # end
+    end
+  end
+
   describe 'test attribute "created_at"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zernio-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.847
+  version: 0.0.848
 platform: ruby
 authors:
 - OpenAPI-Generator