lockally 0.3.1 → 0.3.2

data/lib/lockally/models/whoami.rb

@@ -15,22 +15,43 @@ require 'time'
 
 module Lockally
   class Whoami < ApiModelBase
-    attr_accessor :tenant_id
-
     attr_accessor :tenant
 
-    # The API key's label.
-    attr_accessor :label
-
     attr_accessor :scopes
 
+    attr_accessor :auth
+
+    attr_accessor :key
+
+    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
       {
-        :'tenant_id' => :'tenant_id',
         :'tenant' => :'tenant',
-        :'label' => :'label',
-        :'scopes' => :'scopes'
+        :'scopes' => :'scopes',
+        :'auth' => :'auth',
+        :'key' => :'key'
       }
     end
 
@@ -47,10 +68,10 @@ module Lockally
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'tenant_id' => :'String',
-        :'tenant' => :'String',
-        :'label' => :'String',
-        :'scopes' => :'Array<String>'
+        :'tenant' => :'WhoamiTenant',
+        :'scopes' => :'Array<String>',
+        :'auth' => :'String',
+        :'key' => :'WhoamiKey'
       }
     end
 
@@ -76,22 +97,28 @@ module Lockally
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'tenant_id')
-        self.tenant_id = attributes[:'tenant_id']
-      end
-
       if attributes.key?(:'tenant')
         self.tenant = attributes[:'tenant']
-      end
-
-      if attributes.key?(:'label')
-        self.label = attributes[:'label']
+      else
+        self.tenant = nil
       end
 
       if attributes.key?(:'scopes')
         if (value = attributes[:'scopes']).is_a?(Array)
           self.scopes = value
         end
+      else
+        self.scopes = nil
+      end
+
+      if attributes.key?(:'auth')
+        self.auth = attributes[:'auth']
+      else
+        self.auth = nil
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
       end
     end
 
@@ -100,6 +127,18 @@ module Lockally
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @tenant.nil?
+        invalid_properties.push('invalid value for "tenant", tenant cannot be nil.')
+      end
+
+      if @scopes.nil?
+        invalid_properties.push('invalid value for "scopes", scopes cannot be nil.')
+      end
+
+      if @auth.nil?
+        invalid_properties.push('invalid value for "auth", auth cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -107,18 +146,53 @@ module Lockally
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @tenant.nil?
+      return false if @scopes.nil?
+      return false if @auth.nil?
+      auth_validator = EnumAttributeValidator.new('String', ["api_key", "session"])
+      return false unless auth_validator.valid?(@auth)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] tenant Value to be assigned
+    def tenant=(tenant)
+      if tenant.nil?
+        fail ArgumentError, 'tenant cannot be nil'
+      end
+
+      @tenant = tenant
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scopes Value to be assigned
+    def scopes=(scopes)
+      if scopes.nil?
+        fail ArgumentError, 'scopes cannot be nil'
+      end
+
+      @scopes = scopes
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] auth Object to be assigned
+    def auth=(auth)
+      validator = EnumAttributeValidator.new('String', ["api_key", "session"])
+      unless validator.valid?(auth)
+        fail ArgumentError, "invalid value for \"auth\", must be one of #{validator.allowable_values}."
+      end
+      @auth = auth
+    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 &&
-          tenant_id == o.tenant_id &&
           tenant == o.tenant &&
-          label == o.label &&
-          scopes == o.scopes
+          scopes == o.scopes &&
+          auth == o.auth &&
+          key == o.key
     end
 
     # @see the `==` method
@@ -130,7 +204,7 @@ module Lockally
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [tenant_id, tenant, label, scopes].hash
+      [tenant, scopes, auth, key].hash
     end
 
     # Builds the object from hash

data/lib/lockally/models/whoami_key.rb

@@ -0,0 +1,157 @@
+=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
+  # Present only when auth is api_key.
+  class WhoamiKey < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :label
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'label' => :'label'
+      }
+    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',
+        :'label' => :'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::WhoamiKey` 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::WhoamiKey`. 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']
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      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 &&
+          id == o.id &&
+          label == o.label
+    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, label].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/whoami_tenant.rb

@@ -0,0 +1,166 @@
+=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 WhoamiTenant < ApiModelBase
+    attr_accessor :slug
+
+    # What the account calls itself.
+    attr_accessor :name
+
+    attr_accessor :plan
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'slug' => :'slug',
+        :'name' => :'name',
+        :'plan' => :'plan'
+      }
+    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
+      {
+        :'slug' => :'String',
+        :'name' => :'String',
+        :'plan' => :'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::WhoamiTenant` 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::WhoamiTenant`. 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?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'plan')
+        self.plan = attributes[:'plan']
+      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 &&
+          slug == o.slug &&
+          name == o.name &&
+          plan == o.plan
+    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
+      [slug, name, plan].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/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.23.0
 =end
 
 module Lockally
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/lockally.rb

@@ -203,7 +203,7 @@ require 'lockally/models/thread_classification'
 require 'lockally/models/thread_list'
 require 'lockally/models/thread_message'
 require 'lockally/models/thread_message_body'
-require 'lockally/models/thread_message_body_all_of_body'
+require 'lockally/models/thread_message_body_body'
 require 'lockally/models/thread_summary'
 require 'lockally/models/unit_bundle'
 require 'lockally/models/update_admin_request'
@@ -228,6 +228,8 @@ require 'lockally/models/vacation_params'
 require 'lockally/models/vacation_responder'
 require 'lockally/models/webhook'
 require 'lockally/models/whoami'
+require 'lockally/models/whoami_key'
+require 'lockally/models/whoami_tenant'
 
 # APIs
 require 'lockally/api/add_ons_api'

data/spec/models/agent_send_result_spec.rb

@@ -33,12 +33,24 @@ describe Lockally::AgentSendResult do
     end
   end
 
+  describe 'test attribute "message_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "status"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
+  describe 'test attribute "warning"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "thread_id"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/mailbox_grant_list_spec.rb

@@ -27,7 +27,7 @@ describe Lockally::MailboxGrantList do
     end
   end
 
-  describe 'test attribute "mailboxes"' do
+  describe 'test attribute "grants"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/models/mailbox_grant_spec.rb

@@ -27,7 +27,13 @@ describe Lockally::MailboxGrant do
     end
   end
 
-  describe 'test attribute "id"' do
+  describe 'test attribute "api_key_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "mailbox_id"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
@@ -39,4 +45,10 @@ describe Lockally::MailboxGrant do
     end
   end
 
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/mark_read_result_spec.rb

@@ -27,6 +27,12 @@ describe Lockally::MarkReadResult do
     end
   end
 
+  describe 'test attribute "message_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "read"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/simulated_inbound_spec.rb

@@ -27,6 +27,18 @@ describe Lockally::SimulatedInbound do
     end
   end
 
+  describe 'test attribute "simulated"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "indexed"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "thread_id"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -39,6 +51,12 @@ describe Lockally::SimulatedInbound do
     end
   end
 
+  describe 'test attribute "rfc_message_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "annotations"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/thread_classification_spec.rb

@@ -39,6 +39,12 @@ describe Lockally::ThreadClassification do
     end
   end
 
+  describe 'test attribute "billed"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "classification"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/{thread_message_body_all_of_body_spec.rb → thread_message_body_body_spec.rb}

@@ -14,16 +14,16 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for Lockally::ThreadMessageBodyAllOfBody
+# Unit tests for Lockally::ThreadMessageBodyBody
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe Lockally::ThreadMessageBodyAllOfBody do
-  #let(:instance) { Lockally::ThreadMessageBodyAllOfBody.new }
+describe Lockally::ThreadMessageBodyBody do
+  #let(:instance) { Lockally::ThreadMessageBodyBody.new }
 
-  describe 'test an instance of ThreadMessageBodyAllOfBody' do
-    it 'should create an instance of ThreadMessageBodyAllOfBody' do
+  describe 'test an instance of ThreadMessageBodyBody' do
+    it 'should create an instance of ThreadMessageBodyBody' do
       # uncomment below to test the instance creation
-      #expect(instance).to be_instance_of(Lockally::ThreadMessageBodyAllOfBody)
+      #expect(instance).to be_instance_of(Lockally::ThreadMessageBodyBody)
     end
   end