pingram 1.0.17 → 1.0.18

data/lib/pingram/models/ten_dlc_brand_registration_details.rb

@@ -0,0 +1,599 @@
+=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
+  # System-access GET response; includes internal Telnyx provider IDs and admin-only fields.
+  class TenDlcBrandRegistrationDetails < ApiModelBase
+    attr_accessor :account_id
+
+    attr_accessor :scenario_id
+
+    attr_accessor :business_type
+
+    attr_accessor :legal_name
+
+    # Brand display name (marketing/DBA); defaults to legalName on customer submit.
+    attr_accessor :display_name
+
+    attr_accessor :first_name
+
+    attr_accessor :last_name
+
+    attr_accessor :tax_id
+
+    attr_accessor :website
+
+    attr_accessor :country
+
+    attr_accessor :street
+
+    attr_accessor :city
+
+    attr_accessor :state
+
+    attr_accessor :postal_code
+
+    # Legacy records only; new submissions use structured address fields.
+    attr_accessor :full_address
+
+    attr_accessor :compliance_contact_email
+
+    attr_accessor :compliance_contact_phone
+
+    # Pingram-side brand registration workflow status. - 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 :brand_status
+
+    # Pingram-side brand registration workflow status. - 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 :campaign_status
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :vertical
+
+    # Legacy only when businessType is Other.
+    attr_accessor :entity_type
+
+    attr_accessor :telnyx_profile_id
+
+    attr_accessor :telnyx_brand_id
+
+    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
+      {
+        :'account_id' => :'accountId',
+        :'scenario_id' => :'scenarioId',
+        :'business_type' => :'businessType',
+        :'legal_name' => :'legalName',
+        :'display_name' => :'displayName',
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
+        :'tax_id' => :'taxId',
+        :'website' => :'website',
+        :'country' => :'country',
+        :'street' => :'street',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'postal_code' => :'postalCode',
+        :'full_address' => :'fullAddress',
+        :'compliance_contact_email' => :'complianceContactEmail',
+        :'compliance_contact_phone' => :'complianceContactPhone',
+        :'brand_status' => :'brandStatus',
+        :'campaign_status' => :'campaignStatus',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'vertical' => :'vertical',
+        :'entity_type' => :'entityType',
+        :'telnyx_profile_id' => :'telnyxProfileId',
+        :'telnyx_brand_id' => :'telnyxBrandId'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'scenario_id' => :'String',
+        :'business_type' => :'String',
+        :'legal_name' => :'String',
+        :'display_name' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'tax_id' => :'String',
+        :'website' => :'String',
+        :'country' => :'String',
+        :'street' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'postal_code' => :'String',
+        :'full_address' => :'String',
+        :'compliance_contact_email' => :'String',
+        :'compliance_contact_phone' => :'String',
+        :'brand_status' => :'String',
+        :'campaign_status' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'String',
+        :'vertical' => :'String',
+        :'entity_type' => :'String',
+        :'telnyx_profile_id' => :'String',
+        :'telnyx_brand_id' => :'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::TenDlcBrandRegistrationDetails` 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::TenDlcBrandRegistrationDetails`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
+      end
+
+      if attributes.key?(:'scenario_id')
+        self.scenario_id = attributes[:'scenario_id']
+      else
+        self.scenario_id = nil
+      end
+
+      if attributes.key?(:'business_type')
+        self.business_type = attributes[:'business_type']
+      else
+        self.business_type = nil
+      end
+
+      if attributes.key?(:'legal_name')
+        self.legal_name = attributes[:'legal_name']
+      else
+        self.legal_name = nil
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'tax_id')
+        self.tax_id = attributes[:'tax_id']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      else
+        self.website = nil
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      end
+
+      if attributes.key?(:'street')
+        self.street = attributes[:'street']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'full_address')
+        self.full_address = attributes[:'full_address']
+      end
+
+      if attributes.key?(:'compliance_contact_email')
+        self.compliance_contact_email = attributes[:'compliance_contact_email']
+      else
+        self.compliance_contact_email = nil
+      end
+
+      if attributes.key?(:'compliance_contact_phone')
+        self.compliance_contact_phone = attributes[:'compliance_contact_phone']
+      else
+        self.compliance_contact_phone = nil
+      end
+
+      if attributes.key?(:'brand_status')
+        self.brand_status = attributes[:'brand_status']
+      else
+        self.brand_status = nil
+      end
+
+      if attributes.key?(:'campaign_status')
+        self.campaign_status = attributes[:'campaign_status']
+      else
+        self.campaign_status = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'vertical')
+        self.vertical = attributes[:'vertical']
+      end
+
+      if attributes.key?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      end
+
+      if attributes.key?(:'telnyx_profile_id')
+        self.telnyx_profile_id = attributes[:'telnyx_profile_id']
+      end
+
+      if attributes.key?(:'telnyx_brand_id')
+        self.telnyx_brand_id = attributes[:'telnyx_brand_id']
+      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 @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @scenario_id.nil?
+        invalid_properties.push('invalid value for "scenario_id", scenario_id cannot be nil.')
+      end
+
+      if @business_type.nil?
+        invalid_properties.push('invalid value for "business_type", business_type cannot be nil.')
+      end
+
+      if @legal_name.nil?
+        invalid_properties.push('invalid value for "legal_name", legal_name cannot be nil.')
+      end
+
+      if @website.nil?
+        invalid_properties.push('invalid value for "website", website cannot be nil.')
+      end
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      end
+
+      if @compliance_contact_email.nil?
+        invalid_properties.push('invalid value for "compliance_contact_email", compliance_contact_email cannot be nil.')
+      end
+
+      if @compliance_contact_phone.nil?
+        invalid_properties.push('invalid value for "compliance_contact_phone", compliance_contact_phone cannot be nil.')
+      end
+
+      if @brand_status.nil?
+        invalid_properties.push('invalid value for "brand_status", brand_status cannot be nil.')
+      end
+
+      if @campaign_status.nil?
+        invalid_properties.push('invalid value for "campaign_status", campaign_status cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @account_id.nil?
+      return false if @scenario_id.nil?
+      return false if @business_type.nil?
+      return false if @legal_name.nil?
+      return false if @website.nil?
+      return false if @country.nil?
+      return false if @compliance_contact_email.nil?
+      return false if @compliance_contact_phone.nil?
+      return false if @brand_status.nil?
+      brand_status_validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      return false unless brand_status_validator.valid?(@brand_status)
+      return false if @campaign_status.nil?
+      campaign_status_validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      return false unless campaign_status_validator.valid?(@campaign_status)
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scenario_id Value to be assigned
+    def scenario_id=(scenario_id)
+      if scenario_id.nil?
+        fail ArgumentError, 'scenario_id cannot be nil'
+      end
+
+      @scenario_id = scenario_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] business_type Value to be assigned
+    def business_type=(business_type)
+      if business_type.nil?
+        fail ArgumentError, 'business_type cannot be nil'
+      end
+
+      @business_type = business_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] legal_name Value to be assigned
+    def legal_name=(legal_name)
+      if legal_name.nil?
+        fail ArgumentError, 'legal_name cannot be nil'
+      end
+
+      @legal_name = legal_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] website Value to be assigned
+    def website=(website)
+      if website.nil?
+        fail ArgumentError, 'website cannot be nil'
+      end
+
+      @website = website
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, 'country cannot be nil'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] compliance_contact_email Value to be assigned
+    def compliance_contact_email=(compliance_contact_email)
+      if compliance_contact_email.nil?
+        fail ArgumentError, 'compliance_contact_email cannot be nil'
+      end
+
+      @compliance_contact_email = compliance_contact_email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] compliance_contact_phone Value to be assigned
+    def compliance_contact_phone=(compliance_contact_phone)
+      if compliance_contact_phone.nil?
+        fail ArgumentError, 'compliance_contact_phone cannot be nil'
+      end
+
+      @compliance_contact_phone = compliance_contact_phone
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] brand_status Object to be assigned
+    def brand_status=(brand_status)
+      validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      unless validator.valid?(brand_status)
+        fail ArgumentError, "invalid value for \"brand_status\", must be one of #{validator.allowable_values}."
+      end
+      @brand_status = brand_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] campaign_status Object to be assigned
+    def campaign_status=(campaign_status)
+      validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      unless validator.valid?(campaign_status)
+        fail ArgumentError, "invalid value for \"campaign_status\", must be one of #{validator.allowable_values}."
+      end
+      @campaign_status = campaign_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          account_id == o.account_id &&
+          scenario_id == o.scenario_id &&
+          business_type == o.business_type &&
+          legal_name == o.legal_name &&
+          display_name == o.display_name &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          tax_id == o.tax_id &&
+          website == o.website &&
+          country == o.country &&
+          street == o.street &&
+          city == o.city &&
+          state == o.state &&
+          postal_code == o.postal_code &&
+          full_address == o.full_address &&
+          compliance_contact_email == o.compliance_contact_email &&
+          compliance_contact_phone == o.compliance_contact_phone &&
+          brand_status == o.brand_status &&
+          campaign_status == o.campaign_status &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          vertical == o.vertical &&
+          entity_type == o.entity_type &&
+          telnyx_profile_id == o.telnyx_profile_id &&
+          telnyx_brand_id == o.telnyx_brand_id
+    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
+      [account_id, scenario_id, business_type, legal_name, display_name, first_name, last_name, tax_id, website, country, street, city, state, postal_code, full_address, compliance_contact_email, compliance_contact_phone, brand_status, campaign_status, created_at, updated_at, vertical, entity_type, telnyx_profile_id, telnyx_brand_id].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