pingram 1.0.24 → 1.0.27

data/lib/pingram/models/ten_dlc_brand_registration_details.rb

@@ -52,16 +52,17 @@ 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
 
     attr_accessor :updated_at
 
+    # Industry vertical required before Pingram submits the brand to carriers (for example TECHNOLOGY, HEALTHCARE, RETAIL, or FINANCIAL).
     attr_accessor :vertical
 
     # Legacy only when businessType is Other.

data/lib/pingram/models/ten_dlc_brand_update_request.rb

@@ -16,8 +16,10 @@ require 'time'
 module Pingram
   # Request body for PATCH /registrations/us/10dlc/brand
   class TenDlcBrandUpdateRequest < 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
@@ -29,14 +31,7 @@ module Pingram
 
     attr_accessor :last_name
 
-    attr_accessor :vertical
-
-    # Admin-only; legacy Other records. Ignored on customer PATCH.
-    attr_accessor :entity_type
-
-    # 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
-    attr_accessor :brand_status
-
+    # 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
@@ -86,9 +81,6 @@ module Pingram
         :'display_name' => :'displayName',
         :'first_name' => :'firstName',
         :'last_name' => :'lastName',
-        :'vertical' => :'vertical',
-        :'entity_type' => :'entityType',
-        :'brand_status' => :'brandStatus',
         :'tax_id' => :'taxId',
         :'website' => :'website',
         :'country' => :'country',
@@ -120,9 +112,6 @@ module Pingram
         :'display_name' => :'String',
         :'first_name' => :'String',
         :'last_name' => :'String',
-        :'vertical' => :'String',
-        :'entity_type' => :'String',
-        :'brand_status' => :'String',
         :'tax_id' => :'String',
         :'website' => :'String',
         :'country' => :'String',
@@ -181,18 +170,6 @@ module Pingram
         self.last_name = attributes[:'last_name']
       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
-
       if attributes.key?(:'tax_id')
         self.tax_id = attributes[:'tax_id']
       end
@@ -242,19 +219,31 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      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)
+      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] 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}."
+    # @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
-      @brand_status = brand_status
+      @business_type = business_type
     end
 
     # Checks equality by comparing each attribute.
@@ -268,9 +257,6 @@ module Pingram
           display_name == o.display_name &&
           first_name == o.first_name &&
           last_name == o.last_name &&
-          vertical == o.vertical &&
-          entity_type == o.entity_type &&
-          brand_status == o.brand_status &&
           tax_id == o.tax_id &&
           website == o.website &&
           country == o.country &&
@@ -291,7 +277,7 @@ module Pingram
     # 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, vertical, entity_type, brand_status, 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_campaign_admin_update_request.rb

@@ -0,0 +1,363 @@
+=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 PATCH /registrations/us/10dlc/campaign/admin
+  class TenDlcCampaignAdminUpdateRequest < ApiModelBase
+    attr_accessor :campaign_description
+
+    attr_accessor :campaign_sample1
+
+    attr_accessor :campaign_sample2
+
+    attr_accessor :campaign_sample3
+
+    attr_accessor :campaign_sample4
+
+    attr_accessor :campaign_message_flow
+
+    attr_accessor :campaign_optin_keywords
+
+    attr_accessor :campaign_optin_message
+
+    attr_accessor :campaign_optout_keywords
+
+    attr_accessor :campaign_optout_message
+
+    attr_accessor :campaign_help_keywords
+
+    attr_accessor :campaign_help_message
+
+    attr_accessor :campaign_embedded_link
+
+    attr_accessor :campaign_embedded_link_url
+
+    attr_accessor :campaign_embedded_phone
+
+    attr_accessor :campaign_age_gated
+
+    attr_accessor :campaign_direct_lending
+
+    attr_accessor :campaign_privacy_policy_link
+
+    attr_accessor :campaign_terms_and_conditions_link
+
+    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
+    attr_accessor :campaign_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
+      {
+        :'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',
+        :'campaign_status' => :'campaignStatus'
+      }
+    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',
+        :'campaign_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::TenDlcCampaignAdminUpdateRequest` 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::TenDlcCampaignAdminUpdateRequest`. 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?(:'campaign_status')
+        self.campaign_status = attributes[:'campaign_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'
+      campaign_status_validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      return false unless campaign_status_validator.valid?(@campaign_status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] campaign_status Object to be assigned
+    def campaign_status=(campaign_status)
+      validator = EnumAttributeValidator.new('String', ["not_started", "in_progress", "pending_review", "approved", "rejected", "info_needed"])
+      unless validator.valid?(campaign_status)
+        fail ArgumentError, "invalid value for \"campaign_status\", must be one of #{validator.allowable_values}."
+      end
+      @campaign_status = campaign_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 &&
+          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 &&
+          campaign_status == o.campaign_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
+      [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, campaign_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