lockally 0.1.0 → 0.3.0

data/lib/lockally/models/webhook.rb

@@ -1,7 +1,7 @@
 =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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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 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

data/lib/lockally/models/whoami.rb

@@ -0,0 +1,177 @@
+=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 Whoami < ApiModelBase
+    attr_accessor :tenant_id
+
+    attr_accessor :tenant
+
+    # The API key's label.
+    attr_accessor :label
+
+    attr_accessor :scopes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tenant_id' => :'tenant_id',
+        :'tenant' => :'tenant',
+        :'label' => :'label',
+        :'scopes' => :'scopes'
+      }
+    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
+      {
+        :'tenant_id' => :'String',
+        :'tenant' => :'String',
+        :'label' => :'String',
+        :'scopes' => :'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::Whoami` 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::Whoami`. 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?(:'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']
+      end
+
+      if attributes.key?(:'scopes')
+        if (value = attributes[:'scopes']).is_a?(Array)
+          self.scopes = 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 &&
+          tenant_id == o.tenant_id &&
+          tenant == o.tenant &&
+          label == o.label &&
+          scopes == o.scopes
+    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
+      [tenant_id, tenant, label, scopes].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

@@ -1,7 +1,7 @@
 =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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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 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
@@ -11,5 +11,5 @@ Generator version: 7.23.0
 =end
 
 module Lockally
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/lockally.rb

@@ -1,7 +1,7 @@
 =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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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 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
@@ -26,6 +26,11 @@ require 'lockally/models/add_on'
 require 'lockally/models/add_shared_member_request'
 require 'lockally/models/admin'
 require 'lockally/models/admin_full'
+require 'lockally/models/admin_login200_response'
+require 'lockally/models/admin_login_request'
+require 'lockally/models/agent_send_result'
+require 'lockally/models/ai_config'
+require 'lockally/models/ai_config_update'
 require 'lockally/models/audit_event'
 require 'lockally/models/batch_lookup_public_keys200_response'
 require 'lockally/models/batch_lookup_public_keys200_response_data_inner'
@@ -38,6 +43,13 @@ require 'lockally/models/calendar_member'
 require 'lockally/models/calendar_policies'
 require 'lockally/models/contact'
 require 'lockally/models/contact_list'
+require 'lockally/models/contact_lookup'
+require 'lockally/models/contact_lookup_contact'
+require 'lockally/models/contact_lookup_history'
+require 'lockally/models/create_ai_units_checkout200_response'
+require 'lockally/models/create_alias_request'
+require 'lockally/models/create_api_key201_response'
+require 'lockally/models/create_api_key_request'
 require 'lockally/models/create_billing_checkout200_response'
 require 'lockally/models/create_billing_checkout_request'
 require 'lockally/models/create_calendar_event_request'
@@ -47,16 +59,20 @@ require 'lockally/models/create_contact_list_request'
 require 'lockally/models/create_contact_request'
 require 'lockally/models/create_dedicated_ip_request_request'
 require 'lockally/models/create_distribution_list_request'
+require 'lockally/models/create_domain_request'
 require 'lockally/models/create_encryption_key201_response'
 require 'lockally/models/create_encryption_key_request'
 require 'lockally/models/create_encryption_recovery_request'
+require 'lockally/models/create_mailbox_request'
 require 'lockally/models/create_migration_credential_request'
 require 'lockally/models/create_migration_credential_request_credentials'
 require 'lockally/models/create_migration_request'
 require 'lockally/models/create_resource_request'
+require 'lockally/models/create_suppression_request'
 require 'lockally/models/create_units_checkout200_response'
 require 'lockally/models/create_units_checkout_request'
 require 'lockally/models/create_user_request'
+require 'lockally/models/create_webhook_request'
 require 'lockally/models/dns_record'
 require 'lockally/models/dedicated_ip_request'
 require 'lockally/models/directory_permissions'
@@ -64,9 +80,15 @@ require 'lockally/models/discover_migration202_response'
 require 'lockally/models/distribution_list_detail'
 require 'lockally/models/distribution_list_summary'
 require 'lockally/models/domain'
+require 'lockally/models/draft'
+require 'lockally/models/draft_list'
+require 'lockally/models/draft_result'
+require 'lockally/models/export_mailbox201_response'
 require 'lockally/models/gal_settings'
 require 'lockally/models/get_add_on_status200_response'
 require 'lockally/models/get_audit_summary200_response'
+require 'lockally/models/get_calendar_overview200_response'
+require 'lockally/models/get_calendar_overview200_response_activity_inner'
 require 'lockally/models/get_calendar_security200_response'
 require 'lockally/models/get_calendar_security200_response_alerts_inner'
 require 'lockally/models/get_calendar_security200_response_delegated_access_inner'
@@ -76,6 +98,7 @@ require 'lockally/models/get_contact_list200_response'
 require 'lockally/models/get_contact_list200_response_members_inner'
 require 'lockally/models/get_contact_lists200_response'
 require 'lockally/models/get_contact_lists200_response_data_inner'
+require 'lockally/models/get_current_admin200_response'
 require 'lockally/models/get_directory_activity200_response'
 require 'lockally/models/get_directory_activity200_response_data_inner'
 require 'lockally/models/get_directory_stats200_response'
@@ -93,9 +116,16 @@ require 'lockally/models/get_security200_response_stats_inner'
 require 'lockally/models/get_storage200_response'
 require 'lockally/models/get_storage200_response_top_mailboxes_inner'
 require 'lockally/models/get_storage200_response_top_messages_inner'
+require 'lockally/models/get_usage200_response'
 require 'lockally/models/get_user_insights200_response'
-require 'lockally/models/healthz_get200_response'
+require 'lockally/models/health_check200_response'
+require 'lockally/models/inbox'
+require 'lockally/models/inbox_list'
+require 'lockally/models/invite_admin_request'
 require 'lockally/models/list_add_ons200_response'
+require 'lockally/models/list_admins200_response'
+require 'lockally/models/list_aliases200_response'
+require 'lockally/models/list_api_keys200_response'
 require 'lockally/models/list_calendar_events200_response'
 require 'lockally/models/list_calendar_integrations200_response'
 require 'lockally/models/list_calendar_members200_response'
@@ -104,17 +134,28 @@ require 'lockally/models/list_contact_lists200_response'
 require 'lockally/models/list_contacts200_response'
 require 'lockally/models/list_dedicated_ip_requests200_response'
 require 'lockally/models/list_distribution_lists200_response'
+require 'lockally/models/list_domains200_response'
+require 'lockally/models/list_mailboxes200_response'
+require 'lockally/models/list_messages200_response'
 require 'lockally/models/list_migration_credentials200_response'
 require 'lockally/models/list_migration_events200_response'
 require 'lockally/models/list_migration_mailboxes200_response'
 require 'lockally/models/list_migrations200_response'
 require 'lockally/models/list_resources200_response'
 require 'lockally/models/list_shared_members200_response'
+require 'lockally/models/list_suppressions200_response'
+require 'lockally/models/list_templates200_response'
 require 'lockally/models/list_users200_response'
+require 'lockally/models/list_vacation_responders200_response'
+require 'lockally/models/list_webhooks200_response'
 require 'lockally/models/mailbox'
+require 'lockally/models/mailbox_grant'
+require 'lockally/models/mailbox_grant_list'
 require 'lockally/models/map_migration_request'
 require 'lockally/models/map_migration_request_mappings_inner'
+require 'lockally/models/mark_read_result'
 require 'lockally/models/message'
+require 'lockally/models/message_detail'
 require 'lockally/models/message_stats'
 require 'lockally/models/message_stats_counts'
 require 'lockally/models/message_stats_rates'
@@ -132,16 +173,35 @@ require 'lockally/models/problem'
 require 'lockally/models/replace_distribution_list_members200_response'
 require 'lockally/models/replace_distribution_list_members_request'
 require 'lockally/models/resource'
+require 'lockally/models/return_path'
+require 'lockally/models/return_path_check'
 require 'lockally/models/rotate_encryption_key_request'
+require 'lockally/models/send_email200_response'
+require 'lockally/models/send_email202_response'
+require 'lockally/models/send_email_batch200_response'
+require 'lockally/models/send_email_batch_request'
+require 'lockally/models/send_email_request'
+require 'lockally/models/send_email_request_attachments_inner'
 require 'lockally/models/send_message'
+require 'lockally/models/set_vacation_responder_request'
 require 'lockally/models/shared_member'
 require 'lockally/models/signup_request'
+require 'lockally/models/simulated_inbound'
+require 'lockally/models/start_conversation_request'
 require 'lockally/models/start_migration202_response'
 require 'lockally/models/suppression'
 require 'lockally/models/template'
 require 'lockally/models/template_input'
 require 'lockally/models/tenant'
+require 'lockally/models/thread'
+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_summary'
 require 'lockally/models/unit_bundle'
+require 'lockally/models/update_admin_request'
 require 'lockally/models/update_calendar_event_request'
 require 'lockally/models/update_calendar_integration_request'
 require 'lockally/models/update_calendar_member_request'
@@ -151,48 +211,18 @@ require 'lockally/models/update_contact_list_request'
 require 'lockally/models/update_contact_request'
 require 'lockally/models/update_directory_permissions_request'
 require 'lockally/models/update_gal_settings_request'
+require 'lockally/models/update_mailbox_request'
 require 'lockally/models/update_migration_mailbox_request'
 require 'lockally/models/update_migration_request'
 require 'lockally/models/update_resource_request'
 require 'lockally/models/update_user_request'
+require 'lockally/models/update_webhook_request'
 require 'lockally/models/user'
 require 'lockally/models/user_event'
-require 'lockally/models/v1_admin_login_post200_response'
-require 'lockally/models/v1_admin_login_post_request'
-require 'lockally/models/v1_admin_me_get200_response'
-require 'lockally/models/v1_admins_get200_response'
-require 'lockally/models/v1_admins_id_patch_request'
-require 'lockally/models/v1_admins_post_request'
-require 'lockally/models/v1_aliases_get200_response'
-require 'lockally/models/v1_aliases_post_request'
-require 'lockally/models/v1_api_keys_get200_response'
-require 'lockally/models/v1_api_keys_post201_response'
-require 'lockally/models/v1_api_keys_post_request'
-require 'lockally/models/v1_domains_get200_response'
-require 'lockally/models/v1_domains_post_request'
-require 'lockally/models/v1_inboxes_mailbox_messages_post_request'
-require 'lockally/models/v1_mailboxes_email_export_post201_response'
-require 'lockally/models/v1_mailboxes_email_patch_request'
-require 'lockally/models/v1_mailboxes_email_vacation_put_request'
-require 'lockally/models/v1_mailboxes_get200_response'
-require 'lockally/models/v1_mailboxes_post_request'
-require 'lockally/models/v1_messages_get200_response'
-require 'lockally/models/v1_send_batch_post200_response'
-require 'lockally/models/v1_send_batch_post_request'
-require 'lockally/models/v1_send_post202_response'
-require 'lockally/models/v1_send_post_request'
-require 'lockally/models/v1_send_post_request_attachments_inner'
-require 'lockally/models/v1_suppressions_get200_response'
-require 'lockally/models/v1_suppressions_post_request'
-require 'lockally/models/v1_templates_get200_response'
-require 'lockally/models/v1_usage_get200_response'
-require 'lockally/models/v1_vacation_get200_response'
-require 'lockally/models/v1_webhooks_get200_response'
-require 'lockally/models/v1_webhooks_id_patch_request'
-require 'lockally/models/v1_webhooks_post_request'
 require 'lockally/models/vacation_params'
 require 'lockally/models/vacation_responder'
 require 'lockally/models/webhook'
+require 'lockally/models/whoami'
 
 # APIs
 require 'lockally/api/add_ons_api'

data/lockally.gemspec

@@ -3,7 +3,7 @@
 =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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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 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
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["support@lockally.com"]
   s.homepage    = "https://lockally.com"
   s.summary     = "Ruby client for the Lockally API"
-  s.description = "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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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`. "
+  s.description = "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`. "
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.7"
   s.metadata    = {}

data/spec/api/add_ons_api_spec.rb

@@ -1,7 +1,7 @@
 =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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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 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

data/spec/api/admin_api_spec.rb

@@ -1,7 +1,7 @@
 =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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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 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
@@ -32,35 +32,35 @@ describe 'AdminApi' do
     end
   end
 
-  # unit tests for v1_admin_login_post
+  # unit tests for admin_login
   # Tenant-admin email+password login
   # Exchanges an admin&#39;s email + password for a session token. The web console at &#x60;app.lockally.com&#x60; posts this on form submission and stores the returned token in an httpOnly cookie.  **No enumeration leak.** Wrong-email and wrong-password both return the same 401 with title \&quot;Invalid credentials\&quot;. The argon2id verify runs even on lookup miss (well, structurally — the lookup fails fast but the response shape is constant) so timing leaks are bounded.  Tokens are prefixed &#x60;adm_sess_&#x60; and valid for 7 days. Use as the &#x60;Authorization: Bearer&#x60; value on all subsequent calls. 
-  # @param v1_admin_login_post_request 
+  # @param admin_login_request 
   # @param [Hash] opts the optional parameters
-  # @return [V1AdminLoginPost200Response]
-  describe 'v1_admin_login_post test' do
+  # @return [AdminLogin200Response]
+  describe 'admin_login test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_admin_logout_post
+  # unit tests for admin_logout
   # Invalidate the current admin session
   # Deletes the session row from the database. Idempotent — calling logout on an already-invalid token returns 204 anyway. 
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'v1_admin_logout_post test' do
+  describe 'admin_logout test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_admin_me_get
+  # unit tests for get_current_admin
   # Get the current admin + tenant
   # Returns the admin profile + tenant for the session token presented in &#x60;Authorization: Bearer&#x60;. Used by the web console&#39;s layout load function to populate the sidebar.  Returns 403 if called with an API key (lk_live_*) bearer — admin context only exists for session tokens. 
   # @param [Hash] opts the optional parameters
-  # @return [V1AdminMeGet200Response]
-  describe 'v1_admin_me_get test' do
+  # @return [GetCurrentAdmin200Response]
+  describe 'get_current_admin test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/admins_api_spec.rb

@@ -1,7 +1,7 @@
 =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>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **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 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
@@ -32,48 +32,48 @@ describe 'AdminsApi' do
     end
   end
 
-  # unit tests for v1_admins_get
-  # List tenant admins
+  # unit tests for delete_admin
+  # Delete an admin
+  # Hard-delete. Cascade-drops the admin&#39;s sessions (immediate revocation). Same safety rails as PATCH disabled&#x3D;true. 
+  # @param id 
   # @param [Hash] opts the optional parameters
-  # @return [V1AdminsGet200Response]
-  describe 'v1_admins_get test' do
+  # @return [nil]
+  describe 'delete_admin test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_admins_id_delete
-  # Delete an admin
-  # Hard-delete. Cascade-drops the admin&#39;s sessions (immediate revocation). Same safety rails as PATCH disabled&#x3D;true. 
-  # @param id 
+  # unit tests for invite_admin
+  # Invite a new admin
+  # Creates a new tenant admin. If &#x60;password&#x60; is omitted, lockally generates a 16-char password and returns it ONCE in the response. Email is case-insensitive and unique per tenant. 
+  # @param invite_admin_request 
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'v1_admins_id_delete test' do
+  # @return [AdminFull]
+  describe 'invite_admin test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_admins_id_patch
-  # Update an admin
-  # Supply at least one of &#x60;password&#x60;, &#x60;display_name&#x60;, &#x60;role&#x60;, &#x60;disabled&#x60;.  **Safety rails.** A session bearer (adm_sess_*) cannot disable itself — use another admin or an API key (which bypasses the self-rail). Disabling the last active admin returns 409 to prevent orphaning the tenant from its console. 
-  # @param id 
-  # @param v1_admins_id_patch_request 
+  # unit tests for list_admins
+  # List tenant admins
   # @param [Hash] opts the optional parameters
-  # @return [AdminFull]
-  describe 'v1_admins_id_patch test' do
+  # @return [ListAdmins200Response]
+  describe 'list_admins test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for v1_admins_post
-  # Invite a new admin
-  # Creates a new tenant admin. If &#x60;password&#x60; is omitted, lockally generates a 16-char password and returns it ONCE in the response. Email is case-insensitive and unique per tenant. 
-  # @param v1_admins_post_request 
+  # unit tests for update_admin
+  # Update an admin
+  # Supply at least one of &#x60;password&#x60;, &#x60;display_name&#x60;, &#x60;role&#x60;, &#x60;disabled&#x60;.  **Safety rails.** A session bearer (adm_sess_*) cannot disable itself — use another admin or an API key (which bypasses the self-rail). Disabling the last active admin returns 409 to prevent orphaning the tenant from its console. 
+  # @param id 
+  # @param update_admin_request 
   # @param [Hash] opts the optional parameters
   # @return [AdminFull]
-  describe 'v1_admins_post test' do
+  describe 'update_admin test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end