plainrouter-sdk 0.2.0 → 0.6.0

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

@@ -0,0 +1,276 @@
+=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 ActionCurrentDispositionOutcomePayloadMetricsAnyOf < ApiModelBase
+    attr_accessor :scope
+
+    # Three whole days in the ad account timezone; excludes the change day.
+    attr_accessor :days
+
+    attr_accessor :currency
+
+    attr_accessor :timezone
+
+    # Decimal spend in ISO currency minor units; null when daily mirror data is missing.
+    attr_accessor :spend_minor
+
+    # Arrivals counted by PlainRouter through Signals, never provider conversions.
+    attr_accessor :counted_arrivals
+
+    # Spend divided by counted arrivals, in ISO currency minor units, displayed to six decimal places.
+    attr_accessor :cost_per_counted_arrival_minor
+
+    attr_accessor :verdict
+
+    attr_accessor :loss_threshold_percent
+
+    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
+      {
+        :'scope' => :'scope',
+        :'days' => :'days',
+        :'currency' => :'currency',
+        :'timezone' => :'timezone',
+        :'spend_minor' => :'spend_minor',
+        :'counted_arrivals' => :'counted_arrivals',
+        :'cost_per_counted_arrival_minor' => :'cost_per_counted_arrival_minor',
+        :'verdict' => :'verdict',
+        :'loss_threshold_percent' => :'loss_threshold_percent'
+      }
+    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
+      {
+        :'scope' => :'String',
+        :'days' => :'Array<Date>',
+        :'currency' => :'String',
+        :'timezone' => :'String',
+        :'spend_minor' => :'String',
+        :'counted_arrivals' => :'Integer',
+        :'cost_per_counted_arrival_minor' => :'String',
+        :'verdict' => :'String',
+        :'loss_threshold_percent' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'currency',
+        :'spend_minor',
+        :'counted_arrivals',
+        :'cost_per_counted_arrival_minor',
+        :'verdict',
+      ])
+    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::ActionCurrentDispositionOutcomePayloadMetricsAnyOf` 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::ActionCurrentDispositionOutcomePayloadMetricsAnyOf`. 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?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.key?(:'days')
+        if (value = attributes[:'days']).is_a?(Array)
+          self.days = value
+        end
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'spend_minor')
+        self.spend_minor = attributes[:'spend_minor']
+      end
+
+      if attributes.key?(:'counted_arrivals')
+        self.counted_arrivals = attributes[:'counted_arrivals']
+      end
+
+      if attributes.key?(:'cost_per_counted_arrival_minor')
+        self.cost_per_counted_arrival_minor = attributes[:'cost_per_counted_arrival_minor']
+      end
+
+      if attributes.key?(:'verdict')
+        self.verdict = attributes[:'verdict']
+      end
+
+      if attributes.key?(:'loss_threshold_percent')
+        self.loss_threshold_percent = attributes[:'loss_threshold_percent']
+      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'
+      scope_validator = EnumAttributeValidator.new('String', ["target", "rest_of_account"])
+      return false unless scope_validator.valid?(@scope)
+      verdict_validator = EnumAttributeValidator.new('String', ["held", "lost", "not_judged"])
+      return false unless verdict_validator.valid?(@verdict)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scope Object to be assigned
+    def scope=(scope)
+      validator = EnumAttributeValidator.new('String', ["target", "rest_of_account"])
+      unless validator.valid?(scope)
+        fail ArgumentError, "invalid value for \"scope\", must be one of #{validator.allowable_values}."
+      end
+      @scope = scope
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] verdict Object to be assigned
+    def verdict=(verdict)
+      validator = EnumAttributeValidator.new('String', ["held", "lost", "not_judged"])
+      unless validator.valid?(verdict)
+        fail ArgumentError, "invalid value for \"verdict\", must be one of #{validator.allowable_values}."
+      end
+      @verdict = verdict
+    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 &&
+          scope == o.scope &&
+          days == o.days &&
+          currency == o.currency &&
+          timezone == o.timezone &&
+          spend_minor == o.spend_minor &&
+          counted_arrivals == o.counted_arrivals &&
+          cost_per_counted_arrival_minor == o.cost_per_counted_arrival_minor &&
+          verdict == o.verdict &&
+          loss_threshold_percent == o.loss_threshold_percent
+    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
+      [scope, days, currency, timezone, spend_minor, counted_arrivals, cost_per_counted_arrival_minor, verdict, loss_threshold_percent].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

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

@@ -14,13 +14,26 @@ require 'date'
 require 'time'
 
 module PlainRouter::OpenAPI
+  # Complete projection rows are paged within 80,000 JSON bytes, accounting for both MCP representations. Defaults are bounded. Follow next_cursor with the same scope and filters. One oversized row is explicitly refused; fields are never silently clipped.
   class ActionDryRunReadDryRun < ApiModelBase
     attr_accessor :actions
 
+    attr_accessor :next_cursor
+
+    attr_accessor :truncated
+
+    attr_accessor :continuation
+
+    attr_accessor :total
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'actions' => :'actions'
+        :'actions' => :'actions',
+        :'next_cursor' => :'next_cursor',
+        :'truncated' => :'truncated',
+        :'continuation' => :'continuation',
+        :'total' => :'total'
       }
     end
 
@@ -37,13 +50,18 @@ module PlainRouter::OpenAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'actions' => :'Array<ActionDryRunReadDryRunActionsInner>'
+        :'actions' => :'Array<ActionDryRunReadDryRunActionsInner>',
+        :'next_cursor' => :'Integer',
+        :'truncated' => :'Boolean',
+        :'continuation' => :'String',
+        :'total' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'next_cursor',
       ])
     end
 
@@ -70,6 +88,22 @@ module PlainRouter::OpenAPI
       else
         self.actions = nil
       end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end
+
+      if attributes.key?(:'truncated')
+        self.truncated = attributes[:'truncated']
+      end
+
+      if attributes.key?(:'continuation')
+        self.continuation = attributes[:'continuation']
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -107,7 +141,11 @@ module PlainRouter::OpenAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          actions == o.actions
+          actions == o.actions &&
+          next_cursor == o.next_cursor &&
+          truncated == o.truncated &&
+          continuation == o.continuation &&
+          total == o.total
     end
 
     # @see the `==` method
@@ -119,7 +157,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [actions].hash
+      [actions, next_cursor, truncated, continuation, total].hash
     end
 
     # Builds the object from hash

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module PlainRouter::OpenAPI
+  # Complete projection rows are paged within 80,000 JSON bytes, accounting for both MCP representations. Defaults are bounded. Follow next_cursor with the same scope and filters. One oversized row is explicitly refused; fields are never silently clipped.
   class ActionListReadMeta < ApiModelBase
     attr_accessor :current_page
 
@@ -23,13 +24,22 @@ module PlainRouter::OpenAPI
 
     attr_accessor :total
 
+    attr_accessor :next_cursor
+
+    attr_accessor :truncated
+
+    attr_accessor :continuation
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'current_page' => :'current_page',
         :'last_page' => :'last_page',
         :'per_page' => :'per_page',
-        :'total' => :'total'
+        :'total' => :'total',
+        :'next_cursor' => :'next_cursor',
+        :'truncated' => :'truncated',
+        :'continuation' => :'continuation'
       }
     end
 
@@ -49,13 +59,17 @@ module PlainRouter::OpenAPI
         :'current_page' => :'Integer',
         :'last_page' => :'Integer',
         :'per_page' => :'Integer',
-        :'total' => :'Integer'
+        :'total' => :'Integer',
+        :'next_cursor' => :'Integer',
+        :'truncated' => :'Boolean',
+        :'continuation' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'next_cursor',
       ])
     end
 
@@ -98,6 +112,18 @@ module PlainRouter::OpenAPI
       else
         self.total = nil
       end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end
+
+      if attributes.key?(:'truncated')
+        self.truncated = attributes[:'truncated']
+      end
+
+      if attributes.key?(:'continuation')
+        self.continuation = attributes[:'continuation']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -183,7 +209,10 @@ module PlainRouter::OpenAPI
           current_page == o.current_page &&
           last_page == o.last_page &&
           per_page == o.per_page &&
-          total == o.total
+          total == o.total &&
+          next_cursor == o.next_cursor &&
+          truncated == o.truncated &&
+          continuation == o.continuation
     end
 
     # @see the `==` method
@@ -195,7 +224,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [current_page, last_page, per_page, total].hash
+      [current_page, last_page, per_page, total, next_cursor, truncated, continuation].hash
     end
 
     # Builds the object from hash

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

@@ -21,18 +21,6 @@ module PlainRouter::OpenAPI
 
     attr_accessor :execution_mode
 
-    attr_accessor :max_spend_delta_percent
-
-    attr_accessor :hard_account_daily_cap_minor
-
-    attr_accessor :protected_entities
-
-    attr_accessor :quiet_hours_start
-
-    attr_accessor :quiet_hours_end
-
-    attr_accessor :protect_learning_phase
-
     attr_accessor :outcome_check_after_hours
 
     attr_accessor :anomaly_threshold_percent
@@ -65,12 +53,6 @@ module PlainRouter::OpenAPI
         :'id' => :'id',
         :'workspace_id' => :'workspace_id',
         :'execution_mode' => :'execution_mode',
-        :'max_spend_delta_percent' => :'max_spend_delta_percent',
-        :'hard_account_daily_cap_minor' => :'hard_account_daily_cap_minor',
-        :'protected_entities' => :'protected_entities',
-        :'quiet_hours_start' => :'quiet_hours_start',
-        :'quiet_hours_end' => :'quiet_hours_end',
-        :'protect_learning_phase' => :'protect_learning_phase',
         :'outcome_check_after_hours' => :'outcome_check_after_hours',
         :'anomaly_threshold_percent' => :'anomaly_threshold_percent'
       }
@@ -92,12 +74,6 @@ module PlainRouter::OpenAPI
         :'id' => :'Integer',
         :'workspace_id' => :'Integer',
         :'execution_mode' => :'String',
-        :'max_spend_delta_percent' => :'String',
-        :'hard_account_daily_cap_minor' => :'Integer',
-        :'protected_entities' => :'Array<Object>',
-        :'quiet_hours_start' => :'String',
-        :'quiet_hours_end' => :'String',
-        :'protect_learning_phase' => :'Boolean',
         :'outcome_check_after_hours' => :'Integer',
         :'anomaly_threshold_percent' => :'String'
       }
@@ -107,10 +83,6 @@ module PlainRouter::OpenAPI
     def self.openapi_nullable
       Set.new([
         :'id',
-        :'hard_account_daily_cap_minor',
-        :'protected_entities',
-        :'quiet_hours_start',
-        :'quiet_hours_end',
       ])
     end
 
@@ -148,44 +120,6 @@ module PlainRouter::OpenAPI
         self.execution_mode = nil
       end
 
-      if attributes.key?(:'max_spend_delta_percent')
-        self.max_spend_delta_percent = attributes[:'max_spend_delta_percent']
-      else
-        self.max_spend_delta_percent = nil
-      end
-
-      if attributes.key?(:'hard_account_daily_cap_minor')
-        self.hard_account_daily_cap_minor = attributes[:'hard_account_daily_cap_minor']
-      else
-        self.hard_account_daily_cap_minor = nil
-      end
-
-      if attributes.key?(:'protected_entities')
-        if (value = attributes[:'protected_entities']).is_a?(Array)
-          self.protected_entities = value
-        end
-      else
-        self.protected_entities = nil
-      end
-
-      if attributes.key?(:'quiet_hours_start')
-        self.quiet_hours_start = attributes[:'quiet_hours_start']
-      else
-        self.quiet_hours_start = nil
-      end
-
-      if attributes.key?(:'quiet_hours_end')
-        self.quiet_hours_end = attributes[:'quiet_hours_end']
-      else
-        self.quiet_hours_end = nil
-      end
-
-      if attributes.key?(:'protect_learning_phase')
-        self.protect_learning_phase = attributes[:'protect_learning_phase']
-      else
-        self.protect_learning_phase = nil
-      end
-
       if attributes.key?(:'outcome_check_after_hours')
         self.outcome_check_after_hours = attributes[:'outcome_check_after_hours']
       else
@@ -212,14 +146,6 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "execution_mode", execution_mode cannot be nil.')
       end
 
-      if @max_spend_delta_percent.nil?
-        invalid_properties.push('invalid value for "max_spend_delta_percent", max_spend_delta_percent cannot be nil.')
-      end
-
-      if @protect_learning_phase.nil?
-        invalid_properties.push('invalid value for "protect_learning_phase", protect_learning_phase cannot be nil.')
-      end
-
       if @outcome_check_after_hours.nil?
         invalid_properties.push('invalid value for "outcome_check_after_hours", outcome_check_after_hours cannot be nil.')
       end
@@ -237,10 +163,8 @@ module PlainRouter::OpenAPI
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @workspace_id.nil?
       return false if @execution_mode.nil?
-      execution_mode_validator = EnumAttributeValidator.new('String', ["ask", "full", "suggest_only", "auto_with_limits", "full_auto"])
+      execution_mode_validator = EnumAttributeValidator.new('String', ["ask", "full"])
       return false unless execution_mode_validator.valid?(@execution_mode)
-      return false if @max_spend_delta_percent.nil?
-      return false if @protect_learning_phase.nil?
       return false if @outcome_check_after_hours.nil?
       return false if @anomaly_threshold_percent.nil?
       true
@@ -259,33 +183,13 @@ module PlainRouter::OpenAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] execution_mode Object to be assigned
     def execution_mode=(execution_mode)
-      validator = EnumAttributeValidator.new('String', ["ask", "full", "suggest_only", "auto_with_limits", "full_auto"])
+      validator = EnumAttributeValidator.new('String', ["ask", "full"])
       unless validator.valid?(execution_mode)
         fail ArgumentError, "invalid value for \"execution_mode\", must be one of #{validator.allowable_values}."
       end
       @execution_mode = execution_mode
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] max_spend_delta_percent Value to be assigned
-    def max_spend_delta_percent=(max_spend_delta_percent)
-      if max_spend_delta_percent.nil?
-        fail ArgumentError, 'max_spend_delta_percent cannot be nil'
-      end
-
-      @max_spend_delta_percent = max_spend_delta_percent
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] protect_learning_phase Value to be assigned
-    def protect_learning_phase=(protect_learning_phase)
-      if protect_learning_phase.nil?
-        fail ArgumentError, 'protect_learning_phase cannot be nil'
-      end
-
-      @protect_learning_phase = protect_learning_phase
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] outcome_check_after_hours Value to be assigned
     def outcome_check_after_hours=(outcome_check_after_hours)
@@ -314,12 +218,6 @@ module PlainRouter::OpenAPI
           id == o.id &&
           workspace_id == o.workspace_id &&
           execution_mode == o.execution_mode &&
-          max_spend_delta_percent == o.max_spend_delta_percent &&
-          hard_account_daily_cap_minor == o.hard_account_daily_cap_minor &&
-          protected_entities == o.protected_entities &&
-          quiet_hours_start == o.quiet_hours_start &&
-          quiet_hours_end == o.quiet_hours_end &&
-          protect_learning_phase == o.protect_learning_phase &&
           outcome_check_after_hours == o.outcome_check_after_hours &&
           anomaly_threshold_percent == o.anomaly_threshold_percent
     end
@@ -333,7 +231,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, workspace_id, execution_mode, max_spend_delta_percent, hard_account_daily_cap_minor, protected_entities, quiet_hours_start, quiet_hours_end, protect_learning_phase, outcome_check_after_hours, anomaly_threshold_percent].hash
+      [id, workspace_id, execution_mode, outcome_check_after_hours, anomaly_threshold_percent].hash
     end
 
     # Builds the object from hash