pingram 1.0.28 → 1.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f540ef8b53152ed4f6ecd3308f797e0374b539c96bfd6c23f437f4c939ca8d9
-  data.tar.gz: ef7b88a8438baee017236e05065a974321658e45dc07efe52665a3bdbfa97d5e
+  metadata.gz: b060d82b88d28f53793bd5088b8365bd2b1156c99003032087ff4f7356cde479
+  data.tar.gz: 4c141e3cf23edf0e18a7651746164f869464144116fd31ebc7a738b504ad7130
 SHA512:
-  metadata.gz: 5da3ff704b8ed13a71b3a3d1a0c1a690006e46ff495c4661649e5a8f2cca1c96e596f14587f3020e53e0c98174270fd6b7b5b6134403ebe0e92402a640f69730
-  data.tar.gz: 8c5b60183fc0c0cf58f4b3895a7ebb0665e70ffb4d000a3b694c0a3085cbd537e623727ddd4033e58774b15b921db3b5862084821ca195856890b2ab7bf54b1f
+  metadata.gz: 5c22df0d321c8c8c006c9c5d6d4cf8defd9ecec06365b3fcdcfd975bce559f63af363dd57291b1589e9c3a11297cc44e4fb545a119ce522f021bee38bedf096b
+  data.tar.gz: 0fda0509597950d768dc479f71a60b13dc0bd2ba68e76640b2160ddec58f57d526d2d2a0335feb0c12b45cef63a0198761c1bed891052628c04426dfcd0c9bbf

data/Gemfile.lock

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

data/lib/pingram/api/account_api.rb

@@ -630,5 +630,71 @@ module Pingram
       end
       return data, status_code, headers
     end
+
+    # Update account billing preferences. Only account owners can change these settings.
+    # @param account_patch_request [AccountPatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountGetResponse]
+    def account_update_account_settings(account_patch_request, opts = {})
+      data, _status_code, _headers = account_update_account_settings_with_http_info(account_patch_request, opts)
+      data
+    end
+
+    # Update account billing preferences. Only account owners can change these settings.
+    # @param account_patch_request [AccountPatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountGetResponse, Integer, Hash)>] AccountGetResponse data, response status code and response headers
+    def account_update_account_settings_with_http_info(account_patch_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.account_update_account_settings ...'
+      end
+      # verify the required parameter 'account_patch_request' is set
+      if @api_client.config.client_side_validation && account_patch_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_patch_request' when calling AccountApi.account_update_account_settings"
+      end
+      # resource path
+      local_var_path = '/account'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_patch_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountGetResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.account_update_account_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#account_update_account_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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.28"
+      @user_agent = "pingram-ruby/1.0.30"
       @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,15 @@ module Pingram
 
     attr_accessor :subscription_status
 
+    attr_accessor :pending_downgrade_effective_date
+
+    attr_accessor :pending_downgrade_cost_cap
+
+    attr_accessor :pending_downgrade_account_type
+
+    # When true, paid accounts move up one budget tier at 90% of the monthly budget.
+    attr_accessor :auto_upgrade
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -83,11 +90,14 @@ 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',
+        :'auto_upgrade' => :'autoUpgrade'
       }
     end
 
@@ -114,18 +124,21 @@ 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',
+        :'auto_upgrade' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subscription_status'
+        :'subscription_status',
       ])
     end
 
@@ -195,12 +208,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 +227,22 @@ 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
+
+      if attributes.key?(:'auto_upgrade')
+        self.auto_upgrade = attributes[:'auto_upgrade']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -247,10 +270,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 +294,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 +365,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 +405,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 +430,14 @@ 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 &&
+          auto_upgrade == o.auto_upgrade
     end
 
     # @see the `==` method
@@ -426,7 +449,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, auto_upgrade].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/account_patch_request.rb

@@ -0,0 +1,149 @@
+=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 request: billing preferences.
+  class AccountPatchRequest < ApiModelBase
+    # When true, automatically move up one budget tier at 90% of the monthly budget.
+    attr_accessor :auto_upgrade
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'auto_upgrade' => :'autoUpgrade'
+      }
+    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
+      {
+        :'auto_upgrade' => :'Boolean'
+      }
+    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::AccountPatchRequest` 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::AccountPatchRequest`. 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?(:'auto_upgrade')
+        self.auto_upgrade = attributes[:'auto_upgrade']
+      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 &&
+          auto_upgrade == o.auto_upgrade
+    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
+      [auto_upgrade].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

@@ -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,15 @@ module Pingram
 
     attr_accessor :subscription_status
 
+    attr_accessor :pending_downgrade_effective_date
+
+    attr_accessor :pending_downgrade_cost_cap
+
+    attr_accessor :pending_downgrade_account_type
+
+    # When true, paid accounts move up one budget tier at 90% of the monthly budget.
+    attr_accessor :auto_upgrade
+
     attr_accessor :session_id
 
     attr_accessor :url
@@ -87,11 +94,14 @@ 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',
+        :'auto_upgrade' => :'autoUpgrade',
         :'session_id' => :'sessionId',
         :'url' => :'url'
       }
@@ -120,11 +130,14 @@ 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',
+        :'auto_upgrade' => :'Boolean',
         :'session_id' => :'String',
         :'url' => :'String'
       }
@@ -203,12 +216,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 +236,22 @@ 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?(:'auto_upgrade')
+        self.auto_upgrade = attributes[:'auto_upgrade']
+      end
+
       if attributes.key?(:'session_id')
         self.session_id = attributes[:'session_id']
       end
@@ -263,10 +286,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 +310,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 +381,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 +421,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 +446,14 @@ 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 &&
+          auto_upgrade == o.auto_upgrade &&
           session_id == o.session_id &&
           url == o.url
     end
@@ -444,7 +467,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, auto_upgrade, session_id, url].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.