mparticle 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c59bf45feea215b236bf3031450f13b739685c16f6ff5097fb926f560207109
-  data.tar.gz: a336485e648f6eeb4fdd605ec4a35a1ba708fe7a1f0a29aa3a918e65edaf1700
+  metadata.gz: 9762788a48567b16db7faaf386973958808cfabeca373df4269b1a45a3906641
+  data.tar.gz: f1ef718e0e8454bfb1eb8589b9133be95b462f6d8edf4d8f4ceec3a0f1592645
 SHA512:
-  metadata.gz: 98ea4f17a4eac71825da5d306ffb1d72f09c3fd12d16a575c17a33b91799ea0f83f208ec887bd49c7f39a724d497afb9712bf162034c85928a5f209613829d8c
-  data.tar.gz: 31570c9055b0a71bd2870e7ed442738f1409f59d66dee7dbf50374a42c2323ca11ecb21364579bc55c78cb7f1d75d7658aa939ca2978fe228efee19fbd47a1bb
+  metadata.gz: 1d13b1ea200c1df11fbb53e2dd152eca13f7bc5b3b90d615f7a9452782b083e80f55c910c70a21bd483bee55aaecf442e83b06a4e463ec1a553552c5c2be2950
+  data.tar.gz: 71421fb7806a281311039f53d627df412953e91151feeb66b80dc3d61edd32eb1bbc05f129901187f055799ca200c239b916b51b8a02b8e05199b927fdd403b6

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/example/main.rb

@@ -51,6 +51,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 +67,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
 

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'

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

data/lib/mparticle/models/consent_state.rb

@@ -3,11 +3,13 @@ require 'date'
 module MParticle
   class ConsentState
     attr_accessor :gdpr
+    attr_accessor :ccpa
 
      # Attribute mapping from ruby-style variable name to JSON key.
      def self.attribute_map
       {
         :'gdpr' => 'gdpr',
+        :'ccpa' => 'ccpa',
       }
     end
 
@@ -15,6 +17,7 @@ module MParticle
     def self.swagger_types
       {
         :'gdpr' => 'Hash',
+        :'ccpa' => 'Hash',
       }
     end
 
@@ -31,6 +34,12 @@ module MParticle
       else
         self.gdpr = {}
       end
+
+      if attributes.has_key?(:'ccpa')
+        self.ccpa = attributes[:'ccpa']
+      else
+        self.ccpa = {}
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?

data/lib/mparticle/version.rb

@@ -1,3 +1,3 @@
 module MParticle
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/mparticle.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "mparticle"
-  s.version     = "1.0.5"
+  s.version     = "1.0.6"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["mParticle Inc."]
   s.email       = ["support@mparticle.com"]

data/spec/models/ccpa_consent_state_spec.rb

@@ -0,0 +1,34 @@
+require 'mparticle'
+
+describe 'CCPAConsentState' do
+  it 'should create an instance of CCPAConsentState' do
+    model = MParticle::CCPAConsentState.new
+    expect(model).to be_an_instance_of MParticle::CCPAConsentState
+  end
+
+  it 'should have the property consented (base name: "consented")' do
+    model = MParticle::CCPAConsentState.new
+    model.consented = true
+    expect(model.consented).to eq true
+  end
+
+  it 'should have the property timestamp_unixtime_ms {base name: "timestamp_unixtime_ms" }' do
+    now = Time.now.to_i
+    model = MParticle::CCPAConsentState.new
+    model.timestamp_unixtime_ms = now
+    expect(model.timestamp_unixtime_ms).to eq now
+  end
+
+  it 'should have the property location {base name: "location" }' do
+    model = MParticle::CCPAConsentState.new
+    model.location =  'dtmgbank.com/signup'
+    expect(model.location).to eq 'dtmgbank.com/signup'
+  end
+
+  it 'should have the property hardware_id {base name: "hardware_id" }' do
+    model = MParticle::CCPAConsentState.new
+    model.hardware_id = 'IDFA:a5d934n0-232f-4afc-2e9a-3832d95zc702'
+    expect(model.hardware_id).to eq 'IDFA:a5d934n0-232f-4afc-2e9a-3832d95zc702'
+  end
+
+end

data/spec/models/consent_state_spec.rb

@@ -11,4 +11,9 @@ describe 'ConsentState' do
     expect(model).to have_attributes(:gdpr => {})
   end
 
+  it 'should have the property ccpa (base name: "ccpa")' do
+    model = MParticle::ConsentState.new
+    expect(model).to have_attributes(:ccpa => {})
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mparticle
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - mParticle Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -68,6 +68,7 @@ files:
 - docs/AttributionInfo.md
 - docs/Batch.md
 - docs/BreadcrumbEvent.md
+- docs/CCPAConsentState.md
 - docs/CommerceEvent.md
 - docs/ConsentState.md
 - docs/CrashReportEvent.md
@@ -110,6 +111,7 @@ files:
 - lib/mparticle/models/attribution_info.rb
 - lib/mparticle/models/batch.rb
 - lib/mparticle/models/breadcrumb_event.rb
+- lib/mparticle/models/ccpa_consent_state.rb
 - lib/mparticle/models/commerce_event.rb
 - lib/mparticle/models/consent_state.rb
 - lib/mparticle/models/crash_report_event.rb
@@ -139,8 +141,10 @@ files:
 - lib/mparticle/models/user_identities.rb
 - lib/mparticle/version.rb
 - mparticle-1.0.4.gem
+- mparticle-1.0.5.gem
 - mparticle.gemspec
 - spec/models/app_event_spec.rb
+- spec/models/ccpa_consent_state_spec.rb
 - spec/models/commerce_event_spec.rb
 - spec/models/consent_state_spec.rb
 - spec/models/gdpr_consent_state_spec.rb