ddx_interactions_api 0.1.0.pre.1

data/lib/ddx_interactions_api/models/interaction_dto.rb

@@ -0,0 +1,513 @@
+=begin
+#Interactions API
+
+#Interactions API documentation
+
+The version of the OpenAPI document: v1
+Contact: api@demexchange.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DdxInteractionsApi
+  # Represents a single interaction record containing voter outreach attempt data.
+  class InteractionDto
+    # Optional ID used to identify a specific interaction.  This ID should only be provided in the initial request when re-sending data, and must use DDx-provided  interactionId value. If an existing ID is not provided to mark the interaction as a retry, Interactions API  will populate this ID field and include it in the response for future use if the interaction needs to be re-sent.
+    attr_accessor :interaction_id
+
+    # Optional array of person identifiers representing all IDs from any vendor system for the person interacted with. Each identifier can  contain an ID and type of ID indicating source system. If contact information for a person involved in the interaction is not provided, at least one ID is required.   A maximum of 100 IDs are allowed per interaction.  An ID of type 'VAN' must be present if VAN is included as a destination, even if contact information is provided. Each person identifier type can appear at most once  in the array (i.e. no duplicate types are allowed).
+    attr_accessor :person
+
+    attr_accessor :contact_info
+
+    attr_accessor :channel
+
+    # 2-character US state postal abbreviation (e.g., AL, WY).  Use \"NA\" when the state is unknown.  Must be a valid uppercase state code.
+    attr_accessor :state_code
+
+    # The date and time when the outreach attempt occurred, as reported by the vendor  and normalized to Coordinated Universal Time (UTC).
+    attr_accessor :attempt_date_time
+
+    attr_accessor :method
+
+    # Array of entities (campaign, state party, etc.) that conducted or logged the outreach attempt.  Committee objects consist of a type and an identifier, and at least one committee must be provided.
+    attr_accessor :committee
+
+    # Array of canvasser details for the individual who conducted the outreach attempt, as reported by the vendor.  Optional object containing identifier and identifier type.
+    attr_accessor :canvasser
+
+    # Canonical name of the vendor or tool used to facilitate the outreach attempt.  This field reflects the platform through which the contact was made, not necessarily where the data was ingested from.
+    attr_accessor :vendor_source
+
+    attr_accessor :outcome
+
+    # Optional array of objects that provide additional context around the results of an interaction, such as activist codes or survey responses.  If the type is recognized as an Activist Code Outcome (type = \"activist_code\"),  Communication Consent Outcome (type = \"communication_consent\"), Survey Response Outcome  (type = \"survey_response\"), or Event Signup (type = \"event_signup\") it will be deserialized to that type.  If the type is unrecognized, it will be deserialized to an unvalidated, loosely typed object for flexibility.
+    attr_accessor :outcomes_detailed
+
+    # Unique identifier for interactions that took place during the same conversation or set of conversations.  Used to group related interactions together. Maximum length of 100 characters.
+    attr_accessor :thread_id
+
+    # Additional metadata in JSON format related to the interaction.  Must be valid JSON when provided. Can contain arbitrary structured data relevant to the interaction.
+    attr_accessor :json_metadata
+
+    attr_accessor :van_fields
+
+    # Optional array of initiatives associated with the interaction, such as campaign IDs.  Each initiative can contain a type and an identifier.
+    attr_accessor :initiative
+
+    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
+      {
+        :'interaction_id' => :'interactionId',
+        :'person' => :'person',
+        :'contact_info' => :'contactInfo',
+        :'channel' => :'channel',
+        :'state_code' => :'stateCode',
+        :'attempt_date_time' => :'attemptDateTime',
+        :'method' => :'method',
+        :'committee' => :'committee',
+        :'canvasser' => :'canvasser',
+        :'vendor_source' => :'vendorSource',
+        :'outcome' => :'outcome',
+        :'outcomes_detailed' => :'outcomesDetailed',
+        :'thread_id' => :'threadId',
+        :'json_metadata' => :'jsonMetadata',
+        :'van_fields' => :'vanFields',
+        :'initiative' => :'initiative'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'interaction_id' => :'String',
+        :'person' => :'Array<PersonIdentifier>',
+        :'contact_info' => :'ContactInfo',
+        :'channel' => :'InteractionDtoChannel',
+        :'state_code' => :'String',
+        :'attempt_date_time' => :'Time',
+        :'method' => :'ContactMethod',
+        :'committee' => :'Array<CommitteeDetails>',
+        :'canvasser' => :'Array<CanvasserDetails>',
+        :'vendor_source' => :'String',
+        :'outcome' => :'Outcome',
+        :'outcomes_detailed' => :'Array<InteractionDtoOutcomesDetailedInner>',
+        :'thread_id' => :'String',
+        :'json_metadata' => :'String',
+        :'van_fields' => :'InteractionVanFieldsDto',
+        :'initiative' => :'Array<InitiativeDto>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'person',
+        :'channel',
+        :'canvasser',
+        :'outcomes_detailed',
+        :'thread_id',
+        :'json_metadata',
+        :'initiative'
+      ])
+    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 `DdxInteractionsApi::InteractionDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DdxInteractionsApi::InteractionDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'interaction_id')
+        self.interaction_id = attributes[:'interaction_id']
+      end
+
+      if attributes.key?(:'person')
+        if (value = attributes[:'person']).is_a?(Array)
+          self.person = value
+        end
+      end
+
+      if attributes.key?(:'contact_info')
+        self.contact_info = attributes[:'contact_info']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'state_code')
+        self.state_code = attributes[:'state_code']
+      else
+        self.state_code = nil
+      end
+
+      if attributes.key?(:'attempt_date_time')
+        self.attempt_date_time = attributes[:'attempt_date_time']
+      else
+        self.attempt_date_time = nil
+      end
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      else
+        self.method = nil
+      end
+
+      if attributes.key?(:'committee')
+        if (value = attributes[:'committee']).is_a?(Array)
+          self.committee = value
+        end
+      else
+        self.committee = nil
+      end
+
+      if attributes.key?(:'canvasser')
+        if (value = attributes[:'canvasser']).is_a?(Array)
+          self.canvasser = value
+        end
+      end
+
+      if attributes.key?(:'vendor_source')
+        self.vendor_source = attributes[:'vendor_source']
+      else
+        self.vendor_source = nil
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      else
+        self.outcome = nil
+      end
+
+      if attributes.key?(:'outcomes_detailed')
+        if (value = attributes[:'outcomes_detailed']).is_a?(Array)
+          self.outcomes_detailed = value
+        end
+      end
+
+      if attributes.key?(:'thread_id')
+        self.thread_id = attributes[:'thread_id']
+      end
+
+      if attributes.key?(:'json_metadata')
+        self.json_metadata = attributes[:'json_metadata']
+      end
+
+      if attributes.key?(:'van_fields')
+        self.van_fields = attributes[:'van_fields']
+      end
+
+      if attributes.key?(:'initiative')
+        if (value = attributes[:'initiative']).is_a?(Array)
+          self.initiative = value
+        end
+      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
+      if @state_code.nil?
+        invalid_properties.push('invalid value for "state_code", state_code cannot be nil.')
+      end
+
+      if @state_code.to_s.length > 2
+        invalid_properties.push('invalid value for "state_code", the character length must be smaller than or equal to 2.')
+      end
+
+      if @state_code.to_s.length < 2
+        invalid_properties.push('invalid value for "state_code", the character length must be great than or equal to 2.')
+      end
+
+      if @attempt_date_time.nil?
+        invalid_properties.push('invalid value for "attempt_date_time", attempt_date_time cannot be nil.')
+      end
+
+      if @method.nil?
+        invalid_properties.push('invalid value for "method", method cannot be nil.')
+      end
+
+      if @committee.nil?
+        invalid_properties.push('invalid value for "committee", committee cannot be nil.')
+      end
+
+      if @vendor_source.nil?
+        invalid_properties.push('invalid value for "vendor_source", vendor_source cannot be nil.')
+      end
+
+      if @vendor_source.to_s.length < 1
+        invalid_properties.push('invalid value for "vendor_source", the character length must be great than or equal to 1.')
+      end
+
+      if @outcome.nil?
+        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
+      end
+
+      if !@thread_id.nil? && @thread_id.to_s.length > 100
+        invalid_properties.push('invalid value for "thread_id", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@thread_id.nil? && @thread_id.to_s.length < 0
+        invalid_properties.push('invalid value for "thread_id", the character length must be great than or equal to 0.')
+      end
+
+      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'
+      return false if @state_code.nil?
+      return false if @state_code.to_s.length > 2
+      return false if @state_code.to_s.length < 2
+      return false if @attempt_date_time.nil?
+      return false if @method.nil?
+      return false if @committee.nil?
+      return false if @vendor_source.nil?
+      return false if @vendor_source.to_s.length < 1
+      return false if @outcome.nil?
+      return false if !@thread_id.nil? && @thread_id.to_s.length > 100
+      return false if !@thread_id.nil? && @thread_id.to_s.length < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state_code Value to be assigned
+    def state_code=(state_code)
+      if state_code.nil?
+        fail ArgumentError, 'state_code cannot be nil'
+      end
+
+      if state_code.to_s.length > 2
+        fail ArgumentError, 'invalid value for "state_code", the character length must be smaller than or equal to 2.'
+      end
+
+      if state_code.to_s.length < 2
+        fail ArgumentError, 'invalid value for "state_code", the character length must be great than or equal to 2.'
+      end
+
+      @state_code = state_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vendor_source Value to be assigned
+    def vendor_source=(vendor_source)
+      if vendor_source.nil?
+        fail ArgumentError, 'vendor_source cannot be nil'
+      end
+
+      if vendor_source.to_s.length < 1
+        fail ArgumentError, 'invalid value for "vendor_source", the character length must be great than or equal to 1.'
+      end
+
+      @vendor_source = vendor_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] thread_id Value to be assigned
+    def thread_id=(thread_id)
+      if !thread_id.nil? && thread_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "thread_id", the character length must be smaller than or equal to 100.'
+      end
+
+      if !thread_id.nil? && thread_id.to_s.length < 0
+        fail ArgumentError, 'invalid value for "thread_id", the character length must be great than or equal to 0.'
+      end
+
+      @thread_id = thread_id
+    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 &&
+          interaction_id == o.interaction_id &&
+          person == o.person &&
+          contact_info == o.contact_info &&
+          channel == o.channel &&
+          state_code == o.state_code &&
+          attempt_date_time == o.attempt_date_time &&
+          method == o.method &&
+          committee == o.committee &&
+          canvasser == o.canvasser &&
+          vendor_source == o.vendor_source &&
+          outcome == o.outcome &&
+          outcomes_detailed == o.outcomes_detailed &&
+          thread_id == o.thread_id &&
+          json_metadata == o.json_metadata &&
+          van_fields == o.van_fields &&
+          initiative == o.initiative
+    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
+      [interaction_id, person, contact_info, channel, state_code, attempt_date_time, method, committee, canvasser, vendor_source, outcome, outcomes_detailed, thread_id, json_metadata, van_fields, initiative].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = DdxInteractionsApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ddx_interactions_api/models/interaction_dto_channel.rb

@@ -0,0 +1,56 @@
+=begin
+#Interactions API
+
+#Interactions API documentation
+
+The version of the OpenAPI document: v1
+Contact: api@demexchange.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DdxInteractionsApi
+  # Channel-of-contact details used during the outreach attempt.  If the `type` is recognized as an Address Channel (type = \"address\"), the `value` will be deserialized to that object type.  Other string-based types have specific validation documented in the \"Channel\" section below, like \"phone_number\".  If the `type` is unrecognized, the payload will be deserialized to an unvalidated, loosely typed object for flexibility.
+  module InteractionDtoChannel
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'AddressChannelDetails',
+          :'DynamicChannelDetails'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'type'
+      end
+
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+          :'address' => :'AddressChannelDetails',
+          :'example_type' => :'DynamicChannelDetails'
+        }
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        DdxInteractionsApi.const_get(klass).build_from_hash(data)
+      end
+    end
+  end
+
+end

data/lib/ddx_interactions_api/models/interaction_dto_outcomes_detailed_inner.rb

@@ -0,0 +1,61 @@
+=begin
+#Interactions API
+
+#Interactions API documentation
+
+The version of the OpenAPI document: v1
+Contact: api@demexchange.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DdxInteractionsApi
+  module InteractionDtoOutcomesDetailedInner
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ActivistCodeOutcomeDetails',
+          :'CommunicationConsentOutcomeDetails',
+          :'DynamicOutcomeDetails',
+          :'EventSignupOutcomeDetails',
+          :'SurveyResponseOutcomeDetails'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'type'
+      end
+
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+          :'activist_code' => :'ActivistCodeOutcomeDetails',
+          :'communication_consent' => :'CommunicationConsentOutcomeDetails',
+          :'event_signup' => :'EventSignupOutcomeDetails',
+          :'example_type' => :'DynamicOutcomeDetails',
+          :'survey_response' => :'SurveyResponseOutcomeDetails'
+        }
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        DdxInteractionsApi.const_get(klass).build_from_hash(data)
+      end
+    end
+  end
+
+end