lockally 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f24bc219e41f5e39e6fbf2261fee36481a275ac3d39c18d2658056eaa7234a48
-  data.tar.gz: f327cd437bc456bf649b946c55dd381baf6124ca3d31ba7e92379493dce35c11
+  metadata.gz: 3095a5e6f5c8257afb5ba49d4a692fbf4e5bed572e6b841b8231a0be60868f48
+  data.tar.gz: 13e3f26e3281db298bfb641378730aec7eb42edf880ca3d3f9ca2eb29f20d529
 SHA512:
-  metadata.gz: 92962203eb034a4791390d2574e876b153ae7780af001373002feb2273b2a868220c271b2ccb6b4fbb6af9b0085b78316a6148682841553a7b0a3a2dbd0dd401
-  data.tar.gz: 28fbc4bcc8b4db43c325954c29161e4514a6aad4af1d9761d36538f4e06451e1212eb78758dce42c65ea72aba05a98a2a573696c9a8dc5af75a43e6ab4e1bc55
+  metadata.gz: 073a3603ffc0d7c4ce9113c4161ade6eb059c036f20e13bb1f9a4b2163e5881f44e10639943eee2a749b793003531c5601a832d394be0d3a0069a763a8264205
+  data.tar.gz: 2f1f55e2304ff060f34d9b037728ccec12d31946101eded533880b63d4837083a9ac5e86ee382b9f181a3dadf5157528d22cb418a3a92cff89f6865d1fcb07f8

data/README.md

@@ -35,7 +35,7 @@ Insufficient scope returns `403` with the required scope name in `detail`.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 0.1.0
-- Package version: 0.3.0
+- Package version: 0.3.1
 - Generator version: 7.23.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -52,16 +52,16 @@ gem build lockally.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./lockally-0.3.0.gem
+gem install ./lockally-0.3.1.gem
 ```
 
-(for development, run `gem install --dev ./lockally-0.3.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./lockally-0.3.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'lockally', '~> 0.3.0'
+    gem 'lockally', '~> 0.3.1'
 
 ### Install from Git
 
@@ -316,6 +316,8 @@ Class | Method | HTTP request | Description
  - [Lockally::AgentSendResult](docs/AgentSendResult.md)
  - [Lockally::AiConfig](docs/AiConfig.md)
  - [Lockally::AiConfigUpdate](docs/AiConfigUpdate.md)
+ - [Lockally::Annotations](docs/Annotations.md)
+ - [Lockally::Attachment](docs/Attachment.md)
  - [Lockally::AuditEvent](docs/AuditEvent.md)
  - [Lockally::BatchLookupPublicKeys200Response](docs/BatchLookupPublicKeys200Response.md)
  - [Lockally::BatchLookupPublicKeys200ResponseDataInner](docs/BatchLookupPublicKeys200ResponseDataInner.md)
@@ -326,6 +328,7 @@ Class | Method | HTTP request | Description
  - [Lockally::CalendarIntegration](docs/CalendarIntegration.md)
  - [Lockally::CalendarMember](docs/CalendarMember.md)
  - [Lockally::CalendarPolicies](docs/CalendarPolicies.md)
+ - [Lockally::Classification](docs/Classification.md)
  - [Lockally::Contact](docs/Contact.md)
  - [Lockally::ContactList](docs/ContactList.md)
  - [Lockally::ContactLookup](docs/ContactLookup.md)
@@ -406,6 +409,7 @@ Class | Method | HTTP request | Description
  - [Lockally::HealthCheck200Response](docs/HealthCheck200Response.md)
  - [Lockally::Inbox](docs/Inbox.md)
  - [Lockally::InboxList](docs/InboxList.md)
+ - [Lockally::InjectionRisk](docs/InjectionRisk.md)
  - [Lockally::InviteAdminRequest](docs/InviteAdminRequest.md)
  - [Lockally::ListAddOns200Response](docs/ListAddOns200Response.md)
  - [Lockally::ListAdmins200Response](docs/ListAdmins200Response.md)
@@ -454,6 +458,7 @@ Class | Method | HTTP request | Description
  - [Lockally::MigrationSettings](docs/MigrationSettings.md)
  - [Lockally::ModelAlias](docs/ModelAlias.md)
  - [Lockally::PlanCatalogEntry](docs/PlanCatalogEntry.md)
+ - [Lockally::PolicyFlags](docs/PolicyFlags.md)
  - [Lockally::Problem](docs/Problem.md)
  - [Lockally::ReplaceDistributionListMembers200Response](docs/ReplaceDistributionListMembers200Response.md)
  - [Lockally::ReplaceDistributionListMembersRequest](docs/ReplaceDistributionListMembersRequest.md)

data/docs/Annotations.md

@@ -0,0 +1,22 @@
+# Lockally::Annotations
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attachment_types** | **Array<String>** |  | [optional] |
+| **meeting_request** | **Boolean** |  | [optional] |
+| **injection_risk** | [**InjectionRisk**](InjectionRisk.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Annotations.new(
+  attachment_types: null,
+  meeting_request: null,
+  injection_risk: null
+)
+```
+

data/docs/Attachment.md

@@ -0,0 +1,26 @@
+# Lockally::Attachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** | MIME type. | [optional] |
+| **size** | **Integer** | Bytes. | [optional] |
+| **blob_id** | **String** |  | [optional] |
+| **part_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Attachment.new(
+  name: null,
+  type: null,
+  size: null,
+  blob_id: null,
+  part_id: null
+)
+```
+

data/docs/Classification.md

@@ -0,0 +1,24 @@
+# Lockally::Classification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **intent** | **String** | For example support_request, sales_lead, billing, spam. | [optional] |
+| **urgency** | **String** |  | [optional] |
+| **summary** | **String** | One line. | [optional] |
+| **suggested_action** | **String** | One line. | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Classification.new(
+  intent: null,
+  urgency: null,
+  summary: null,
+  suggested_action: null
+)
+```
+

data/docs/Draft.md

@@ -13,7 +13,7 @@
 | **subject** | **String** |  | [optional] |
 | **body_text** | **String** |  | [optional] |
 | **status** | **String** |  |  |
-| **policy_flags** | **Hash<String, Object>** |  |  |
+| **policy_flags** | [**PolicyFlags**](PolicyFlags.md) |  |  |
 | **reviewed_at** | **Time** |  | [optional] |
 | **sent_message_id** | **String** |  | [optional] |
 | **created_at** | **Time** |  |  |

data/docs/DraftResult.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **draft_id** | **String** |  |  |
 | **status** | **String** |  |  |
-| **policy_flags** | **Hash<String, Object>** |  |  |
+| **policy_flags** | [**PolicyFlags**](PolicyFlags.md) |  |  |
 | **thread_id** | **String** |  | [optional] |
 | **sent** | [**AgentSendResult**](AgentSendResult.md) |  | [optional] |
 

data/docs/InjectionRisk.md

@@ -0,0 +1,20 @@
+# Lockally::InjectionRisk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flagged** | **Boolean** |  | [optional] |
+| **signals** | **Array<String>** | The phrases that tripped the check. | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::InjectionRisk.new(
+  flagged: null,
+  signals: null
+)
+```
+

data/docs/PolicyFlags.md

@@ -0,0 +1,28 @@
+# Lockally::PolicyFlags
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **always_approve** | **Boolean** |  | [optional] |
+| **injection_risk** | **Boolean** |  | [optional] |
+| **new_recipient** | **Array<String>** |  | [optional] |
+| **new_thread** | **Boolean** |  | [optional] |
+| **pii** | **Array<String>** |  | [optional] |
+| **recipient_count** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::PolicyFlags.new(
+  always_approve: null,
+  injection_risk: null,
+  new_recipient: null,
+  new_thread: null,
+  pii: null,
+  recipient_count: null
+)
+```
+

data/docs/SimulatedInbound.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **thread_id** | **String** |  | [optional] |
 | **message_id** | **String** |  | [optional] |
-| **annotations** | **Hash<String, Object>** |  | [optional] |
+| **annotations** | [**Annotations**](Annotations.md) |  | [optional] |
 
 ## Example
 

data/docs/ThreadClassification.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **thread_id** | **String** |  |  |
 | **cached** | **Boolean** | True when a previous classification was reused. | [optional] |
-| **classification** | **Hash<String, Object>** | Intent | [optional] |
+| **classification** | [**Classification**](Classification.md) |  | [optional] |
 
 ## Example
 

data/docs/ThreadMessage.md

@@ -13,8 +13,8 @@
 | **to** | **Array<String>** |  |  |
 | **snippet** | **String** |  | [optional] |
 | **has_attachments** | **Boolean** |  |  |
-| **attachments** | **Array<Hash<String, Object>>** |  | [optional] |
-| **annotations** | **Hash<String, Object>** | Signals computed at ingest | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
+| **annotations** | [**Annotations**](Annotations.md) |  | [optional] |
 | **received_at** | **Time** |  |  |
 
 ## Example

data/docs/ThreadMessageBody.md

@@ -13,8 +13,8 @@
 | **to** | **Array<String>** |  |  |
 | **snippet** | **String** |  | [optional] |
 | **has_attachments** | **Boolean** |  |  |
-| **attachments** | **Array<Hash<String, Object>>** |  | [optional] |
-| **annotations** | **Hash<String, Object>** | Signals computed at ingest | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
+| **annotations** | [**Annotations**](Annotations.md) |  | [optional] |
 | **received_at** | **Time** |  |  |
 | **body** | [**ThreadMessageBodyAllOfBody**](ThreadMessageBodyAllOfBody.md) |  | [optional] |
 

data/lib/lockally/models/annotations.rb

@@ -0,0 +1,168 @@
+=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
+  # Signals computed at ingest, before an agent sees the message. A key is absent when its check did not fire. 
+  class Annotations < ApiModelBase
+    attr_accessor :attachment_types
+
+    attr_accessor :meeting_request
+
+    attr_accessor :injection_risk
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachment_types' => :'attachment_types',
+        :'meeting_request' => :'meeting_request',
+        :'injection_risk' => :'injection_risk'
+      }
+    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
+      {
+        :'attachment_types' => :'Array<String>',
+        :'meeting_request' => :'Boolean',
+        :'injection_risk' => :'InjectionRisk'
+      }
+    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::Annotations` 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::Annotations`. 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?(:'attachment_types')
+        if (value = attributes[:'attachment_types']).is_a?(Array)
+          self.attachment_types = value
+        end
+      end
+
+      if attributes.key?(:'meeting_request')
+        self.meeting_request = attributes[:'meeting_request']
+      end
+
+      if attributes.key?(:'injection_risk')
+        self.injection_risk = attributes[:'injection_risk']
+      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 &&
+          attachment_types == o.attachment_types &&
+          meeting_request == o.meeting_request &&
+          injection_risk == o.injection_risk
+    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
+      [attachment_types, meeting_request, injection_risk].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/attachment.rb

@@ -0,0 +1,185 @@
+=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 Attachment < ApiModelBase
+    attr_accessor :name
+
+    # MIME type.
+    attr_accessor :type
+
+    # Bytes.
+    attr_accessor :size
+
+    attr_accessor :blob_id
+
+    attr_accessor :part_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'type' => :'type',
+        :'size' => :'size',
+        :'blob_id' => :'blobId',
+        :'part_id' => :'partId'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'type' => :'String',
+        :'size' => :'Integer',
+        :'blob_id' => :'String',
+        :'part_id' => :'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::Attachment` 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::Attachment`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      end
+
+      if attributes.key?(:'blob_id')
+        self.blob_id = attributes[:'blob_id']
+      end
+
+      if attributes.key?(:'part_id')
+        self.part_id = attributes[:'part_id']
+      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 &&
+          name == o.name &&
+          type == o.type &&
+          size == o.size &&
+          blob_id == o.blob_id &&
+          part_id == o.part_id
+    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
+      [name, type, size, blob_id, part_id].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