lockally 0.1.0 → 0.3.0

data/lib/lockally/api/migrations_api.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/api/resources_api.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/api/send_api.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
@@ -19,59 +19,39 @@ module Lockally
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List outbound messages
-    # Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box. 
+    # Cancel a scheduled send
+    # Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :status 
-    # @option opts [String] :sender Exact match against the &#x60;from&#x60; mailbox.
-    # @option opts [String] :q Free-text search across subject + sender.
-    # @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
-    # @option opts [String] :cursor queued_at of the prior page boundary. Pass back the &#x60;next_cursor&#x60; returned by the previous call.
-    # @option opts [Integer] :limit  (default to 50)
-    # @return [V1MessagesGet200Response]
-    def v1_messages_get(opts = {})
-      data, _status_code, _headers = v1_messages_get_with_http_info(opts)
-      data
+    # @return [nil]
+    def cancel_message(id, opts = {})
+      cancel_message_with_http_info(id, opts)
+      nil
     end
 
-    # List outbound messages
-    # Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box. 
+    # Cancel a scheduled send
+    # Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :status 
-    # @option opts [String] :sender Exact match against the &#x60;from&#x60; mailbox.
-    # @option opts [String] :q Free-text search across subject + sender.
-    # @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
-    # @option opts [String] :cursor queued_at of the prior page boundary. Pass back the &#x60;next_cursor&#x60; returned by the previous call.
-    # @option opts [Integer] :limit  (default to 50)
-    # @return [Array<(V1MessagesGet200Response, Integer, Hash)>] V1MessagesGet200Response data, response status code and response headers
-    def v1_messages_get_with_http_info(opts = {})
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def cancel_message_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SendApi.v1_messages_get ...'
-      end
-      allowable_values = ["queued", "sending", "delivered", "bounced", "deferred", "complaint"]
-      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
-        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+        @api_client.config.logger.debug 'Calling API: SendApi.cancel_message ...'
       end
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendApi.v1_messages_get, must be smaller than or equal to 200.'
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SendApi.cancel_message"
       end
-
       # resource path
-      local_var_path = '/v1/messages'
+      local_var_path = '/v1/messages/{id}'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
-      query_params[:'sender'] = opts[:'sender'] if !opts[:'sender'].nil?
-      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
-      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
-      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
-      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+      header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -80,13 +60,13 @@ module Lockally
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'V1MessagesGet200Response'
+      return_type = opts[:debug_return_type]
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SendApi.v1_messages_get",
+        :operation => :"SendApi.cancel_message",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -95,35 +75,33 @@ module Lockally
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SendApi#v1_messages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SendApi#cancel_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Cancel a scheduled send
-    # Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
+    # Get message status
     # @param id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def v1_messages_id_delete(id, opts = {})
-      v1_messages_id_delete_with_http_info(id, opts)
-      nil
+    # @return [MessageDetail]
+    def get_message(id, opts = {})
+      data, _status_code, _headers = get_message_with_http_info(id, opts)
+      data
     end
 
-    # Cancel a scheduled send
-    # Cancels a still-scheduled message (future queued_at). Already sending/sent → 409.
+    # Get message status
     # @param id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def v1_messages_id_delete_with_http_info(id, opts = {})
+    # @return [Array<(MessageDetail, Integer, Hash)>] MessageDetail data, response status code and response headers
+    def get_message_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SendApi.v1_messages_id_delete ...'
+        @api_client.config.logger.debug 'Calling API: SendApi.get_message ...'
       end
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling SendApi.v1_messages_id_delete"
+        fail ArgumentError, "Missing the required parameter 'id' when calling SendApi.get_message"
       end
       # resource path
       local_var_path = '/v1/messages/{id}'.sub('{id}', CGI.escape(id.to_s))
@@ -134,7 +112,7 @@ module Lockally
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -143,13 +121,13 @@ module Lockally
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'MessageDetail'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SendApi.v1_messages_id_delete",
+        :operation => :"SendApi.get_message",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -158,39 +136,44 @@ module Lockally
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SendApi#v1_messages_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SendApi#get_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get message status
-    # @param id [String] 
+    # Aggregate delivery stats
+    # Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking. 
     # @param [Hash] opts the optional parameters
-    # @return [Message]
-    def v1_messages_id_get(id, opts = {})
-      data, _status_code, _headers = v1_messages_id_get_with_http_info(id, opts)
+    # @option opts [Time] :from Window start (default 7 days ago).
+    # @option opts [Time] :to Window end (default now).
+    # @option opts [String] :domain Filter by sender domain.
+    # @return [MessageStats]
+    def get_message_stats(opts = {})
+      data, _status_code, _headers = get_message_stats_with_http_info(opts)
       data
     end
 
-    # Get message status
-    # @param id [String] 
+    # Aggregate delivery stats
+    # Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking. 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Message, Integer, Hash)>] Message data, response status code and response headers
-    def v1_messages_id_get_with_http_info(id, opts = {})
+    # @option opts [Time] :from Window start (default 7 days ago).
+    # @option opts [Time] :to Window end (default now).
+    # @option opts [String] :domain Filter by sender domain.
+    # @return [Array<(MessageStats, Integer, Hash)>] MessageStats data, response status code and response headers
+    def get_message_stats_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SendApi.v1_messages_id_get ...'
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling SendApi.v1_messages_id_get"
+        @api_client.config.logger.debug 'Calling API: SendApi.get_message_stats ...'
       end
       # resource path
-      local_var_path = '/v1/messages/{id}'.sub('{id}', CGI.escape(id.to_s))
+      local_var_path = '/v1/messages/stats'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+      query_params[:'domain'] = opts[:'domain'] if !opts[:'domain'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -204,13 +187,13 @@ module Lockally
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Message'
+      return_type = opts[:debug_return_type] || 'MessageStats'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SendApi.v1_messages_id_get",
+        :operation => :"SendApi.get_message_stats",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -221,42 +204,59 @@ module Lockally
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SendApi#v1_messages_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SendApi#get_message_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Aggregate delivery stats
-    # Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking. 
+    # List outbound messages
+    # Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Time] :from Window start (default 7 days ago).
-    # @option opts [Time] :to Window end (default now).
-    # @option opts [String] :domain Filter by sender domain.
-    # @return [MessageStats]
-    def v1_messages_stats_get(opts = {})
-      data, _status_code, _headers = v1_messages_stats_get_with_http_info(opts)
+    # @option opts [String] :status 
+    # @option opts [String] :sender Exact match against the &#x60;from&#x60; mailbox.
+    # @option opts [String] :q Free-text search across subject + sender.
+    # @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
+    # @option opts [String] :cursor queued_at of the prior page boundary. Pass back the &#x60;next_cursor&#x60; returned by the previous call.
+    # @option opts [Integer] :limit  (default to 50)
+    # @return [ListMessages200Response]
+    def list_messages(opts = {})
+      data, _status_code, _headers = list_messages_with_http_info(opts)
       data
     end
 
-    # Aggregate delivery stats
-    # Counts by delivery outcome (delivered/bounced/deferred/complaint) plus rates over a window, from the delivery-event store. Privacy-first: this reflects what receiving servers reported, NOT whether a human opened the mail — Lockally does no open/click tracking. 
+    # List outbound messages
+    # Returns recent outbound messages for the calling tenant, sorted newest first. Backs the send-status pill in the SvelteKit /sends view and the outbound search box. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Time] :from Window start (default 7 days ago).
-    # @option opts [Time] :to Window end (default now).
-    # @option opts [String] :domain Filter by sender domain.
-    # @return [Array<(MessageStats, Integer, Hash)>] MessageStats data, response status code and response headers
-    def v1_messages_stats_get_with_http_info(opts = {})
+    # @option opts [String] :status 
+    # @option opts [String] :sender Exact match against the &#x60;from&#x60; mailbox.
+    # @option opts [String] :q Free-text search across subject + sender.
+    # @option opts [Time] :since Only messages queued at or after this RFC 3339 instant.
+    # @option opts [String] :cursor queued_at of the prior page boundary. Pass back the &#x60;next_cursor&#x60; returned by the previous call.
+    # @option opts [Integer] :limit  (default to 50)
+    # @return [Array<(ListMessages200Response, Integer, Hash)>] ListMessages200Response data, response status code and response headers
+    def list_messages_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SendApi.v1_messages_stats_get ...'
+        @api_client.config.logger.debug 'Calling API: SendApi.list_messages ...'
       end
+      allowable_values = ["queued", "sending", "delivered", "bounced", "deferred", "complaint"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendApi.list_messages, must be smaller than or equal to 200.'
+      end
+
       # resource path
-      local_var_path = '/v1/messages/stats'
+      local_var_path = '/v1/messages'
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
-      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
-      query_params[:'domain'] = opts[:'domain'] if !opts[:'domain'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'sender'] = opts[:'sender'] if !opts[:'sender'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -270,13 +270,13 @@ module Lockally
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'MessageStats'
+      return_type = opts[:debug_return_type] || 'ListMessages200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SendApi.v1_messages_stats_get",
+        :operation => :"SendApi.list_messages",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -287,46 +287,46 @@ module Lockally
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SendApi#v1_messages_stats_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SendApi#list_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Send a batch of emails
-    # Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`. 
+    # Send an email
+    # Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`.  **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message.  **Sender authorisation.** `from` must be an address the calling tenant owns on a verified domain. A mailbox always qualifies. On business and combined accounts an **alias** qualifies too, so a send-only address such as `no-reply@` need not be a billed seat. An alias on an unverified domain, or one belonging to another account, is refused with `403`. A catch-all creates no aliases and so grants no sending rights.  **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped.  **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send.  **Not every success is a 202.** Check the status code, not just the body. A `200` means nothing was queued: either every recipient was already suppressed, or the call used a test key and the send was simulated. Both are successes, and neither produces a real delivery. See the `200` response below.  **Warm-up headers.** While the platform is in its outbound warm-up ramp, accepted sends carry `X-Warmup-Day`, `X-Warmup-Daily-Cap` and `X-Warmup-Used-Today`. They describe a platform-wide cap shared by every tenant, not your own allowance, and they disappear once the ramp finishes. Hitting the cap returns 429. 
     # @param idempotency_key [String] 
-    # @param v1_send_batch_post_request [V1SendBatchPostRequest] 
+    # @param send_email_request [SendEmailRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [V1SendBatchPost200Response]
-    def v1_send_batch_post(idempotency_key, v1_send_batch_post_request, opts = {})
-      data, _status_code, _headers = v1_send_batch_post_with_http_info(idempotency_key, v1_send_batch_post_request, opts)
+    # @return [SendEmail200Response]
+    def send_email(idempotency_key, send_email_request, opts = {})
+      data, _status_code, _headers = send_email_with_http_info(idempotency_key, send_email_request, opts)
       data
     end
 
-    # Send a batch of emails
-    # Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One &#x60;Idempotency-Key&#x60; header covers the batch; per-message keys are derived as &#x60;&lt;key&gt;:&lt;index&gt;&#x60;. 
+    # Send an email
+    # Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally&#39;s queue; the actual SMTP submission to the recipient is async. Track delivery via &#x60;GET /v1/messages/{id}&#x60; or webhook subscriptions for &#x60;delivery.delivered&#x60; / &#x60;delivery.bounced&#x60; / &#x60;delivery.complaint&#x60;.  **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message.  **Sender authorisation.** &#x60;from&#x60; must be an address the calling tenant owns on a verified domain. A mailbox always qualifies. On business and combined accounts an **alias** qualifies too, so a send-only address such as &#x60;no-reply@&#x60; need not be a billed seat. An alias on an unverified domain, or one belonging to another account, is refused with &#x60;403&#x60;. A catch-all creates no aliases and so grants no sending rights.  **Rate cap.** Per-tenant &#x60;rate_cap_per_min&#x60; (returned on &#x60;/v1/tenant&#x60;) is enforced — 429 with &#x60;Retry-After: 60&#x60; once tripped.  **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a &#x60;warning&#x60; field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send.  **Not every success is a 202.** Check the status code, not just the body. A &#x60;200&#x60; means nothing was queued: either every recipient was already suppressed, or the call used a test key and the send was simulated. Both are successes, and neither produces a real delivery. See the &#x60;200&#x60; response below.  **Warm-up headers.** While the platform is in its outbound warm-up ramp, accepted sends carry &#x60;X-Warmup-Day&#x60;, &#x60;X-Warmup-Daily-Cap&#x60; and &#x60;X-Warmup-Used-Today&#x60;. They describe a platform-wide cap shared by every tenant, not your own allowance, and they disappear once the ramp finishes. Hitting the cap returns 429. 
     # @param idempotency_key [String] 
-    # @param v1_send_batch_post_request [V1SendBatchPostRequest] 
+    # @param send_email_request [SendEmailRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(V1SendBatchPost200Response, Integer, Hash)>] V1SendBatchPost200Response data, response status code and response headers
-    def v1_send_batch_post_with_http_info(idempotency_key, v1_send_batch_post_request, opts = {})
+    # @return [Array<(SendEmail200Response, Integer, Hash)>] SendEmail200Response data, response status code and response headers
+    def send_email_with_http_info(idempotency_key, send_email_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SendApi.v1_send_batch_post ...'
+        @api_client.config.logger.debug 'Calling API: SendApi.send_email ...'
       end
       # verify the required parameter 'idempotency_key' is set
       if @api_client.config.client_side_validation && idempotency_key.nil?
-        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling SendApi.v1_send_batch_post"
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling SendApi.send_email"
       end
-      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 200
-        fail ArgumentError, 'invalid value for "idempotency_key" when calling SendApi.v1_send_batch_post, the character length must be smaller than or equal to 200.'
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling SendApi.send_email, the character length must be smaller than or equal to 255.'
       end
 
-      # verify the required parameter 'v1_send_batch_post_request' is set
-      if @api_client.config.client_side_validation && v1_send_batch_post_request.nil?
-        fail ArgumentError, "Missing the required parameter 'v1_send_batch_post_request' when calling SendApi.v1_send_batch_post"
+      # verify the required parameter 'send_email_request' is set
+      if @api_client.config.client_side_validation && send_email_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_email_request' when calling SendApi.send_email"
       end
       # resource path
-      local_var_path = '/v1/send/batch'
+      local_var_path = '/v1/send'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -346,16 +346,16 @@ module Lockally
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_send_batch_post_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(send_email_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'V1SendBatchPost200Response'
+      return_type = opts[:debug_return_type] || 'SendEmail200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SendApi.v1_send_batch_post",
+        :operation => :"SendApi.send_email",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -366,46 +366,46 @@ module Lockally
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SendApi#v1_send_batch_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SendApi#send_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Send an email
-    # Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally's queue; the actual SMTP submission to the recipient is async. Track delivery via `GET /v1/messages/{id}` or webhook subscriptions for `delivery.delivered` / `delivery.bounced` / `delivery.complaint`.  **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message.  **Sender authorisation.** `from` must be a non-disabled mailbox owned by the calling tenant on a verified domain. Sending from aliases is not yet supported.  **Rate cap.** Per-tenant `rate_cap_per_min` (returned on `/v1/tenant`) is enforced — 429 with `Retry-After: 60` once tripped.  **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a `warning` field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send. 
+    # Send a batch of emails
+    # Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One `Idempotency-Key` header covers the batch; per-message keys are derived as `<key>:<index>`. 
     # @param idempotency_key [String] 
-    # @param v1_send_post_request [V1SendPostRequest] 
+    # @param send_email_batch_request [SendEmailBatchRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [V1SendPost202Response]
-    def v1_send_post(idempotency_key, v1_send_post_request, opts = {})
-      data, _status_code, _headers = v1_send_post_with_http_info(idempotency_key, v1_send_post_request, opts)
+    # @return [SendEmailBatch200Response]
+    def send_email_batch(idempotency_key, send_email_batch_request, opts = {})
+      data, _status_code, _headers = send_email_batch_with_http_info(idempotency_key, send_email_batch_request, opts)
       data
     end
 
-    # Send an email
-    # Submits an email for delivery via lockally. Returns 202 immediately once the message is accepted into lockally&#39;s queue; the actual SMTP submission to the recipient is async. Track delivery via &#x60;GET /v1/messages/{id}&#x60; or webhook subscriptions for &#x60;delivery.delivered&#x60; / &#x60;delivery.bounced&#x60; / &#x60;delivery.complaint&#x60;.  **Idempotency-Key required.** Per design L7 — any unique string per send, 24-hour dedupe window. Repeated calls with the same key return byte-exact the original response and do NOT create a duplicate message.  **Sender authorisation.** &#x60;from&#x60; must be a non-disabled mailbox owned by the calling tenant on a verified domain. Sending from aliases is not yet supported.  **Rate cap.** Per-tenant &#x60;rate_cap_per_min&#x60; (returned on &#x60;/v1/tenant&#x60;) is enforced — 429 with &#x60;Retry-After: 60&#x60; once tripped.  **Recipient warning.** Over 25 total recipients (To+Cc+Bcc) sets a &#x60;warning&#x60; field in the response — large fan-outs queue noticeably at scale. Hard cap is 100/send. 
+    # Send a batch of emails
+    # Sends up to 500 messages in one call. Each is validated and enqueued independently — a bad message fails only its own slot (partial success, HTTP 200). One &#x60;Idempotency-Key&#x60; header covers the batch; per-message keys are derived as &#x60;&lt;key&gt;:&lt;index&gt;&#x60;. 
     # @param idempotency_key [String] 
-    # @param v1_send_post_request [V1SendPostRequest] 
+    # @param send_email_batch_request [SendEmailBatchRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(V1SendPost202Response, Integer, Hash)>] V1SendPost202Response data, response status code and response headers
-    def v1_send_post_with_http_info(idempotency_key, v1_send_post_request, opts = {})
+    # @return [Array<(SendEmailBatch200Response, Integer, Hash)>] SendEmailBatch200Response data, response status code and response headers
+    def send_email_batch_with_http_info(idempotency_key, send_email_batch_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SendApi.v1_send_post ...'
+        @api_client.config.logger.debug 'Calling API: SendApi.send_email_batch ...'
       end
       # verify the required parameter 'idempotency_key' is set
       if @api_client.config.client_side_validation && idempotency_key.nil?
-        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling SendApi.v1_send_post"
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling SendApi.send_email_batch"
       end
-      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 255
-        fail ArgumentError, 'invalid value for "idempotency_key" when calling SendApi.v1_send_post, the character length must be smaller than or equal to 255.'
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 200
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling SendApi.send_email_batch, the character length must be smaller than or equal to 200.'
       end
 
-      # verify the required parameter 'v1_send_post_request' is set
-      if @api_client.config.client_side_validation && v1_send_post_request.nil?
-        fail ArgumentError, "Missing the required parameter 'v1_send_post_request' when calling SendApi.v1_send_post"
+      # verify the required parameter 'send_email_batch_request' is set
+      if @api_client.config.client_side_validation && send_email_batch_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_email_batch_request' when calling SendApi.send_email_batch"
       end
       # resource path
-      local_var_path = '/v1/send'
+      local_var_path = '/v1/send/batch'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -425,16 +425,16 @@ module Lockally
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_send_post_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(send_email_batch_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'V1SendPost202Response'
+      return_type = opts[:debug_return_type] || 'SendEmailBatch200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SendApi.v1_send_post",
+        :operation => :"SendApi.send_email_batch",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -445,7 +445,7 @@ module Lockally
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SendApi#v1_send_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SendApi#send_email_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/lockally/api/signup_api.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
@@ -22,7 +22,7 @@ module Lockally
     # Sign up a new tenant
     # @param signup_request [SignupRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [V1AdminLoginPost200Response]
+    # @return [AdminLogin200Response]
     def signup(signup_request, opts = {})
       data, _status_code, _headers = signup_with_http_info(signup_request, opts)
       data
@@ -31,7 +31,7 @@ module Lockally
     # Sign up a new tenant
     # @param signup_request [SignupRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(V1AdminLoginPost200Response, Integer, Hash)>] V1AdminLoginPost200Response data, response status code and response headers
+    # @return [Array<(AdminLogin200Response, Integer, Hash)>] AdminLogin200Response data, response status code and response headers
     def signup_with_http_info(signup_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SignupApi.signup ...'
@@ -63,7 +63,7 @@ module Lockally
       post_body = opts[:debug_body] || @api_client.object_to_http_body(signup_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'V1AdminLoginPost200Response'
+      return_type = opts[:debug_return_type] || 'AdminLogin200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || []