pingram 1.0.38 → 1.0.40

data/lib/pingram/models/sms_local_number_registration_admin_documents_inner.rb

@@ -0,0 +1,243 @@
+=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
+  # One submitted document with a short-lived link for admin review.
+  class SmsLocalNumberRegistrationAdminDocumentsInner < 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
+
+    # Short-lived presigned GET URL for the stored document.
+    attr_accessor :url
+
+    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',
+        :'url' => :'url'
+      }
+    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',
+        :'url' => :'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::SmsLocalNumberRegistrationAdminDocumentsInner` 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::SmsLocalNumberRegistrationAdminDocumentsInner`. 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?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = 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 @url.nil?
+        invalid_properties.push('invalid value for "url", url 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 @url.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] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      @url = url
+    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 &&
+          url == o.url
+    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, url].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/sms_local_number_submit_response.rb

@@ -0,0 +1,345 @@
+=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
+  # Result of submitting a local-number registration to the carrier.
+  class SmsLocalNumberSubmitResponse < ApiModelBase
+    attr_accessor :mock
+
+    attr_accessor :submitted
+
+    # GB and IL local-number registration.
+    attr_accessor :country
+
+    # 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
+
+    attr_accessor :requirement_group_id
+
+    attr_accessor :requirement_status
+
+    attr_accessor :slots
+
+    attr_accessor :questions
+
+    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
+      {
+        :'mock' => :'mock',
+        :'submitted' => :'submitted',
+        :'country' => :'country',
+        :'status' => :'status',
+        :'requirement_group_id' => :'requirementGroupId',
+        :'requirement_status' => :'requirementStatus',
+        :'slots' => :'slots',
+        :'questions' => :'questions'
+      }
+    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
+      {
+        :'mock' => :'Boolean',
+        :'submitted' => :'Boolean',
+        :'country' => :'String',
+        :'status' => :'String',
+        :'requirement_group_id' => :'String',
+        :'requirement_status' => :'String',
+        :'slots' => :'Array<SmsLocalNumberSubmitResponseSlotsInner>',
+        :'questions' => :'Array<SmsLocalNumberSubmitResponseQuestionsInner>'
+      }
+    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::SmsLocalNumberSubmitResponse` 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::SmsLocalNumberSubmitResponse`. 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?(:'mock')
+        self.mock = attributes[:'mock']
+      else
+        self.mock = nil
+      end
+
+      if attributes.key?(:'submitted')
+        self.submitted = attributes[:'submitted']
+      else
+        self.submitted = nil
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'requirement_group_id')
+        self.requirement_group_id = attributes[:'requirement_group_id']
+      end
+
+      if attributes.key?(:'requirement_status')
+        self.requirement_status = attributes[:'requirement_status']
+      end
+
+      if attributes.key?(:'slots')
+        if (value = attributes[:'slots']).is_a?(Array)
+          self.slots = value
+        end
+      else
+        self.slots = nil
+      end
+
+      if attributes.key?(:'questions')
+        if (value = attributes[:'questions']).is_a?(Array)
+          self.questions = value
+        end
+      else
+        self.questions = 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 @mock.nil?
+        invalid_properties.push('invalid value for "mock", mock cannot be nil.')
+      end
+
+      if @submitted.nil?
+        invalid_properties.push('invalid value for "submitted", submitted cannot be nil.')
+      end
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @slots.nil?
+        invalid_properties.push('invalid value for "slots", slots cannot be nil.')
+      end
+
+      if @questions.nil?
+        invalid_properties.push('invalid value for "questions", questions 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 @mock.nil?
+      return false if @submitted.nil?
+      return false if @country.nil?
+      country_validator = EnumAttributeValidator.new('String', ["GB", "IL"])
+      return false unless country_validator.valid?(@country)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      return false unless status_validator.valid?(@status)
+      return false if @slots.nil?
+      return false if @questions.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mock Value to be assigned
+    def mock=(mock)
+      if mock.nil?
+        fail ArgumentError, 'mock cannot be nil'
+      end
+
+      @mock = mock
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] submitted Value to be assigned
+    def submitted=(submitted)
+      if submitted.nil?
+        fail ArgumentError, 'submitted cannot be nil'
+      end
+
+      @submitted = submitted
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] country Object to be assigned
+    def country=(country)
+      validator = EnumAttributeValidator.new('String', ["GB", "IL"])
+      unless validator.valid?(country)
+        fail ArgumentError, "invalid value for \"country\", must be one of #{validator.allowable_values}."
+      end
+      @country = country
+    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 with validation
+    # @param [Object] slots Value to be assigned
+    def slots=(slots)
+      if slots.nil?
+        fail ArgumentError, 'slots cannot be nil'
+      end
+
+      @slots = slots
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] questions Value to be assigned
+    def questions=(questions)
+      if questions.nil?
+        fail ArgumentError, 'questions cannot be nil'
+      end
+
+      @questions = questions
+    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 &&
+          mock == o.mock &&
+          submitted == o.submitted &&
+          country == o.country &&
+          status == o.status &&
+          requirement_group_id == o.requirement_group_id &&
+          requirement_status == o.requirement_status &&
+          slots == o.slots &&
+          questions == o.questions
+    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
+      [mock, submitted, country, status, requirement_group_id, requirement_status, slots, questions].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