pingram 1.0.35 → 1.0.37

data/lib/pingram/models/billing_email.rb

@@ -0,0 +1,177 @@
+=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
+  # GET/PATCH /account/billing-email response.
+  class BillingEmail < 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::BillingEmail` 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::BillingEmail`. 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']
+      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? && @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.nil? && @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? && @email.to_s.length > 320
+      return false if !@email.nil? && @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/billing_post_response_body.rb

@@ -55,6 +55,8 @@ module Pingram
     # When true, paid accounts move up one budget tier at 90% of the monthly budget.
     attr_accessor :auto_upgrade
 
+    attr_accessor :billing_alerts
+
     attr_accessor :session_id
 
     attr_accessor :url
@@ -102,6 +104,7 @@ module Pingram
         :'pending_downgrade_cost_cap' => :'pendingDowngradeCostCap',
         :'pending_downgrade_account_type' => :'pendingDowngradeAccountType',
         :'auto_upgrade' => :'autoUpgrade',
+        :'billing_alerts' => :'billingAlerts',
         :'session_id' => :'sessionId',
         :'url' => :'url'
       }
@@ -138,6 +141,7 @@ module Pingram
         :'pending_downgrade_cost_cap' => :'Float',
         :'pending_downgrade_account_type' => :'String',
         :'auto_upgrade' => :'Boolean',
+        :'billing_alerts' => :'AccountGetResponseBillingAlerts',
         :'session_id' => :'String',
         :'url' => :'String'
       }
@@ -252,6 +256,10 @@ module Pingram
         self.auto_upgrade = attributes[:'auto_upgrade']
       end
 
+      if attributes.key?(:'billing_alerts')
+        self.billing_alerts = attributes[:'billing_alerts']
+      end
+
       if attributes.key?(:'session_id')
         self.session_id = attributes[:'session_id']
       end
@@ -454,6 +462,7 @@ module Pingram
           pending_downgrade_cost_cap == o.pending_downgrade_cost_cap &&
           pending_downgrade_account_type == o.pending_downgrade_account_type &&
           auto_upgrade == o.auto_upgrade &&
+          billing_alerts == o.billing_alerts &&
           session_id == o.session_id &&
           url == o.url
     end
@@ -467,7 +476,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, account_type, creator, name, messages_cap, cost_cap, sms_cap, call_cap, billing_version, anniversary_date, created_at, updated_at, status, subscription_status, pending_downgrade_effective_date, pending_downgrade_cost_cap, pending_downgrade_account_type, auto_upgrade, session_id, url].hash
+      [account_id, account_type, creator, name, messages_cap, cost_cap, sms_cap, call_cap, billing_version, anniversary_date, created_at, updated_at, status, subscription_status, pending_downgrade_effective_date, pending_downgrade_cost_cap, pending_downgrade_account_type, auto_upgrade, billing_alerts, session_id, url].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/cancel_subscription_request.rb

@@ -0,0 +1,168 @@
+=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
+  # POST /account/subscription/cancel request.
+  class CancelSubscriptionRequest < ApiModelBase
+    # Optional note about why you are canceling. Helps us improve the product.
+    attr_accessor :reason
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reason' => :'reason'
+      }
+    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
+      {
+        :'reason' => :'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::CancelSubscriptionRequest` 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::CancelSubscriptionRequest`. 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?(:'reason')
+        self.reason = attributes[:'reason']
+      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 !@reason.nil? && @reason.to_s.length > 5000
+        invalid_properties.push('invalid value for "reason", the character length must be smaller than or equal to 5000.')
+      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 !@reason.nil? && @reason.to_s.length > 5000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reason Value to be assigned
+    def reason=(reason)
+      if reason.nil?
+        fail ArgumentError, 'reason cannot be nil'
+      end
+
+      if reason.to_s.length > 5000
+        fail ArgumentError, 'invalid value for "reason", the character length must be smaller than or equal to 5000.'
+      end
+
+      @reason = reason
+    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 &&
+          reason == o.reason
+    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
+      [reason].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/phone_verify_start_response.rb

@@ -17,10 +17,14 @@ module Pingram
   class PhoneVerifyStartResponse < ApiModelBase
     attr_accessor :started
 
+    # Seconds until this signup can request another code for the same number.
+    attr_accessor :resend_after_seconds
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'started' => :'started'
+        :'started' => :'started',
+        :'resend_after_seconds' => :'resendAfterSeconds'
       }
     end
 
@@ -37,7 +41,8 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'started' => :'Boolean'
+        :'started' => :'Boolean',
+        :'resend_after_seconds' => :'Float'
       }
     end
 
@@ -68,6 +73,10 @@ module Pingram
       else
         self.started = nil
       end
+
+      if attributes.key?(:'resend_after_seconds')
+        self.resend_after_seconds = attributes[:'resend_after_seconds']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -105,7 +114,8 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          started == o.started
+          started == o.started &&
+          resend_after_seconds == o.resend_after_seconds
     end
 
     # @see the `==` method
@@ -117,7 +127,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [started].hash
+      [started, resend_after_seconds].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/send_email_request.rb

@@ -46,6 +46,12 @@ module Pingram
     # The BCC addresses of the email.
     attr_accessor :bcc_addresses
 
+    # When false, this send does not record opens and no open pixel is added. Delivery, bounce, and complaint events are unchanged. Defaults to true.
+    attr_accessor :open_tracking
+
+    # When false, links are left as written and clicks are not recorded. Delivery, bounce, and complaint events are unchanged. Defaults to true.
+    attr_accessor :click_tracking
+
     # URL-based file attachments. Up to 20 MB per file.
     attr_accessor :attachments
 
@@ -65,6 +71,8 @@ module Pingram
         :'reply_to_addresses' => :'replyToAddresses',
         :'cc_addresses' => :'ccAddresses',
         :'bcc_addresses' => :'bccAddresses',
+        :'open_tracking' => :'openTracking',
+        :'click_tracking' => :'clickTracking',
         :'attachments' => :'attachments',
         :'schedule' => :'schedule'
       }
@@ -93,6 +101,8 @@ module Pingram
         :'reply_to_addresses' => :'Array<String>',
         :'cc_addresses' => :'Array<String>',
         :'bcc_addresses' => :'Array<String>',
+        :'open_tracking' => :'Boolean',
+        :'click_tracking' => :'Boolean',
         :'attachments' => :'Array<SendEmailRequestAttachmentsInner>',
         :'schedule' => :'String'
       }
@@ -174,6 +184,14 @@ module Pingram
         end
       end
 
+      if attributes.key?(:'open_tracking')
+        self.open_tracking = attributes[:'open_tracking']
+      end
+
+      if attributes.key?(:'click_tracking')
+        self.click_tracking = attributes[:'click_tracking']
+      end
+
       if attributes.key?(:'attachments')
         if (value = attributes[:'attachments']).is_a?(Array)
           self.attachments = value
@@ -275,6 +293,8 @@ module Pingram
           reply_to_addresses == o.reply_to_addresses &&
           cc_addresses == o.cc_addresses &&
           bcc_addresses == o.bcc_addresses &&
+          open_tracking == o.open_tracking &&
+          click_tracking == o.click_tracking &&
           attachments == o.attachments &&
           schedule == o.schedule
     end
@@ -288,7 +308,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, to, subject, html, from_name, from_address, preview_text, reply_to_addresses, cc_addresses, bcc_addresses, attachments, schedule].hash
+      [type, to, subject, html, from_name, from_address, preview_text, reply_to_addresses, cc_addresses, bcc_addresses, open_tracking, click_tracking, attachments, schedule].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/sender_post_body_options_email.rb

@@ -31,6 +31,12 @@ module Pingram
     # Override sender display name.
     attr_accessor :from_name
 
+    # When false, this send does not record opens and no open pixel is added. Delivery, bounce, and complaint events are unchanged. Defaults to true.
+    attr_accessor :open_tracking
+
+    # When false, links are left as written and clicks are not recorded. Delivery, bounce, and complaint events are unchanged. Defaults to true.
+    attr_accessor :click_tracking
+
     # File attachments (by URL or inline base64 content). Inline `content`: ~4 MB raw per file (413 if exceeded). URL `url`: up to 20 MB per file.
     attr_accessor :attachments
 
@@ -42,6 +48,8 @@ module Pingram
         :'bcc_addresses' => :'bccAddresses',
         :'from_address' => :'fromAddress',
         :'from_name' => :'fromName',
+        :'open_tracking' => :'openTracking',
+        :'click_tracking' => :'clickTracking',
         :'attachments' => :'attachments'
       }
     end
@@ -64,6 +72,8 @@ module Pingram
         :'bcc_addresses' => :'Array<String>',
         :'from_address' => :'String',
         :'from_name' => :'String',
+        :'open_tracking' => :'Boolean',
+        :'click_tracking' => :'Boolean',
         :'attachments' => :'Array<SenderPostBodyOptionsEmailAttachmentsInner>'
       }
     end
@@ -116,6 +126,14 @@ module Pingram
         self.from_name = attributes[:'from_name']
       end
 
+      if attributes.key?(:'open_tracking')
+        self.open_tracking = attributes[:'open_tracking']
+      end
+
+      if attributes.key?(:'click_tracking')
+        self.click_tracking = attributes[:'click_tracking']
+      end
+
       if attributes.key?(:'attachments')
         if (value = attributes[:'attachments']).is_a?(Array)
           self.attachments = value
@@ -148,6 +166,8 @@ module Pingram
           bcc_addresses == o.bcc_addresses &&
           from_address == o.from_address &&
           from_name == o.from_name &&
+          open_tracking == o.open_tracking &&
+          click_tracking == o.click_tracking &&
           attachments == o.attachments
     end
 
@@ -160,7 +180,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [reply_to_addresses, cc_addresses, bcc_addresses, from_address, from_name, attachments].hash
+      [reply_to_addresses, cc_addresses, bcc_addresses, from_address, from_name, open_tracking, click_tracking, attachments].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/sender_post_body_sms.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Inline SMS content (message, autoReply, from, mediaUrls).
+  # Inline SMS content (message, from, mediaUrls).
   class SenderPostBodySms < ApiModelBase
     # SMS/MMS body text.
     attr_accessor :message

data/lib/pingram/models/sender_post_body_sms_auto_reply.rb

@@ -14,8 +14,9 @@ require 'date'
 require 'time'
 
 module Pingram
+  # @deprecated Ignored. SMS auto-reply is no longer available. Replacing with SMS_INBOUND: handle that webhook and send your own reply.
   class SenderPostBodySmsAutoReply < ApiModelBase
-    # Auto-reply message to send when user texts in.
+    # @deprecated Ignored. SMS auto-reply is no longer available. Replacing with SMS_INBOUND: handle that webhook and send your own reply.
     attr_accessor :message
 
     # Attribute mapping from ruby-style variable name to JSON key.