lago_ruby 0.46.0.pre.beta

data/docs/WebhookEndpointsApi.md

@@ -0,0 +1,363 @@
+# LagoAPI::WebhookEndpointsApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_webhook_endpoint**](WebhookEndpointsApi.md#create_webhook_endpoint) | **POST** /webhook_endpoints | Create a webhook_endpoint |
+| [**destroy_webhook_endpoint**](WebhookEndpointsApi.md#destroy_webhook_endpoint) | **DELETE** /webhook_endpoints/{lago_id} | Delete a webhook endpoint |
+| [**find_all_webhook_endpoints**](WebhookEndpointsApi.md#find_all_webhook_endpoints) | **GET** /webhook_endpoints | List all webhook endpoints |
+| [**find_webhook_endpoint**](WebhookEndpointsApi.md#find_webhook_endpoint) | **GET** /webhook_endpoints/{lago_id} | Retrieve a webhook endpoint |
+| [**update_webhook_endpoint**](WebhookEndpointsApi.md#update_webhook_endpoint) | **PUT** /webhook_endpoints/{lago_id} | Update a webhook endpoint |
+
+
+## create_webhook_endpoint
+
+> <CreateWebhookEndpoint200Response> create_webhook_endpoint(create_webhook_endpoint_request)
+
+Create a webhook_endpoint
+
+This endpoint is used to create a webhook endpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::WebhookEndpointsApi.new
+create_webhook_endpoint_request = LagoAPI::CreateWebhookEndpointRequest.new # CreateWebhookEndpointRequest | Webhook Endpoint payload
+
+begin
+  # Create a webhook_endpoint
+  result = api_instance.create_webhook_endpoint(create_webhook_endpoint_request)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->create_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the create_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWebhookEndpoint200Response>, Integer, Hash)> create_webhook_endpoint_with_http_info(create_webhook_endpoint_request)
+
+```ruby
+begin
+  # Create a webhook_endpoint
+  data, status_code, headers = api_instance.create_webhook_endpoint_with_http_info(create_webhook_endpoint_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWebhookEndpoint200Response>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->create_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_webhook_endpoint_request** | [**CreateWebhookEndpointRequest**](CreateWebhookEndpointRequest.md) | Webhook Endpoint payload |  |
+
+### Return type
+
+[**CreateWebhookEndpoint200Response**](CreateWebhookEndpoint200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## destroy_webhook_endpoint
+
+> Object destroy_webhook_endpoint(lago_id)
+
+Delete a webhook endpoint
+
+This endpoint is used to delete an existing webhook endpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::WebhookEndpointsApi.new
+lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
+
+begin
+  # Delete a webhook endpoint
+  result = api_instance.destroy_webhook_endpoint(lago_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->destroy_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the destroy_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> destroy_webhook_endpoint_with_http_info(lago_id)
+
+```ruby
+begin
+  # Delete a webhook endpoint
+  data, status_code, headers = api_instance.destroy_webhook_endpoint_with_http_info(lago_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->destroy_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint&#39;s record within the Lago system. |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_all_webhook_endpoints
+
+> <FindAllWebhookEndpoints200Response> find_all_webhook_endpoints(opts)
+
+List all webhook endpoints
+
+This endpoint is used to list all webhook endpoints.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::WebhookEndpointsApi.new
+opts = {
+  page: 1, # Integer | Page number.
+  per_page: 20 # Integer | Number of records per page.
+}
+
+begin
+  # List all webhook endpoints
+  result = api_instance.find_all_webhook_endpoints(opts)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->find_all_webhook_endpoints: #{e}"
+end
+```
+
+#### Using the find_all_webhook_endpoints_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FindAllWebhookEndpoints200Response>, Integer, Hash)> find_all_webhook_endpoints_with_http_info(opts)
+
+```ruby
+begin
+  # List all webhook endpoints
+  data, status_code, headers = api_instance.find_all_webhook_endpoints_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FindAllWebhookEndpoints200Response>
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->find_all_webhook_endpoints_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number. | [optional] |
+| **per_page** | **Integer** | Number of records per page. | [optional] |
+
+### Return type
+
+[**FindAllWebhookEndpoints200Response**](FindAllWebhookEndpoints200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_webhook_endpoint
+
+> Object find_webhook_endpoint(lago_id)
+
+Retrieve a webhook endpoint
+
+This endpoint is used to retrieve an existing webhook endpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::WebhookEndpointsApi.new
+lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
+
+begin
+  # Retrieve a webhook endpoint
+  result = api_instance.find_webhook_endpoint(lago_id)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->find_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the find_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> find_webhook_endpoint_with_http_info(lago_id)
+
+```ruby
+begin
+  # Retrieve a webhook endpoint
+  data, status_code, headers = api_instance.find_webhook_endpoint_with_http_info(lago_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->find_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint&#39;s record within the Lago system. |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_webhook_endpoint
+
+> Object update_webhook_endpoint(lago_id, create_webhook_endpoint_request)
+
+Update a webhook endpoint
+
+This endpoint is used to update an existing webhook endpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::WebhookEndpointsApi.new
+lago_id = '1a901a90-1a90-1a90-1a90-1a901a901a90' # String | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint's record within the Lago system.
+create_webhook_endpoint_request = LagoAPI::CreateWebhookEndpointRequest.new # CreateWebhookEndpointRequest | Webhook Endpoint update payload
+
+begin
+  # Update a webhook endpoint
+  result = api_instance.update_webhook_endpoint(lago_id, create_webhook_endpoint_request)
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->update_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the update_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> update_webhook_endpoint_with_http_info(lago_id, create_webhook_endpoint_request)
+
+```ruby
+begin
+  # Update a webhook endpoint
+  data, status_code, headers = api_instance.update_webhook_endpoint_with_http_info(lago_id, create_webhook_endpoint_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->update_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lago_id** | **String** | Unique identifier assigned to the webhook endpoint within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the webhook endpoint&#39;s record within the Lago system. |  |
+| **create_webhook_endpoint_request** | [**CreateWebhookEndpointRequest**](CreateWebhookEndpointRequest.md) | Webhook Endpoint update payload |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/WebhooksApi.md

@@ -0,0 +1,74 @@
+# LagoAPI::WebhooksApi
+
+All URIs are relative to *https://api.getlago.com/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**fetch_public_key**](WebhooksApi.md#fetch_public_key) | **GET** /webhooks/public_key | Retrieve webhook public key |
+
+
+## fetch_public_key
+
+> String fetch_public_key
+
+Retrieve webhook public key
+
+This endpoint is used to retrieve the public key used to verify the webhooks signature
+
+### Examples
+
+```ruby
+require 'time'
+require 'lago_ruby'
+# setup authorization
+LagoAPI.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LagoAPI::WebhooksApi.new
+
+begin
+  # Retrieve webhook public key
+  result = api_instance.fetch_public_key
+  p result
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhooksApi->fetch_public_key: #{e}"
+end
+```
+
+#### Using the fetch_public_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> fetch_public_key_with_http_info
+
+```ruby
+begin
+  # Retrieve webhook public key
+  data, status_code, headers = api_instance.fetch_public_key_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue LagoAPI::ApiError => e
+  puts "Error when calling WebhooksApi->fetch_public_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/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/lago_ruby.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Lago API documentation
+
+#Lago API allows your application to push customer information and metrics (events) from your application to the billing application.
+
+The version of the OpenAPI document: 0.46.0-beta
+Contact: tech@getlago.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "lago_ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lago_ruby"
+  s.version     = LagoAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lago"]
+  s.email       = ["tech@getlago.com"]
+  s.homepage    = "https://github.com/getlago/lago-ruby"
+  s.summary     = "Ruby wrapper for the Lago API"
+  s.description = "Enable your ruby application to interact with the Lago API"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+
+  s.metadata['homepage_uri'] = "https://www.getlago.com/"
+  s.metadata['source_code_uri'] = s.homepage
+  s.metadata['documentation_uri'] = "https://doc.getlago.com"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end