diff --git a/docs/AppleUserSocialConnection.md b/docs/AppleUserSocialConnection.md deleted file mode 100644 index 4c272b5..0000000 --- a/docs/AppleUserSocialConnection.md +++ /dev/null @@ -1,24 +0,0 @@ -# OpenapiClient::AppleUserSocialConnection - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **provider_id** | **String** | The external ID of the Social Connection. | | -| **created_at** | **Time** | | | -| **last_login_at** | **Time** | | | -| **provider_identifier** | **String** | The email of connected social user. | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::AppleUserSocialConnection.new( - provider_id: null, - created_at: null, - last_login_at: null, - provider_identifier: null -) -``` - diff --git a/docs/CreateMagicLinkRequest.md b/docs/CreateMagicLinkRequest.md deleted file mode 100644 index 3b6817f..0000000 --- a/docs/CreateMagicLinkRequest.md +++ /dev/null @@ -1,36 +0,0 @@ -# OpenapiClient::CreateMagicLinkRequest - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **channel** | [**MagicLinkChannel**](MagicLinkChannel.md) | | [optional] | -| **email** | **String** | | [optional] | -| **language** | **String** | language of the email to send (optional) | [optional] | -| **magic_link_path** | **String** | must be a relative url | [optional] | -| **phone** | **String** | | [optional] | -| **redirect_url** | **String** | | [optional] | -| **_send** | **Boolean** | | [optional] | -| **ttl** | **Integer** | | [optional] | -| **type** | [**MagicLinkType**](MagicLinkType.md) | | [optional] | -| **user_id** | **String** | | [optional] | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::CreateMagicLinkRequest.new( - channel: null, - email: null, - language: null, - magic_link_path: null, - phone: null, - redirect_url: null, - _send: null, - ttl: null, - type: null, - user_id: null -) -``` - diff --git a/docs/CreateUserArgs.md b/docs/CreateUserArgs.md deleted file mode 100644 index 353b191..0000000 --- a/docs/CreateUserArgs.md +++ /dev/null @@ -1,22 +0,0 @@ -# OpenapiClient::CreateUserArgs - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **email** | **String** | Email of the new user. Either this or `phone` is required; both may be provided. | [optional] | -| **phone** | **String** | Phone number of the new user. Either this or `email` is required; both may be provided. | [optional] | -| **user_metadata** | **Object** | | [optional] | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::CreateUserArgs.new( - email: null, - phone: null, - user_metadata: null -) -``` - diff --git a/docs/GithubUserSocialConnection.md b/docs/GithubUserSocialConnection.md deleted file mode 100644 index 03e9304..0000000 --- a/docs/GithubUserSocialConnection.md +++ /dev/null @@ -1,24 +0,0 @@ -# OpenapiClient::GithubUserSocialConnection - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **provider_id** | **String** | The external ID of the Social Connection. | | -| **created_at** | **Time** | | | -| **last_login_at** | **Time** | | | -| **provider_identifier** | **String** | The email of connected social user. | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::GithubUserSocialConnection.new( - provider_id: null, - created_at: null, - last_login_at: null, - provider_identifier: null -) -``` - diff --git a/docs/GoogleUserSocialConnection.md b/docs/GoogleUserSocialConnection.md deleted file mode 100644 index d825cc1..0000000 --- a/docs/GoogleUserSocialConnection.md +++ /dev/null @@ -1,24 +0,0 @@ -# OpenapiClient::GoogleUserSocialConnection - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **provider_id** | **String** | The external ID of the Social Connection. | | -| **created_at** | **Time** | | | -| **last_login_at** | **Time** | | | -| **provider_identifier** | **String** | The email of connected social user. | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::GoogleUserSocialConnection.new( - provider_id: null, - created_at: null, - last_login_at: null, - provider_identifier: null -) -``` - diff --git a/docs/Link.md b/docs/Link.md deleted file mode 100644 index f8d98b9..0000000 --- a/docs/Link.md +++ /dev/null @@ -1,18 +0,0 @@ -# OpenapiClient::Link - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **href** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::Link.new( - href: null -) -``` - diff --git a/docs/ListDevicesResponse.md b/docs/ListDevicesResponse.md deleted file mode 100644 index aa523c2..0000000 --- a/docs/ListDevicesResponse.md +++ /dev/null @@ -1,18 +0,0 @@ -# OpenapiClient::ListDevicesResponse - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **devices** | [**Array<WebAuthnDevices>**](WebAuthnDevices.md) | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::ListDevicesResponse.new( - devices: null -) -``` - diff --git a/docs/ListPaginatedUsersItem.md b/docs/ListPaginatedUsersItem.md deleted file mode 100644 index affeff3..0000000 --- a/docs/ListPaginatedUsersItem.md +++ /dev/null @@ -1,40 +0,0 @@ -# OpenapiClient::ListPaginatedUsersItem - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | | | -| **email** | **String** | | | -| **email_verified** | **Boolean** | | | -| **external_id** | **String** | The external ID of the user. Only set if the user was created in a Flex app. | | -| **id** | **String** | | | -| **last_login_at** | **Time** | | | -| **login_count** | **Integer** | | | -| **phone** | **String** | | | -| **phone_verified** | **Boolean** | | | -| **status** | [**UserStatus**](UserStatus.md) | | | -| **updated_at** | **Time** | | | -| **user_metadata** | **Object** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::ListPaginatedUsersItem.new( - created_at: null, - email: null, - email_verified: null, - external_id: null, - id: null, - last_login_at: null, - login_count: null, - phone: null, - phone_verified: null, - status: null, - updated_at: null, - user_metadata: null -) -``` - diff --git a/docs/ListPaginatedUsersResponse.md b/docs/ListPaginatedUsersResponse.md deleted file mode 100644 index 8006470..0000000 --- a/docs/ListPaginatedUsersResponse.md +++ /dev/null @@ -1,28 +0,0 @@ -# OpenapiClient::ListPaginatedUsersResponse - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_links** | [**PaginatedLinks**](PaginatedLinks.md) | | | -| **created_before** | **Integer** | time anchor (Unix timestamp) --> all users returned created before this timestamp | | -| **limit** | **Integer** | | | -| **page** | **Integer** | | | -| **total_users** | **Integer** | total number of users for a particular query | | -| **users** | [**Array<ListPaginatedUsersItem>**](ListPaginatedUsersItem.md) | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::ListPaginatedUsersResponse.new( - _links: null, - created_before: null, - limit: null, - page: null, - total_users: null, - users: null -) -``` - diff --git a/docs/MagicLink.md b/docs/MagicLink.md deleted file mode 100644 index b1f2a36..0000000 --- a/docs/MagicLink.md +++ /dev/null @@ -1,36 +0,0 @@ -# OpenapiClient::MagicLink - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **activated** | **Boolean** | | | -| **app_id** | **String** | | | -| **id** | **String** | | | -| **identifier** | **String** | | | -| **redirect_url** | **String** | | | -| **secret** | **String** | | | -| **ttl** | **Integer** | | | -| **type** | [**MagicLinkType**](MagicLinkType.md) | | | -| **url** | **String** | | | -| **user_id** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::MagicLink.new( - activated: null, - app_id: null, - id: null, - identifier: null, - redirect_url: null, - secret: null, - ttl: null, - type: null, - url: null, - user_id: null -) -``` - diff --git a/docs/MagicLinkChannel.md b/docs/MagicLinkChannel.md deleted file mode 100644 index a763094..0000000 --- a/docs/MagicLinkChannel.md +++ /dev/null @@ -1,15 +0,0 @@ -# OpenapiClient::MagicLinkChannel - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::MagicLinkChannel.new() -``` - diff --git a/docs/MagicLinkResponse.md b/docs/MagicLinkResponse.md deleted file mode 100644 index 29a7c2c..0000000 --- a/docs/MagicLinkResponse.md +++ /dev/null @@ -1,18 +0,0 @@ -# OpenapiClient::MagicLinkResponse - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **magic_link** | [**MagicLink**](MagicLink.md) | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::MagicLinkResponse.new( - magic_link: null -) -``` - diff --git a/docs/MagicLinkType.md b/docs/MagicLinkType.md deleted file mode 100644 index 1d104fd..0000000 --- a/docs/MagicLinkType.md +++ /dev/null @@ -1,15 +0,0 @@ -# OpenapiClient::MagicLinkType - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::MagicLinkType.new() -``` - diff --git a/docs/MagicLinksApi.md b/docs/MagicLinksApi.md deleted file mode 100644 index 0e5ce5c..0000000 --- a/docs/MagicLinksApi.md +++ /dev/null @@ -1,79 +0,0 @@ -# OpenapiClient::MagicLinksApi - -All URIs are relative to *https://api.passage.id/v1* - -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_magic_link**](MagicLinksApi.md#create_magic_link) | **POST** /apps/{app_id}/magic-links | Create Embeddable Magic Link | - - -## create_magic_link - -> create_magic_link(app_id, create_magic_link_request) - -Create Embeddable Magic Link - -Create magic link for 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::MagicLinksApi.new -app_id = 'app_id_example' # String | App ID -create_magic_link_request = OpenapiClient::CreateMagicLinkRequest.new # CreateMagicLinkRequest | Request to create a magic link - -begin - # Create Embeddable Magic Link - result = api_instance.create_magic_link(app_id, create_magic_link_request) - p result -rescue OpenapiClient::ApiError => e - puts "Error when calling MagicLinksApi->create_magic_link: #{e}" -end -``` - -#### Using the create_magic_link_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> create_magic_link_with_http_info(app_id, create_magic_link_request) - -```ruby -begin - # Create Embeddable Magic Link - data, status_code, headers = api_instance.create_magic_link_with_http_info(app_id, create_magic_link_request) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue OpenapiClient::ApiError => e - puts "Error when calling MagicLinksApi->create_magic_link_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_id** | **String** | App ID | | -| **create_magic_link_request** | [**CreateMagicLinkRequest**](CreateMagicLinkRequest.md) | Request to create a magic link | | - -### Return type - -[**MagicLinkResponse**](MagicLinkResponse.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - diff --git a/docs/Model400Error.md b/docs/Model400Error.md deleted file mode 100644 index 9d7e5fc..0000000 --- a/docs/Model400Error.md +++ /dev/null @@ -1,20 +0,0 @@ -# OpenapiClient::Model400Error - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | | | -| **error** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::Model400Error.new( - code: null, - error: null -) -``` - diff --git a/docs/Model401Error.md b/docs/Model401Error.md deleted file mode 100644 index afd3845..0000000 --- a/docs/Model401Error.md +++ /dev/null @@ -1,20 +0,0 @@ -# OpenapiClient::Model401Error - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | | | -| **error** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::Model401Error.new( - code: null, - error: null -) -``` - diff --git a/docs/Model403Error.md b/docs/Model403Error.md deleted file mode 100644 index d20700a..0000000 --- a/docs/Model403Error.md +++ /dev/null @@ -1,20 +0,0 @@ -# OpenapiClient::Model403Error - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | | | -| **error** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::Model403Error.new( - code: null, - error: null -) -``` - diff --git a/docs/Model404Error.md b/docs/Model404Error.md deleted file mode 100644 index 1dcd2ef..0000000 --- a/docs/Model404Error.md +++ /dev/null @@ -1,20 +0,0 @@ -# OpenapiClient::Model404Error - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | | | -| **error** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::Model404Error.new( - code: null, - error: null -) -``` - diff --git a/docs/Model500Error.md b/docs/Model500Error.md deleted file mode 100644 index 3be33d3..0000000 --- a/docs/Model500Error.md +++ /dev/null @@ -1,20 +0,0 @@ -# OpenapiClient::Model500Error - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | | | -| **error** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::Model500Error.new( - code: null, - error: null -) -``` - diff --git a/docs/Nonce.md b/docs/Nonce.md deleted file mode 100644 index aa15b2c..0000000 --- a/docs/Nonce.md +++ /dev/null @@ -1,18 +0,0 @@ -# OpenapiClient::Nonce - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **nonce** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::Nonce.new( - nonce: null -) -``` - diff --git a/docs/PaginatedLinks.md b/docs/PaginatedLinks.md deleted file mode 100644 index 464a5f0..0000000 --- a/docs/PaginatedLinks.md +++ /dev/null @@ -1,26 +0,0 @@ -# OpenapiClient::PaginatedLinks - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **first** | [**Link**](Link.md) | | | -| **last** | [**Link**](Link.md) | | | -| **_next** | [**Link**](Link.md) | | | -| **previous** | [**Link**](Link.md) | | | -| **_self** | [**Link**](Link.md) | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::PaginatedLinks.new( - first: null, - last: null, - _next: null, - previous: null, - _self: null -) -``` - diff --git a/docs/PassageUser.md b/docs/PassageUser.md deleted file mode 100644 index 9d62410..0000000 --- a/docs/PassageUser.md +++ /dev/null @@ -1,50 +0,0 @@ -# OpenapiClient::PassageUser - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | | | -| **email** | **String** | | | -| **email_verified** | **Boolean** | | | -| **external_id** | **String** | The external ID of the user. Only set if the user was created in a Flex app. | | -| **id** | **String** | | | -| **last_login_at** | **Time** | | | -| **login_count** | **Integer** | | | -| **phone** | **String** | | | -| **phone_verified** | **Boolean** | | | -| **recent_events** | [**Array<UserRecentEvent>**](UserRecentEvent.md) | | | -| **social_connections** | [**UserSocialConnections**](UserSocialConnections.md) | | | -| **status** | [**UserStatus**](UserStatus.md) | | | -| **updated_at** | **Time** | | | -| **user_metadata** | **Object** | | | -| **webauthn** | **Boolean** | | | -| **webauthn_devices** | [**Array<WebAuthnDevices>**](WebAuthnDevices.md) | | | -| **webauthn_types** | [**Array<WebAuthnType>**](WebAuthnType.md) | List of credential types that have been used for authentication | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::PassageUser.new( - created_at: null, - email: null, - email_verified: null, - external_id: null, - id: null, - last_login_at: null, - login_count: null, - phone: null, - phone_verified: null, - recent_events: null, - social_connections: null, - status: null, - updated_at: null, - user_metadata: null, - webauthn: null, - webauthn_devices: null, - webauthn_types: null -) -``` - diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 4211178..0000000 --- a/docs/README.md +++ /dev/null @@ -1,147 +0,0 @@ -# openapi_client - -OpenapiClient - the Ruby gem for the Passage Management API - -Passage's management API to manage your Passage apps and users. - -This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - -- API version: 1 -- Package version: 1.0.0 -- Generator version: 7.11.0-SNAPSHOT -- Build package: org.openapitools.codegen.languages.RubyClientCodegen -For more information, please visit [https://passage.id/support](https://passage.id/support) - -## 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://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile: - - gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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' - -# Setup authorization -OpenapiClient.configure do |config| - # Configure Bearer authorization (JWT): bearerAuth - config.access_token = 'YOUR_BEARER_TOKEN' - # Configure a proc to get access tokens in lieu of the static access_token configuration - config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } - # Configure faraday connection - config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' } -end - -api_instance = OpenapiClient::MagicLinksApi.new -app_id = 'app_id_example' # String | App ID -create_magic_link_request = OpenapiClient::CreateMagicLinkRequest.new # CreateMagicLinkRequest | Request to create a magic link - -begin - #Create Embeddable Magic Link - result = api_instance.create_magic_link(app_id, create_magic_link_request) - p result -rescue OpenapiClient::ApiError => e - puts "Exception when calling MagicLinksApi->create_magic_link: #{e}" -end - -``` - -## Documentation for API Endpoints - -All URIs are relative to *https://api.passage.id/v1* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*OpenapiClient::MagicLinksApi* | [**create_magic_link**](docs/MagicLinksApi.md#create_magic_link) | **POST** /apps/{app_id}/magic-links | Create Embeddable Magic Link -*OpenapiClient::TokensApi* | [**revoke_user_refresh_tokens**](docs/TokensApi.md#revoke_user_refresh_tokens) | **DELETE** /apps/{app_id}/users/{user_id}/tokens | Revokes refresh tokens -*OpenapiClient::UserDevicesApi* | [**delete_user_devices**](docs/UserDevicesApi.md#delete_user_devices) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user -*OpenapiClient::UserDevicesApi* | [**list_user_devices**](docs/UserDevicesApi.md#list_user_devices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices -*OpenapiClient::UsersApi* | [**activate_user**](docs/UsersApi.md#activate_user) | **PATCH** /apps/{app_id}/users/{user_id}/activate | Activate User -*OpenapiClient::UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /apps/{app_id}/users | Create User -*OpenapiClient::UsersApi* | [**deactivate_user**](docs/UsersApi.md#deactivate_user) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User -*OpenapiClient::UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User -*OpenapiClient::UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /apps/{app_id}/users/{user_id} | Get User -*OpenapiClient::UsersApi* | [**list_paginated_users**](docs/UsersApi.md#list_paginated_users) | **GET** /apps/{app_id}/users | List Users -*OpenapiClient::UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User - - -## Documentation for Models - - - [OpenapiClient::AppleUserSocialConnection](docs/AppleUserSocialConnection.md) - - [OpenapiClient::CreateMagicLinkRequest](docs/CreateMagicLinkRequest.md) - - [OpenapiClient::CreateUserArgs](docs/CreateUserArgs.md) - - [OpenapiClient::GithubUserSocialConnection](docs/GithubUserSocialConnection.md) - - [OpenapiClient::GoogleUserSocialConnection](docs/GoogleUserSocialConnection.md) - - [OpenapiClient::Link](docs/Link.md) - - [OpenapiClient::ListDevicesResponse](docs/ListDevicesResponse.md) - - [OpenapiClient::ListPaginatedUsersItem](docs/ListPaginatedUsersItem.md) - - [OpenapiClient::ListPaginatedUsersResponse](docs/ListPaginatedUsersResponse.md) - - [OpenapiClient::MagicLink](docs/MagicLink.md) - - [OpenapiClient::MagicLinkChannel](docs/MagicLinkChannel.md) - - [OpenapiClient::MagicLinkResponse](docs/MagicLinkResponse.md) - - [OpenapiClient::MagicLinkType](docs/MagicLinkType.md) - - [OpenapiClient::Model400Error](docs/Model400Error.md) - - [OpenapiClient::Model401Error](docs/Model401Error.md) - - [OpenapiClient::Model403Error](docs/Model403Error.md) - - [OpenapiClient::Model404Error](docs/Model404Error.md) - - [OpenapiClient::Model500Error](docs/Model500Error.md) - - [OpenapiClient::Nonce](docs/Nonce.md) - - [OpenapiClient::PaginatedLinks](docs/PaginatedLinks.md) - - [OpenapiClient::PassageUser](docs/PassageUser.md) - - [OpenapiClient::SocialConnectionType](docs/SocialConnectionType.md) - - [OpenapiClient::UpdateUserArgs](docs/UpdateUserArgs.md) - - [OpenapiClient::UserEventAction](docs/UserEventAction.md) - - [OpenapiClient::UserEventStatus](docs/UserEventStatus.md) - - [OpenapiClient::UserRecentEvent](docs/UserRecentEvent.md) - - [OpenapiClient::UserResponse](docs/UserResponse.md) - - [OpenapiClient::UserSocialConnections](docs/UserSocialConnections.md) - - [OpenapiClient::UserStatus](docs/UserStatus.md) - - [OpenapiClient::WebAuthnDevices](docs/WebAuthnDevices.md) - - [OpenapiClient::WebAuthnIcons](docs/WebAuthnIcons.md) - - [OpenapiClient::WebAuthnType](docs/WebAuthnType.md) - - -## Documentation for Authorization - - -Authentication schemes defined for the API: -### bearerAuth - -- **Type**: Bearer authentication (JWT) - diff --git a/docs/SocialConnectionType.md b/docs/SocialConnectionType.md deleted file mode 100644 index afb0742..0000000 --- a/docs/SocialConnectionType.md +++ /dev/null @@ -1,15 +0,0 @@ -# OpenapiClient::SocialConnectionType - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::SocialConnectionType.new() -``` - diff --git a/docs/TokensApi.md b/docs/TokensApi.md deleted file mode 100644 index 242e039..0000000 --- a/docs/TokensApi.md +++ /dev/null @@ -1,78 +0,0 @@ -# OpenapiClient::TokensApi - -All URIs are relative to *https://api.passage.id/v1* - -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**revoke_user_refresh_tokens**](TokensApi.md#revoke_user_refresh_tokens) | **DELETE** /apps/{app_id}/users/{user_id}/tokens | Revokes refresh tokens | - - -## revoke_user_refresh_tokens - -> revoke_user_refresh_tokens(app_id, user_id) - -Revokes refresh tokens - -Revokes all refresh tokens for 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::TokensApi.new -app_id = 'app_id_example' # String | App ID -user_id = 'user_id_example' # String | User ID - -begin - # Revokes refresh tokens - api_instance.revoke_user_refresh_tokens(app_id, user_id) -rescue OpenapiClient::ApiError => e - puts "Error when calling TokensApi->revoke_user_refresh_tokens: #{e}" -end -``` - -#### Using the revoke_user_refresh_tokens_with_http_info variant - -This returns an Array which contains the response data (`nil` in this case), status code and headers. - -> revoke_user_refresh_tokens_with_http_info(app_id, user_id) - -```ruby -begin - # Revokes refresh tokens - data, status_code, headers = api_instance.revoke_user_refresh_tokens_with_http_info(app_id, user_id) - p status_code # => 2xx - p headers # => { ... } - p data # => nil -rescue OpenapiClient::ApiError => e - puts "Error when calling TokensApi->revoke_user_refresh_tokens_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 - diff --git a/docs/UpdateUserArgs.md b/docs/UpdateUserArgs.md deleted file mode 100644 index 90a34ae..0000000 --- a/docs/UpdateUserArgs.md +++ /dev/null @@ -1,22 +0,0 @@ -# OpenapiClient::UpdateUserArgs - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **email** | **String** | | [optional] | -| **phone** | **String** | | [optional] | -| **user_metadata** | **Object** | | [optional] | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::UpdateUserArgs.new( - email: null, - phone: null, - user_metadata: null -) -``` - diff --git a/docs/UserDevicesApi.md b/docs/UserDevicesApi.md deleted file mode 100644 index 950533a..0000000 --- a/docs/UserDevicesApi.md +++ /dev/null @@ -1,152 +0,0 @@ -# OpenapiClient::UserDevicesApi - -All URIs are relative to *https://api.passage.id/v1* - -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**delete_user_devices**](UserDevicesApi.md#delete_user_devices) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user | -| [**list_user_devices**](UserDevicesApi.md#list_user_devices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices | - - -## delete_user_devices - -> delete_user_devices(app_id, user_id, device_id) - -Delete a device for a user - -Delete a device for 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::UserDevicesApi.new -app_id = 'app_id_example' # String | App ID -user_id = 'user_id_example' # String | User ID -device_id = 'device_id_example' # String | Device ID - -begin - # Delete a device for a user - api_instance.delete_user_devices(app_id, user_id, device_id) -rescue OpenapiClient::ApiError => e - puts "Error when calling UserDevicesApi->delete_user_devices: #{e}" -end -``` - -#### Using the delete_user_devices_with_http_info variant - -This returns an Array which contains the response data (`nil` in this case), status code and headers. - -> delete_user_devices_with_http_info(app_id, user_id, device_id) - -```ruby -begin - # Delete a device for a user - data, status_code, headers = api_instance.delete_user_devices_with_http_info(app_id, user_id, device_id) - p status_code # => 2xx - p headers # => { ... } - p data # => nil -rescue OpenapiClient::ApiError => e - puts "Error when calling UserDevicesApi->delete_user_devices_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_id** | **String** | App ID | | -| **user_id** | **String** | User ID | | -| **device_id** | **String** | Device ID | | - -### Return type - -nil (empty response body) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## list_user_devices - -> list_user_devices(app_id, user_id) - -List User Devices - -List user devices. - -### 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::UserDevicesApi.new -app_id = 'app_id_example' # String | App ID -user_id = 'user_id_example' # String | User ID - -begin - # List User Devices - result = api_instance.list_user_devices(app_id, user_id) - p result -rescue OpenapiClient::ApiError => e - puts "Error when calling UserDevicesApi->list_user_devices: #{e}" -end -``` - -#### Using the list_user_devices_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> list_user_devices_with_http_info(app_id, user_id) - -```ruby -begin - # List User Devices - data, status_code, headers = api_instance.list_user_devices_with_http_info(app_id, user_id) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue OpenapiClient::ApiError => e - puts "Error when calling UserDevicesApi->list_user_devices_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_id** | **String** | App ID | | -| **user_id** | **String** | User ID | | - -### Return type - -[**ListDevicesResponse**](ListDevicesResponse.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - diff --git a/docs/UserEventAction.md b/docs/UserEventAction.md deleted file mode 100644 index fbe2184..0000000 --- a/docs/UserEventAction.md +++ /dev/null @@ -1,15 +0,0 @@ -# OpenapiClient::UserEventAction - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::UserEventAction.new() -``` - diff --git a/docs/UserEventStatus.md b/docs/UserEventStatus.md deleted file mode 100644 index 6ec7804..0000000 --- a/docs/UserEventStatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# OpenapiClient::UserEventStatus - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::UserEventStatus.new() -``` - diff --git a/docs/UserRecentEvent.md b/docs/UserRecentEvent.md deleted file mode 100644 index fb64b87..0000000 --- a/docs/UserRecentEvent.md +++ /dev/null @@ -1,36 +0,0 @@ -# OpenapiClient::UserRecentEvent - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | | | -| **completed_at** | **Time** | | | -| **id** | **String** | | | -| **ip_addr** | **String** | | | -| **status** | [**UserEventStatus**](UserEventStatus.md) | | | -| **type** | **String** | | | -| **user_agent** | **String** | The raw user agent value from the originating device | | -| **user_agent_display** | **String** | A display-friendly version of the user agent | | -| **action** | [**UserEventAction**](UserEventAction.md) | | | -| **social_login_type** | [**SocialConnectionType**](SocialConnectionType.md) | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::UserRecentEvent.new( - created_at: null, - completed_at: null, - id: null, - ip_addr: null, - status: null, - type: null, - user_agent: null, - user_agent_display: null, - action: null, - social_login_type: null -) -``` - diff --git a/docs/UserResponse.md b/docs/UserResponse.md deleted file mode 100644 index fef8437..0000000 --- a/docs/UserResponse.md +++ /dev/null @@ -1,18 +0,0 @@ -# OpenapiClient::UserResponse - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user** | [**PassageUser**](PassageUser.md) | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::UserResponse.new( - user: null -) -``` - diff --git a/docs/UserSocialConnections.md b/docs/UserSocialConnections.md deleted file mode 100644 index d429d28..0000000 --- a/docs/UserSocialConnections.md +++ /dev/null @@ -1,22 +0,0 @@ -# OpenapiClient::UserSocialConnections - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apple** | [**AppleUserSocialConnection**](AppleUserSocialConnection.md) | | [optional] | -| **github** | [**GithubUserSocialConnection**](GithubUserSocialConnection.md) | | [optional] | -| **google** | [**GoogleUserSocialConnection**](GoogleUserSocialConnection.md) | | [optional] | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::UserSocialConnections.new( - apple: null, - github: null, - google: null -) -``` - diff --git a/docs/UserStatus.md b/docs/UserStatus.md deleted file mode 100644 index f343eae..0000000 --- a/docs/UserStatus.md +++ /dev/null @@ -1,15 +0,0 @@ -# OpenapiClient::UserStatus - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::UserStatus.new() -``` - diff --git a/docs/UsersApi.md b/docs/UsersApi.md deleted file mode 100644 index fe65648..0000000 --- a/docs/UsersApi.md +++ /dev/null @@ -1,534 +0,0 @@ -# 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 | -| [**list_paginated_users**](UsersApi.md#list_paginated_users) | **GET** /apps/{app_id}/users | List Users | -| [**update_user**](UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User | - - -## activate_user - -> 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. - -> , 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 # => -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 - -> create_user(app_id, create_user_args) - -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_args = OpenapiClient::CreateUserArgs.new # CreateUserArgs | email, phone, user_metadata - -begin - # Create User - result = api_instance.create_user(app_id, create_user_args) - 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. - -> , Integer, Hash)> create_user_with_http_info(app_id, create_user_args) - -```ruby -begin - # Create User - data, status_code, headers = api_instance.create_user_with_http_info(app_id, create_user_args) - p status_code # => 2xx - p headers # => { ... } - p data # => -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_args** | [**CreateUserArgs**](CreateUserArgs.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 - -> 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. - -> , 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 # => -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. - -> 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 - -> 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. - -> , 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 # => -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 - - -## list_paginated_users - -> list_paginated_users(app_id, opts) - -List Users - -List users for an app. - -### 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 -opts = { - page: 56, # Integer | page to fetch (min=1) - limit: 56, # Integer | number of users to fetch per page (max=500) - created_before: 56, # Integer | Unix timestamp to anchor pagination results (fetches events that were created before the timestamp) - order_by: 'order_by_example', # String | Comma separated list of : (example: order_by=id:DESC,created_at:ASC) **cannot order_by `identifier` - identifier: 'identifier_example', # String | search users email OR phone (pagination prepended operators identifier=, identifier=, identifier=, identifier=, identifier=, identifier=) - id: 'id_example', # String | search users id (pagination prepended operators id=, id=, id=, id=, id=, id=) - login_count: 56, # Integer | search users login_count (pagination prepended operators login_count=, login_count=, login_count=, login_count=) - status: 'status_example', # String | search users by status (pagination prepended operators status=, status=, status=, status=, status=, status=) -- valid values: (active, inactive, pending) - created_at: 'created_at_example', # String | search users created_at (pagination prepended operators created_at=, created_at=, created_at=, created_at= -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required - updated_at: 'updated_at_example', # String | search users updated_at (pagination prepended operators updated_at=, updated_at=, updated_at=, updated_at= -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required - last_login_at: 'last_login_at_example' # String | search users last_login_at (pagination prepended operators last_login_at=, lat_login_at=, last_login_at=, last_login_at= -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required -} - -begin - # List Users - result = api_instance.list_paginated_users(app_id, opts) - p result -rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->list_paginated_users: #{e}" -end -``` - -#### Using the list_paginated_users_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> list_paginated_users_with_http_info(app_id, opts) - -```ruby -begin - # List Users - data, status_code, headers = api_instance.list_paginated_users_with_http_info(app_id, opts) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->list_paginated_users_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_id** | **String** | App ID | | -| **page** | **Integer** | page to fetch (min=1) | [optional] | -| **limit** | **Integer** | number of users to fetch per page (max=500) | [optional] | -| **created_before** | **Integer** | Unix timestamp to anchor pagination results (fetches events that were created before the timestamp) | [optional] | -| **order_by** | **String** | Comma separated list of <field>:<ASC/DESC> (example: order_by=id:DESC,created_at:ASC) **cannot order_by `identifier` | [optional] | -| **identifier** | **String** | search users email OR phone (pagination prepended operators identifier=<val>, identifier=<ne:val>, identifier=<gt:val>, identifier=<lt:val>, identifier=<like:val>, identifier=<not_like:val>) | [optional] | -| **id** | **String** | search users id (pagination prepended operators id=<val>, id=<ne:val>, id=<gt:val>, id=<lt:val>, id=<like:val>, id=<not_like:val>) | [optional] | -| **login_count** | **Integer** | search users login_count (pagination prepended operators login_count=<val>, login_count=<ne:val>, login_count=<gt:val>, login_count=<lt:val>) | [optional] | -| **status** | **String** | search users by status (pagination prepended operators status=<val>, status=<ne:val>, status=<gt:val>, status=<lt:val>, status=<like:val>, status=<not_like:val>) -- valid values: (active, inactive, pending) | [optional] | -| **created_at** | **String** | search users created_at (pagination prepended operators created_at=<val>, created_at=<ne:val>, created_at=<gt:val>, created_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | [optional] | -| **updated_at** | **String** | search users updated_at (pagination prepended operators updated_at=<val>, updated_at=<ne:val>, updated_at=<gt:val>, updated_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | [optional] | -| **last_login_at** | **String** | search users last_login_at (pagination prepended operators last_login_at=<val>, lat_login_at=<ne:val>, last_login_at=<gt:val>, last_login_at=<lt:val> -- valid timestamp in the format: 2006-01-02T15:04:05.000000Z required | [optional] | - -### Return type - -[**ListPaginatedUsersResponse**](ListPaginatedUsersResponse.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## update_user - -> update_user(app_id, user_id, update_user_args) - -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_args = OpenapiClient::UpdateUserArgs.new # UpdateUserArgs | user settings - -begin - # Update User - result = api_instance.update_user(app_id, user_id, update_user_args) - 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. - -> , Integer, Hash)> update_user_with_http_info(app_id, user_id, update_user_args) - -```ruby -begin - # Update User - data, status_code, headers = api_instance.update_user_with_http_info(app_id, user_id, update_user_args) - p status_code # => 2xx - p headers # => { ... } - p data # => -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_args** | [**UpdateUserArgs**](UpdateUserArgs.md) | user settings | | - -### Return type - -[**UserResponse**](UserResponse.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - diff --git a/docs/WebAuthnDevices.md b/docs/WebAuthnDevices.md deleted file mode 100644 index ca22e0f..0000000 --- a/docs/WebAuthnDevices.md +++ /dev/null @@ -1,34 +0,0 @@ -# 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 -) -``` - diff --git a/docs/WebAuthnIcons.md b/docs/WebAuthnIcons.md deleted file mode 100644 index 9ef5798..0000000 --- a/docs/WebAuthnIcons.md +++ /dev/null @@ -1,20 +0,0 @@ -# OpenapiClient::WebAuthnIcons - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **light** | **String** | | | -| **dark** | **String** | | | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::WebAuthnIcons.new( - light: null, - dark: null -) -``` - diff --git a/docs/WebAuthnType.md b/docs/WebAuthnType.md deleted file mode 100644 index ce7e25e..0000000 --- a/docs/WebAuthnType.md +++ /dev/null @@ -1,15 +0,0 @@ -# OpenapiClient::WebAuthnType - -## Properties - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | - -## Example - -```ruby -require 'openapi_client' - -instance = OpenapiClient::WebAuthnType.new() -``` - diff --git a/generate.sh b/generate.sh index a309848..1ec8d42 100755 --- a/generate.sh +++ b/generate.sh @@ -13,12 +13,9 @@ docker run --rm -v "${PWD}:/local" -u $(id -u) openapitools/openapi-generator-cl -g ruby \ -o /local/generated \ --additional-properties=library=faraday \ + --global-property apiTests=false,modelTests=false,apiDocs=false,modelDocs=false \ --model-name-mappings CreateUserRequest=CreateUserArgs,UpdateUserRequest=UpdateUserArgs,UserInfo=PassageUser -rm -rf ./docs -mv ./generated/docs ./docs -mv ./generated/README.md ./docs - rm -rf ./lib/openapi_client mv ./generated/lib/openapi_client ./lib @@ -27,4 +24,4 @@ mv ./generated/lib/openapi_client.rb ./lib/openapi_client.rb rm -rf ./generated -sed -i 's/require /require_relative /g' ./lib/openapi_client.rb \ No newline at end of file +sed -i 's/require /require_relative /g' ./lib/openapi_client.rb