pingram 1.0.24 → 1.0.27

data/lib/pingram/models/billing_post_response_body.rb

@@ -46,6 +46,8 @@ module Pingram
 
     attr_accessor :status
 
+    attr_accessor :subscription_status
+
     attr_accessor :session_id
 
     attr_accessor :url
@@ -89,6 +91,7 @@ module Pingram
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
         :'status' => :'status',
+        :'subscription_status' => :'subscriptionStatus',
         :'session_id' => :'sessionId',
         :'url' => :'url'
       }
@@ -121,6 +124,7 @@ module Pingram
         :'created_at' => :'String',
         :'updated_at' => :'String',
         :'status' => :'String',
+        :'subscription_status' => :'String',
         :'session_id' => :'String',
         :'url' => :'String'
       }
@@ -129,6 +133,7 @@ module Pingram
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'subscription_status',
       ])
     end
 
@@ -220,6 +225,10 @@ module Pingram
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'subscription_status')
+        self.subscription_status = attributes[:'subscription_status']
+      end
+
       if attributes.key?(:'session_id')
         self.session_id = attributes[:'session_id']
       end
@@ -287,6 +296,8 @@ module Pingram
       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)
       true
     end
 
@@ -390,6 +401,16 @@ module Pingram
       @status = status
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] subscription_status Object to be assigned
+    def subscription_status=(subscription_status)
+      validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
+      unless validator.valid?(subscription_status)
+        fail ArgumentError, "invalid value for \"subscription_status\", must be one of #{validator.allowable_values}."
+      end
+      @subscription_status = subscription_status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -409,6 +430,7 @@ module Pingram
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           status == o.status &&
+          subscription_status == o.subscription_status &&
           session_id == o.session_id &&
           url == o.url
     end
@@ -422,7 +444,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, session_id, url].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
     end
 
     # Builds the object from hash

data/lib/pingram/models/logs_get_response_logs_inner.rb

@@ -1514,11 +1514,11 @@ module Pingram
       return false unless inapp_failed_code_validator.valid?(@inapp_failed_code)
       mobile_push_failed_code_validator = EnumAttributeValidator.new('String', ["NO_APN_CONFIG", "NO_FCM_CONFIG", "INVALID_APN_TOKEN", "INVALID_FCM_TOKEN", "UNKNOWN"])
       return false unless mobile_push_failed_code_validator.valid?(@mobile_push_failed_code)
-      email_failed_code_validator = EnumAttributeValidator.new('String', ["UNVERIFIED_SENDER", "PERMANENT_GENERAL_BOUNCE", "PERMANENT_NO_EMAIL_BOUNCE", "PERMANENT_SUPPRESSED_BOUNCE", "TRANSIENT_GENERAL_BOUNCE", "TRANSIENT_MAILBOX_FULL_BOUNCE", "TRANSIENT_MESSAGE_TOO_LARGE_BOUNCE", "TRANSIENT_CONTENT_REJECTED_BOUNCE", "TRANSIENT_ATTACHMENT_REJECTED_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT_ABUSE", "COMPLAINT_AUTH", "COMPLAINT_FRAUD", "COMPLAINT_NOT_SPAM", "COMPLAINT_OTHER", "COMPLAINT_VIRUS", "SUPPRESSED_COMPLAINT", "SUPPRESSED_BOUNCE", "MISSING_EMAIL_RECIPIENT", "MISSING_EMAIL_SUBJECT", "MISSING_EMAIL_HTML", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      email_failed_code_validator = EnumAttributeValidator.new('String', ["UNVERIFIED_SENDER", "PERMANENT_GENERAL_BOUNCE", "PERMANENT_NO_EMAIL_BOUNCE", "PERMANENT_SUPPRESSED_BOUNCE", "TRANSIENT_GENERAL_BOUNCE", "TRANSIENT_MAILBOX_FULL_BOUNCE", "TRANSIENT_MESSAGE_TOO_LARGE_BOUNCE", "TRANSIENT_CONTENT_REJECTED_BOUNCE", "TRANSIENT_ATTACHMENT_REJECTED_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT_ABUSE", "COMPLAINT_AUTH", "COMPLAINT_FRAUD", "COMPLAINT_NOT_SPAM", "COMPLAINT_OTHER", "COMPLAINT_VIRUS", "SUPPRESSED_COMPLAINT", "SUPPRESSED_BOUNCE", "MISSING_EMAIL_RECIPIENT", "MISSING_EMAIL_SUBJECT", "MISSING_EMAIL_HTML", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       return false unless email_failed_code_validator.valid?(@email_failed_code)
       email_inbound_resolution_type_validator = EnumAttributeValidator.new('String', ["reply", "builtin", "custom"])
       return false unless email_inbound_resolution_type_validator.valid?(@email_inbound_resolution_type)
-      web_push_failed_code_validator = EnumAttributeValidator.new('String', ["UNSUBSCIRBED_OR_EXPIRED", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      web_push_failed_code_validator = EnumAttributeValidator.new('String', ["UNSUBSCIRBED_OR_EXPIRED", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       return false unless web_push_failed_code_validator.valid?(@web_push_failed_code)
       ignored_validator = EnumAttributeValidator.new('String', ["THROTTLING", "DEDUPLICATION", "DISABLED_NOTIFICATION", "ALL_CHANNELS_IGNORED"])
       return false unless ignored_validator.valid?(@ignored)
@@ -1550,13 +1550,13 @@ module Pingram
       return false unless slack_routing_validator.valid?(@slack_routing)
       slack_routing_reason_validator = EnumAttributeValidator.new('String', ["IGNORE_BY_PREFERENCES", "IGNORE_BY_ENVIRONMENT", "IGNORE_BY_DEFAULT_DELIVERY"])
       return false unless slack_routing_reason_validator.valid?(@slack_routing_reason)
-      slack_failed_code_validator = EnumAttributeValidator.new('String', ["CHANNEL_NOT_FOUND", "NOT_IN_CHANNEL", "CHANNEL_ARCHIVED", "MESSAGE_TOO_LONG", "NO_TEXT", "RESTRICTED_ACTION", "TOKEN_EXPIRED", "INVALID_AUTH", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      slack_failed_code_validator = EnumAttributeValidator.new('String', ["CHANNEL_NOT_FOUND", "NOT_IN_CHANNEL", "CHANNEL_ARCHIVED", "MESSAGE_TOO_LONG", "NO_TEXT", "RESTRICTED_ACTION", "TOKEN_EXPIRED", "INVALID_AUTH", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       return false unless slack_failed_code_validator.valid?(@slack_failed_code)
       call_delivered_code_validator = EnumAttributeValidator.new('String', ["COMPLETED", "BUSY", "NO_ANSWER", "UNKNOWN"])
       return false unless call_delivered_code_validator.valid?(@call_delivered_code)
-      call_failed_code_validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      call_failed_code_validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       return false unless call_failed_code_validator.valid?(@call_failed_code)
-      sms_failed_code_validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      sms_failed_code_validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       return false unless sms_failed_code_validator.valid?(@sms_failed_code)
       true
     end
@@ -1614,7 +1614,7 @@ module Pingram
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] email_failed_code Object to be assigned
     def email_failed_code=(email_failed_code)
-      validator = EnumAttributeValidator.new('String', ["UNVERIFIED_SENDER", "PERMANENT_GENERAL_BOUNCE", "PERMANENT_NO_EMAIL_BOUNCE", "PERMANENT_SUPPRESSED_BOUNCE", "TRANSIENT_GENERAL_BOUNCE", "TRANSIENT_MAILBOX_FULL_BOUNCE", "TRANSIENT_MESSAGE_TOO_LARGE_BOUNCE", "TRANSIENT_CONTENT_REJECTED_BOUNCE", "TRANSIENT_ATTACHMENT_REJECTED_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT_ABUSE", "COMPLAINT_AUTH", "COMPLAINT_FRAUD", "COMPLAINT_NOT_SPAM", "COMPLAINT_OTHER", "COMPLAINT_VIRUS", "SUPPRESSED_COMPLAINT", "SUPPRESSED_BOUNCE", "MISSING_EMAIL_RECIPIENT", "MISSING_EMAIL_SUBJECT", "MISSING_EMAIL_HTML", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      validator = EnumAttributeValidator.new('String', ["UNVERIFIED_SENDER", "PERMANENT_GENERAL_BOUNCE", "PERMANENT_NO_EMAIL_BOUNCE", "PERMANENT_SUPPRESSED_BOUNCE", "TRANSIENT_GENERAL_BOUNCE", "TRANSIENT_MAILBOX_FULL_BOUNCE", "TRANSIENT_MESSAGE_TOO_LARGE_BOUNCE", "TRANSIENT_CONTENT_REJECTED_BOUNCE", "TRANSIENT_ATTACHMENT_REJECTED_BOUNCE", "UNDETERMINED_BOUNCE", "COMPLAINT_ABUSE", "COMPLAINT_AUTH", "COMPLAINT_FRAUD", "COMPLAINT_NOT_SPAM", "COMPLAINT_OTHER", "COMPLAINT_VIRUS", "SUPPRESSED_COMPLAINT", "SUPPRESSED_BOUNCE", "MISSING_EMAIL_RECIPIENT", "MISSING_EMAIL_SUBJECT", "MISSING_EMAIL_HTML", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       unless validator.valid?(email_failed_code)
         fail ArgumentError, "invalid value for \"email_failed_code\", must be one of #{validator.allowable_values}."
       end
@@ -1634,7 +1634,7 @@ module Pingram
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] web_push_failed_code Object to be assigned
     def web_push_failed_code=(web_push_failed_code)
-      validator = EnumAttributeValidator.new('String', ["UNSUBSCIRBED_OR_EXPIRED", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      validator = EnumAttributeValidator.new('String', ["UNSUBSCIRBED_OR_EXPIRED", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       unless validator.valid?(web_push_failed_code)
         fail ArgumentError, "invalid value for \"web_push_failed_code\", must be one of #{validator.allowable_values}."
       end
@@ -1794,7 +1794,7 @@ module Pingram
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] slack_failed_code Object to be assigned
     def slack_failed_code=(slack_failed_code)
-      validator = EnumAttributeValidator.new('String', ["CHANNEL_NOT_FOUND", "NOT_IN_CHANNEL", "CHANNEL_ARCHIVED", "MESSAGE_TOO_LONG", "NO_TEXT", "RESTRICTED_ACTION", "TOKEN_EXPIRED", "INVALID_AUTH", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      validator = EnumAttributeValidator.new('String', ["CHANNEL_NOT_FOUND", "NOT_IN_CHANNEL", "CHANNEL_ARCHIVED", "MESSAGE_TOO_LONG", "NO_TEXT", "RESTRICTED_ACTION", "TOKEN_EXPIRED", "INVALID_AUTH", "UNKNOWN", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       unless validator.valid?(slack_failed_code)
         fail ArgumentError, "invalid value for \"slack_failed_code\", must be one of #{validator.allowable_values}."
       end
@@ -1814,7 +1814,7 @@ module Pingram
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] call_failed_code Object to be assigned
     def call_failed_code=(call_failed_code)
-      validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       unless validator.valid?(call_failed_code)
         fail ArgumentError, "invalid value for \"call_failed_code\", must be one of #{validator.allowable_values}."
       end
@@ -1824,7 +1824,7 @@ module Pingram
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] sms_failed_code Object to be assigned
     def sms_failed_code=(sms_failed_code)
-      validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT"])
+      validator = EnumAttributeValidator.new('String', ["13224", "21211", "21215", "21265", "21610", "21614", "21612", "30005", "30006", "30007", "30008", "30453", "40001", "40002", "40010", "40300", "Unknown", "MISSING_SMS_RECIPIENT", "MISSING_SMS_MESSAGE", "INVALID_PHONE_NUMBER", "NO_ADDRESS", "USAGE_LIMIT", "VERIFICATION_LIMIT", "TEMPLATE_NOT_FOUND", "NO_DEFAULT_TEMPLATE", "SPAM_CONTENT", "SMS_FREE_RESTRICTED"])
       unless validator.valid?(sms_failed_code)
         fail ArgumentError, "invalid value for \"sms_failed_code\", must be one of #{validator.allowable_values}."
       end

data/lib/pingram/models/ten_dlc_brand_admin_update_request.rb

@@ -0,0 +1,378 @@
+=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 the superadmin-only PATCH /registrations/us/10dlc/brand/admin
+  class TenDlcBrandAdminUpdateRequest < ApiModelBase
+    # Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor
+    attr_accessor :scenario_id
+
+    # 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
+
+    attr_accessor :legal_name
+
+    # Brand display name (marketing/DBA); defaults to legalName when omitted on legalName-only updates.
+    attr_accessor :display_name
+
+    attr_accessor :first_name
+
+    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.
+    attr_accessor :tax_id
+
+    attr_accessor :website
+
+    attr_accessor :country
+
+    attr_accessor :street
+
+    attr_accessor :city
+
+    attr_accessor :state
+
+    attr_accessor :postal_code
+
+    attr_accessor :compliance_contact_email
+
+    attr_accessor :compliance_contact_phone
+
+    # Industry vertical required before Pingram submits the brand to carriers.
+    attr_accessor :vertical
+
+    # Legacy only when businessType is Other.
+    attr_accessor :entity_type
+
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    attr_accessor :brand_status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'scenario_id' => :'scenarioId',
+        :'business_type' => :'businessType',
+        :'legal_name' => :'legalName',
+        :'display_name' => :'displayName',
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
+        :'tax_id' => :'taxId',
+        :'website' => :'website',
+        :'country' => :'country',
+        :'street' => :'street',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'postal_code' => :'postalCode',
+        :'compliance_contact_email' => :'complianceContactEmail',
+        :'compliance_contact_phone' => :'complianceContactPhone',
+        :'vertical' => :'vertical',
+        :'entity_type' => :'entityType',
+        :'brand_status' => :'brandStatus'
+      }
+    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',
+        :'display_name' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'tax_id' => :'String',
+        :'website' => :'String',
+        :'country' => :'String',
+        :'street' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'postal_code' => :'String',
+        :'compliance_contact_email' => :'String',
+        :'compliance_contact_phone' => :'String',
+        :'vertical' => :'String',
+        :'entity_type' => :'String',
+        :'brand_status' => :'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::TenDlcBrandAdminUpdateRequest` 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::TenDlcBrandAdminUpdateRequest`. 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?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_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?(:'street')
+        self.street = attributes[:'street']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      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
+
+      if attributes.key?(:'vertical')
+        self.vertical = attributes[:'vertical']
+      end
+
+      if attributes.key?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      end
+
+      if attributes.key?(:'brand_status')
+        self.brand_status = attributes[:'brand_status']
+      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'
+      scenario_id_validator = EnumAttributeValidator.new('String', ["own_brand", "client_brand"])
+      return false unless scenario_id_validator.valid?(@scenario_id)
+      business_type_validator = EnumAttributeValidator.new('String', ["PRIVATE_PROFIT", "SOLE_PROPRIETOR", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"])
+      return false unless business_type_validator.valid?(@business_type)
+      vertical_validator = EnumAttributeValidator.new('String', ["AGRICULTURE", "COMMUNICATION", "CONSTRUCTION", "EDUCATION", "ENERGY", "ENTERTAINMENT", "FINANCIAL", "GAMBLING", "GOVERNMENT", "HEALTHCARE", "HOSPITALITY", "HUMAN_RESOURCES", "INSURANCE", "LEGAL", "MANUFACTURING", "NGO", "POLITICAL", "POSTAL", "PROFESSIONAL", "REAL_ESTATE", "RETAIL", "TECHNOLOGY", "TRANSPORTATION"])
+      return false unless vertical_validator.valid?(@vertical)
+      brand_status_validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      return false unless brand_status_validator.valid?(@brand_status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scenario_id Object to be assigned
+    def scenario_id=(scenario_id)
+      validator = EnumAttributeValidator.new('String', ["own_brand", "client_brand"])
+      unless validator.valid?(scenario_id)
+        fail ArgumentError, "invalid value for \"scenario_id\", must be one of #{validator.allowable_values}."
+      end
+      @scenario_id = scenario_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] business_type Object to be assigned
+    def business_type=(business_type)
+      validator = EnumAttributeValidator.new('String', ["PRIVATE_PROFIT", "SOLE_PROPRIETOR", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"])
+      unless validator.valid?(business_type)
+        fail ArgumentError, "invalid value for \"business_type\", must be one of #{validator.allowable_values}."
+      end
+      @business_type = business_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] vertical Object to be assigned
+    def vertical=(vertical)
+      validator = EnumAttributeValidator.new('String', ["AGRICULTURE", "COMMUNICATION", "CONSTRUCTION", "EDUCATION", "ENERGY", "ENTERTAINMENT", "FINANCIAL", "GAMBLING", "GOVERNMENT", "HEALTHCARE", "HOSPITALITY", "HUMAN_RESOURCES", "INSURANCE", "LEGAL", "MANUFACTURING", "NGO", "POLITICAL", "POSTAL", "PROFESSIONAL", "REAL_ESTATE", "RETAIL", "TECHNOLOGY", "TRANSPORTATION"])
+      unless validator.valid?(vertical)
+        fail ArgumentError, "invalid value for \"vertical\", must be one of #{validator.allowable_values}."
+      end
+      @vertical = vertical
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] brand_status Object to be assigned
+    def brand_status=(brand_status)
+      validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      unless validator.valid?(brand_status)
+        fail ArgumentError, "invalid value for \"brand_status\", must be one of #{validator.allowable_values}."
+      end
+      @brand_status = brand_status
+    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 &&
+          display_name == o.display_name &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          tax_id == o.tax_id &&
+          website == o.website &&
+          country == o.country &&
+          street == o.street &&
+          city == o.city &&
+          state == o.state &&
+          postal_code == o.postal_code &&
+          compliance_contact_email == o.compliance_contact_email &&
+          compliance_contact_phone == o.compliance_contact_phone &&
+          vertical == o.vertical &&
+          entity_type == o.entity_type &&
+          brand_status == o.brand_status
+    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, display_name, first_name, last_name, tax_id, website, country, street, city, state, postal_code, compliance_contact_email, compliance_contact_phone, vertical, entity_type, brand_status].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/ten_dlc_brand_create_request.rb

@@ -16,16 +16,21 @@ require 'time'
 module Pingram
   # Request body for POST /registrations/us/10dlc/brand
   class TenDlcBrandCreateRequest < ApiModelBase
+    # Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor
     attr_accessor :scenario_id
 
+    # 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
 
     attr_accessor :legal_name
 
+    # Required when businessType is SOLE_PROPRIETOR.
     attr_accessor :first_name
 
+    # 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. Required except when businessType is SOLE_PROPRIETOR.
     attr_accessor :tax_id
 
     attr_accessor :website
@@ -44,6 +49,28 @@ module Pingram
 
     attr_accessor :compliance_contact_phone
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -228,7 +255,11 @@ module Pingram
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @scenario_id.nil?
+      scenario_id_validator = EnumAttributeValidator.new('String', ["own_brand", "client_brand"])
+      return false unless scenario_id_validator.valid?(@scenario_id)
       return false if @business_type.nil?
+      business_type_validator = EnumAttributeValidator.new('String', ["PRIVATE_PROFIT", "SOLE_PROPRIETOR", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"])
+      return false unless business_type_validator.valid?(@business_type)
       return false if @legal_name.nil?
       return false if @website.nil?
       return false if @country.nil?
@@ -237,23 +268,23 @@ module Pingram
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] scenario_id Value to be assigned
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scenario_id Object to be assigned
     def scenario_id=(scenario_id)
-      if scenario_id.nil?
-        fail ArgumentError, 'scenario_id cannot be nil'
+      validator = EnumAttributeValidator.new('String', ["own_brand", "client_brand"])
+      unless validator.valid?(scenario_id)
+        fail ArgumentError, "invalid value for \"scenario_id\", must be one of #{validator.allowable_values}."
       end
-
       @scenario_id = scenario_id
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] business_type Value to be assigned
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] business_type Object to be assigned
     def business_type=(business_type)
-      if business_type.nil?
-        fail ArgumentError, 'business_type cannot be nil'
+      validator = EnumAttributeValidator.new('String', ["PRIVATE_PROFIT", "SOLE_PROPRIETOR", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"])
+      unless validator.valid?(business_type)
+        fail ArgumentError, "invalid value for \"business_type\", must be one of #{validator.allowable_values}."
       end
-
       @business_type = business_type
     end
 

data/lib/pingram/models/ten_dlc_brand_registration.rb

@@ -52,10 +52,10 @@ module Pingram
 
     attr_accessor :compliance_contact_phone
 
-    # Pingram-side brand registration workflow status. - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
     attr_accessor :brand_status
 
-    # Pingram-side brand registration workflow status. - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
+    # Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome
     attr_accessor :campaign_status
 
     attr_accessor :created_at