plainrouter-sdk 0.1.1 → 0.5.0

data/lib/plainrouter/openapi/models/destination_status.rb

@@ -1,7 +1,7 @@
 =begin
-#PlainRouter Conversion API
+#Plainrouter Conversion API
 
-#PlainRouter public Signals Conversion API.
+#Plainrouter public Signals Conversion API.
 
 The version of the OpenAPI document: 0.5.0
 

data/lib/plainrouter/openapi/models/destination_type.rb

@@ -1,7 +1,7 @@
 =begin
-#PlainRouter Conversion API
+#Plainrouter Conversion API
 
-#PlainRouter public Signals Conversion API.
+#Plainrouter public Signals Conversion API.
 
 The version of the OpenAPI document: 0.5.0
 
@@ -16,9 +16,10 @@ require 'time'
 module PlainRouter::OpenAPI
   class DestinationType
     META = "meta".freeze
+    GOOGLE_ADS = "google_ads".freeze
 
     def self.all_vars
-      @all_vars ||= [META].freeze
+      @all_vars ||= [META, GOOGLE_ADS].freeze
     end
 
     # Builds the enum from string

data/lib/plainrouter/openapi/models/emq_snapshot.rb

@@ -1,7 +1,7 @@
 =begin
-#PlainRouter Conversion API
+#Plainrouter Conversion API
 
-#PlainRouter public Signals Conversion API.
+#Plainrouter public Signals Conversion API.
 
 The version of the OpenAPI document: 0.5.0
 
@@ -17,6 +17,9 @@ module PlainRouter::OpenAPI
   class EmqSnapshot < ApiModelBase
     attr_accessor :id
 
+    attr_accessor :workspace_id
+
+    # Deprecated alias of workspace_id; contains the workspace ID in decimal string form.
     attr_accessor :signal_tracker_id
 
     attr_accessor :destination_id
@@ -39,6 +42,7 @@ module PlainRouter::OpenAPI
     def self.attribute_map
       {
         :'id' => :'id',
+        :'workspace_id' => :'workspace_id',
         :'signal_tracker_id' => :'signal_tracker_id',
         :'destination_id' => :'destination_id',
         :'score' => :'score',
@@ -65,6 +69,7 @@ module PlainRouter::OpenAPI
     def self.openapi_types
       {
         :'id' => :'Integer',
+        :'workspace_id' => :'Integer',
         :'signal_tracker_id' => :'String',
         :'destination_id' => :'String',
         :'score' => :'Float',
@@ -109,6 +114,12 @@ module PlainRouter::OpenAPI
         self.id = nil
       end
 
+      if attributes.key?(:'workspace_id')
+        self.workspace_id = attributes[:'workspace_id']
+      else
+        self.workspace_id = nil
+      end
+
       if attributes.key?(:'signal_tracker_id')
         self.signal_tracker_id = attributes[:'signal_tracker_id']
       else
@@ -175,6 +186,10 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
+      if @workspace_id.nil?
+        invalid_properties.push('invalid value for "workspace_id", workspace_id cannot be nil.')
+      end
+
       if @signal_tracker_id.nil?
         invalid_properties.push('invalid value for "signal_tracker_id", signal_tracker_id cannot be nil.')
       end
@@ -203,6 +218,7 @@ module PlainRouter::OpenAPI
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
+      return false if @workspace_id.nil?
       return false if @signal_tracker_id.nil?
       return false if @destination_id.nil?
       return false if @score.nil?
@@ -221,6 +237,16 @@ module PlainRouter::OpenAPI
       @id = id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] workspace_id Value to be assigned
+    def workspace_id=(workspace_id)
+      if workspace_id.nil?
+        fail ArgumentError, 'workspace_id cannot be nil'
+      end
+
+      @workspace_id = workspace_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] signal_tracker_id Value to be assigned
     def signal_tracker_id=(signal_tracker_id)
@@ -277,6 +303,7 @@ module PlainRouter::OpenAPI
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          workspace_id == o.workspace_id &&
           signal_tracker_id == o.signal_tracker_id &&
           destination_id == o.destination_id &&
           score == o.score &&
@@ -297,7 +324,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, signal_tracker_id, destination_id, score, week_over_week_change, alerted, platform_response, measured_at, created_at, updated_at].hash
+      [id, workspace_id, signal_tracker_id, destination_id, score, week_over_week_change, alerted, platform_response, measured_at, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/plainrouter/openapi/models/error_message.rb

@@ -1,7 +1,7 @@
 =begin
-#PlainRouter Conversion API
+#Plainrouter Conversion API
 
-#PlainRouter public Signals Conversion API.
+#Plainrouter public Signals Conversion API.
 
 The version of the OpenAPI document: 0.5.0
 

data/lib/plainrouter/openapi/models/event.rb

@@ -1,7 +1,7 @@
 =begin
-#PlainRouter Conversion API
+#Plainrouter Conversion API
 
-#PlainRouter public Signals Conversion API.
+#Plainrouter public Signals Conversion API.
 
 The version of the OpenAPI document: 0.5.0
 
@@ -17,8 +17,6 @@ module PlainRouter::OpenAPI
   class Event < ApiModelBase
     attr_accessor :id
 
-    attr_accessor :signal_tracker_id
-
     attr_accessor :parent_event_id
 
     attr_accessor :event_name
@@ -51,6 +49,8 @@ module PlainRouter::OpenAPI
 
     attr_accessor :traffic_class
 
+    attr_accessor :workspace_id
+
     attr_accessor :consent
 
     attr_accessor :user_data_hashed
@@ -65,6 +65,10 @@ module PlainRouter::OpenAPI
 
     attr_accessor :payload_expired
 
+    attr_accessor :consent_source
+
+    attr_accessor :consent_ui_version
+
     attr_accessor :deliveries
 
     class EnumAttributeValidator
@@ -93,7 +97,6 @@ module PlainRouter::OpenAPI
     def self.attribute_map
       {
         :'id' => :'id',
-        :'signal_tracker_id' => :'signal_tracker_id',
         :'parent_event_id' => :'parent_event_id',
         :'event_name' => :'event_name',
         :'event_time' => :'event_time',
@@ -110,6 +113,7 @@ module PlainRouter::OpenAPI
         :'consent_normalization_version' => :'consent_normalization_version',
         :'policy_class' => :'policy_class',
         :'traffic_class' => :'traffic_class',
+        :'workspace_id' => :'workspace_id',
         :'consent' => :'consent',
         :'user_data_hashed' => :'user_data_hashed',
         :'click_ids' => :'click_ids',
@@ -117,6 +121,8 @@ module PlainRouter::OpenAPI
         :'value_data' => :'value_data',
         :'event_source' => :'event_source',
         :'payload_expired' => :'payload_expired',
+        :'consent_source' => :'consent_source',
+        :'consent_ui_version' => :'consent_ui_version',
         :'deliveries' => :'deliveries'
       }
     end
@@ -135,7 +141,6 @@ module PlainRouter::OpenAPI
     def self.openapi_types
       {
         :'id' => :'String',
-        :'signal_tracker_id' => :'String',
         :'parent_event_id' => :'String',
         :'event_name' => :'String',
         :'event_time' => :'Time',
@@ -152,13 +157,16 @@ module PlainRouter::OpenAPI
         :'consent_normalization_version' => :'String',
         :'policy_class' => :'JurisdictionPolicyClass',
         :'traffic_class' => :'TrafficClass',
+        :'workspace_id' => :'Integer',
         :'consent' => :'String',
-        :'user_data_hashed' => :'String',
+        :'user_data_hashed' => :'GetEvent200ResponseEventUserDataHashed',
         :'click_ids' => :'String',
         :'session' => :'String',
         :'value_data' => :'String',
         :'event_source' => :'String',
         :'payload_expired' => :'Boolean',
+        :'consent_source' => :'String',
+        :'consent_ui_version' => :'Integer',
         :'deliveries' => :'Array<Object>'
       }
     end
@@ -170,6 +178,7 @@ module PlainRouter::OpenAPI
         :'order_id',
         :'value_amount',
         :'value_currency',
+        :'user_data_hashed',
       ])
     end
 
@@ -195,12 +204,6 @@ module PlainRouter::OpenAPI
         self.id = nil
       end
 
-      if attributes.key?(:'signal_tracker_id')
-        self.signal_tracker_id = attributes[:'signal_tracker_id']
-      else
-        self.signal_tracker_id = nil
-      end
-
       if attributes.key?(:'parent_event_id')
         self.parent_event_id = attributes[:'parent_event_id']
       else
@@ -297,6 +300,12 @@ module PlainRouter::OpenAPI
         self.traffic_class = nil
       end
 
+      if attributes.key?(:'workspace_id')
+        self.workspace_id = attributes[:'workspace_id']
+      else
+        self.workspace_id = nil
+      end
+
       if attributes.key?(:'consent')
         self.consent = attributes[:'consent']
       else
@@ -339,6 +348,14 @@ module PlainRouter::OpenAPI
         self.payload_expired = nil
       end
 
+      if attributes.key?(:'consent_source')
+        self.consent_source = attributes[:'consent_source']
+      end
+
+      if attributes.key?(:'consent_ui_version')
+        self.consent_ui_version = attributes[:'consent_ui_version']
+      end
+
       if attributes.key?(:'deliveries')
         if (value = attributes[:'deliveries']).is_a?(Array)
           self.deliveries = value
@@ -357,10 +374,6 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @signal_tracker_id.nil?
-        invalid_properties.push('invalid value for "signal_tracker_id", signal_tracker_id cannot be nil.')
-      end
-
       if @event_name.nil?
         invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
       end
@@ -409,12 +422,12 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "traffic_class", traffic_class cannot be nil.')
       end
 
-      if @consent.nil?
-        invalid_properties.push('invalid value for "consent", consent cannot be nil.')
+      if @workspace_id.nil?
+        invalid_properties.push('invalid value for "workspace_id", workspace_id cannot be nil.')
       end
 
-      if @user_data_hashed.nil?
-        invalid_properties.push('invalid value for "user_data_hashed", user_data_hashed cannot be nil.')
+      if @consent.nil?
+        invalid_properties.push('invalid value for "consent", consent cannot be nil.')
       end
 
       if @click_ids.nil?
@@ -437,6 +450,14 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "payload_expired", payload_expired cannot be nil.')
       end
 
+      if !@consent_ui_version.nil? && @consent_ui_version > 999999
+        invalid_properties.push('invalid value for "consent_ui_version", must be smaller than or equal to 999999.')
+      end
+
+      if !@consent_ui_version.nil? && @consent_ui_version < 1
+        invalid_properties.push('invalid value for "consent_ui_version", must be greater than or equal to 1.')
+      end
+
       if @deliveries.nil?
         invalid_properties.push('invalid value for "deliveries", deliveries cannot be nil.')
       end
@@ -449,7 +470,6 @@ module PlainRouter::OpenAPI
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
-      return false if @signal_tracker_id.nil?
       return false if @event_name.nil?
       return false if @event_time.nil?
       return false if @action_source.nil?
@@ -462,13 +482,17 @@ module PlainRouter::OpenAPI
       return false if @consent_normalization_version.nil?
       return false if @policy_class.nil?
       return false if @traffic_class.nil?
+      return false if @workspace_id.nil?
       return false if @consent.nil?
-      return false if @user_data_hashed.nil?
       return false if @click_ids.nil?
       return false if @session.nil?
       return false if @value_data.nil?
       return false if @event_source.nil?
       return false if @payload_expired.nil?
+      consent_source_validator = EnumAttributeValidator.new('String', ["explicit", "tcf", "consent_mode", "plainrouter", "cmp:cookiebot", "cmp:usercentrics", "cmp:cookieyes", "cmp:consentstack", "cmp:iubenda"])
+      return false unless consent_source_validator.valid?(@consent_source)
+      return false if !@consent_ui_version.nil? && @consent_ui_version > 999999
+      return false if !@consent_ui_version.nil? && @consent_ui_version < 1
       return false if @deliveries.nil?
       true
     end
@@ -483,16 +507,6 @@ module PlainRouter::OpenAPI
       @id = id
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] signal_tracker_id Value to be assigned
-    def signal_tracker_id=(signal_tracker_id)
-      if signal_tracker_id.nil?
-        fail ArgumentError, 'signal_tracker_id cannot be nil'
-      end
-
-      @signal_tracker_id = signal_tracker_id
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] event_name Value to be assigned
     def event_name=(event_name)
@@ -614,23 +628,23 @@ module PlainRouter::OpenAPI
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] consent Value to be assigned
-    def consent=(consent)
-      if consent.nil?
-        fail ArgumentError, 'consent cannot be nil'
+    # @param [Object] workspace_id Value to be assigned
+    def workspace_id=(workspace_id)
+      if workspace_id.nil?
+        fail ArgumentError, 'workspace_id cannot be nil'
       end
 
-      @consent = consent
+      @workspace_id = workspace_id
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] user_data_hashed Value to be assigned
-    def user_data_hashed=(user_data_hashed)
-      if user_data_hashed.nil?
-        fail ArgumentError, 'user_data_hashed cannot be nil'
+    # @param [Object] consent Value to be assigned
+    def consent=(consent)
+      if consent.nil?
+        fail ArgumentError, 'consent cannot be nil'
       end
 
-      @user_data_hashed = user_data_hashed
+      @consent = consent
     end
 
     # Custom attribute writer method with validation
@@ -683,6 +697,34 @@ module PlainRouter::OpenAPI
       @payload_expired = payload_expired
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] consent_source Object to be assigned
+    def consent_source=(consent_source)
+      validator = EnumAttributeValidator.new('String', ["explicit", "tcf", "consent_mode", "plainrouter", "cmp:cookiebot", "cmp:usercentrics", "cmp:cookieyes", "cmp:consentstack", "cmp:iubenda"])
+      unless validator.valid?(consent_source)
+        fail ArgumentError, "invalid value for \"consent_source\", must be one of #{validator.allowable_values}."
+      end
+      @consent_source = consent_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] consent_ui_version Value to be assigned
+    def consent_ui_version=(consent_ui_version)
+      if consent_ui_version.nil?
+        fail ArgumentError, 'consent_ui_version cannot be nil'
+      end
+
+      if consent_ui_version > 999999
+        fail ArgumentError, 'invalid value for "consent_ui_version", must be smaller than or equal to 999999.'
+      end
+
+      if consent_ui_version < 1
+        fail ArgumentError, 'invalid value for "consent_ui_version", must be greater than or equal to 1.'
+      end
+
+      @consent_ui_version = consent_ui_version
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] deliveries Value to be assigned
     def deliveries=(deliveries)
@@ -699,7 +741,6 @@ module PlainRouter::OpenAPI
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          signal_tracker_id == o.signal_tracker_id &&
           parent_event_id == o.parent_event_id &&
           event_name == o.event_name &&
           event_time == o.event_time &&
@@ -716,6 +757,7 @@ module PlainRouter::OpenAPI
           consent_normalization_version == o.consent_normalization_version &&
           policy_class == o.policy_class &&
           traffic_class == o.traffic_class &&
+          workspace_id == o.workspace_id &&
           consent == o.consent &&
           user_data_hashed == o.user_data_hashed &&
           click_ids == o.click_ids &&
@@ -723,6 +765,8 @@ module PlainRouter::OpenAPI
           value_data == o.value_data &&
           event_source == o.event_source &&
           payload_expired == o.payload_expired &&
+          consent_source == o.consent_source &&
+          consent_ui_version == o.consent_ui_version &&
           deliveries == o.deliveries
     end
 
@@ -735,7 +779,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, signal_tracker_id, parent_event_id, event_name, event_time, action_source, event_class, order_id, value_amount, value_currency, created_at, consent_basis, measurement_class, attribution_join, enforcement_scope, consent_normalization_version, policy_class, traffic_class, consent, user_data_hashed, click_ids, session, value_data, event_source, payload_expired, deliveries].hash
+      [id, parent_event_id, event_name, event_time, action_source, event_class, order_id, value_amount, value_currency, created_at, consent_basis, measurement_class, attribution_join, enforcement_scope, consent_normalization_version, policy_class, traffic_class, workspace_id, consent, user_data_hashed, click_ids, session, value_data, event_source, payload_expired, consent_source, consent_ui_version, deliveries].hash
     end
 
     # Builds the object from hash

data/lib/plainrouter/openapi/models/execute_deployment_plan_request.rb

@@ -0,0 +1,200 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class ExecuteDeploymentPlanRequest < ApiModelBase
+    attr_accessor :review_version
+
+    attr_accessor :intent_key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'review_version' => :'review_version',
+        :'intent_key' => :'intent_key'
+      }
+    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
+      {
+        :'review_version' => :'String',
+        :'intent_key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'intent_key'
+      ])
+    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 `PlainRouter::OpenAPI::ExecuteDeploymentPlanRequest` 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 `PlainRouter::OpenAPI::ExecuteDeploymentPlanRequest`. 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?(:'review_version')
+        self.review_version = attributes[:'review_version']
+      else
+        self.review_version = nil
+      end
+
+      if attributes.key?(:'intent_key')
+        self.intent_key = attributes[:'intent_key']
+      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 @review_version.nil?
+        invalid_properties.push('invalid value for "review_version", review_version cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^[a-f0-9]{64}$/)
+      if @review_version !~ pattern
+        invalid_properties.push("invalid value for \"review_version\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@intent_key.nil? && @intent_key.to_s.length > 240
+        invalid_properties.push('invalid value for "intent_key", the character length must be smaller than or equal to 240.')
+      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 @review_version.nil?
+      return false if @review_version !~ Regexp.new(/^[a-f0-9]{64}$/)
+      return false if !@intent_key.nil? && @intent_key.to_s.length > 240
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] review_version Value to be assigned
+    def review_version=(review_version)
+      if review_version.nil?
+        fail ArgumentError, 'review_version cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[a-f0-9]{64}$/)
+      if review_version !~ pattern
+        fail ArgumentError, "invalid value for \"review_version\", must conform to the pattern #{pattern}."
+      end
+
+      @review_version = review_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] intent_key Value to be assigned
+    def intent_key=(intent_key)
+      if !intent_key.nil? && intent_key.to_s.length > 240
+        fail ArgumentError, 'invalid value for "intent_key", the character length must be smaller than or equal to 240.'
+      end
+
+      @intent_key = intent_key
+    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 &&
+          review_version == o.review_version &&
+          intent_key == o.intent_key
+    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
+      [review_version, intent_key].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