pingram 1.0.27 → 1.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c682a7732ba9868e586369b82a719570baf9f9fe029e13a8ef895e0fc451042
-  data.tar.gz: c54f21943d81cabf01873ba3086f2d64efb6339d45f285bd7d521039c20697ca
+  metadata.gz: ab6b12d140400b9c491e3025a6e639755a4b6886e63bcc4e2598d0188ce88b03
+  data.tar.gz: b6d665310b2a86321250102351d6cf0e33e075762100cd1f1241a0de94d95081
 SHA512:
-  metadata.gz: 2b5b66b2b13533f553ea0e01922c293c33d5706f53791011965e5af6e9951312aeb7478f6eb7943781fa9fc9ade4a69a5ca6a4d7808cc2d010b0a0d3728b84d8
-  data.tar.gz: d1b588e8de8d3d6683022be600a650bfae370dbc518fa7b7169aa8ee43965d153b596abdb5378b3ba619cf8a74d6a3cd020163de3ef9845fead0985fc15b904f
+  metadata.gz: e66a6cf106093028d03e68973ae5bd38ea5ccf83361652fbb3e0dc7aca6c79f406026d7c01f74000a70206f937c7cd37fd342631a037f2b5ff6b0098c0c04d11
+  data.tar.gz: 71085fe7822cbb180feef15ee59f2b0efb2d9ba584e64c80c84c07e4a0e29659e187b16c1ca5eaa77d419b25bfe552523f671d94e6976021e25e545de22d9cf4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.27)
+    pingram (1.0.29)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/lib/pingram/api_client.rb

@@ -32,7 +32,7 @@ module Pingram
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "pingram-ruby/1.0.27"
+      @user_agent = "pingram-ruby/1.0.29"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/models/account_get_response.rb

@@ -38,8 +38,6 @@ module Pingram
     # ISO date (YYYY-MM-DD) when the billing cycle resets.
     attr_accessor :anniversary_date
 
-    attr_accessor :allow_overage
-
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -48,6 +46,12 @@ module Pingram
 
     attr_accessor :subscription_status
 
+    attr_accessor :pending_downgrade_effective_date
+
+    attr_accessor :pending_downgrade_cost_cap
+
+    attr_accessor :pending_downgrade_account_type
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -83,11 +87,13 @@ module Pingram
         :'call_cap' => :'callCap',
         :'billing_version' => :'billingVersion',
         :'anniversary_date' => :'anniversaryDate',
-        :'allow_overage' => :'allowOverage',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
         :'status' => :'status',
-        :'subscription_status' => :'subscriptionStatus'
+        :'subscription_status' => :'subscriptionStatus',
+        :'pending_downgrade_effective_date' => :'pendingDowngradeEffectiveDate',
+        :'pending_downgrade_cost_cap' => :'pendingDowngradeCostCap',
+        :'pending_downgrade_account_type' => :'pendingDowngradeAccountType'
       }
     end
 
@@ -114,18 +120,20 @@ module Pingram
         :'call_cap' => :'Float',
         :'billing_version' => :'Float',
         :'anniversary_date' => :'String',
-        :'allow_overage' => :'Boolean',
         :'created_at' => :'String',
         :'updated_at' => :'String',
         :'status' => :'String',
-        :'subscription_status' => :'String'
+        :'subscription_status' => :'String',
+        :'pending_downgrade_effective_date' => :'String',
+        :'pending_downgrade_cost_cap' => :'Float',
+        :'pending_downgrade_account_type' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subscription_status'
+        :'subscription_status',
       ])
     end
 
@@ -195,12 +203,6 @@ module Pingram
         self.anniversary_date = nil
       end
 
-      if attributes.key?(:'allow_overage')
-        self.allow_overage = attributes[:'allow_overage']
-      else
-        self.allow_overage = nil
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
@@ -220,6 +222,18 @@ module Pingram
       if attributes.key?(:'subscription_status')
         self.subscription_status = attributes[:'subscription_status']
       end
+
+      if attributes.key?(:'pending_downgrade_effective_date')
+        self.pending_downgrade_effective_date = attributes[:'pending_downgrade_effective_date']
+      end
+
+      if attributes.key?(:'pending_downgrade_cost_cap')
+        self.pending_downgrade_cost_cap = attributes[:'pending_downgrade_cost_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_account_type')
+        self.pending_downgrade_account_type = attributes[:'pending_downgrade_account_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -247,10 +261,6 @@ module Pingram
         invalid_properties.push('invalid value for "anniversary_date", anniversary_date cannot be nil.')
       end
 
-      if @allow_overage.nil?
-        invalid_properties.push('invalid value for "allow_overage", allow_overage cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -275,13 +285,14 @@ module Pingram
       billing_version_validator = EnumAttributeValidator.new('Float', [1, 3])
       return false unless billing_version_validator.valid?(@billing_version)
       return false if @anniversary_date.nil?
-      return false if @allow_overage.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       status_validator = EnumAttributeValidator.new('String', ["verified", "unverified", "blocked"])
       return false unless status_validator.valid?(@status)
       subscription_status_validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
       return false unless subscription_status_validator.valid?(@subscription_status)
+      pending_downgrade_account_type_validator = EnumAttributeValidator.new('String', ["free"])
+      return false unless pending_downgrade_account_type_validator.valid?(@pending_downgrade_account_type)
       true
     end
 
@@ -345,16 +356,6 @@ module Pingram
       @anniversary_date = anniversary_date
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] allow_overage Value to be assigned
-    def allow_overage=(allow_overage)
-      if allow_overage.nil?
-        fail ArgumentError, 'allow_overage cannot be nil'
-      end
-
-      @allow_overage = allow_overage
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] created_at Value to be assigned
     def created_at=(created_at)
@@ -395,6 +396,16 @@ module Pingram
       @subscription_status = subscription_status
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pending_downgrade_account_type Object to be assigned
+    def pending_downgrade_account_type=(pending_downgrade_account_type)
+      validator = EnumAttributeValidator.new('String', ["free"])
+      unless validator.valid?(pending_downgrade_account_type)
+        fail ArgumentError, "invalid value for \"pending_downgrade_account_type\", must be one of #{validator.allowable_values}."
+      end
+      @pending_downgrade_account_type = pending_downgrade_account_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -410,11 +421,13 @@ module Pingram
           call_cap == o.call_cap &&
           billing_version == o.billing_version &&
           anniversary_date == o.anniversary_date &&
-          allow_overage == o.allow_overage &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           status == o.status &&
-          subscription_status == o.subscription_status
+          subscription_status == o.subscription_status &&
+          pending_downgrade_effective_date == o.pending_downgrade_effective_date &&
+          pending_downgrade_cost_cap == o.pending_downgrade_cost_cap &&
+          pending_downgrade_account_type == o.pending_downgrade_account_type
     end
 
     # @see the `==` method
@@ -426,7 +439,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, allow_overage, created_at, updated_at, status, subscription_status].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].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/billing_post_response_body.rb

@@ -38,8 +38,6 @@ module Pingram
     # ISO date (YYYY-MM-DD) when the billing cycle resets.
     attr_accessor :anniversary_date
 
-    attr_accessor :allow_overage
-
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -48,6 +46,12 @@ module Pingram
 
     attr_accessor :subscription_status
 
+    attr_accessor :pending_downgrade_effective_date
+
+    attr_accessor :pending_downgrade_cost_cap
+
+    attr_accessor :pending_downgrade_account_type
+
     attr_accessor :session_id
 
     attr_accessor :url
@@ -87,11 +91,13 @@ module Pingram
         :'call_cap' => :'callCap',
         :'billing_version' => :'billingVersion',
         :'anniversary_date' => :'anniversaryDate',
-        :'allow_overage' => :'allowOverage',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
         :'status' => :'status',
         :'subscription_status' => :'subscriptionStatus',
+        :'pending_downgrade_effective_date' => :'pendingDowngradeEffectiveDate',
+        :'pending_downgrade_cost_cap' => :'pendingDowngradeCostCap',
+        :'pending_downgrade_account_type' => :'pendingDowngradeAccountType',
         :'session_id' => :'sessionId',
         :'url' => :'url'
       }
@@ -120,11 +126,13 @@ module Pingram
         :'call_cap' => :'Float',
         :'billing_version' => :'Float',
         :'anniversary_date' => :'String',
-        :'allow_overage' => :'Boolean',
         :'created_at' => :'String',
         :'updated_at' => :'String',
         :'status' => :'String',
         :'subscription_status' => :'String',
+        :'pending_downgrade_effective_date' => :'String',
+        :'pending_downgrade_cost_cap' => :'Float',
+        :'pending_downgrade_account_type' => :'String',
         :'session_id' => :'String',
         :'url' => :'String'
       }
@@ -203,12 +211,6 @@ module Pingram
         self.anniversary_date = nil
       end
 
-      if attributes.key?(:'allow_overage')
-        self.allow_overage = attributes[:'allow_overage']
-      else
-        self.allow_overage = nil
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
@@ -229,6 +231,18 @@ module Pingram
         self.subscription_status = attributes[:'subscription_status']
       end
 
+      if attributes.key?(:'pending_downgrade_effective_date')
+        self.pending_downgrade_effective_date = attributes[:'pending_downgrade_effective_date']
+      end
+
+      if attributes.key?(:'pending_downgrade_cost_cap')
+        self.pending_downgrade_cost_cap = attributes[:'pending_downgrade_cost_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_account_type')
+        self.pending_downgrade_account_type = attributes[:'pending_downgrade_account_type']
+      end
+
       if attributes.key?(:'session_id')
         self.session_id = attributes[:'session_id']
       end
@@ -263,10 +277,6 @@ module Pingram
         invalid_properties.push('invalid value for "anniversary_date", anniversary_date cannot be nil.')
       end
 
-      if @allow_overage.nil?
-        invalid_properties.push('invalid value for "allow_overage", allow_overage cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -291,13 +301,14 @@ module Pingram
       billing_version_validator = EnumAttributeValidator.new('Float', [1, 3])
       return false unless billing_version_validator.valid?(@billing_version)
       return false if @anniversary_date.nil?
-      return false if @allow_overage.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       status_validator = EnumAttributeValidator.new('String', ["verified", "unverified", "blocked"])
       return false unless status_validator.valid?(@status)
       subscription_status_validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
       return false unless subscription_status_validator.valid?(@subscription_status)
+      pending_downgrade_account_type_validator = EnumAttributeValidator.new('String', ["free"])
+      return false unless pending_downgrade_account_type_validator.valid?(@pending_downgrade_account_type)
       true
     end
 
@@ -361,16 +372,6 @@ module Pingram
       @anniversary_date = anniversary_date
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] allow_overage Value to be assigned
-    def allow_overage=(allow_overage)
-      if allow_overage.nil?
-        fail ArgumentError, 'allow_overage cannot be nil'
-      end
-
-      @allow_overage = allow_overage
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] created_at Value to be assigned
     def created_at=(created_at)
@@ -411,6 +412,16 @@ module Pingram
       @subscription_status = subscription_status
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pending_downgrade_account_type Object to be assigned
+    def pending_downgrade_account_type=(pending_downgrade_account_type)
+      validator = EnumAttributeValidator.new('String', ["free"])
+      unless validator.valid?(pending_downgrade_account_type)
+        fail ArgumentError, "invalid value for \"pending_downgrade_account_type\", must be one of #{validator.allowable_values}."
+      end
+      @pending_downgrade_account_type = pending_downgrade_account_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -426,11 +437,13 @@ module Pingram
           call_cap == o.call_cap &&
           billing_version == o.billing_version &&
           anniversary_date == o.anniversary_date &&
-          allow_overage == o.allow_overage &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           status == o.status &&
           subscription_status == o.subscription_status &&
+          pending_downgrade_effective_date == o.pending_downgrade_effective_date &&
+          pending_downgrade_cost_cap == o.pending_downgrade_cost_cap &&
+          pending_downgrade_account_type == o.pending_downgrade_account_type &&
           session_id == o.session_id &&
           url == o.url
     end
@@ -444,7 +457,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, allow_overage, created_at, updated_at, status, subscription_status, 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, session_id, url].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/create_account_response.rb

@@ -24,6 +24,9 @@ module Pingram
 
     attr_accessor :subscription_status
 
+    # Default secret API key for the new account (`pingram_sk_…`).
+    attr_accessor :api_key
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -52,7 +55,8 @@ module Pingram
         :'account_id' => :'accountId',
         :'name' => :'name',
         :'status' => :'status',
-        :'subscription_status' => :'subscriptionStatus'
+        :'subscription_status' => :'subscriptionStatus',
+        :'api_key' => :'apiKey'
       }
     end
 
@@ -72,14 +76,15 @@ module Pingram
         :'account_id' => :'String',
         :'name' => :'String',
         :'status' => :'String',
-        :'subscription_status' => :'String'
+        :'subscription_status' => :'String',
+        :'api_key' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subscription_status'
+        :'subscription_status',
       ])
     end
 
@@ -120,6 +125,12 @@ module Pingram
       if attributes.key?(:'subscription_status')
         self.subscription_status = attributes[:'subscription_status']
       end
+
+      if attributes.key?(:'api_key')
+        self.api_key = attributes[:'api_key']
+      else
+        self.api_key = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -139,6 +150,10 @@ module Pingram
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
+      if @api_key.nil?
+        invalid_properties.push('invalid value for "api_key", api_key cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -153,6 +168,7 @@ module Pingram
       return false unless status_validator.valid?(@status)
       subscription_status_validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
       return false unless subscription_status_validator.valid?(@subscription_status)
+      return false if @api_key.nil?
       true
     end
 
@@ -196,6 +212,16 @@ module Pingram
       @subscription_status = subscription_status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] api_key Value to be assigned
+    def api_key=(api_key)
+      if api_key.nil?
+        fail ArgumentError, 'api_key cannot be nil'
+      end
+
+      @api_key = api_key
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -204,7 +230,8 @@ module Pingram
           account_id == o.account_id &&
           name == o.name &&
           status == o.status &&
-          subscription_status == o.subscription_status
+          subscription_status == o.subscription_status &&
+          api_key == o.api_key
     end
 
     # @see the `==` method
@@ -216,7 +243,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, name, status, subscription_status].hash
+      [account_id, name, status, subscription_status, api_key].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/ten_dlc_brand_admin_update_request.rb

@@ -22,32 +22,43 @@ module Pingram
     # Legal entity type for a 10DLC brand. - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.) - SOLE_PROPRIETOR: sole proprietorship - PUBLIC_PROFIT: publicly traded for-profit - NON_PROFIT: non-profit - GOVERNMENT: government
     attr_accessor :business_type
 
+    # Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).
     attr_accessor :legal_name
 
-    # Brand display name (marketing/DBA); defaults to legalName when omitted on legalName-only updates.
+    # Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName.
     attr_accessor :display_name
 
+    # Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
     attr_accessor :first_name
 
+    # Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
     attr_accessor :last_name
 
-    # For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier.
+    # For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.
     attr_accessor :tax_id
 
+    # Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.
     attr_accessor :website
 
+    # ISO 3166-1 alpha-2 country of incorporation (for example US or CA).
     attr_accessor :country
 
+    # Street address that matches official tax registration.
     attr_accessor :street
 
+    # City that matches official tax registration.
     attr_accessor :city
 
+    # State (US) or province (CA) that matches official tax registration.
     attr_accessor :state
 
+    # ZIP code (US) or postal code (CA) that matches official tax registration.
     attr_accessor :postal_code
 
+    # Email for the 10DLC compliance contact. Used for carrier and registration follow-up.
     attr_accessor :compliance_contact_email
 
+    # Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.
     attr_accessor :compliance_contact_phone
 
     # Industry vertical required before Pingram submits the brand to carriers.