plainrouter-sdk 0.2.0 → 0.5.0

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

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

@@ -0,0 +1,374 @@
+=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 ActionPolicyResult < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :policy_id
+
+    attr_accessor :policy_version
+
+    attr_accessor :phase
+
+    attr_accessor :outcome
+
+    attr_accessor :reasons
+
+    attr_accessor :reason_details
+
+    attr_accessor :requested_minor
+
+    attr_accessor :evaluated_at
+
+    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
+      {
+        :'id' => :'id',
+        :'policy_id' => :'policy_id',
+        :'policy_version' => :'policy_version',
+        :'phase' => :'phase',
+        :'outcome' => :'outcome',
+        :'reasons' => :'reasons',
+        :'reason_details' => :'reason_details',
+        :'requested_minor' => :'requested_minor',
+        :'evaluated_at' => :'evaluated_at'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'policy_id' => :'String',
+        :'policy_version' => :'Integer',
+        :'phase' => :'String',
+        :'outcome' => :'String',
+        :'reasons' => :'Array<String>',
+        :'reason_details' => :'Array<String>',
+        :'requested_minor' => :'Integer',
+        :'evaluated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'reason_details',
+        :'requested_minor',
+      ])
+    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::ActionPolicyResult` 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::ActionPolicyResult`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'policy_id')
+        self.policy_id = attributes[:'policy_id']
+      else
+        self.policy_id = nil
+      end
+
+      if attributes.key?(:'policy_version')
+        self.policy_version = attributes[:'policy_version']
+      else
+        self.policy_version = nil
+      end
+
+      if attributes.key?(:'phase')
+        self.phase = attributes[:'phase']
+      else
+        self.phase = nil
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      else
+        self.outcome = nil
+      end
+
+      if attributes.key?(:'reasons')
+        if (value = attributes[:'reasons']).is_a?(Array)
+          self.reasons = value
+        end
+      else
+        self.reasons = nil
+      end
+
+      if attributes.key?(:'reason_details')
+        if (value = attributes[:'reason_details']).is_a?(Array)
+          self.reason_details = value
+        end
+      else
+        self.reason_details = nil
+      end
+
+      if attributes.key?(:'requested_minor')
+        self.requested_minor = attributes[:'requested_minor']
+      else
+        self.requested_minor = nil
+      end
+
+      if attributes.key?(:'evaluated_at')
+        self.evaluated_at = attributes[:'evaluated_at']
+      else
+        self.evaluated_at = nil
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @policy_id.nil?
+        invalid_properties.push('invalid value for "policy_id", policy_id cannot be nil.')
+      end
+
+      if @policy_version.nil?
+        invalid_properties.push('invalid value for "policy_version", policy_version cannot be nil.')
+      end
+
+      if @phase.nil?
+        invalid_properties.push('invalid value for "phase", phase cannot be nil.')
+      end
+
+      if @outcome.nil?
+        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
+      end
+
+      if @reasons.nil?
+        invalid_properties.push('invalid value for "reasons", reasons cannot be nil.')
+      end
+
+      if @evaluated_at.nil?
+        invalid_properties.push('invalid value for "evaluated_at", evaluated_at cannot be nil.')
+      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 @id.nil?
+      return false if @policy_id.nil?
+      return false if @policy_version.nil?
+      return false if @phase.nil?
+      phase_validator = EnumAttributeValidator.new('String', ["proposal", "approval", "execution"])
+      return false unless phase_validator.valid?(@phase)
+      return false if @outcome.nil?
+      outcome_validator = EnumAttributeValidator.new('String', ["allowed", "approval_required", "blocked"])
+      return false unless outcome_validator.valid?(@outcome)
+      return false if @reasons.nil?
+      return false if @evaluated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] policy_id Value to be assigned
+    def policy_id=(policy_id)
+      if policy_id.nil?
+        fail ArgumentError, 'policy_id cannot be nil'
+      end
+
+      @policy_id = policy_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] policy_version Value to be assigned
+    def policy_version=(policy_version)
+      if policy_version.nil?
+        fail ArgumentError, 'policy_version cannot be nil'
+      end
+
+      @policy_version = policy_version
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] phase Object to be assigned
+    def phase=(phase)
+      validator = EnumAttributeValidator.new('String', ["proposal", "approval", "execution"])
+      unless validator.valid?(phase)
+        fail ArgumentError, "invalid value for \"phase\", must be one of #{validator.allowable_values}."
+      end
+      @phase = phase
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] outcome Object to be assigned
+    def outcome=(outcome)
+      validator = EnumAttributeValidator.new('String', ["allowed", "approval_required", "blocked"])
+      unless validator.valid?(outcome)
+        fail ArgumentError, "invalid value for \"outcome\", must be one of #{validator.allowable_values}."
+      end
+      @outcome = outcome
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reasons Value to be assigned
+    def reasons=(reasons)
+      if reasons.nil?
+        fail ArgumentError, 'reasons cannot be nil'
+      end
+
+      @reasons = reasons
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] evaluated_at Value to be assigned
+    def evaluated_at=(evaluated_at)
+      if evaluated_at.nil?
+        fail ArgumentError, 'evaluated_at cannot be nil'
+      end
+
+      @evaluated_at = evaluated_at
+    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 &&
+          id == o.id &&
+          policy_id == o.policy_id &&
+          policy_version == o.policy_version &&
+          phase == o.phase &&
+          outcome == o.outcome &&
+          reasons == o.reasons &&
+          reason_details == o.reason_details &&
+          requested_minor == o.requested_minor &&
+          evaluated_at == o.evaluated_at
+    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
+      [id, policy_id, policy_version, phase, outcome, reasons, reason_details, requested_minor, evaluated_at].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_proposal_input.rb

@@ -27,6 +27,8 @@ module PlainRouter::OpenAPI
 
     attr_accessor :account_id
 
+    attr_accessor :workspace_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -57,7 +59,8 @@ module PlainRouter::OpenAPI
         :'idempotency_key' => :'idempotency_key',
         :'evidence' => :'evidence',
         :'target_source' => :'target_source',
-        :'account_id' => :'account_id'
+        :'account_id' => :'account_id',
+        :'workspace_id' => :'workspace_id'
       }
     end
 
@@ -79,7 +82,8 @@ module PlainRouter::OpenAPI
         :'idempotency_key' => :'String',
         :'evidence' => :'Array<ActionProposalInputEvidenceInner>',
         :'target_source' => :'String',
-        :'account_id' => :'Integer'
+        :'account_id' => :'Integer',
+        :'workspace_id' => :'Integer'
       }
     end
 
@@ -142,6 +146,10 @@ module PlainRouter::OpenAPI
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
+
+      if attributes.key?(:'workspace_id')
+        self.workspace_id = attributes[:'workspace_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -197,6 +205,10 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "account_id", must be greater than or equal to 1.')
       end
 
+      if !@workspace_id.nil? && @workspace_id < 1
+        invalid_properties.push('invalid value for "workspace_id", must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -218,6 +230,7 @@ module PlainRouter::OpenAPI
       target_source_validator = EnumAttributeValidator.new('String', ["human_supplied"])
       return false unless target_source_validator.valid?(@target_source)
       return false if !@account_id.nil? && @account_id < 1
+      return false if !@workspace_id.nil? && @workspace_id < 1
       true
     end
 
@@ -309,6 +322,20 @@ module PlainRouter::OpenAPI
       @account_id = account_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
+
+      if workspace_id < 1
+        fail ArgumentError, 'invalid value for "workspace_id", must be greater than or equal to 1.'
+      end
+
+      @workspace_id = workspace_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -319,7 +346,8 @@ module PlainRouter::OpenAPI
           idempotency_key == o.idempotency_key &&
           evidence == o.evidence &&
           target_source == o.target_source &&
-          account_id == o.account_id
+          account_id == o.account_id &&
+          workspace_id == o.workspace_id
     end
 
     # @see the `==` method
@@ -331,7 +359,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [actions, rationale, idempotency_key, evidence, target_source, account_id].hash
+      [actions, rationale, idempotency_key, evidence, target_source, account_id, workspace_id].hash
     end
 
     # Builds the object from hash