passageidentity 0.2.3 → 0.3.0

data/docs/generated/UsersApi.md

@@ -0,0 +1,440 @@
+# OpenapiClient::UsersApi
+
+All URIs are relative to *https://api.passage.id/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**activate_user**](UsersApi.md#activate_user) | **PATCH** /apps/{app_id}/users/{user_id}/activate | Activate User |
+| [**create_user**](UsersApi.md#create_user) | **POST** /apps/{app_id}/users | Create User |
+| [**deactivate_user**](UsersApi.md#deactivate_user) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User |
+| [**delete_user**](UsersApi.md#delete_user) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User |
+| [**get_user**](UsersApi.md#get_user) | **GET** /apps/{app_id}/users/{user_id} | Get User |
+| [**update_user**](UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User |
+
+
+## activate_user
+
+> <UserResponse> activate_user(app_id, user_id)
+
+Activate User
+
+Activate a user. They will now be able to login.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UsersApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+
+begin
+  # Activate User
+  result = api_instance.activate_user(app_id, user_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->activate_user: #{e}"
+end
+```
+
+#### Using the activate_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> activate_user_with_http_info(app_id, user_id)
+
+```ruby
+begin
+  # Activate User
+  data, status_code, headers = api_instance.activate_user_with_http_info(app_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->activate_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_user
+
+> <UserResponse> create_user(app_id, create_user_request)
+
+Create User
+
+Create user for an application. Must provide an email of phone number identifier.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UsersApi.new
+app_id = 'app_id_example' # String | App ID
+create_user_request = OpenapiClient::CreateUserRequest.new # CreateUserRequest | email, phone, user_metadata
+
+begin
+  # Create User
+  result = api_instance.create_user(app_id, create_user_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->create_user: #{e}"
+end
+```
+
+#### Using the create_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> create_user_with_http_info(app_id, create_user_request)
+
+```ruby
+begin
+  # Create User
+  data, status_code, headers = api_instance.create_user_with_http_info(app_id, create_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->create_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **create_user_request** | [**CreateUserRequest**](CreateUserRequest.md) | email, phone, user_metadata |  |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_user
+
+> <UserResponse> deactivate_user(app_id, user_id)
+
+Deactivate User
+
+Deactivate a user. Their account will still exist, but they will not be able to login.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UsersApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+
+begin
+  # Deactivate User
+  result = api_instance.deactivate_user(app_id, user_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->deactivate_user: #{e}"
+end
+```
+
+#### Using the deactivate_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> deactivate_user_with_http_info(app_id, user_id)
+
+```ruby
+begin
+  # Deactivate User
+  data, status_code, headers = api_instance.deactivate_user_with_http_info(app_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->deactivate_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_user
+
+> delete_user(app_id, user_id)
+
+Delete User
+
+Delete a user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UsersApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+
+begin
+  # Delete User
+  api_instance.delete_user(app_id, user_id)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->delete_user: #{e}"
+end
+```
+
+#### Using the delete_user_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_user_with_http_info(app_id, user_id)
+
+```ruby
+begin
+  # Delete User
+  data, status_code, headers = api_instance.delete_user_with_http_info(app_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->delete_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user
+
+> <UserResponse> get_user(app_id, user_id)
+
+Get User
+
+Get information about a user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UsersApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+
+begin
+  # Get User
+  result = api_instance.get_user(app_id, user_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->get_user: #{e}"
+end
+```
+
+#### Using the get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> get_user_with_http_info(app_id, user_id)
+
+```ruby
+begin
+  # Get User
+  data, status_code, headers = api_instance.get_user_with_http_info(app_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_user
+
+> <UserResponse> update_user(app_id, user_id, update_user_request)
+
+Update User
+
+Update a user's information.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UsersApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+update_user_request = OpenapiClient::UpdateUserRequest.new # UpdateUserRequest | user settings
+
+begin
+  # Update User
+  result = api_instance.update_user(app_id, user_id, update_user_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->update_user: #{e}"
+end
+```
+
+#### Using the update_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserResponse>, Integer, Hash)> update_user_with_http_info(app_id, user_id, update_user_request)
+
+```ruby
+begin
+  # Update User
+  data, status_code, headers = api_instance.update_user_with_http_info(app_id, user_id, update_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UsersApi->update_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+| **update_user_request** | [**UpdateUserRequest**](UpdateUserRequest.md) | user settings |  |
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/generated/WebAuthnDevices.md

@@ -0,0 +1,34 @@
+# OpenapiClient::WebAuthnDevices
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | The first time this webAuthn device was used to authenticate the user |  |
+| **cred_id** | **String** | The CredID for this webAuthn device |  |
+| **friendly_name** | **String** | The friendly name for the webAuthn device used to authenticate |  |
+| **id** | **String** | The ID of the webAuthn device used for authentication |  |
+| **last_login_at** | **Time** | The last time this webAuthn device was used to authenticate the user |  |
+| **type** | [**WebAuthnType**](WebAuthnType.md) |  |  |
+| **updated_at** | **Time** | The last time this webAuthn device was updated |  |
+| **usage_count** | **Integer** | How many times this webAuthn device has been used to authenticate the user |  |
+| **icons** | [**WebAuthnIcons**](WebAuthnIcons.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::WebAuthnDevices.new(
+  created_at: null,
+  cred_id: null,
+  friendly_name: null,
+  id: null,
+  last_login_at: null,
+  type: null,
+  updated_at: null,
+  usage_count: null,
+  icons: null
+)
+```
+

data/docs/generated/WebAuthnIcons.md

@@ -0,0 +1,20 @@
+# OpenapiClient::WebAuthnIcons
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **light** | **String** |  |  |
+| **dark** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::WebAuthnIcons.new(
+  light: null,
+  dark: null
+)
+```
+

data/docs/generated/WebAuthnType.md

@@ -0,0 +1,15 @@
+# OpenapiClient::WebAuthnType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::WebAuthnType.new()
+```
+

data/generate.sh

@@ -0,0 +1,31 @@
+# #!/bin/bash
+# set -e
+
+if [ -z "$1" ]; then
+  echo "Required generator file is missing."
+  exit 1
+fi
+
+file="$1"
+
+npm install @openapitools/openapi-generator-cli -g
+
+mkdir generated
+
+openapi-generator-cli generate \
+  -i "$file" \
+  -g ruby \
+  -o ./generated \
+  --additional-properties=modelPropertyNaming=original,library=faraday
+
+rm -rf ./docs/generated
+mv ./generated/docs ./docs/generated
+mv ./generated/README.md ./docs/generated
+
+rm -rf ./lib/openapi_client
+mv ./generated/lib/openapi_client ./lib
+
+rm -rf ./lib/openapi_client.rb
+mv ./generated/lib/openapi_client.rb ./lib/openapi_client.rb
+
+rm -rf ./generated

data/lib/openapi_client/api/apps_api.rb

@@ -0,0 +1,85 @@
+=begin
+#Passage Management API
+
+#Passage's management API to manage your Passage apps and users.
+
+The version of the OpenAPI document: 1
+Contact: support@passage.id
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'cgi'
+
+module OpenapiClient
+  class AppsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get App
+    # Get app information.
+    # @param app_id [String] App ID
+    # @param [Hash] opts the optional parameters
+    # @return [AppResponse]
+    def get_app(app_id, opts = {})
+      data, _status_code, _headers = get_app_with_http_info(app_id, opts)
+      data
+    end
+
+    # Get App
+    # Get app information.
+    # @param app_id [String] App ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AppResponse, Integer, Hash)>] AppResponse data, response status code and response headers
+    def get_app_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AppsApi.get_app ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppsApi.get_app"
+      end
+      # resource path
+      local_var_path = '/apps/{app_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AppResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AppsApi.get_app",
+        :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: AppsApi#get_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end