pingram 1.0.39 → 1.0.40

data/lib/pingram/models/local_number_admin_update_request.rb

@@ -0,0 +1,213 @@
+=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 LocalNumberAdminUpdateRequest < ApiModelBase
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    attr_accessor :status
+
+    # Whether this local number is registered to a person or a business. - personal: an individual. firstName and lastName are that person. - business: a company. firstName and lastName are the authorized representative.
+    attr_accessor :registration_type
+
+    attr_accessor :fields
+
+    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
+      {
+        :'status' => :'status',
+        :'registration_type' => :'registrationType',
+        :'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
+      {
+        :'status' => :'String',
+        :'registration_type' => :'String',
+        :'fields' => :'LocalNumberAdminUpdateRequestFields'
+      }
+    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::LocalNumberAdminUpdateRequest` 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::LocalNumberAdminUpdateRequest`. 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?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'registration_type')
+        self.registration_type = attributes[:'registration_type']
+      end
+
+      if attributes.key?(:'fields')
+        self.fields = attributes[:'fields']
+      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', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      return false unless status_validator.valid?(@status)
+      registration_type_validator = EnumAttributeValidator.new('String', ["personal", "business"])
+      return false unless registration_type_validator.valid?(@registration_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      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] registration_type Object to be assigned
+    def registration_type=(registration_type)
+      validator = EnumAttributeValidator.new('String', ["personal", "business"])
+      unless validator.valid?(registration_type)
+        fail ArgumentError, "invalid value for \"registration_type\", must be one of #{validator.allowable_values}."
+      end
+      @registration_type = registration_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 &&
+          status == o.status &&
+          registration_type == o.registration_type &&
+          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
+      [status, registration_type, 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/pingram/models/local_number_admin_update_request_fields.rb

@@ -0,0 +1,380 @@
+=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 LocalNumberAdminUpdateRequestFields < ApiModelBase
+    # First name. For a business registration, the authorized representative.
+    attr_accessor :first_name
+
+    # Last name. For a business registration, the authorized representative.
+    attr_accessor :last_name
+
+    # Contact phone number.
+    attr_accessor :contact_phone
+
+    # Street address, including the building number and street name. An IL registration also includes the apartment or suite.
+    attr_accessor :street
+
+    # City.
+    attr_accessor :city
+
+    # Postal or ZIP code.
+    attr_accessor :postal_code
+
+    # Building number when it is sent separately from the street address.
+    attr_accessor :building_number
+
+    # State or province. Required for an IL registration.
+    attr_accessor :state
+
+    # Company name. Required for a business registration.
+    attr_accessor :company_name
+
+    # Company website, including https://. Required for a GB business registration.
+    attr_accessor :company_website
+
+    # How this number will be used. Required. A personal registration describes the inbound line, such as appointment reminders or two-factor authentication codes. A business registration describes messages sent to people who opted in, such as appointment reminders or delivery updates.
+    attr_accessor :business_use_case
+
+    # True when someone else, such as a client, will use the number. False when you or your business will use it.
+    attr_accessor :sub_allocated
+
+    # Name of the person or business who will use the number. Required when subAllocated is true.
+    attr_accessor :sub_allocated_party
+
+    # Country of the address, as a country name or an ISO 3166-1 alpha-2 code. Required for an IL registration, which can use an address outside Israel. A GB registration uses a United Kingdom address and does not send this field.
+    attr_accessor :address_country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
+        :'contact_phone' => :'contactPhone',
+        :'street' => :'street',
+        :'city' => :'city',
+        :'postal_code' => :'postalCode',
+        :'building_number' => :'buildingNumber',
+        :'state' => :'state',
+        :'company_name' => :'companyName',
+        :'company_website' => :'companyWebsite',
+        :'business_use_case' => :'businessUseCase',
+        :'sub_allocated' => :'subAllocated',
+        :'sub_allocated_party' => :'subAllocatedParty',
+        :'address_country' => :'addressCountry'
+      }
+    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
+      {
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'contact_phone' => :'String',
+        :'street' => :'String',
+        :'city' => :'String',
+        :'postal_code' => :'String',
+        :'building_number' => :'String',
+        :'state' => :'String',
+        :'company_name' => :'String',
+        :'company_website' => :'String',
+        :'business_use_case' => :'String',
+        :'sub_allocated' => :'Boolean',
+        :'sub_allocated_party' => :'String',
+        :'address_country' => :'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::LocalNumberAdminUpdateRequestFields` 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::LocalNumberAdminUpdateRequestFields`. 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?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      else
+        self.last_name = nil
+      end
+
+      if attributes.key?(:'contact_phone')
+        self.contact_phone = attributes[:'contact_phone']
+      else
+        self.contact_phone = nil
+      end
+
+      if attributes.key?(:'street')
+        self.street = attributes[:'street']
+      else
+        self.street = nil
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      else
+        self.city = nil
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      else
+        self.postal_code = nil
+      end
+
+      if attributes.key?(:'building_number')
+        self.building_number = attributes[:'building_number']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'company_website')
+        self.company_website = attributes[:'company_website']
+      end
+
+      if attributes.key?(:'business_use_case')
+        self.business_use_case = attributes[:'business_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
+
+      if attributes.key?(:'address_country')
+        self.address_country = attributes[:'address_country']
+      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 @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @contact_phone.nil?
+        invalid_properties.push('invalid value for "contact_phone", contact_phone cannot be nil.')
+      end
+
+      if @street.nil?
+        invalid_properties.push('invalid value for "street", street cannot be nil.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @postal_code.nil?
+        invalid_properties.push('invalid value for "postal_code", postal_code 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 @first_name.nil?
+      return false if @last_name.nil?
+      return false if @contact_phone.nil?
+      return false if @street.nil?
+      return false if @city.nil?
+      return false if @postal_code.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if first_name.nil?
+        fail ArgumentError, 'first_name cannot be nil'
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        fail ArgumentError, 'last_name cannot be nil'
+      end
+
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contact_phone Value to be assigned
+    def contact_phone=(contact_phone)
+      if contact_phone.nil?
+        fail ArgumentError, 'contact_phone cannot be nil'
+      end
+
+      @contact_phone = contact_phone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] street Value to be assigned
+    def street=(street)
+      if street.nil?
+        fail ArgumentError, 'street cannot be nil'
+      end
+
+      @street = street
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, 'postal_code cannot be nil'
+      end
+
+      @postal_code = postal_code
+    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 &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          contact_phone == o.contact_phone &&
+          street == o.street &&
+          city == o.city &&
+          postal_code == o.postal_code &&
+          building_number == o.building_number &&
+          state == o.state &&
+          company_name == o.company_name &&
+          company_website == o.company_website &&
+          business_use_case == o.business_use_case &&
+          sub_allocated == o.sub_allocated &&
+          sub_allocated_party == o.sub_allocated_party &&
+          address_country == o.address_country
+    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
+      [first_name, last_name, contact_phone, street, city, postal_code, building_number, state, company_name, company_website, business_use_case, sub_allocated, sub_allocated_party, address_country].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