yalla_auth_ruby_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a742e8d8188ae6641429152574de7bc12a62fe0fb867d6383e302a8deada77e8
+  data.tar.gz: 97574dbd9b7c937fba1dd1e7c6fea16ec84d1e1d521cf1e80cd2609ce43d5023
+SHA512:
+  metadata.gz: 834cc3bf8475fbfc977823dc7f07f8cca31bf72e07f4f15db69e1da39852902b312effc86f8b1bf31b29f7cd858d4d708ab3f41c24904ab28d4cb31f3cfd126c
+  data.tar.gz: 0c902721a7819f7260e4db25ac26cff60d09dd1f2098d28c280fd08210ad257daba5bc0dcc0480cd943c49ba4f1202bf3cd4eef1153360354ce9b27ef917a6ea

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,111 @@
+# openapi_client
+
+OpenapiClient - the Ruby gem for the API V1
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v1
+- Package version: 1.0.0
+- Generator version: 7.12.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build openapi_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./openapi_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'openapi_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'openapi_client', :git => 'https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::AppsApi.new
+access_token = 'access_token_example' # String | 
+opts = {
+  app: OpenapiClient::App.new # App | 
+}
+
+begin
+  #create app
+  api_instance.create_app(access_token, opts)
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling AppsApi->create_app: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://127.0.0.1:3085*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OpenapiClient::AppsApi* | [**create_app**](docs/AppsApi.md#create_app) | **POST** /api/v1/apps | create app
+*OpenapiClient::AppsApi* | [**delete_app**](docs/AppsApi.md#delete_app) | **DELETE** /api/v1/apps/{id} | delete app
+*OpenapiClient::AppsApi* | [**get_app**](docs/AppsApi.md#get_app) | **GET** /api/v1/apps/{id} | show app
+*OpenapiClient::AppsApi* | [**get_apps**](docs/AppsApi.md#get_apps) | **GET** /api/v1/apps | list apps
+*OpenapiClient::AppsApi* | [**patch_app**](docs/AppsApi.md#patch_app) | **PATCH** /api/v1/apps/{id} | update app
+*OpenapiClient::AppsApi* | [**update_app**](docs/AppsApi.md#update_app) | **PUT** /api/v1/apps/{id} | update app
+*OpenapiClient::AuthApi* | [**auth_validate_token_get**](docs/AuthApi.md#auth_validate_token_get) | **GET** /auth/validate_token | validates a token
+*OpenapiClient::UsersApi* | [**add_role_to_user**](docs/UsersApi.md#add_role_to_user) | **POST** /api/v1/users/{user_id}/roles | add role to user
+*OpenapiClient::UsersApi* | [**delete_role_from_user**](docs/UsersApi.md#delete_role_from_user) | **DELETE** /api/v1/users/{user_id}/roles/{role_id} | delete role
+*OpenapiClient::UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /api/v1/users/{id} | delete user
+*OpenapiClient::UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /api/v1/users/{id} | show user
+*OpenapiClient::UsersApi* | [**get_user_roles**](docs/UsersApi.md#get_user_roles) | **GET** /api/v1/users/{user_id}/roles | list roles of a user
+*OpenapiClient::UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /api/v1/users | list users
+*OpenapiClient::UsersApi* | [**patch_user**](docs/UsersApi.md#patch_user) | **PATCH** /api/v1/users/{id} | update user
+*OpenapiClient::UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /api/v1/users/{id} | update user
+
+
+## Documentation for Models
+
+ - [OpenapiClient::App](docs/App.md)
+ - [OpenapiClient::AuthValidateTokenGet200Response](docs/AuthValidateTokenGet200Response.md)
+ - [OpenapiClient::Role](docs/Role.md)
+ - [OpenapiClient::User](docs/User.md)
+ - [OpenapiClient::UserAppAdd](docs/UserAppAdd.md)
+ - [OpenapiClient::UserRoleAdd](docs/UserRoleAdd.md)
+
+
+## Documentation for Authorization
+
+Endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/App.md

@@ -0,0 +1,32 @@
+# OpenapiClient::App
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **category** | **String** |  | [optional] |
+| **logo** | **String** |  | [optional] |
+| **catalog** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::App.new(
+  name: My App,
+  url: https://www.example.com,
+  label: App label,
+  description: Short app info,
+  status: available,
+  category: administration,
+  logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA...,
+  catalog: true
+)
+```
+

data/docs/AppsApi.md

@@ -0,0 +1,399 @@
+# OpenapiClient::AppsApi
+
+All URIs are relative to *http://127.0.0.1:3085*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_app**](AppsApi.md#create_app) | **POST** /api/v1/apps | create app |
+| [**delete_app**](AppsApi.md#delete_app) | **DELETE** /api/v1/apps/{id} | delete app |
+| [**get_app**](AppsApi.md#get_app) | **GET** /api/v1/apps/{id} | show app |
+| [**get_apps**](AppsApi.md#get_apps) | **GET** /api/v1/apps | list apps |
+| [**patch_app**](AppsApi.md#patch_app) | **PATCH** /api/v1/apps/{id} | update app |
+| [**update_app**](AppsApi.md#update_app) | **PUT** /api/v1/apps/{id} | update app |
+
+
+## create_app
+
+> create_app(access_token, opts)
+
+create app
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+
+api_instance = OpenapiClient::AppsApi.new
+access_token = 'access_token_example' # String | 
+opts = {
+  app: OpenapiClient::App.new # App | 
+}
+
+begin
+  # create app
+  api_instance.create_app(access_token, opts)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->create_app: #{e}"
+end
+```
+
+#### Using the create_app_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)> create_app_with_http_info(access_token, opts)
+
+```ruby
+begin
+  # create app
+  data, status_code, headers = api_instance.create_app_with_http_info(access_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->create_app_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+| **app** | [**App**](App.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_app
+
+> delete_app(access_token, id)
+
+delete app
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+
+api_instance = OpenapiClient::AppsApi.new
+access_token = 'access_token_example' # String | 
+id = 'id_example' # String | id
+
+begin
+  # delete app
+  api_instance.delete_app(access_token, id)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->delete_app: #{e}"
+end
+```
+
+#### Using the delete_app_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)> delete_app_with_http_info(access_token, id)
+
+```ruby
+begin
+  # delete app
+  data, status_code, headers = api_instance.delete_app_with_http_info(access_token, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->delete_app_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+| **id** | **String** | id |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_app
+
+> get_app(access_token, id)
+
+show app
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+
+api_instance = OpenapiClient::AppsApi.new
+access_token = 'access_token_example' # String | 
+id = 'id_example' # String | id
+
+begin
+  # show app
+  api_instance.get_app(access_token, id)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->get_app: #{e}"
+end
+```
+
+#### Using the get_app_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)> get_app_with_http_info(access_token, id)
+
+```ruby
+begin
+  # show app
+  data, status_code, headers = api_instance.get_app_with_http_info(access_token, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->get_app_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+| **id** | **String** | id |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_apps
+
+> get_apps(access_token)
+
+list apps
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+
+api_instance = OpenapiClient::AppsApi.new
+access_token = 'access_token_example' # String | 
+
+begin
+  # list apps
+  api_instance.get_apps(access_token)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->get_apps: #{e}"
+end
+```
+
+#### Using the get_apps_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)> get_apps_with_http_info(access_token)
+
+```ruby
+begin
+  # list apps
+  data, status_code, headers = api_instance.get_apps_with_http_info(access_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->get_apps_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_app
+
+> patch_app(access_token, id, opts)
+
+update app
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+
+api_instance = OpenapiClient::AppsApi.new
+access_token = 'access_token_example' # String | 
+id = 'id_example' # String | id
+opts = {
+  app: OpenapiClient::App.new # App | 
+}
+
+begin
+  # update app
+  api_instance.patch_app(access_token, id, opts)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->patch_app: #{e}"
+end
+```
+
+#### Using the patch_app_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)> patch_app_with_http_info(access_token, id, opts)
+
+```ruby
+begin
+  # update app
+  data, status_code, headers = api_instance.patch_app_with_http_info(access_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->patch_app_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+| **id** | **String** | id |  |
+| **app** | [**App**](App.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_app
+
+> update_app(access_token, id, opts)
+
+update app
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+
+api_instance = OpenapiClient::AppsApi.new
+access_token = 'access_token_example' # String | 
+id = 'id_example' # String | id
+opts = {
+  app: OpenapiClient::App.new # App | 
+}
+
+begin
+  # update app
+  api_instance.update_app(access_token, id, opts)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->update_app: #{e}"
+end
+```
+
+#### Using the update_app_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)> update_app_with_http_info(access_token, id, opts)
+
+```ruby
+begin
+  # update app
+  data, status_code, headers = api_instance.update_app_with_http_info(access_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AppsApi->update_app_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+| **id** | **String** | id |  |
+| **app** | [**App**](App.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AuthApi.md

@@ -0,0 +1,70 @@
+# OpenapiClient::AuthApi
+
+All URIs are relative to *http://127.0.0.1:3085*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**auth_validate_token_get**](AuthApi.md#auth_validate_token_get) | **GET** /auth/validate_token | validates a token |
+
+
+## auth_validate_token_get
+
+> <AuthValidateTokenGet200Response> auth_validate_token_get(access_token)
+
+validates a token
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+
+api_instance = OpenapiClient::AuthApi.new
+access_token = 'access_token_example' # String | 
+
+begin
+  # validates a token
+  result = api_instance.auth_validate_token_get(access_token)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AuthApi->auth_validate_token_get: #{e}"
+end
+```
+
+#### Using the auth_validate_token_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthValidateTokenGet200Response>, Integer, Hash)> auth_validate_token_get_with_http_info(access_token)
+
+```ruby
+begin
+  # validates a token
+  data, status_code, headers = api_instance.auth_validate_token_get_with_http_info(access_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthValidateTokenGet200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling AuthApi->auth_validate_token_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+
+### Return type
+
+[**AuthValidateTokenGet200Response**](AuthValidateTokenGet200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AuthValidateTokenGet200Response.md

@@ -0,0 +1,20 @@
+# OpenapiClient::AuthValidateTokenGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **user** | [**User**](User.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::AuthValidateTokenGet200Response.new(
+  success: null,
+  user: null
+)
+```
+

data/docs/Role.md

@@ -0,0 +1,34 @@
+# OpenapiClient::Role
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **app_id** | **Integer** |  | [optional] |
+| **related_role_id** | **Integer** |  | [optional] |
+| **related_user_id** | **Integer** |  | [optional] |
+| **role_id** | **Integer** |  | [optional] |
+| **user_id** | **Integer** |  | [optional] |
+| **role** | **String** |  | [optional] |
+| **app** | **Object** |  | [optional] |
+| **related_role** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Role.new(
+  id: 12,
+  app_id: null,
+  related_role_id: null,
+  related_user_id: null,
+  role_id: 2,
+  user_id: 2,
+  role: APP_CREATE,
+  app: null,
+  related_role: null
+)
+```
+