lockally 0.1.0

data/docs/WebhooksApi.md

@@ -0,0 +1,285 @@
+# Lockally::WebhooksApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_webhooks_get**](WebhooksApi.md#v1_webhooks_get) | **GET** /v1/webhooks | List webhooks |
+| [**v1_webhooks_id_delete**](WebhooksApi.md#v1_webhooks_id_delete) | **DELETE** /v1/webhooks/{id} | Delete a webhook |
+| [**v1_webhooks_id_patch**](WebhooksApi.md#v1_webhooks_id_patch) | **PATCH** /v1/webhooks/{id} | Update a webhook |
+| [**v1_webhooks_post**](WebhooksApi.md#v1_webhooks_post) | **POST** /v1/webhooks | Create a webhook |
+
+
+## v1_webhooks_get
+
+> <V1WebhooksGet200Response> v1_webhooks_get
+
+List webhooks
+
+Returns the calling tenant's webhook subscriptions. Never returns the signing secret — only metadata. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::WebhooksApi.new
+
+begin
+  # List webhooks
+  result = api_instance.v1_webhooks_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_get: #{e}"
+end
+```
+
+#### Using the v1_webhooks_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1WebhooksGet200Response>, Integer, Hash)> v1_webhooks_get_with_http_info
+
+```ruby
+begin
+  # List webhooks
+  data, status_code, headers = api_instance.v1_webhooks_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1WebhooksGet200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1WebhooksGet200Response**](V1WebhooksGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_webhooks_id_delete
+
+> v1_webhooks_id_delete(id)
+
+Delete a webhook
+
+Hard-delete; cascades to `webhook_deliveries` history.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::WebhooksApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete a webhook
+  api_instance.v1_webhooks_id_delete(id)
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_id_delete: #{e}"
+end
+```
+
+#### Using the v1_webhooks_id_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v1_webhooks_id_delete_with_http_info(id)
+
+```ruby
+begin
+  # Delete a webhook
+  data, status_code, headers = api_instance.v1_webhooks_id_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v1_webhooks_id_patch
+
+> <Webhook> v1_webhooks_id_patch(id, v1_webhooks_id_patch_request)
+
+Update a webhook
+
+Supply at least one of `url`, `events`, `paused`. Setting `paused` to `false` ALSO resets `consecutive_failures` to 0 — re-arms the 50-failure auto-pause counter. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::WebhooksApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+v1_webhooks_id_patch_request = Lockally::V1WebhooksIdPatchRequest.new # V1WebhooksIdPatchRequest | 
+
+begin
+  # Update a webhook
+  result = api_instance.v1_webhooks_id_patch(id, v1_webhooks_id_patch_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_id_patch: #{e}"
+end
+```
+
+#### Using the v1_webhooks_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Webhook>, Integer, Hash)> v1_webhooks_id_patch_with_http_info(id, v1_webhooks_id_patch_request)
+
+```ruby
+begin
+  # Update a webhook
+  data, status_code, headers = api_instance.v1_webhooks_id_patch_with_http_info(id, v1_webhooks_id_patch_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **v1_webhooks_id_patch_request** | [**V1WebhooksIdPatchRequest**](V1WebhooksIdPatchRequest.md) |  |  |
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## v1_webhooks_post
+
+> <Webhook> v1_webhooks_post(v1_webhooks_post_request)
+
+Create a webhook
+
+Subscribes a URL to one or more event types. Returns the `signing_secret` ONCE in the response — store it immediately. The dispatcher signs every outbound POST per design L3:      X-Lockally-Signature: t=<unix>,v1=<hex(hmac_sha256(secret, t + \".\" + body))>  Verify on your end using HMAC-SHA256 with a 5-minute timestamp window (replay protection). A reference verifier ships in [internal/webhook](https://github.com/ucheigwedinma/lockally/blob/main/internal/webhook/sign.go).  Event names: see the [event catalogue](https://github.com/ucheigwedinma/lockally/blob/main/docs/v1-design.md#64-webhook-event-catalogue-v1). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::WebhooksApi.new
+v1_webhooks_post_request = Lockally::V1WebhooksPostRequest.new({url: 'https://example.com/webhooks/lockally', events: ['domain.verified']}) # V1WebhooksPostRequest | 
+
+begin
+  # Create a webhook
+  result = api_instance.v1_webhooks_post(v1_webhooks_post_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_post: #{e}"
+end
+```
+
+#### Using the v1_webhooks_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Webhook>, Integer, Hash)> v1_webhooks_post_with_http_info(v1_webhooks_post_request)
+
+```ruby
+begin
+  # Create a webhook
+  data, status_code, headers = api_instance.v1_webhooks_post_with_http_info(v1_webhooks_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Webhook>
+rescue Lockally::ApiError => e
+  puts "Error when calling WebhooksApi->v1_webhooks_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v1_webhooks_post_request** | [**V1WebhooksPostRequest**](V1WebhooksPostRequest.md) |  |  |
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/lockally/api/add_ons_api.rb

@@ -0,0 +1,260 @@
+=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 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 'cgi'
+
+module Lockally
+  class AddOnsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Activate an add-on
+    # @param name [String] Add-on key
+    # @param [Hash] opts the optional parameters
+    # @return [ActivateAddOn200Response]
+    def activate_add_on(name, opts = {})
+      data, _status_code, _headers = activate_add_on_with_http_info(name, opts)
+      data
+    end
+
+    # Activate an add-on
+    # @param name [String] Add-on key
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivateAddOn200Response, Integer, Hash)>] ActivateAddOn200Response data, response status code and response headers
+    def activate_add_on_with_http_info(name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddOnsApi.activate_add_on ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling AddOnsApi.activate_add_on"
+      end
+      # resource path
+      local_var_path = '/v1/add-ons/{name}/activate'.sub('{name}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ActivateAddOn200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AddOnsApi.activate_add_on",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: AddOnsApi#activate_add_on\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Cancel an add-on
+    # @param name [String] Add-on key
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def cancel_add_on(name, opts = {})
+      cancel_add_on_with_http_info(name, opts)
+      nil
+    end
+
+    # Cancel an add-on
+    # @param name [String] Add-on key
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def cancel_add_on_with_http_info(name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddOnsApi.cancel_add_on ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling AddOnsApi.cancel_add_on"
+      end
+      # resource path
+      local_var_path = '/v1/add-ons/{name}/cancel'.sub('{name}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AddOnsApi.cancel_add_on",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: AddOnsApi#cancel_add_on\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get add-on status
+    # @param name [String] Add-on key
+    # @param [Hash] opts the optional parameters
+    # @return [GetAddOnStatus200Response]
+    def get_add_on_status(name, opts = {})
+      data, _status_code, _headers = get_add_on_status_with_http_info(name, opts)
+      data
+    end
+
+    # Get add-on status
+    # @param name [String] Add-on key
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetAddOnStatus200Response, Integer, Hash)>] GetAddOnStatus200Response data, response status code and response headers
+    def get_add_on_status_with_http_info(name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddOnsApi.get_add_on_status ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling AddOnsApi.get_add_on_status"
+      end
+      # resource path
+      local_var_path = '/v1/add-ons/{name}'.sub('{name}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetAddOnStatus200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AddOnsApi.get_add_on_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: AddOnsApi#get_add_on_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List add-ons
+    # @param [Hash] opts the optional parameters
+    # @return [ListAddOns200Response]
+    def list_add_ons(opts = {})
+      data, _status_code, _headers = list_add_ons_with_http_info(opts)
+      data
+    end
+
+    # List add-ons
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListAddOns200Response, Integer, Hash)>] ListAddOns200Response data, response status code and response headers
+    def list_add_ons_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddOnsApi.list_add_ons ...'
+      end
+      # resource path
+      local_var_path = '/v1/add-ons'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListAddOns200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AddOnsApi.list_add_ons",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: AddOnsApi#list_add_ons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end