pingram 1.0.38 → 1.0.40

data/lib/pingram/models/sms_registration_sender_id.rb

@@ -0,0 +1,360 @@
+=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
+  # Sender ID for one destination country. `status` is present only when `registrationRequired` is true.
+  class SmsRegistrationSenderId < ApiModelBase
+    # ISO 3166-1 alpha-2 destination country.
+    attr_accessor :country
+
+    # The account Sender ID, or null when none has been submitted.
+    attr_accessor :sender_id
+
+    # Whether the account Sender ID can be used for a destination country. - available: the Sender ID can be enabled for this country - unsupported: sending to this country with a Sender ID is not supported - contact_us: not available yet; contact us about support for this country
+    attr_accessor :availability
+
+    # True when this country requires Sender ID registration before it can be enabled.
+    attr_accessor :registration_required
+
+    # True when this country has been added for the account Sender ID.
+    attr_accessor :added
+
+    # True when the account Sender ID can be used to send to this country.
+    attr_accessor :enabled
+
+    # What is needed next, or why the Sender ID cannot be used for this country.
+    attr_accessor :message
+
+    # 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
+
+    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',
+        :'sender_id' => :'senderId',
+        :'availability' => :'availability',
+        :'registration_required' => :'registrationRequired',
+        :'added' => :'added',
+        :'enabled' => :'enabled',
+        :'message' => :'message',
+        :'status' => :'status'
+      }
+    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
+      {
+        :'country' => :'String',
+        :'sender_id' => :'String',
+        :'availability' => :'String',
+        :'registration_required' => :'Boolean',
+        :'added' => :'Boolean',
+        :'enabled' => :'Boolean',
+        :'message' => :'String',
+        :'status' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sender_id',
+      ])
+    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::SmsRegistrationSenderId` 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::SmsRegistrationSenderId`. 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?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      end
+
+      if attributes.key?(:'sender_id')
+        self.sender_id = attributes[:'sender_id']
+      else
+        self.sender_id = nil
+      end
+
+      if attributes.key?(:'availability')
+        self.availability = attributes[:'availability']
+      else
+        self.availability = nil
+      end
+
+      if attributes.key?(:'registration_required')
+        self.registration_required = attributes[:'registration_required']
+      else
+        self.registration_required = nil
+      end
+
+      if attributes.key?(:'added')
+        self.added = attributes[:'added']
+      else
+        self.added = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      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 @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      end
+
+      if @availability.nil?
+        invalid_properties.push('invalid value for "availability", availability cannot be nil.')
+      end
+
+      if @registration_required.nil?
+        invalid_properties.push('invalid value for "registration_required", registration_required cannot be nil.')
+      end
+
+      if @added.nil?
+        invalid_properties.push('invalid value for "added", added cannot be nil.')
+      end
+
+      if @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message 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 @country.nil?
+      return false if @availability.nil?
+      availability_validator = EnumAttributeValidator.new('String', ["available", "unsupported", "contact_us"])
+      return false unless availability_validator.valid?(@availability)
+      return false if @registration_required.nil?
+      return false if @added.nil?
+      return false if @enabled.nil?
+      return false if @message.nil?
+      status_validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      return false unless status_validator.valid?(@status)
+      true
+    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 checking allowed values (enum).
+    # @param [Object] availability Object to be assigned
+    def availability=(availability)
+      validator = EnumAttributeValidator.new('String', ["available", "unsupported", "contact_us"])
+      unless validator.valid?(availability)
+        fail ArgumentError, "invalid value for \"availability\", must be one of #{validator.allowable_values}."
+      end
+      @availability = availability
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] registration_required Value to be assigned
+    def registration_required=(registration_required)
+      if registration_required.nil?
+        fail ArgumentError, 'registration_required cannot be nil'
+      end
+
+      @registration_required = registration_required
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] added Value to be assigned
+    def added=(added)
+      if added.nil?
+        fail ArgumentError, 'added cannot be nil'
+      end
+
+      @added = added
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] enabled Value to be assigned
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'enabled cannot be nil'
+      end
+
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    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
+
+    # 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 &&
+          sender_id == o.sender_id &&
+          availability == o.availability &&
+          registration_required == o.registration_required &&
+          added == o.added &&
+          enabled == o.enabled &&
+          message == o.message &&
+          status == o.status
+    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
+      [country, sender_id, availability, registration_required, added, enabled, message, status].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/{bind_number_response.rb → sms_registration_update_request.rb}

@@ -14,13 +14,17 @@ require 'date'
 require 'time'
 
 module Pingram
-  class BindNumberResponse < ApiModelBase
-    attr_accessor :agent
+  # Body for PATCH /registrations/{country}/{kind}. Include the object that matches `kind`.
+  class SmsRegistrationUpdateRequest < ApiModelBase
+    attr_accessor :a2p10dlc
+
+    attr_accessor :local_number
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'agent' => :'agent'
+        :'a2p10dlc' => :'a2p10dlc',
+        :'local_number' => :'localNumber'
       }
     end
 
@@ -37,7 +41,8 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'agent' => :'BindNumberResponseAgent'
+        :'a2p10dlc' => :'SmsRegistrationUpdateRequestA2p10dlc',
+        :'local_number' => :'SmsRegistrationUpdateRequestLocalNumber'
       }
     end
 
@@ -51,22 +56,24 @@ 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::BindNumberResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::SmsRegistrationUpdateRequest` 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::BindNumberResponse`. 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::SmsRegistrationUpdateRequest`. 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?(:'a2p10dlc')
+        self.a2p10dlc = attributes[:'a2p10dlc']
+      end
+
+      if attributes.key?(:'local_number')
+        self.local_number = attributes[:'local_number']
       end
     end
 
@@ -75,10 +82,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 +89,16 @@ 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
+          a2p10dlc == o.a2p10dlc &&
+          local_number == o.local_number
     end
 
     # @see the `==` method
@@ -117,7 +110,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [agent].hash
+      [a2p10dlc, local_number].hash
     end
 
     # Builds the object from hash