lockally 0.3.0 → 0.3.1

data/lib/lockally/models/classification.rb

@@ -0,0 +1,211 @@
+=begin
+#lockally control plane
+
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+
+The version of the OpenAPI document: 0.1.0
+Contact: support@lockally.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lockally
+  class Classification < ApiModelBase
+    # For example support_request, sales_lead, billing, spam.
+    attr_accessor :intent
+
+    attr_accessor :urgency
+
+    # One line.
+    attr_accessor :summary
+
+    # One line.
+    attr_accessor :suggested_action
+
+    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
+      {
+        :'intent' => :'intent',
+        :'urgency' => :'urgency',
+        :'summary' => :'summary',
+        :'suggested_action' => :'suggested_action'
+      }
+    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
+      {
+        :'intent' => :'String',
+        :'urgency' => :'String',
+        :'summary' => :'String',
+        :'suggested_action' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Lockally::Classification` 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 `Lockally::Classification`. 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?(:'intent')
+        self.intent = attributes[:'intent']
+      end
+
+      if attributes.key?(:'urgency')
+        self.urgency = attributes[:'urgency']
+      end
+
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      end
+
+      if attributes.key?(:'suggested_action')
+        self.suggested_action = attributes[:'suggested_action']
+      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'
+      urgency_validator = EnumAttributeValidator.new('String', ["low", "normal", "high"])
+      return false unless urgency_validator.valid?(@urgency)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] urgency Object to be assigned
+    def urgency=(urgency)
+      validator = EnumAttributeValidator.new('String', ["low", "normal", "high"])
+      unless validator.valid?(urgency)
+        fail ArgumentError, "invalid value for \"urgency\", must be one of #{validator.allowable_values}."
+      end
+      @urgency = urgency
+    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 &&
+          intent == o.intent &&
+          urgency == o.urgency &&
+          summary == o.summary &&
+          suggested_action == o.suggested_action
+    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
+      [intent, urgency, summary, suggested_action].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/lockally/models/draft.rb

@@ -107,7 +107,7 @@ module Lockally
         :'subject' => :'String',
         :'body_text' => :'String',
         :'status' => :'String',
-        :'policy_flags' => :'Hash<String, Object>',
+        :'policy_flags' => :'PolicyFlags',
         :'reviewed_at' => :'Time',
         :'sent_message_id' => :'String',
         :'created_at' => :'Time',
@@ -186,9 +186,7 @@ module Lockally
       end
 
       if attributes.key?(:'policy_flags')
-        if (value = attributes[:'policy_flags']).is_a?(Hash)
-          self.policy_flags = value
-        end
+        self.policy_flags = attributes[:'policy_flags']
       else
         self.policy_flags = nil
       end

data/lib/lockally/models/draft_result.rb

@@ -73,7 +73,7 @@ module Lockally
       {
         :'draft_id' => :'String',
         :'status' => :'String',
-        :'policy_flags' => :'Hash<String, Object>',
+        :'policy_flags' => :'PolicyFlags',
         :'thread_id' => :'String',
         :'sent' => :'AgentSendResult'
       }
@@ -114,9 +114,7 @@ module Lockally
       end
 
       if attributes.key?(:'policy_flags')
-        if (value = attributes[:'policy_flags']).is_a?(Hash)
-          self.policy_flags = value
-        end
+        self.policy_flags = attributes[:'policy_flags']
       else
         self.policy_flags = nil
       end

data/lib/lockally/models/injection_risk.rb

@@ -0,0 +1,159 @@
+=begin
+#lockally control plane
+
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+
+The version of the OpenAPI document: 0.1.0
+Contact: support@lockally.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lockally
+  class InjectionRisk < ApiModelBase
+    attr_accessor :flagged
+
+    # The phrases that tripped the check.
+    attr_accessor :signals
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'flagged' => :'flagged',
+        :'signals' => :'signals'
+      }
+    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
+      {
+        :'flagged' => :'Boolean',
+        :'signals' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Lockally::InjectionRisk` 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 `Lockally::InjectionRisk`. 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?(:'flagged')
+        self.flagged = attributes[:'flagged']
+      end
+
+      if attributes.key?(:'signals')
+        if (value = attributes[:'signals']).is_a?(Array)
+          self.signals = value
+        end
+      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'
+      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 &&
+          flagged == o.flagged &&
+          signals == o.signals
+    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
+      [flagged, signals].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/lockally/models/policy_flags.rb

@@ -0,0 +1,197 @@
+=begin
+#lockally control plane
+
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+
+The version of the OpenAPI document: 0.1.0
+Contact: support@lockally.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lockally
+  # Why a draft was held. A key is absent when that check passed. The set is closed: a flag added to the policy engine must be added here too, or typed clients will drop it. 
+  class PolicyFlags < ApiModelBase
+    attr_accessor :always_approve
+
+    attr_accessor :injection_risk
+
+    attr_accessor :new_recipient
+
+    attr_accessor :new_thread
+
+    attr_accessor :pii
+
+    attr_accessor :recipient_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'always_approve' => :'always_approve',
+        :'injection_risk' => :'injection_risk',
+        :'new_recipient' => :'new_recipient',
+        :'new_thread' => :'new_thread',
+        :'pii' => :'pii',
+        :'recipient_count' => :'recipient_count'
+      }
+    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
+      {
+        :'always_approve' => :'Boolean',
+        :'injection_risk' => :'Boolean',
+        :'new_recipient' => :'Array<String>',
+        :'new_thread' => :'Boolean',
+        :'pii' => :'Array<String>',
+        :'recipient_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Lockally::PolicyFlags` 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 `Lockally::PolicyFlags`. 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?(:'always_approve')
+        self.always_approve = attributes[:'always_approve']
+      end
+
+      if attributes.key?(:'injection_risk')
+        self.injection_risk = attributes[:'injection_risk']
+      end
+
+      if attributes.key?(:'new_recipient')
+        if (value = attributes[:'new_recipient']).is_a?(Array)
+          self.new_recipient = value
+        end
+      end
+
+      if attributes.key?(:'new_thread')
+        self.new_thread = attributes[:'new_thread']
+      end
+
+      if attributes.key?(:'pii')
+        if (value = attributes[:'pii']).is_a?(Array)
+          self.pii = value
+        end
+      end
+
+      if attributes.key?(:'recipient_count')
+        self.recipient_count = attributes[:'recipient_count']
+      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'
+      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 &&
+          always_approve == o.always_approve &&
+          injection_risk == o.injection_risk &&
+          new_recipient == o.new_recipient &&
+          new_thread == o.new_thread &&
+          pii == o.pii &&
+          recipient_count == o.recipient_count
+    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
+      [always_approve, injection_risk, new_recipient, new_thread, pii, recipient_count].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/lockally/models/simulated_inbound.rb

@@ -45,7 +45,7 @@ module Lockally
       {
         :'thread_id' => :'String',
         :'message_id' => :'String',
-        :'annotations' => :'Hash<String, Object>'
+        :'annotations' => :'Annotations'
       }
     end
 
@@ -80,9 +80,7 @@ module Lockally
       end
 
       if attributes.key?(:'annotations')
-        if (value = attributes[:'annotations']).is_a?(Hash)
-          self.annotations = value
-        end
+        self.annotations = attributes[:'annotations']
       end
     end
 

data/lib/lockally/models/thread_classification.rb

@@ -20,7 +20,6 @@ module Lockally
     # True when a previous classification was reused.
     attr_accessor :cached
 
-    # Intent
     attr_accessor :classification
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -47,7 +46,7 @@ module Lockally
       {
         :'thread_id' => :'String',
         :'cached' => :'Boolean',
-        :'classification' => :'Hash<String, Object>'
+        :'classification' => :'Classification'
       }
     end
 
@@ -84,9 +83,7 @@ module Lockally
       end
 
       if attributes.key?(:'classification')
-        if (value = attributes[:'classification']).is_a?(Hash)
-          self.classification = value
-        end
+        self.classification = attributes[:'classification']
       end
     end
 

data/lib/lockally/models/thread_message.rb

@@ -36,7 +36,6 @@ module Lockally
 
     attr_accessor :attachments
 
-    # Signals computed at ingest
     attr_accessor :annotations
 
     attr_accessor :received_at
@@ -103,8 +102,8 @@ module Lockally
         :'to' => :'Array<String>',
         :'snippet' => :'String',
         :'has_attachments' => :'Boolean',
-        :'attachments' => :'Array<Hash<String, Object>>',
-        :'annotations' => :'Hash<String, Object>',
+        :'attachments' => :'Array<Attachment>',
+        :'annotations' => :'Annotations',
         :'received_at' => :'Time'
       }
     end
@@ -188,9 +187,7 @@ module Lockally
       end
 
       if attributes.key?(:'annotations')
-        if (value = attributes[:'annotations']).is_a?(Hash)
-          self.annotations = value
-        end
+        self.annotations = attributes[:'annotations']
       end
 
       if attributes.key?(:'received_at')