pingram 1.0.10 → 1.0.11

data/lib/pingram/models/a2p_registration_create_request.rb

@@ -0,0 +1,356 @@
+=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
+  # Request body for POST /registrations/a2p
+  class A2pRegistrationCreateRequest < ApiModelBase
+    attr_accessor :scenario_id
+
+    attr_accessor :business_type
+
+    attr_accessor :legal_name
+
+    attr_accessor :tax_id
+
+    attr_accessor :website
+
+    attr_accessor :country
+
+    attr_accessor :full_address
+
+    attr_accessor :compliance_contact_email
+
+    attr_accessor :compliance_contact_phone
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'scenario_id' => :'scenarioId',
+        :'business_type' => :'businessType',
+        :'legal_name' => :'legalName',
+        :'tax_id' => :'taxId',
+        :'website' => :'website',
+        :'country' => :'country',
+        :'full_address' => :'fullAddress',
+        :'compliance_contact_email' => :'complianceContactEmail',
+        :'compliance_contact_phone' => :'complianceContactPhone'
+      }
+    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
+      {
+        :'scenario_id' => :'String',
+        :'business_type' => :'String',
+        :'legal_name' => :'String',
+        :'tax_id' => :'String',
+        :'website' => :'String',
+        :'country' => :'String',
+        :'full_address' => :'String',
+        :'compliance_contact_email' => :'String',
+        :'compliance_contact_phone' => :'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::A2pRegistrationCreateRequest` 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::A2pRegistrationCreateRequest`. 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?(:'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?(:'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?(:'full_address')
+        self.full_address = attributes[:'full_address']
+      else
+        self.full_address = nil
+      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
+    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 @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 @full_address.nil?
+        invalid_properties.push('invalid value for "full_address", full_address 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
+
+      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 @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 @full_address.nil?
+      return false if @compliance_contact_email.nil?
+      return false if @compliance_contact_phone.nil?
+      true
+    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] full_address Value to be assigned
+    def full_address=(full_address)
+      if full_address.nil?
+        fail ArgumentError, 'full_address cannot be nil'
+      end
+
+      @full_address = full_address
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          scenario_id == o.scenario_id &&
+          business_type == o.business_type &&
+          legal_name == o.legal_name &&
+          tax_id == o.tax_id &&
+          website == o.website &&
+          country == o.country &&
+          full_address == o.full_address &&
+          compliance_contact_email == o.compliance_contact_email &&
+          compliance_contact_phone == o.compliance_contact_phone
+    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
+      [scenario_id, business_type, legal_name, tax_id, website, country, full_address, compliance_contact_email, compliance_contact_phone].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/a2p_registration_update_request.rb

@@ -0,0 +1,220 @@
+=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
+  # Request body for PUT /registrations/a2p
+  class A2pRegistrationUpdateRequest < ApiModelBase
+    attr_accessor :scenario_id
+
+    attr_accessor :business_type
+
+    attr_accessor :legal_name
+
+    attr_accessor :tax_id
+
+    attr_accessor :website
+
+    attr_accessor :country
+
+    attr_accessor :full_address
+
+    attr_accessor :compliance_contact_email
+
+    attr_accessor :compliance_contact_phone
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'scenario_id' => :'scenarioId',
+        :'business_type' => :'businessType',
+        :'legal_name' => :'legalName',
+        :'tax_id' => :'taxId',
+        :'website' => :'website',
+        :'country' => :'country',
+        :'full_address' => :'fullAddress',
+        :'compliance_contact_email' => :'complianceContactEmail',
+        :'compliance_contact_phone' => :'complianceContactPhone'
+      }
+    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
+      {
+        :'scenario_id' => :'String',
+        :'business_type' => :'String',
+        :'legal_name' => :'String',
+        :'tax_id' => :'String',
+        :'website' => :'String',
+        :'country' => :'String',
+        :'full_address' => :'String',
+        :'compliance_contact_email' => :'String',
+        :'compliance_contact_phone' => :'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::A2pRegistrationUpdateRequest` 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::A2pRegistrationUpdateRequest`. 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?(:'scenario_id')
+        self.scenario_id = attributes[:'scenario_id']
+      end
+
+      if attributes.key?(:'business_type')
+        self.business_type = attributes[:'business_type']
+      end
+
+      if attributes.key?(:'legal_name')
+        self.legal_name = attributes[:'legal_name']
+      end
+
+      if attributes.key?(:'tax_id')
+        self.tax_id = attributes[:'tax_id']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      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']
+      end
+
+      if attributes.key?(:'compliance_contact_phone')
+        self.compliance_contact_phone = attributes[:'compliance_contact_phone']
+      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'
+      true
+    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 &&
+          scenario_id == o.scenario_id &&
+          business_type == o.business_type &&
+          legal_name == o.legal_name &&
+          tax_id == o.tax_id &&
+          website == o.website &&
+          country == o.country &&
+          full_address == o.full_address &&
+          compliance_contact_email == o.compliance_contact_email &&
+          compliance_contact_phone == o.compliance_contact_phone
+    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
+      [scenario_id, business_type, legal_name, tax_id, website, country, full_address, compliance_contact_email, compliance_contact_phone].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/events_webhook_response.rb

@@ -25,6 +25,9 @@ module Pingram
     # List of subscribed event types for this webhook configuration.
     attr_accessor :events
 
+    # HMAC secret for verifying webhook signatures. Use this with your X-Pingram-Signature verification.
+    attr_accessor :secret
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -52,7 +55,8 @@ module Pingram
       {
         :'webhook_id' => :'webhookId',
         :'webhook' => :'webhook',
-        :'events' => :'events'
+        :'events' => :'events',
+        :'secret' => :'secret'
       }
     end
 
@@ -71,7 +75,8 @@ module Pingram
       {
         :'webhook_id' => :'String',
         :'webhook' => :'String',
-        :'events' => :'Array<String>'
+        :'events' => :'Array<String>',
+        :'secret' => :'String'
       }
     end
 
@@ -116,6 +121,12 @@ module Pingram
       else
         self.events = nil
       end
+
+      if attributes.key?(:'secret')
+        self.secret = attributes[:'secret']
+      else
+        self.secret = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -135,6 +146,10 @@ module Pingram
         invalid_properties.push('invalid value for "events", events cannot be nil.')
       end
 
+      if @secret.nil?
+        invalid_properties.push('invalid value for "secret", secret cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -145,6 +160,7 @@ module Pingram
       return false if @webhook_id.nil?
       return false if @webhook.nil?
       return false if @events.nil?
+      return false if @secret.nil?
       true
     end
 
@@ -168,6 +184,16 @@ module Pingram
       @webhook = webhook
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] secret Value to be assigned
+    def secret=(secret)
+      if secret.nil?
+        fail ArgumentError, 'secret cannot be nil'
+      end
+
+      @secret = secret
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -175,7 +201,8 @@ module Pingram
       self.class == o.class &&
           webhook_id == o.webhook_id &&
           webhook == o.webhook &&
-          events == o.events
+          events == o.events &&
+          secret == o.secret
     end
 
     # @see the `==` method
@@ -187,7 +214,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_id, webhook, events].hash
+      [webhook_id, webhook, events, secret].hash
     end
 
     # Builds the object from hash