pingram 1.0.36 → 1.0.38

data/lib/pingram/models/start_change_email_request.rb

@@ -0,0 +1,201 @@
+=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 StartChangeEmailRequest < ApiModelBase
+    attr_accessor :new_email
+
+    # Current account password. Required before a login-email change starts.
+    attr_accessor :password
+
+    # TOTP code. Required when software-token MFA is enabled.
+    attr_accessor :mfa_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'new_email' => :'newEmail',
+        :'password' => :'password',
+        :'mfa_code' => :'mfaCode'
+      }
+    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
+      {
+        :'new_email' => :'String',
+        :'password' => :'String',
+        :'mfa_code' => :'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::StartChangeEmailRequest` 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::StartChangeEmailRequest`. 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?(:'new_email')
+        self.new_email = attributes[:'new_email']
+      else
+        self.new_email = nil
+      end
+
+      if attributes.key?(:'password')
+        self.password = attributes[:'password']
+      else
+        self.password = nil
+      end
+
+      if attributes.key?(:'mfa_code')
+        self.mfa_code = attributes[:'mfa_code']
+      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 @new_email.nil?
+        invalid_properties.push('invalid value for "new_email", new_email cannot be nil.')
+      end
+
+      if @password.nil?
+        invalid_properties.push('invalid value for "password", password 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 @new_email.nil?
+      return false if @password.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_email Value to be assigned
+    def new_email=(new_email)
+      if new_email.nil?
+        fail ArgumentError, 'new_email cannot be nil'
+      end
+
+      @new_email = new_email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] password Value to be assigned
+    def password=(password)
+      if password.nil?
+        fail ArgumentError, 'password cannot be nil'
+      end
+
+      @password = password
+    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 &&
+          new_email == o.new_email &&
+          password == o.password &&
+          mfa_code == o.mfa_code
+    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
+      [new_email, password, mfa_code].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/update_billing_email_request.rb

@@ -0,0 +1,184 @@
+=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
+  # PATCH /account/billing-email request.
+  class UpdateBillingEmailRequest < ApiModelBase
+    # Address that receives invoices and receipts.
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email'
+      }
+    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
+      {
+        :'email' => :'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::UpdateBillingEmailRequest` 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::UpdateBillingEmailRequest`. 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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = 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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @email.to_s.length > 320
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 320.')
+      end
+
+      if @email.to_s.length < 3
+        invalid_properties.push('invalid value for "email", the character length must be greater than or equal to 3.')
+      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 @email.nil?
+      return false if @email.to_s.length > 320
+      return false if @email.to_s.length < 3
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length > 320
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 320.'
+      end
+
+      if email.to_s.length < 3
+        fail ArgumentError, 'invalid value for "email", the character length must be greater than or equal to 3.'
+      end
+
+      @email = email
+    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 &&
+          email == o.email
+    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
+      [email].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/webhook_endpoint_upsert_request.rb

@@ -16,7 +16,7 @@ require 'time'
 module Pingram
   # Request body for creating or updating an events webhook endpoint.
   class WebhookEndpointUpsertRequest < ApiModelBase
-    # Public http or https URL that accepts POST with a JSON event body. Return 2xx to acknowledge. Requests include X-Pingram-Id, X-Pingram-Signature (v1 HMAC-SHA256), and X-Pingram-Timestamp.
+    # Public HTTPS URL that accepts POST with a JSON event body. Return 2xx to acknowledge. Private, loopback, and link-local addresses are rejected. Requests include X-Pingram-Id, X-Pingram-Signature (v1 HMAC-SHA256), and X-Pingram-Timestamp.
     attr_accessor :webhook
 
     # Full set of event types to deliver to this URL. Omitting an event on update unsubscribes it. Inbound SMS to the free shared number only works when that person has already received a text from this number. Inbound SMS to a dedicated number works normally.

data/lib/pingram/models/webhook_event.rb

@@ -38,6 +38,30 @@ module Pingram
     # Link tags for EMAIL_CLICK events.
     attr_accessor :clicked_link_tags
 
+    # Account id, for ACCOUNT_USAGE.
+    attr_accessor :account_id
+
+    # Billing period start (YYYY-MM-DD), for ACCOUNT_USAGE.
+    attr_accessor :year_month_day
+
+    # Date the monthly budget resets (YYYY-MM-DD), for ACCOUNT_USAGE.
+    attr_accessor :resets_on
+
+    # Whole percent of the monthly budget used, for ACCOUNT_USAGE.
+    attr_accessor :percent
+
+    # Amount spent against the monthly budget, for ACCOUNT_USAGE.
+    attr_accessor :spent
+
+    # Monthly budget the percent was measured against, for ACCOUNT_USAGE.
+    attr_accessor :cost_cap
+
+    # Whether the account raises its budget automatically, for ACCOUNT_USAGE.
+    attr_accessor :auto_upgrade
+
+    # Per-channel volume and cost for the current period, for ACCOUNT_USAGE.
+    attr_accessor :usage
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -70,7 +94,15 @@ module Pingram
         :'tracking_id' => :'trackingId',
         :'failure_code' => :'failureCode',
         :'clicked_link' => :'clickedLink',
-        :'clicked_link_tags' => :'clickedLinkTags'
+        :'clicked_link_tags' => :'clickedLinkTags',
+        :'account_id' => :'accountId',
+        :'year_month_day' => :'yearMonthDay',
+        :'resets_on' => :'resetsOn',
+        :'percent' => :'percent',
+        :'spent' => :'spent',
+        :'cost_cap' => :'costCap',
+        :'auto_upgrade' => :'autoUpgrade',
+        :'usage' => :'usage'
       }
     end
 
@@ -94,7 +126,15 @@ module Pingram
         :'tracking_id' => :'String',
         :'failure_code' => :'String',
         :'clicked_link' => :'String',
-        :'clicked_link_tags' => :'Hash<String, Array<String>>'
+        :'clicked_link_tags' => :'Hash<String, Array<String>>',
+        :'account_id' => :'String',
+        :'year_month_day' => :'String',
+        :'resets_on' => :'String',
+        :'percent' => :'Float',
+        :'spent' => :'Float',
+        :'cost_cap' => :'Float',
+        :'auto_upgrade' => :'Boolean',
+        :'usage' => :'Hash<String, WebhookEventUsageValue>'
       }
     end
 
@@ -163,6 +203,40 @@ module Pingram
           self.clicked_link_tags = value
         end
       end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'year_month_day')
+        self.year_month_day = attributes[:'year_month_day']
+      end
+
+      if attributes.key?(:'resets_on')
+        self.resets_on = attributes[:'resets_on']
+      end
+
+      if attributes.key?(:'percent')
+        self.percent = attributes[:'percent']
+      end
+
+      if attributes.key?(:'spent')
+        self.spent = attributes[:'spent']
+      end
+
+      if attributes.key?(:'cost_cap')
+        self.cost_cap = attributes[:'cost_cap']
+      end
+
+      if attributes.key?(:'auto_upgrade')
+        self.auto_upgrade = attributes[:'auto_upgrade']
+      end
+
+      if attributes.key?(:'usage')
+        if (value = attributes[:'usage']).is_a?(Hash)
+          self.usage = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -198,7 +272,7 @@ module Pingram
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @event_type.nil?
-      event_type_validator = EnumAttributeValidator.new('String', ["EMAIL_OPEN", "EMAIL_CLICK", "EMAIL_FAILED", "EMAIL_DELIVERED", "EMAIL_UNSUBSCRIBE", "EMAIL_INBOUND", "INAPP_WEB_FAILED", "INAPP_WEB_UNSUBSCRIBE", "SMS_DELIVERED", "SMS_FAILED", "SMS_UNSUBSCRIBE", "SMS_SUBSCRIBE", "SMS_INBOUND", "PUSH_FAILED", "PUSH_UNSUBSCRIBE", "CALL_FAILED", "CALL_UNSUBSCRIBE", "WEB_PUSH_FAILED", "WEB_PUSH_UNSUBSCRIBE", "SLACK_FAILED", "SLACK_UNSUBSCRIBE"])
+      event_type_validator = EnumAttributeValidator.new('String', ["EMAIL_OPEN", "EMAIL_CLICK", "EMAIL_FAILED", "EMAIL_DELIVERED", "EMAIL_UNSUBSCRIBE", "EMAIL_INBOUND", "INAPP_WEB_FAILED", "INAPP_WEB_UNSUBSCRIBE", "SMS_DELIVERED", "SMS_FAILED", "SMS_UNSUBSCRIBE", "SMS_SUBSCRIBE", "SMS_INBOUND", "PUSH_FAILED", "PUSH_UNSUBSCRIBE", "CALL_FAILED", "CALL_UNSUBSCRIBE", "WEB_PUSH_FAILED", "WEB_PUSH_UNSUBSCRIBE", "SLACK_FAILED", "SLACK_UNSUBSCRIBE", "ACCOUNT_USAGE"])
       return false unless event_type_validator.valid?(@event_type)
       return false if @channel.nil?
       return false if @user_id.nil?
@@ -210,7 +284,7 @@ module Pingram
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] event_type Object to be assigned
     def event_type=(event_type)
-      validator = EnumAttributeValidator.new('String', ["EMAIL_OPEN", "EMAIL_CLICK", "EMAIL_FAILED", "EMAIL_DELIVERED", "EMAIL_UNSUBSCRIBE", "EMAIL_INBOUND", "INAPP_WEB_FAILED", "INAPP_WEB_UNSUBSCRIBE", "SMS_DELIVERED", "SMS_FAILED", "SMS_UNSUBSCRIBE", "SMS_SUBSCRIBE", "SMS_INBOUND", "PUSH_FAILED", "PUSH_UNSUBSCRIBE", "CALL_FAILED", "CALL_UNSUBSCRIBE", "WEB_PUSH_FAILED", "WEB_PUSH_UNSUBSCRIBE", "SLACK_FAILED", "SLACK_UNSUBSCRIBE"])
+      validator = EnumAttributeValidator.new('String', ["EMAIL_OPEN", "EMAIL_CLICK", "EMAIL_FAILED", "EMAIL_DELIVERED", "EMAIL_UNSUBSCRIBE", "EMAIL_INBOUND", "INAPP_WEB_FAILED", "INAPP_WEB_UNSUBSCRIBE", "SMS_DELIVERED", "SMS_FAILED", "SMS_UNSUBSCRIBE", "SMS_SUBSCRIBE", "SMS_INBOUND", "PUSH_FAILED", "PUSH_UNSUBSCRIBE", "CALL_FAILED", "CALL_UNSUBSCRIBE", "WEB_PUSH_FAILED", "WEB_PUSH_UNSUBSCRIBE", "SLACK_FAILED", "SLACK_UNSUBSCRIBE", "ACCOUNT_USAGE"])
       unless validator.valid?(event_type)
         fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
       end
@@ -269,7 +343,15 @@ module Pingram
           tracking_id == o.tracking_id &&
           failure_code == o.failure_code &&
           clicked_link == o.clicked_link &&
-          clicked_link_tags == o.clicked_link_tags
+          clicked_link_tags == o.clicked_link_tags &&
+          account_id == o.account_id &&
+          year_month_day == o.year_month_day &&
+          resets_on == o.resets_on &&
+          percent == o.percent &&
+          spent == o.spent &&
+          cost_cap == o.cost_cap &&
+          auto_upgrade == o.auto_upgrade &&
+          usage == o.usage
     end
 
     # @see the `==` method
@@ -281,7 +363,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [event_type, channel, user_id, notification_id, tracking_id, failure_code, clicked_link, clicked_link_tags].hash
+      [event_type, channel, user_id, notification_id, tracking_id, failure_code, clicked_link, clicked_link_tags, account_id, year_month_day, resets_on, percent, spent, cost_cap, auto_upgrade, usage].hash
     end
 
     # Builds the object from hash