lockally 0.3.0 → 0.3.2

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/mailbox_grant.rb

@@ -15,15 +15,21 @@ require 'time'
 
 module Lockally
   class MailboxGrant < ApiModelBase
-    attr_accessor :id
+    attr_accessor :api_key_id
+
+    attr_accessor :mailbox_id
 
     attr_accessor :mailbox
 
+    attr_accessor :created_at
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'mailbox' => :'mailbox'
+        :'api_key_id' => :'api_key_id',
+        :'mailbox_id' => :'mailbox_id',
+        :'mailbox' => :'mailbox',
+        :'created_at' => :'created_at'
       }
     end
 
@@ -40,8 +46,10 @@ module Lockally
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'mailbox' => :'String'
+        :'api_key_id' => :'String',
+        :'mailbox_id' => :'String',
+        :'mailbox' => :'String',
+        :'created_at' => :'Time'
       }
     end
 
@@ -67,13 +75,21 @@ module Lockally
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'api_key_id')
+        self.api_key_id = attributes[:'api_key_id']
+      end
+
+      if attributes.key?(:'mailbox_id')
+        self.mailbox_id = attributes[:'mailbox_id']
       end
 
       if attributes.key?(:'mailbox')
         self.mailbox = attributes[:'mailbox']
       end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -96,8 +112,10 @@ module Lockally
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          mailbox == o.mailbox
+          api_key_id == o.api_key_id &&
+          mailbox_id == o.mailbox_id &&
+          mailbox == o.mailbox &&
+          created_at == o.created_at
     end
 
     # @see the `==` method
@@ -109,7 +127,7 @@ module Lockally
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, mailbox].hash
+      [api_key_id, mailbox_id, mailbox, created_at].hash
     end
 
     # Builds the object from hash

data/lib/lockally/models/mailbox_grant_list.rb

@@ -15,12 +15,12 @@ require 'time'
 
 module Lockally
   class MailboxGrantList < ApiModelBase
-    attr_accessor :mailboxes
+    attr_accessor :grants
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'mailboxes' => :'mailboxes'
+        :'grants' => :'grants'
       }
     end
 
@@ -37,7 +37,7 @@ module Lockally
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'mailboxes' => :'Array<MailboxGrant>'
+        :'grants' => :'Array<MailboxGrant>'
       }
     end
 
@@ -63,12 +63,12 @@ module Lockally
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'mailboxes')
-        if (value = attributes[:'mailboxes']).is_a?(Array)
-          self.mailboxes = value
+      if attributes.key?(:'grants')
+        if (value = attributes[:'grants']).is_a?(Array)
+          self.grants = value
         end
       else
-        self.mailboxes = nil
+        self.grants = nil
       end
     end
 
@@ -77,8 +77,8 @@ module Lockally
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @mailboxes.nil?
-        invalid_properties.push('invalid value for "mailboxes", mailboxes cannot be nil.')
+      if @grants.nil?
+        invalid_properties.push('invalid value for "grants", grants cannot be nil.')
       end
 
       invalid_properties
@@ -88,18 +88,18 @@ module Lockally
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @mailboxes.nil?
+      return false if @grants.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] mailboxes Value to be assigned
-    def mailboxes=(mailboxes)
-      if mailboxes.nil?
-        fail ArgumentError, 'mailboxes cannot be nil'
+    # @param [Object] grants Value to be assigned
+    def grants=(grants)
+      if grants.nil?
+        fail ArgumentError, 'grants cannot be nil'
       end
 
-      @mailboxes = mailboxes
+      @grants = grants
     end
 
     # Checks equality by comparing each attribute.
@@ -107,7 +107,7 @@ module Lockally
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          mailboxes == o.mailboxes
+          grants == o.grants
     end
 
     # @see the `==` method
@@ -119,7 +119,7 @@ module Lockally
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mailboxes].hash
+      [grants].hash
     end
 
     # Builds the object from hash

data/lib/lockally/models/mark_read_result.rb

@@ -15,11 +15,14 @@ require 'time'
 
 module Lockally
   class MarkReadResult < ApiModelBase
+    attr_accessor :message_id
+
     attr_accessor :read
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'message_id' => :'message_id',
         :'read' => :'read'
       }
     end
@@ -37,6 +40,7 @@ module Lockally
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'message_id' => :'String',
         :'read' => :'Boolean'
       }
     end
@@ -63,6 +67,10 @@ module Lockally
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'message_id')
+        self.message_id = attributes[:'message_id']
+      end
+
       if attributes.key?(:'read')
         self.read = attributes[:'read']
       end
@@ -88,6 +96,7 @@ module Lockally
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          message_id == o.message_id &&
           read == o.read
     end
 
@@ -100,7 +109,7 @@ module Lockally
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [read].hash
+      [message_id, read].hash
     end
 
     # Builds the object from hash

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

@@ -15,17 +15,27 @@ require 'time'
 
 module Lockally
   class SimulatedInbound < ApiModelBase
+    attr_accessor :simulated
+
+    # True when the message was adopted into a thread.
+    attr_accessor :indexed
+
     attr_accessor :thread_id
 
     attr_accessor :message_id
 
+    attr_accessor :rfc_message_id
+
     attr_accessor :annotations
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'simulated' => :'simulated',
+        :'indexed' => :'indexed',
         :'thread_id' => :'thread_id',
         :'message_id' => :'message_id',
+        :'rfc_message_id' => :'rfc_message_id',
         :'annotations' => :'annotations'
       }
     end
@@ -43,9 +53,12 @@ module Lockally
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'simulated' => :'Boolean',
+        :'indexed' => :'Boolean',
         :'thread_id' => :'String',
         :'message_id' => :'String',
-        :'annotations' => :'Hash<String, Object>'
+        :'rfc_message_id' => :'String',
+        :'annotations' => :'Annotations'
       }
     end
 
@@ -71,6 +84,14 @@ module Lockally
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'simulated')
+        self.simulated = attributes[:'simulated']
+      end
+
+      if attributes.key?(:'indexed')
+        self.indexed = attributes[:'indexed']
+      end
+
       if attributes.key?(:'thread_id')
         self.thread_id = attributes[:'thread_id']
       end
@@ -79,10 +100,12 @@ module Lockally
         self.message_id = attributes[:'message_id']
       end
 
+      if attributes.key?(:'rfc_message_id')
+        self.rfc_message_id = attributes[:'rfc_message_id']
+      end
+
       if attributes.key?(:'annotations')
-        if (value = attributes[:'annotations']).is_a?(Hash)
-          self.annotations = value
-        end
+        self.annotations = attributes[:'annotations']
       end
     end
 
@@ -106,8 +129,11 @@ module Lockally
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          simulated == o.simulated &&
+          indexed == o.indexed &&
           thread_id == o.thread_id &&
           message_id == o.message_id &&
+          rfc_message_id == o.rfc_message_id &&
           annotations == o.annotations
     end
 
@@ -120,7 +146,7 @@ module Lockally
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [thread_id, message_id, annotations].hash
+      [simulated, indexed, thread_id, message_id, rfc_message_id, annotations].hash
     end
 
     # Builds the object from hash