pingram 1.0.39 → 1.0.40

data/lib/pingram/models/sms_registration_update_request_a2p10dlc.rb

@@ -0,0 +1,535 @@
+=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
+  # Fields for updating a US A2P 10DLC registration. `country` is the country of incorporation (US or CA), not the destination.
+  class SmsRegistrationUpdateRequestA2p10dlc < 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
+
+    # 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
+
+    # Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).
+    attr_accessor :legal_name
+
+    # 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. 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
+      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
+      {
+        :'campaign_description' => :'campaignDescription',
+        :'campaign_sample1' => :'campaignSample1',
+        :'campaign_sample2' => :'campaignSample2',
+        :'campaign_sample3' => :'campaignSample3',
+        :'campaign_sample4' => :'campaignSample4',
+        :'campaign_message_flow' => :'campaignMessageFlow',
+        :'campaign_optin_keywords' => :'campaignOptinKeywords',
+        :'campaign_optin_message' => :'campaignOptinMessage',
+        :'campaign_optout_keywords' => :'campaignOptoutKeywords',
+        :'campaign_optout_message' => :'campaignOptoutMessage',
+        :'campaign_help_keywords' => :'campaignHelpKeywords',
+        :'campaign_help_message' => :'campaignHelpMessage',
+        :'campaign_embedded_link' => :'campaignEmbeddedLink',
+        :'campaign_embedded_link_url' => :'campaignEmbeddedLinkUrl',
+        :'campaign_embedded_phone' => :'campaignEmbeddedPhone',
+        :'campaign_age_gated' => :'campaignAgeGated',
+        :'campaign_direct_lending' => :'campaignDirectLending',
+        :'campaign_privacy_policy_link' => :'campaignPrivacyPolicyLink',
+        :'campaign_terms_and_conditions_link' => :'campaignTermsAndConditionsLink',
+        :'campaign_usecase' => :'campaignUsecase',
+        :'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'
+      }
+    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
+      {
+        :'campaign_description' => :'String',
+        :'campaign_sample1' => :'String',
+        :'campaign_sample2' => :'String',
+        :'campaign_sample3' => :'String',
+        :'campaign_sample4' => :'String',
+        :'campaign_message_flow' => :'String',
+        :'campaign_optin_keywords' => :'String',
+        :'campaign_optin_message' => :'String',
+        :'campaign_optout_keywords' => :'String',
+        :'campaign_optout_message' => :'String',
+        :'campaign_help_keywords' => :'String',
+        :'campaign_help_message' => :'String',
+        :'campaign_embedded_link' => :'Boolean',
+        :'campaign_embedded_link_url' => :'String',
+        :'campaign_embedded_phone' => :'Boolean',
+        :'campaign_age_gated' => :'Boolean',
+        :'campaign_direct_lending' => :'Boolean',
+        :'campaign_privacy_policy_link' => :'String',
+        :'campaign_terms_and_conditions_link' => :'String',
+        :'campaign_usecase' => :'String',
+        :'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'
+      }
+    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::SmsRegistrationUpdateRequestA2p10dlc` 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::SmsRegistrationUpdateRequestA2p10dlc`. 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?(:'campaign_description')
+        self.campaign_description = attributes[:'campaign_description']
+      end
+
+      if attributes.key?(:'campaign_sample1')
+        self.campaign_sample1 = attributes[:'campaign_sample1']
+      end
+
+      if attributes.key?(:'campaign_sample2')
+        self.campaign_sample2 = attributes[:'campaign_sample2']
+      end
+
+      if attributes.key?(:'campaign_sample3')
+        self.campaign_sample3 = attributes[:'campaign_sample3']
+      end
+
+      if attributes.key?(:'campaign_sample4')
+        self.campaign_sample4 = attributes[:'campaign_sample4']
+      end
+
+      if attributes.key?(:'campaign_message_flow')
+        self.campaign_message_flow = attributes[:'campaign_message_flow']
+      end
+
+      if attributes.key?(:'campaign_optin_keywords')
+        self.campaign_optin_keywords = attributes[:'campaign_optin_keywords']
+      end
+
+      if attributes.key?(:'campaign_optin_message')
+        self.campaign_optin_message = attributes[:'campaign_optin_message']
+      end
+
+      if attributes.key?(:'campaign_optout_keywords')
+        self.campaign_optout_keywords = attributes[:'campaign_optout_keywords']
+      end
+
+      if attributes.key?(:'campaign_optout_message')
+        self.campaign_optout_message = attributes[:'campaign_optout_message']
+      end
+
+      if attributes.key?(:'campaign_help_keywords')
+        self.campaign_help_keywords = attributes[:'campaign_help_keywords']
+      end
+
+      if attributes.key?(:'campaign_help_message')
+        self.campaign_help_message = attributes[:'campaign_help_message']
+      end
+
+      if attributes.key?(:'campaign_embedded_link')
+        self.campaign_embedded_link = attributes[:'campaign_embedded_link']
+      end
+
+      if attributes.key?(:'campaign_embedded_link_url')
+        self.campaign_embedded_link_url = attributes[:'campaign_embedded_link_url']
+      end
+
+      if attributes.key?(:'campaign_embedded_phone')
+        self.campaign_embedded_phone = attributes[:'campaign_embedded_phone']
+      end
+
+      if attributes.key?(:'campaign_age_gated')
+        self.campaign_age_gated = attributes[:'campaign_age_gated']
+      end
+
+      if attributes.key?(:'campaign_direct_lending')
+        self.campaign_direct_lending = attributes[:'campaign_direct_lending']
+      end
+
+      if attributes.key?(:'campaign_privacy_policy_link')
+        self.campaign_privacy_policy_link = attributes[:'campaign_privacy_policy_link']
+      end
+
+      if attributes.key?(:'campaign_terms_and_conditions_link')
+        self.campaign_terms_and_conditions_link = attributes[:'campaign_terms_and_conditions_link']
+      end
+
+      if attributes.key?(:'campaign_usecase')
+        self.campaign_usecase = attributes[:'campaign_usecase']
+      end
+
+      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
+    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)
+      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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          campaign_description == o.campaign_description &&
+          campaign_sample1 == o.campaign_sample1 &&
+          campaign_sample2 == o.campaign_sample2 &&
+          campaign_sample3 == o.campaign_sample3 &&
+          campaign_sample4 == o.campaign_sample4 &&
+          campaign_message_flow == o.campaign_message_flow &&
+          campaign_optin_keywords == o.campaign_optin_keywords &&
+          campaign_optin_message == o.campaign_optin_message &&
+          campaign_optout_keywords == o.campaign_optout_keywords &&
+          campaign_optout_message == o.campaign_optout_message &&
+          campaign_help_keywords == o.campaign_help_keywords &&
+          campaign_help_message == o.campaign_help_message &&
+          campaign_embedded_link == o.campaign_embedded_link &&
+          campaign_embedded_link_url == o.campaign_embedded_link_url &&
+          campaign_embedded_phone == o.campaign_embedded_phone &&
+          campaign_age_gated == o.campaign_age_gated &&
+          campaign_direct_lending == o.campaign_direct_lending &&
+          campaign_privacy_policy_link == o.campaign_privacy_policy_link &&
+          campaign_terms_and_conditions_link == o.campaign_terms_and_conditions_link &&
+          campaign_usecase == o.campaign_usecase &&
+          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
+    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
+      [campaign_description, campaign_sample1, campaign_sample2, campaign_sample3, campaign_sample4, campaign_message_flow, campaign_optin_keywords, campaign_optin_message, campaign_optout_keywords, campaign_optout_message, campaign_help_keywords, campaign_help_message, campaign_embedded_link, campaign_embedded_link_url, campaign_embedded_phone, campaign_age_gated, campaign_direct_lending, campaign_privacy_policy_link, campaign_terms_and_conditions_link, campaign_usecase, 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
+    # @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