mparticle 1.0.5 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c59bf45feea215b236bf3031450f13b739685c16f6ff5097fb926f560207109
-  data.tar.gz: a336485e648f6eeb4fdd605ec4a35a1ba708fe7a1f0a29aa3a918e65edaf1700
+  metadata.gz: 3b4b30c931a78c920091ae233dda6a478d5f2fbf9b57ca4470a8ee4d1fd866d1
+  data.tar.gz: 4a8f7748c45ab84b9a180c84001379b0d102b9b973c2b302ed1de367afcc3ccd
 SHA512:
-  metadata.gz: 98ea4f17a4eac71825da5d306ffb1d72f09c3fd12d16a575c17a33b91799ea0f83f208ec887bd49c7f39a724d497afb9712bf162034c85928a5f209613829d8c
-  data.tar.gz: 31570c9055b0a71bd2870e7ed442738f1409f59d66dee7dbf50374a42c2323ca11ecb21364579bc55c78cb7f1d75d7658aa939ca2978fe228efee19fbd47a1bb
+  metadata.gz: 54b7b4841fec9dbac24534a31fcc003b360e3d49a165d9d330116b291005f9be7b85f6161387c7fc8f4351c0a2d0c867c1a36c2c14d3d8b5ff590e1b480a8403
+  data.tar.gz: 6aa790099163be36dfc190374048755bd905ae8d9b3476ffc1ca0687423a0e15f8f7b5926fbe766dba59ea8c620ce090dcc1fe9122c1e44bea843ade1d16743c

data/README.md

@@ -41,6 +41,11 @@ api_instance = MParticle::EventsApi.new(config)
 
 batch = MParticle::Batch.new
 batch.environment = 'development'
+batch.context =  MParticle::BatchContext.new
+
+batch.context.data_plan =  MParticle::DataPlanContext.new
+batch.context.data_plan.plan_id =  'my_plan_id'
+batch.context.data_plan.plan_version =  1
 
 user_identities = MParticle::UserIdentities.new
 user_identities.customerid = '12345'

data/docs/Batch.md

@@ -18,3 +18,6 @@
 | **api_key**                 | **String**                                              |             | [optional] |
 | **mpid**                    | **Integer**                                             |             | [optional] |
 | **mp_deviceid**             | **String**                                              |             | [optional] |
+| **timestamp_unixtime_ms**   | **Integer**                                             |             | [optional] |
+| **context**                 | [**BatchContext**](BatchContext.md)                     |             | [optional] |
+| **integration_attributes**  | **Hash<Integer,Hash<String,String>>**                          |             | [optional] |

data/docs/CCPAConsentState.md

@@ -0,0 +1,10 @@
+# mParticle.CCPAConsentState
+
+## Properties
+
+| Name                      | Type        | Description | Notes |
+| ------------------------- | ----------- | ----------- | ----- |
+| **consented**             | **Boolean** |             |       |
+| **timestamp_unixtime_ms** | **Number**  |             |       |
+| **location**              | **String**  |             |       |
+| **hardware_id**           | **String**  |             |       |

data/docs/ConsentState.md

@@ -2,6 +2,7 @@
 
 ## Properties
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
+| Name      | Type     | Description | Notes |
+| --------- | -------- | ----------- | ----- |
+| **gdpr ** | **Hash** |             |       |
+| **ccpa ** | **Hash** |             |       |

data/docs/UserIdentities.md

@@ -13,5 +13,17 @@ Name | Type | Description | Notes
 **email** | **String** |  | [optional] 
 **_alias** | **String** |  | [optional] 
 **facebook_custom_audience_id** | **String** |  | [optional] 
+**other_id_2** | **String** |  | [optional] 
+**other_id_3** | **String** |  | [optional] 
+**other_id_4** | **String** |  | [optional] 
+**other_id_5** | **String** |  | [optional] 
+**other_id_6** | **String** |  | [optional] 
+**other_id_7** | **String** |  | [optional] 
+**other_id_8** | **String** |  | [optional] 
+**other_id_9** | **String** |  | [optional] 
+**other_id_10** | **String** |  | [optional] 
+**mobile_number** | **String** |  | [optional] 
+**phone_number_2** | **String** |  | [optional] 
+**phone_number_3** | **String** |  | [optional] 
 
 

data/example/main.rb

@@ -2,6 +2,7 @@
 
 # load the gem
 require 'mparticle'
+require 'date'
 config = MParticle::Configuration.new
 config.api_key = 'REPLACE WITH API KEY'
 config.api_secret = 'REPLACE WITH API SECRET'
@@ -10,6 +11,7 @@ config.api_secret = 'REPLACE WITH API SECRET'
 api_instance = MParticle::EventsApi.new(config)
 
 batch = MParticle::Batch.new
+batch.timestamp_unixtime_ms = DateTime.now.strftime('%Q').to_i
 batch.environment = 'development'
 
 user_identities = MParticle::UserIdentities.new
@@ -51,6 +53,13 @@ commerce_event = {
 batch.events = [MParticle::SessionStartEvent.new, app_event, MParticle::SessionEndEvent.new]
 batch.user_identities = user_identities
 
+ccpa_consent_state = MParticle::CCPAConsentState.new
+ccpa_consent_state.document = 'document.agreement.v3'
+ccpa_consent_state.consented = true
+ccpa_consent_state.timestamp_unixtime_ms = Time.now.to_i
+ccpa_consent_state.location = 'mparticle.test/signup'
+ccpa_consent_state.hardware_id = 'IDFA:a5d96n32-224a-3b11-1088-a202695bc710'
+
 gdpr_consent_state = MParticle::GDPRConsentState.new
 gdpr_consent_state.document = 'document_agreement.v2'
 gdpr_consent_state.consented = true
@@ -60,8 +69,9 @@ gdpr_consent_state.hardware_id = 'IDFA:a5d934n0-232f-4afc-2e9a-3832d95zc702'
 
 consent_state = MParticle::ConsentState.new
 # Make sure this purpose matches your consent purpose in
-# Setup > GDPR Settings
-# https://docs.mparticle.com/guides/consent-management/#enabling-gdpr-consent-management
+# Workspace Settings > Workspace > Regulations
+# https://docs.mparticle.com/guides/consent-management/
+consent_state.ccpa = { 'data_sale_opt_out' => ccpa_consent_state }
 consent_state.gdpr = { 'document_agreement' => gdpr_consent_state }
 batch.consent_state = consent_state
 
@@ -78,5 +88,5 @@ begin
   # wait for the thread, otherwise process may exit too early
   thread.join
 rescue MParticle::ApiError => e
-  puts "Exception when calling mParticle: #{e}"
+  puts "Exception when calling mParticle: #{e.response_body}"
 end

data/lib/mparticle.rb

@@ -13,6 +13,7 @@ require 'mparticle/models/application_state_transition_event'
 require 'mparticle/models/attribution_info'
 require 'mparticle/models/batch'
 require 'mparticle/models/breadcrumb_event'
+require 'mparticle/models/ccpa_consent_state'
 require 'mparticle/models/commerce_event'
 require 'mparticle/models/consent_state'
 require 'mparticle/models/crash_report_event'
@@ -40,6 +41,8 @@ require 'mparticle/models/session_start_event'
 require 'mparticle/models/shopping_cart'
 require 'mparticle/models/source_information'
 require 'mparticle/models/user_identities'
+require 'mparticle/models/batch_context'
+require 'mparticle/models/data_plan_context'
 
 # APIs
 require 'mparticle/api/events_api'

data/lib/mparticle/api_client.rb

@@ -19,7 +19,7 @@ module MParticle
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config)
       @config = config
-      @user_agent = "mParticle Ruby client/1.0.3"
+      @user_agent = "mParticle Ruby client/1.0.10"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

data/lib/mparticle/models/batch.rb

@@ -31,6 +31,12 @@ module MParticle
 
     attr_accessor :mp_deviceid
 
+    attr_accessor :timestamp_unixtime_ms
+
+    attr_accessor :context
+
+    attr_accessor :integration_attributes
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -109,7 +115,10 @@ module MParticle
         :'user_identities' => :'user_identities',
         :'api_key' => :'api_key',
         :'mpid' => :'mpid',
-        :'mp_deviceid' => :'mp_deviceid'
+        :'mp_deviceid' => :'mp_deviceid',
+        :'timestamp_unixtime_ms' => :'timestamp_unixtime_ms',
+        :'context' => :'context',
+        :'integration_attributes' => :'integration_attributes'
       }
     end
 
@@ -128,7 +137,11 @@ module MParticle
         :'user_identities' => :'UserIdentities',
         :'api_key' => :'String',
         :'mpid' => :'Integer',
-        :'mp_deviceid' => :'String'
+        :'mp_deviceid' => :'String',
+        :'timestamp_unixtime_ms' => :'Integer',
+        :'consent_state' => :'ConsentState',
+        :'context' => :'BatchContext',
+        :'integration_attributes' => :'Hash<Integer,Hash<String,String>>'
       }
     end
 
@@ -196,6 +209,22 @@ module MParticle
         self.mp_deviceid = attributes[:'mp_deviceid']
       end
 
+      if attributes.has_key?(:'timestamp_unixtime_ms')
+        self.timestamp_unixtime_ms = attributes[:'timestamp_unixtime_ms']
+      end
+
+      if attributes.has_key?(:'consent_state')
+        self.consent_state = attributes[:'consent_state']
+      end
+
+      if attributes.has_key?(:'context')
+        self.context = attributes[:'context']
+      end
+      
+      if attributes.has_key?(:'integration_attributes')
+        self.integration_attributes = attributes[:'integration_attributes']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -245,7 +274,9 @@ module MParticle
           user_identities == o.user_identities &&
           api_key == o.api_key &&
           mpid == o.mpid &&
-          mp_deviceid == o.mp_deviceid
+          mp_deviceid == o.mp_deviceid &&
+          timestamp_unixtime_ms == o.timestamp_unixtime_ms &&
+          integration_attributes == o.integration_attributes
     end
 
     # @see the `==` method
@@ -257,7 +288,7 @@ module MParticle
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [events, source_request_id, environment, ip, schema_version, device_info, application_info, user_attributes, deleted_user_attributes, user_identities, api_key, mpid, mp_deviceid].hash
+      [events, source_request_id, environment, ip, schema_version, device_info, application_info, user_attributes, deleted_user_attributes, user_identities, api_key, mpid, mp_deviceid, timestamp_unixtime_ms, integration_attributes].hash
     end
 
     # Builds the object from hash

data/lib/mparticle/models/batch_context.rb

@@ -0,0 +1,177 @@
+require 'date'
+
+module MParticle
+
+  class BatchContext
+    attr_accessor :data_plan
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data_plan' => :'data_plan'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data_plan' => :'DataPlanContext'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'data_plan')
+        self.data_plan = attributes[:'data_plan']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return true
+    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 &&
+          data_plan == o.data_plan
+          
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [data_plan].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = MParticle.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/mparticle/models/ccpa_consent_state.rb

@@ -0,0 +1,233 @@
+module MParticle
+  class CCPAConsentState
+    attr_accessor :document
+    attr_accessor :consented
+    attr_accessor :timestamp_unixtime_ms 
+    attr_accessor :location
+    attr_accessor :hardware_id
+
+     # Attribute mapping from ruby-style variable name to JSON key.
+     def self.attribute_map
+      {
+        :'document' => 'document',
+        :'consented' => 'consented',
+        :'timestamp_unixtime_ms' => 'timestamp_unixtime_ms', 
+        :'location' => 'location',
+        :'hardware_id' => 'hardware_id',
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'document' => 'String',
+        :'consented' => 'Boolean',
+        :'timestamp_unixtime_ms' => 'Integer', 
+        :'location' => 'String',
+        :'hardware_id' => 'String',
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'document')
+        self.document = attributes[:'document']
+      end
+
+      if attributes.has_key?(:'consented')
+        self.consented = attributes[:'consented']
+      end
+
+      if attributes.has_key?(:'timestamp_unixtime_ms')
+        self.timestamp_unixtime_ms = attributes[:'timestamp_unixtime_ms']
+      end
+
+      if attributes.has_key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.has_key?(:'hardware_id')
+        self.hardware_id = attributes[:'hardware_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+
+      if @document.nil?
+        invalid_properties.push("invalid value for 'document', document cannot be nil.")
+      end
+
+      if @consented.nil?
+        invalid_properties.push("invalid value for 'consented', consented cannot be nil.")
+      end
+
+      if @timestamp_unixtime_ms.nil?
+        invalid_properties.push("invalid value for 'timestamp_unixtime_ms', timestamp_unixtime_ms cannot be nil.")
+      end
+
+      if @location.nil?
+        invalid_properties.push("invalid value for 'location', location cannot be nil.")
+      end
+
+      if @hardware_id.nil?
+        invalid_properties.push("invalid value for 'hardware_id', hardware_id cannot be nil.")
+      end
+
+      return 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?
+      return false if @document.nil?
+      return false if @consented.nil?
+      return false if @timestamp_unixtime_ms.nil?
+      return false if @location.nil?
+      return false if @hardware_id.nil?
+      return true
+    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 &&
+          document == o.document &&
+          consented == o.consented &&
+          timestamp_unixtime_ms == o.timestamp_unixtime_ms &&
+          location == o.location &&
+          hardware_id == o.hardware_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [
+        document,
+        consented,
+        timestamp_unixtime_ms,
+        location,
+        hardware_id,
+      ].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = MParticle.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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