pingram 1.0.39 → 1.0.40

data/lib/pingram/models/{bind_number_response_agent.rb → sms_sender_id_admin.rb}

@@ -14,17 +14,18 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Agent record returned by GET /voice/agents.
-  class BindNumberResponseAgent < ApiModelBase
-    attr_accessor :agent_id
+  # Admin view of the account Sender ID, including whether it has been submitted to carriers.
+  class SmsSenderIdAdmin < ApiModelBase
+    attr_accessor :account_id
 
-    attr_accessor :deployment
+    attr_accessor :sender_id
 
-    attr_accessor :spec
+    # 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 :phone_numbers
+    attr_accessor :profile_id
 
-    attr_accessor :worker_presence
+    attr_accessor :submitted_to_provider_at
 
     attr_accessor :created_at
 
@@ -55,11 +56,11 @@ module Pingram
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'agent_id' => :'agentId',
-        :'deployment' => :'deployment',
-        :'spec' => :'spec',
-        :'phone_numbers' => :'phoneNumbers',
-        :'worker_presence' => :'workerPresence',
+        :'account_id' => :'accountId',
+        :'sender_id' => :'senderId',
+        :'status' => :'status',
+        :'profile_id' => :'profileId',
+        :'submitted_to_provider_at' => :'submittedToProviderAt',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt'
       }
@@ -78,11 +79,11 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'agent_id' => :'String',
-        :'deployment' => :'String',
-        :'spec' => :'BindNumberResponseAgentSpec',
-        :'phone_numbers' => :'Array<String>',
-        :'worker_presence' => :'String',
+        :'account_id' => :'String',
+        :'sender_id' => :'String',
+        :'status' => :'String',
+        :'profile_id' => :'String',
+        :'submitted_to_provider_at' => :'String',
         :'created_at' => :'String',
         :'updated_at' => :'String'
       }
@@ -98,46 +99,42 @@ 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::BindNumberResponseAgent` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::SmsSenderIdAdmin` 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::BindNumberResponseAgent`. 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::SmsSenderIdAdmin`. 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_id')
-        self.agent_id = attributes[:'agent_id']
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
       else
-        self.agent_id = nil
+        self.account_id = nil
       end
 
-      if attributes.key?(:'deployment')
-        self.deployment = attributes[:'deployment']
+      if attributes.key?(:'sender_id')
+        self.sender_id = attributes[:'sender_id']
       else
-        self.deployment = nil
+        self.sender_id = nil
       end
 
-      if attributes.key?(:'spec')
-        self.spec = attributes[:'spec']
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
       else
-        self.spec = nil
+        self.status = nil
       end
 
-      if attributes.key?(:'phone_numbers')
-        if (value = attributes[:'phone_numbers']).is_a?(Array)
-          self.phone_numbers = value
-        end
-      else
-        self.phone_numbers = nil
+      if attributes.key?(:'profile_id')
+        self.profile_id = attributes[:'profile_id']
       end
 
-      if attributes.key?(:'worker_presence')
-        self.worker_presence = attributes[:'worker_presence']
+      if attributes.key?(:'submitted_to_provider_at')
+        self.submitted_to_provider_at = attributes[:'submitted_to_provider_at']
       end
 
       if attributes.key?(:'created_at')
@@ -158,20 +155,16 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @agent_id.nil?
-        invalid_properties.push('invalid value for "agent_id", agent_id cannot be nil.')
-      end
-
-      if @deployment.nil?
-        invalid_properties.push('invalid value for "deployment", deployment cannot be nil.')
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
       end
 
-      if @spec.nil?
-        invalid_properties.push('invalid value for "spec", spec cannot be nil.')
+      if @sender_id.nil?
+        invalid_properties.push('invalid value for "sender_id", sender_id cannot be nil.')
       end
 
-      if @phone_numbers.nil?
-        invalid_properties.push('invalid value for "phone_numbers", phone_numbers cannot be nil.')
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
       if @created_at.nil?
@@ -189,67 +182,44 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @agent_id.nil?
-      return false if @deployment.nil?
-      deployment_validator = EnumAttributeValidator.new('String', ["hosted", "ejected"])
-      return false unless deployment_validator.valid?(@deployment)
-      return false if @spec.nil?
-      return false if @phone_numbers.nil?
-      worker_presence_validator = EnumAttributeValidator.new('String', ["online", "offline"])
-      return false unless worker_presence_validator.valid?(@worker_presence)
+      return false if @account_id.nil?
+      return false if @sender_id.nil?
+      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 @created_at.nil?
       return false if @updated_at.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] agent_id Value to be assigned
-    def agent_id=(agent_id)
-      if agent_id.nil?
-        fail ArgumentError, 'agent_id cannot be nil'
-      end
-
-      @agent_id = agent_id
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] deployment Object to be assigned
-    def deployment=(deployment)
-      validator = EnumAttributeValidator.new('String', ["hosted", "ejected"])
-      unless validator.valid?(deployment)
-        fail ArgumentError, "invalid value for \"deployment\", must be one of #{validator.allowable_values}."
-      end
-      @deployment = deployment
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] spec Value to be assigned
-    def spec=(spec)
-      if spec.nil?
-        fail ArgumentError, 'spec cannot be nil'
+    # @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
 
-      @spec = spec
+      @account_id = account_id
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] phone_numbers Value to be assigned
-    def phone_numbers=(phone_numbers)
-      if phone_numbers.nil?
-        fail ArgumentError, 'phone_numbers cannot be nil'
+    # @param [Object] sender_id Value to be assigned
+    def sender_id=(sender_id)
+      if sender_id.nil?
+        fail ArgumentError, 'sender_id cannot be nil'
       end
 
-      @phone_numbers = phone_numbers
+      @sender_id = sender_id
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] worker_presence Object to be assigned
-    def worker_presence=(worker_presence)
-      validator = EnumAttributeValidator.new('String', ["online", "offline"])
-      unless validator.valid?(worker_presence)
-        fail ArgumentError, "invalid value for \"worker_presence\", must be one of #{validator.allowable_values}."
+    # @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
-      @worker_presence = worker_presence
+      @status = status
     end
 
     # Custom attribute writer method with validation
@@ -277,11 +247,11 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          agent_id == o.agent_id &&
-          deployment == o.deployment &&
-          spec == o.spec &&
-          phone_numbers == o.phone_numbers &&
-          worker_presence == o.worker_presence &&
+          account_id == o.account_id &&
+          sender_id == o.sender_id &&
+          status == o.status &&
+          profile_id == o.profile_id &&
+          submitted_to_provider_at == o.submitted_to_provider_at &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -295,7 +265,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [agent_id, deployment, spec, phone_numbers, worker_presence, created_at, updated_at].hash
+      [account_id, sender_id, status, profile_id, submitted_to_provider_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/sms_sender_id_admin_update_request.rb

@@ -0,0 +1,189 @@
+=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 SmsSenderIdAdminUpdateRequest < 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
+
+    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'
+      }
+    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'
+      }
+    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::SmsSenderIdAdminUpdateRequest` 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::SmsSenderIdAdminUpdateRequest`. 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']
+      else
+        self.status = 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 @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @status.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 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 &&
+          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
+      [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/{delete_voice_agent_response.rb → sms_sender_id_create_request.rb}

@@ -14,13 +14,14 @@ require 'date'
 require 'time'
 
 module Pingram
-  class DeleteVoiceAgentResponse < ApiModelBase
-    attr_accessor :deleted
+  class SmsSenderIdCreateRequest < ApiModelBase
+    # Alphanumeric Sender ID, 3–11 letters, numbers, and spaces.
+    attr_accessor :sender_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'deleted' => :'deleted'
+        :'sender_id' => :'senderId'
       }
     end
 
@@ -37,7 +38,7 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'deleted' => :'Boolean'
+        :'sender_id' => :'String'
       }
     end
 
@@ -51,22 +52,22 @@ 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::DeleteVoiceAgentResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::SmsSenderIdCreateRequest` 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::DeleteVoiceAgentResponse`. 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::SmsSenderIdCreateRequest`. 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?(:'deleted')
-        self.deleted = attributes[:'deleted']
+      if attributes.key?(:'sender_id')
+        self.sender_id = attributes[:'sender_id']
       else
-        self.deleted = nil
+        self.sender_id = nil
       end
     end
 
@@ -75,8 +76,8 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @deleted.nil?
-        invalid_properties.push('invalid value for "deleted", deleted cannot be nil.')
+      if @sender_id.nil?
+        invalid_properties.push('invalid value for "sender_id", sender_id cannot be nil.')
       end
 
       invalid_properties
@@ -86,18 +87,18 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @deleted.nil?
+      return false if @sender_id.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] deleted Value to be assigned
-    def deleted=(deleted)
-      if deleted.nil?
-        fail ArgumentError, 'deleted cannot be nil'
+    # @param [Object] sender_id Value to be assigned
+    def sender_id=(sender_id)
+      if sender_id.nil?
+        fail ArgumentError, 'sender_id cannot be nil'
       end
 
-      @deleted = deleted
+      @sender_id = sender_id
     end
 
     # Checks equality by comparing each attribute.
@@ -105,7 +106,7 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          deleted == o.deleted
+          sender_id == o.sender_id
     end
 
     # @see the `==` method
@@ -117,7 +118,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [deleted].hash
+      [sender_id].hash
     end
 
     # Builds the object from hash