lockally 0.1.0 → 0.3.0

data/lib/lockally/api/admins_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,23 +19,31 @@ module Lockally
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List tenant admins
+    # Delete an admin
+    # Hard-delete. Cascade-drops the admin's sessions (immediate revocation). Same safety rails as PATCH disabled=true. 
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [V1AdminsGet200Response]
-    def v1_admins_get(opts = {})
-      data, _status_code, _headers = v1_admins_get_with_http_info(opts)
-      data
+    # @return [nil]
+    def delete_admin(id, opts = {})
+      delete_admin_with_http_info(id, opts)
+      nil
     end
 
-    # List tenant admins
+    # Delete an admin
+    # Hard-delete. Cascade-drops the admin&#39;s sessions (immediate revocation). Same safety rails as PATCH disabled&#x3D;true. 
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(V1AdminsGet200Response, Integer, Hash)>] V1AdminsGet200Response data, response status code and response headers
-    def v1_admins_get_with_http_info(opts = {})
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_admin_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AdminsApi.v1_admins_get ...'
+        @api_client.config.logger.debug 'Calling API: AdminsApi.delete_admin ...'
+      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 AdminsApi.delete_admin"
       end
       # resource path
-      local_var_path = '/v1/admins'
+      local_var_path = '/v1/admins/{id}'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -43,7 +51,7 @@ module Lockally
       # 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] || {}
@@ -52,13 +60,13 @@ module Lockally
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'V1AdminsGet200Response'
+      return_type = opts[:debug_return_type]
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"AdminsApi.v1_admins_get",
+        :operation => :"AdminsApi.delete_admin",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -67,38 +75,38 @@ 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: AdminsApi#v1_admins_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AdminsApi#delete_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete an admin
-    # Hard-delete. Cascade-drops the admin's sessions (immediate revocation). Same safety rails as PATCH disabled=true. 
-    # @param id [String] 
+    # Invite a new admin
+    # Creates a new tenant admin. If `password` 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 [InviteAdminRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def v1_admins_id_delete(id, opts = {})
-      v1_admins_id_delete_with_http_info(id, opts)
-      nil
+    # @return [AdminFull]
+    def invite_admin(invite_admin_request, opts = {})
+      data, _status_code, _headers = invite_admin_with_http_info(invite_admin_request, opts)
+      data
     end
 
-    # Delete an admin
-    # Hard-delete. Cascade-drops the admin&#39;s sessions (immediate revocation). Same safety rails as PATCH disabled&#x3D;true. 
-    # @param id [String] 
+    # 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 [InviteAdminRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def v1_admins_id_delete_with_http_info(id, opts = {})
+    # @return [Array<(AdminFull, Integer, Hash)>] AdminFull data, response status code and response headers
+    def invite_admin_with_http_info(invite_admin_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AdminsApi.v1_admins_id_delete ...'
+        @api_client.config.logger.debug 'Calling API: AdminsApi.invite_admin ...'
       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 AdminsApi.v1_admins_id_delete"
+      # verify the required parameter 'invite_admin_request' is set
+      if @api_client.config.client_side_validation && invite_admin_request.nil?
+        fail ArgumentError, "Missing the required parameter 'invite_admin_request' when calling AdminsApi.invite_admin"
       end
       # resource path
-      local_var_path = '/v1/admins/{id}'.sub('{id}', CGI.escape(id.to_s))
+      local_var_path = '/v1/admins'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -106,22 +114,27 @@ 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_admin_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'AdminFull'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"AdminsApi.v1_admins_id_delete",
+        :operation => :"AdminsApi.invite_admin",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -130,44 +143,30 @@ 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(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AdminsApi#v1_admins_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AdminsApi#invite_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update an admin
-    # Supply at least one of `password`, `display_name`, `role`, `disabled`.  **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 [String] 
-    # @param v1_admins_id_patch_request [V1AdminsIdPatchRequest] 
+    # List tenant admins
     # @param [Hash] opts the optional parameters
-    # @return [AdminFull]
-    def v1_admins_id_patch(id, v1_admins_id_patch_request, opts = {})
-      data, _status_code, _headers = v1_admins_id_patch_with_http_info(id, v1_admins_id_patch_request, opts)
+    # @return [ListAdmins200Response]
+    def list_admins(opts = {})
+      data, _status_code, _headers = list_admins_with_http_info(opts)
       data
     end
 
-    # 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 [String] 
-    # @param v1_admins_id_patch_request [V1AdminsIdPatchRequest] 
+    # List tenant admins
     # @param [Hash] opts the optional parameters
-    # @return [Array<(AdminFull, Integer, Hash)>] AdminFull data, response status code and response headers
-    def v1_admins_id_patch_with_http_info(id, v1_admins_id_patch_request, opts = {})
+    # @return [Array<(ListAdmins200Response, Integer, Hash)>] ListAdmins200Response data, response status code and response headers
+    def list_admins_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AdminsApi.v1_admins_id_patch ...'
-      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 AdminsApi.v1_admins_id_patch"
-      end
-      # verify the required parameter 'v1_admins_id_patch_request' is set
-      if @api_client.config.client_side_validation && v1_admins_id_patch_request.nil?
-        fail ArgumentError, "Missing the required parameter 'v1_admins_id_patch_request' when calling AdminsApi.v1_admins_id_patch"
+        @api_client.config.logger.debug 'Calling API: AdminsApi.list_admins ...'
       end
       # resource path
-      local_var_path = '/v1/admins/{id}'.sub('{id}', CGI.escape(id.to_s))
+      local_var_path = '/v1/admins'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -176,26 +175,21 @@ module Lockally
       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']
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/json'])
-      if !content_type.nil?
-          header_params['Content-Type'] = content_type
-      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_admins_id_patch_request)
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'AdminFull'
+      return_type = opts[:debug_return_type] || 'ListAdmins200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"AdminsApi.v1_admins_id_patch",
+        :operation => :"AdminsApi.list_admins",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -204,38 +198,44 @@ module Lockally
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PATCH, 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: AdminsApi#v1_admins_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AdminsApi#list_admins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Invite a new admin
-    # Creates a new tenant admin. If `password` 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 [V1AdminsPostRequest] 
+    # Update an admin
+    # Supply at least one of `password`, `display_name`, `role`, `disabled`.  **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 [String] 
+    # @param update_admin_request [UpdateAdminRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AdminFull]
-    def v1_admins_post(v1_admins_post_request, opts = {})
-      data, _status_code, _headers = v1_admins_post_with_http_info(v1_admins_post_request, opts)
+    def update_admin(id, update_admin_request, opts = {})
+      data, _status_code, _headers = update_admin_with_http_info(id, update_admin_request, opts)
       data
     end
 
-    # 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 [V1AdminsPostRequest] 
+    # 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 [String] 
+    # @param update_admin_request [UpdateAdminRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AdminFull, Integer, Hash)>] AdminFull data, response status code and response headers
-    def v1_admins_post_with_http_info(v1_admins_post_request, opts = {})
+    def update_admin_with_http_info(id, update_admin_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AdminsApi.v1_admins_post ...'
+        @api_client.config.logger.debug 'Calling API: AdminsApi.update_admin ...'
+      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 AdminsApi.update_admin"
       end
-      # verify the required parameter 'v1_admins_post_request' is set
-      if @api_client.config.client_side_validation && v1_admins_post_request.nil?
-        fail ArgumentError, "Missing the required parameter 'v1_admins_post_request' when calling AdminsApi.v1_admins_post"
+      # verify the required parameter 'update_admin_request' is set
+      if @api_client.config.client_side_validation && update_admin_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_admin_request' when calling AdminsApi.update_admin"
       end
       # resource path
-      local_var_path = '/v1/admins'
+      local_var_path = '/v1/admins/{id}'.sub('{id}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -254,7 +254,7 @@ module Lockally
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_admins_post_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_admin_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'AdminFull'
@@ -263,7 +263,7 @@ module Lockally
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"AdminsApi.v1_admins_post",
+        :operation => :"AdminsApi.update_admin",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -272,9 +272,9 @@ module Lockally
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AdminsApi#v1_admins_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AdminsApi#update_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end