pingram 1.0.28 → 1.0.30

data/lib/pingram/models/ten_dlc_brand_create_request.rb

@@ -22,31 +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
 
-    # Required when businessType is SOLE_PROPRIETOR.
+    # Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For companies with no DBA, use the same value as legalName. For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name (set firstName and lastName for that). If the sole proprietor has no DBA, use first and last name.
+    attr_accessor :display_name
+
+    # Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.
     attr_accessor :first_name
 
-    # Required when businessType is SOLE_PROPRIETOR.
+    # 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. 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
 
     class EnumAttributeValidator
@@ -77,6 +89,7 @@ module Pingram
         :'scenario_id' => :'scenarioId',
         :'business_type' => :'businessType',
         :'legal_name' => :'legalName',
+        :'display_name' => :'displayName',
         :'first_name' => :'firstName',
         :'last_name' => :'lastName',
         :'tax_id' => :'taxId',
@@ -107,6 +120,7 @@ module Pingram
         :'scenario_id' => :'String',
         :'business_type' => :'String',
         :'legal_name' => :'String',
+        :'display_name' => :'String',
         :'first_name' => :'String',
         :'last_name' => :'String',
         :'tax_id' => :'String',
@@ -157,8 +171,12 @@ module Pingram
 
       if attributes.key?(:'legal_name')
         self.legal_name = attributes[:'legal_name']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
       else
-        self.legal_name = nil
+        self.display_name = nil
       end
 
       if attributes.key?(:'first_name')
@@ -187,18 +205,26 @@ module Pingram
 
       if attributes.key?(:'street')
         self.street = attributes[:'street']
+      else
+        self.street = nil
       end
 
       if attributes.key?(:'city')
         self.city = attributes[:'city']
+      else
+        self.city = nil
       end
 
       if attributes.key?(:'state')
         self.state = attributes[:'state']
+      else
+        self.state = nil
       end
 
       if attributes.key?(:'postal_code')
         self.postal_code = attributes[:'postal_code']
+      else
+        self.postal_code = nil
       end
 
       if attributes.key?(:'compliance_contact_email')
@@ -227,8 +253,8 @@ module Pingram
         invalid_properties.push('invalid value for "business_type", business_type cannot be nil.')
       end
 
-      if @legal_name.nil?
-        invalid_properties.push('invalid value for "legal_name", legal_name cannot be nil.')
+      if @display_name.nil?
+        invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
       end
 
       if @website.nil?
@@ -239,6 +265,22 @@ module Pingram
         invalid_properties.push('invalid value for "country", country cannot be nil.')
       end
 
+      if @street.nil?
+        invalid_properties.push('invalid value for "street", street cannot be nil.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @postal_code.nil?
+        invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
+      end
+
       if @compliance_contact_email.nil?
         invalid_properties.push('invalid value for "compliance_contact_email", compliance_contact_email cannot be nil.')
       end
@@ -260,9 +302,13 @@ module Pingram
       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 @display_name.nil?
       return false if @website.nil?
       return false if @country.nil?
+      return false if @street.nil?
+      return false if @city.nil?
+      return false if @state.nil?
+      return false if @postal_code.nil?
       return false if @compliance_contact_email.nil?
       return false if @compliance_contact_phone.nil?
       true
@@ -289,13 +335,13 @@ module Pingram
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] legal_name Value to be assigned
-    def legal_name=(legal_name)
-      if legal_name.nil?
-        fail ArgumentError, 'legal_name cannot be nil'
+    # @param [Object] display_name Value to be assigned
+    def display_name=(display_name)
+      if display_name.nil?
+        fail ArgumentError, 'display_name cannot be nil'
       end
 
-      @legal_name = legal_name
+      @display_name = display_name
     end
 
     # Custom attribute writer method with validation
@@ -318,6 +364,46 @@ module Pingram
       @country = country
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] street Value to be assigned
+    def street=(street)
+      if street.nil?
+        fail ArgumentError, 'street cannot be nil'
+      end
+
+      @street = street
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, 'postal_code cannot be nil'
+      end
+
+      @postal_code = postal_code
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] compliance_contact_email Value to be assigned
     def compliance_contact_email=(compliance_contact_email)
@@ -346,6 +432,7 @@ module Pingram
           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 &&
@@ -368,7 +455,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [scenario_id, business_type, legal_name, first_name, last_name, tax_id, website, country, street, city, state, postal_code, compliance_contact_email, compliance_contact_phone].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].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/ten_dlc_brand_registration.rb

@@ -22,34 +22,46 @@ module Pingram
 
     attr_accessor :business_type
 
+    # Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.
     attr_accessor :legal_name
 
-    # Brand display name (marketing/DBA); defaults to legalName on customer submit.
+    # Public brand name shown to recipients and carriers.
     attr_accessor :display_name
 
+    # Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
     attr_accessor :first_name
 
+    # Legal last name of the sole proprietor. Present 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. Omitted when businessType is SOLE_PROPRIETOR.
     attr_accessor :tax_id
 
+    # Public website for the brand.
     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
 
     # Legacy records only; new submissions use structured address fields.
     attr_accessor :full_address
 
+    # Email for the 10DLC compliance contact.
     attr_accessor :compliance_contact_email
 
+    # Phone number for the 10DLC compliance contact.
     attr_accessor :compliance_contact_phone
 
     # 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

data/lib/pingram/models/ten_dlc_brand_registration_details.rb

@@ -22,34 +22,46 @@ module Pingram
 
     attr_accessor :business_type
 
+    # Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.
     attr_accessor :legal_name
 
-    # Brand display name (marketing/DBA); defaults to legalName on customer submit.
+    # Public brand name shown to recipients and carriers.
     attr_accessor :display_name
 
+    # Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.
     attr_accessor :first_name
 
+    # Legal last name of the sole proprietor. Present 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. Omitted when businessType is SOLE_PROPRIETOR.
     attr_accessor :tax_id
 
+    # Public website for the brand.
     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
 
     # Legacy records only; new submissions use structured address fields.
     attr_accessor :full_address
 
+    # Email for the 10DLC compliance contact.
     attr_accessor :compliance_contact_email
 
+    # Phone number for the 10DLC compliance contact.
     attr_accessor :compliance_contact_phone
 
     # 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

data/lib/pingram/models/ten_dlc_brand_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
 
     class EnumAttributeValidator

data/lib/pingram/models/ten_dlc_campaign_admin_update_request.rb

@@ -16,44 +16,64 @@ require 'time'
 module Pingram
   # Request body for PATCH /registrations/us/10dlc/campaign/admin
   class TenDlcCampaignAdminUpdateRequest < ApiModelBase
+    # Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
     attr_accessor :campaign_description
 
+    # Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
     attr_accessor :campaign_sample1
 
+    # Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
     attr_accessor :campaign_sample2
 
+    # Optional third example SMS.
     attr_accessor :campaign_sample3
 
+    # Optional fourth example SMS.
     attr_accessor :campaign_sample4
 
+    # How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
     attr_accessor :campaign_message_flow
 
+    # Extra opt-in keywords as a comma-separated list. START is always included.
     attr_accessor :campaign_optin_keywords
 
+    # Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
     attr_accessor :campaign_optin_message
 
+    # Extra opt-out keywords as a comma-separated list. STOP is always included.
     attr_accessor :campaign_optout_keywords
 
+    # Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
     attr_accessor :campaign_optout_message
 
+    # Extra help keywords as a comma-separated list. HELP is always included.
     attr_accessor :campaign_help_keywords
 
+    # Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
     attr_accessor :campaign_help_message
 
+    # Whether campaign messages include URLs.
     attr_accessor :campaign_embedded_link
 
+    # Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
     attr_accessor :campaign_embedded_link_url
 
+    # Whether campaign messages include phone numbers.
     attr_accessor :campaign_embedded_phone
 
+    # Whether campaign content is age-restricted (18+).
     attr_accessor :campaign_age_gated
 
+    # Whether the campaign relates to direct lending or loan products.
     attr_accessor :campaign_direct_lending
 
+    # Public URL of the privacy policy that covers this SMS program.
     attr_accessor :campaign_privacy_policy_link
 
+    # Public URL of the terms and conditions that cover this SMS program.
     attr_accessor :campaign_terms_and_conditions_link
 
+    # 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
     attr_accessor :campaign_usecase
 
     # 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

data/lib/pingram/models/ten_dlc_campaign_registration.rb

@@ -21,44 +21,64 @@ module Pingram
     # 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
 
+    # Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
     attr_accessor :campaign_description
 
+    # Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
     attr_accessor :campaign_sample1
 
+    # Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
     attr_accessor :campaign_sample2
 
+    # Optional third example SMS.
     attr_accessor :campaign_sample3
 
+    # Optional fourth example SMS.
     attr_accessor :campaign_sample4
 
+    # How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
     attr_accessor :campaign_message_flow
 
+    # Extra opt-in keywords as a comma-separated list. START is always included.
     attr_accessor :campaign_optin_keywords
 
+    # Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
     attr_accessor :campaign_optin_message
 
+    # Extra opt-out keywords as a comma-separated list. STOP is always included.
     attr_accessor :campaign_optout_keywords
 
+    # Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
     attr_accessor :campaign_optout_message
 
+    # Extra help keywords as a comma-separated list. HELP is always included.
     attr_accessor :campaign_help_keywords
 
+    # Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
     attr_accessor :campaign_help_message
 
+    # Whether campaign messages include URLs.
     attr_accessor :campaign_embedded_link
 
+    # Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
     attr_accessor :campaign_embedded_link_url
 
+    # Whether campaign messages include phone numbers.
     attr_accessor :campaign_embedded_phone
 
+    # Whether campaign content is age-restricted (18+).
     attr_accessor :campaign_age_gated
 
+    # Whether the campaign relates to direct lending or loan products.
     attr_accessor :campaign_direct_lending
 
+    # Public URL of the privacy policy that covers this SMS program.
     attr_accessor :campaign_privacy_policy_link
 
+    # Public URL of the terms and conditions that cover this SMS program.
     attr_accessor :campaign_terms_and_conditions_link
 
+    # 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
     attr_accessor :campaign_usecase
 
     attr_accessor :created_at

data/lib/pingram/models/ten_dlc_campaign_registration_details.rb

@@ -21,44 +21,64 @@ module Pingram
     # 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
 
+    # Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
     attr_accessor :campaign_description
 
+    # Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
     attr_accessor :campaign_sample1
 
+    # Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
     attr_accessor :campaign_sample2
 
+    # Optional third example SMS.
     attr_accessor :campaign_sample3
 
+    # Optional fourth example SMS.
     attr_accessor :campaign_sample4
 
+    # How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
     attr_accessor :campaign_message_flow
 
+    # Extra opt-in keywords as a comma-separated list. START is always included.
     attr_accessor :campaign_optin_keywords
 
+    # Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
     attr_accessor :campaign_optin_message
 
+    # Extra opt-out keywords as a comma-separated list. STOP is always included.
     attr_accessor :campaign_optout_keywords
 
+    # Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
     attr_accessor :campaign_optout_message
 
+    # Extra help keywords as a comma-separated list. HELP is always included.
     attr_accessor :campaign_help_keywords
 
+    # Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
     attr_accessor :campaign_help_message
 
+    # Whether campaign messages include URLs.
     attr_accessor :campaign_embedded_link
 
+    # Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
     attr_accessor :campaign_embedded_link_url
 
+    # Whether campaign messages include phone numbers.
     attr_accessor :campaign_embedded_phone
 
+    # Whether campaign content is age-restricted (18+).
     attr_accessor :campaign_age_gated
 
+    # Whether the campaign relates to direct lending or loan products.
     attr_accessor :campaign_direct_lending
 
+    # Public URL of the privacy policy that covers this SMS program.
     attr_accessor :campaign_privacy_policy_link
 
+    # Public URL of the terms and conditions that cover this SMS program.
     attr_accessor :campaign_terms_and_conditions_link
 
+    # 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
     attr_accessor :campaign_usecase
 
     attr_accessor :created_at

data/lib/pingram/models/ten_dlc_campaign_update_request.rb

@@ -16,44 +16,64 @@ require 'time'
 module Pingram
   # Request body for PATCH /registrations/us/10dlc/campaign
   class TenDlcCampaignUpdateRequest < ApiModelBase
+    # Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.
     attr_accessor :campaign_description
 
+    # Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.
     attr_accessor :campaign_sample1
 
+    # Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.
     attr_accessor :campaign_sample2
 
+    # Optional third example SMS.
     attr_accessor :campaign_sample3
 
+    # Optional fourth example SMS.
     attr_accessor :campaign_sample4
 
+    # How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.
     attr_accessor :campaign_message_flow
 
+    # Extra opt-in keywords as a comma-separated list. START is always included.
     attr_accessor :campaign_optin_keywords
 
+    # Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.
     attr_accessor :campaign_optin_message
 
+    # Extra opt-out keywords as a comma-separated list. STOP is always included.
     attr_accessor :campaign_optout_keywords
 
+    # Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.
     attr_accessor :campaign_optout_message
 
+    # Extra help keywords as a comma-separated list. HELP is always included.
     attr_accessor :campaign_help_keywords
 
+    # Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).
     attr_accessor :campaign_help_message
 
+    # Whether campaign messages include URLs.
     attr_accessor :campaign_embedded_link
 
+    # Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.
     attr_accessor :campaign_embedded_link_url
 
+    # Whether campaign messages include phone numbers.
     attr_accessor :campaign_embedded_phone
 
+    # Whether campaign content is age-restricted (18+).
     attr_accessor :campaign_age_gated
 
+    # Whether the campaign relates to direct lending or loan products.
     attr_accessor :campaign_direct_lending
 
+    # Public URL of the privacy policy that covers this SMS program.
     attr_accessor :campaign_privacy_policy_link
 
+    # Public URL of the terms and conditions that cover this SMS program.
     attr_accessor :campaign_terms_and_conditions_link
 
+    # 10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.
     attr_accessor :campaign_usecase
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Pingram
-  VERSION = '1.0.28'
+  VERSION = '1.0.30'
 end

data/lib/pingram.rb

@@ -25,6 +25,7 @@ require 'pingram/models/accept_invite_response'
 require 'pingram/models/account_addresses_response'
 require 'pingram/models/account_addresses_response_addresses_inner'
 require 'pingram/models/account_get_response'
+require 'pingram/models/account_patch_request'
 require 'pingram/models/address_response'
 require 'pingram/models/api_error_body'
 require 'pingram/models/api_error_response'