pingram 1.0.38 → 1.0.40

data/lib/pingram/models/{update_voice_agent_response.rb → local_number_submit_request.rb}

@@ -14,13 +14,22 @@ require 'date'
 require 'time'
 
 module Pingram
-  class UpdateVoiceAgentResponse < ApiModelBase
-    attr_accessor :agent
+  class LocalNumberSubmitRequest < ApiModelBase
+    # Admin-confirmed use case. Required for personal registrations.
+    attr_accessor :use_case
+
+    # Whether the number will be sub-allocated to a third party.
+    attr_accessor :sub_allocated
+
+    # Required when subAllocated is true.
+    attr_accessor :sub_allocated_party
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'agent' => :'agent'
+        :'use_case' => :'useCase',
+        :'sub_allocated' => :'subAllocated',
+        :'sub_allocated_party' => :'subAllocatedParty'
       }
     end
 
@@ -37,7 +46,9 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'agent' => :'BindNumberResponseAgent'
+        :'use_case' => :'String',
+        :'sub_allocated' => :'Boolean',
+        :'sub_allocated_party' => :'String'
       }
     end
 
@@ -51,22 +62,28 @@ module Pingram
     # @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 `Pingram::UpdateVoiceAgentResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::LocalNumberSubmitRequest` 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 `Pingram::UpdateVoiceAgentResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::LocalNumberSubmitRequest`. 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?(:'agent')
-        self.agent = attributes[:'agent']
-      else
-        self.agent = nil
+      if attributes.key?(:'use_case')
+        self.use_case = attributes[:'use_case']
+      end
+
+      if attributes.key?(:'sub_allocated')
+        self.sub_allocated = attributes[:'sub_allocated']
+      end
+
+      if attributes.key?(:'sub_allocated_party')
+        self.sub_allocated_party = attributes[:'sub_allocated_party']
       end
     end
 
@@ -75,10 +92,6 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @agent.nil?
-        invalid_properties.push('invalid value for "agent", agent cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -86,26 +99,17 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @agent.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] agent Value to be assigned
-    def agent=(agent)
-      if agent.nil?
-        fail ArgumentError, 'agent cannot be nil'
-      end
-
-      @agent = agent
-    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 &&
-          agent == o.agent
+          use_case == o.use_case &&
+          sub_allocated == o.sub_allocated &&
+          sub_allocated_party == o.sub_allocated_party
     end
 
     # @see the `==` method
@@ -117,7 +121,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [agent].hash
+      [use_case, sub_allocated, sub_allocated_party].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/local_number_upload_request.rb

@@ -0,0 +1,267 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  class LocalNumberUploadRequest < ApiModelBase
+    # Which document this is. - passport_or_id: GB personal, with utility_bill. - utility_bill: needed for GB registration; must be less than 3 months old. - company_registration_certificate: GB business, with utility_bill. - proof_of_address: needed for IL registration; must be less than 3 months old. - business_registration_certificate: IL business, with proof_of_address.
+    attr_accessor :doc_kind
+
+    attr_accessor :file_name
+
+    attr_accessor :content_type
+
+    attr_accessor :content_length
+
+    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
+      {
+        :'doc_kind' => :'docKind',
+        :'file_name' => :'fileName',
+        :'content_type' => :'contentType',
+        :'content_length' => :'contentLength'
+      }
+    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
+      {
+        :'doc_kind' => :'String',
+        :'file_name' => :'String',
+        :'content_type' => :'String',
+        :'content_length' => :'Float'
+      }
+    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 `Pingram::LocalNumberUploadRequest` 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 `Pingram::LocalNumberUploadRequest`. 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?(:'doc_kind')
+        self.doc_kind = attributes[:'doc_kind']
+      else
+        self.doc_kind = nil
+      end
+
+      if attributes.key?(:'file_name')
+        self.file_name = attributes[:'file_name']
+      else
+        self.file_name = nil
+      end
+
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      else
+        self.content_type = nil
+      end
+
+      if attributes.key?(:'content_length')
+        self.content_length = attributes[:'content_length']
+      else
+        self.content_length = nil
+      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
+      if @doc_kind.nil?
+        invalid_properties.push('invalid value for "doc_kind", doc_kind cannot be nil.')
+      end
+
+      if @file_name.nil?
+        invalid_properties.push('invalid value for "file_name", file_name cannot be nil.')
+      end
+
+      if @content_type.nil?
+        invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
+      end
+
+      if @content_length.nil?
+        invalid_properties.push('invalid value for "content_length", content_length cannot be nil.')
+      end
+
+      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'
+      return false if @doc_kind.nil?
+      doc_kind_validator = EnumAttributeValidator.new('String', ["passport_or_id", "company_registration_certificate", "utility_bill", "business_registration_certificate", "proof_of_address"])
+      return false unless doc_kind_validator.valid?(@doc_kind)
+      return false if @file_name.nil?
+      return false if @content_type.nil?
+      return false if @content_length.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] doc_kind Object to be assigned
+    def doc_kind=(doc_kind)
+      validator = EnumAttributeValidator.new('String', ["passport_or_id", "company_registration_certificate", "utility_bill", "business_registration_certificate", "proof_of_address"])
+      unless validator.valid?(doc_kind)
+        fail ArgumentError, "invalid value for \"doc_kind\", must be one of #{validator.allowable_values}."
+      end
+      @doc_kind = doc_kind
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] file_name Value to be assigned
+    def file_name=(file_name)
+      if file_name.nil?
+        fail ArgumentError, 'file_name cannot be nil'
+      end
+
+      @file_name = file_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] content_type Value to be assigned
+    def content_type=(content_type)
+      if content_type.nil?
+        fail ArgumentError, 'content_type cannot be nil'
+      end
+
+      @content_type = content_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] content_length Value to be assigned
+    def content_length=(content_length)
+      if content_length.nil?
+        fail ArgumentError, 'content_length cannot be nil'
+      end
+
+      @content_length = content_length
+    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 &&
+          doc_kind == o.doc_kind &&
+          file_name == o.file_name &&
+          content_type == o.content_type &&
+          content_length == o.content_length
+    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
+      [doc_kind, file_name, content_type, content_length].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/pingram/models/local_number_upload_response.rb

@@ -0,0 +1,240 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  class LocalNumberUploadResponse < ApiModelBase
+    attr_accessor :upload_url
+
+    attr_accessor :s3_key
+
+    attr_accessor :method
+
+    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
+      {
+        :'upload_url' => :'uploadUrl',
+        :'s3_key' => :'s3Key',
+        :'method' => :'method'
+      }
+    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
+      {
+        :'upload_url' => :'String',
+        :'s3_key' => :'String',
+        :'method' => :'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 `Pingram::LocalNumberUploadResponse` 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 `Pingram::LocalNumberUploadResponse`. 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?(:'upload_url')
+        self.upload_url = attributes[:'upload_url']
+      else
+        self.upload_url = nil
+      end
+
+      if attributes.key?(:'s3_key')
+        self.s3_key = attributes[:'s3_key']
+      else
+        self.s3_key = nil
+      end
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      else
+        self.method = nil
+      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
+      if @upload_url.nil?
+        invalid_properties.push('invalid value for "upload_url", upload_url cannot be nil.')
+      end
+
+      if @s3_key.nil?
+        invalid_properties.push('invalid value for "s3_key", s3_key cannot be nil.')
+      end
+
+      if @method.nil?
+        invalid_properties.push('invalid value for "method", method cannot be nil.')
+      end
+
+      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'
+      return false if @upload_url.nil?
+      return false if @s3_key.nil?
+      return false if @method.nil?
+      method_validator = EnumAttributeValidator.new('String', ["PUT"])
+      return false unless method_validator.valid?(@method)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] upload_url Value to be assigned
+    def upload_url=(upload_url)
+      if upload_url.nil?
+        fail ArgumentError, 'upload_url cannot be nil'
+      end
+
+      @upload_url = upload_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] s3_key Value to be assigned
+    def s3_key=(s3_key)
+      if s3_key.nil?
+        fail ArgumentError, 's3_key cannot be nil'
+      end
+
+      @s3_key = s3_key
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] method Object to be assigned
+    def method=(method)
+      validator = EnumAttributeValidator.new('String', ["PUT"])
+      unless validator.valid?(method)
+        fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
+      end
+      @method = method
+    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 &&
+          upload_url == o.upload_url &&
+          s3_key == o.s3_key &&
+          method == o.method
+    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
+      [upload_url, s3_key, method].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