From 6fc3dc8f10b5abb4e703b80ea01b4b49471e62bf Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 1 Feb 2024 17:31:31 +0000 Subject: [PATCH] SDK updates --- generated/docs/Api/AppsApi.md | 68 ----- generated/docs/Api/MagicLinksApi.md | 70 ----- generated/docs/Api/TokensApi.md | 69 ----- generated/docs/Api/UserDevicesApi.md | 134 ---------- generated/docs/Api/UsersApi.md | 386 --------------------------- 5 files changed, 727 deletions(-) delete mode 100644 generated/docs/Api/AppsApi.md delete mode 100644 generated/docs/Api/MagicLinksApi.md delete mode 100644 generated/docs/Api/TokensApi.md delete mode 100644 generated/docs/Api/UserDevicesApi.md delete mode 100644 generated/docs/Api/UsersApi.md diff --git a/generated/docs/Api/AppsApi.md b/generated/docs/Api/AppsApi.md deleted file mode 100644 index 65ca3f4..0000000 --- a/generated/docs/Api/AppsApi.md +++ /dev/null @@ -1,68 +0,0 @@ -# OpenAPI\Client\AppsApi - -All URIs are relative to https://api.passage.id/v1, except if the operation defines another base path. - -| Method | HTTP request | Description | -| ------------- | ------------- | ------------- | -| [**getApp()**](AppsApi.md#getApp) | **GET** /apps/{app_id} | Get App | - - -## `getApp()` - -```php -getApp($app_id): \OpenAPI\Client\Model\AppResponse -``` - -Get App - -Get app information. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\AppsApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID - -try { - $result = $apiInstance->getApp($app_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling AppsApi->getApp: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | - -### Return type - -[**\OpenAPI\Client\Model\AppResponse**](../Model/AppResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) diff --git a/generated/docs/Api/MagicLinksApi.md b/generated/docs/Api/MagicLinksApi.md deleted file mode 100644 index 4651feb..0000000 --- a/generated/docs/Api/MagicLinksApi.md +++ /dev/null @@ -1,70 +0,0 @@ -# OpenAPI\Client\MagicLinksApi - -All URIs are relative to https://api.passage.id/v1, except if the operation defines another base path. - -| Method | HTTP request | Description | -| ------------- | ------------- | ------------- | -| [**createMagicLink()**](MagicLinksApi.md#createMagicLink) | **POST** /apps/{app_id}/magic-links | Create Embeddable Magic Link | - - -## `createMagicLink()` - -```php -createMagicLink($app_id, $create_magic_link_request): \OpenAPI\Client\Model\MagicLinkResponse -``` - -Create Embeddable Magic Link - -Create magic link for a user. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\MagicLinksApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$create_magic_link_request = new \OpenAPI\Client\Model\CreateMagicLinkRequest(); // \OpenAPI\Client\Model\CreateMagicLinkRequest | magic link request - -try { - $result = $apiInstance->createMagicLink($app_id, $create_magic_link_request); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling MagicLinksApi->createMagicLink: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **create_magic_link_request** | [**\OpenAPI\Client\Model\CreateMagicLinkRequest**](../Model/CreateMagicLinkRequest.md)| magic link request | | - -### Return type - -[**\OpenAPI\Client\Model\MagicLinkResponse**](../Model/MagicLinkResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: `application/json` -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) diff --git a/generated/docs/Api/TokensApi.md b/generated/docs/Api/TokensApi.md deleted file mode 100644 index 9c74371..0000000 --- a/generated/docs/Api/TokensApi.md +++ /dev/null @@ -1,69 +0,0 @@ -# OpenAPI\Client\TokensApi - -All URIs are relative to https://api.passage.id/v1, except if the operation defines another base path. - -| Method | HTTP request | Description | -| ------------- | ------------- | ------------- | -| [**revokeUserRefreshTokens()**](TokensApi.md#revokeUserRefreshTokens) | **DELETE** /apps/{app_id}/users/{user_id}/tokens | Revokes refresh tokens | - - -## `revokeUserRefreshTokens()` - -```php -revokeUserRefreshTokens($app_id, $user_id) -``` - -Revokes refresh tokens - -Revokes all refresh tokens for a user - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\TokensApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID - -try { - $apiInstance->revokeUserRefreshTokens($app_id, $user_id); -} catch (Exception $e) { - echo 'Exception when calling TokensApi->revokeUserRefreshTokens: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | - -### Return type - -void (empty response body) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) diff --git a/generated/docs/Api/UserDevicesApi.md b/generated/docs/Api/UserDevicesApi.md deleted file mode 100644 index b040ebb..0000000 --- a/generated/docs/Api/UserDevicesApi.md +++ /dev/null @@ -1,134 +0,0 @@ -# OpenAPI\Client\UserDevicesApi - -All URIs are relative to https://api.passage.id/v1, except if the operation defines another base path. - -| Method | HTTP request | Description | -| ------------- | ------------- | ------------- | -| [**deleteUserDevices()**](UserDevicesApi.md#deleteUserDevices) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user | -| [**listUserDevices()**](UserDevicesApi.md#listUserDevices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices | - - -## `deleteUserDevices()` - -```php -deleteUserDevices($app_id, $user_id, $device_id) -``` - -Delete a device for a user - -Delete a device for a user. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UserDevicesApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID -$device_id = 'device_id_example'; // string | Device ID - -try { - $apiInstance->deleteUserDevices($app_id, $user_id, $device_id); -} catch (Exception $e) { - echo 'Exception when calling UserDevicesApi->deleteUserDevices: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | -| **device_id** | **string**| Device ID | | - -### Return type - -void (empty response body) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) - -## `listUserDevices()` - -```php -listUserDevices($app_id, $user_id): \OpenAPI\Client\Model\ListDevicesResponse -``` - -List User Devices - -List user devices. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UserDevicesApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID - -try { - $result = $apiInstance->listUserDevices($app_id, $user_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling UserDevicesApi->listUserDevices: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | - -### Return type - -[**\OpenAPI\Client\Model\ListDevicesResponse**](../Model/ListDevicesResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) diff --git a/generated/docs/Api/UsersApi.md b/generated/docs/Api/UsersApi.md deleted file mode 100644 index 5367759..0000000 --- a/generated/docs/Api/UsersApi.md +++ /dev/null @@ -1,386 +0,0 @@ -# OpenAPI\Client\UsersApi - -All URIs are relative to https://api.passage.id/v1, except if the operation defines another base path. - -| Method | HTTP request | Description | -| ------------- | ------------- | ------------- | -| [**activateUser()**](UsersApi.md#activateUser) | **PATCH** /apps/{app_id}/users/{user_id}/activate | Activate User | -| [**createUser()**](UsersApi.md#createUser) | **POST** /apps/{app_id}/users | Create User | -| [**deactivateUser()**](UsersApi.md#deactivateUser) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User | -| [**deleteUser()**](UsersApi.md#deleteUser) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User | -| [**getUser()**](UsersApi.md#getUser) | **GET** /apps/{app_id}/users/{user_id} | Get User | -| [**updateUser()**](UsersApi.md#updateUser) | **PATCH** /apps/{app_id}/users/{user_id} | Update User | - - -## `activateUser()` - -```php -activateUser($app_id, $user_id): \OpenAPI\Client\Model\UserResponse -``` - -Activate User - -Activate a user. They will now be able to login. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UsersApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID - -try { - $result = $apiInstance->activateUser($app_id, $user_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling UsersApi->activateUser: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | - -### Return type - -[**\OpenAPI\Client\Model\UserResponse**](../Model/UserResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) - -## `createUser()` - -```php -createUser($app_id, $create_user_request): \OpenAPI\Client\Model\UserResponse -``` - -Create User - -Create user for an application. Must provide an email of phone number identifier. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UsersApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$create_user_request = new \OpenAPI\Client\Model\CreateUserRequest(); // \OpenAPI\Client\Model\CreateUserRequest | email, phone, user_metadata - -try { - $result = $apiInstance->createUser($app_id, $create_user_request); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling UsersApi->createUser: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **create_user_request** | [**\OpenAPI\Client\Model\CreateUserRequest**](../Model/CreateUserRequest.md)| email, phone, user_metadata | | - -### Return type - -[**\OpenAPI\Client\Model\UserResponse**](../Model/UserResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: `application/json` -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) - -## `deactivateUser()` - -```php -deactivateUser($app_id, $user_id): \OpenAPI\Client\Model\UserResponse -``` - -Deactivate User - -Deactivate a user. Their account will still exist, but they will not be able to login. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UsersApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID - -try { - $result = $apiInstance->deactivateUser($app_id, $user_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling UsersApi->deactivateUser: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | - -### Return type - -[**\OpenAPI\Client\Model\UserResponse**](../Model/UserResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) - -## `deleteUser()` - -```php -deleteUser($app_id, $user_id) -``` - -Delete User - -Delete a user. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UsersApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID - -try { - $apiInstance->deleteUser($app_id, $user_id); -} catch (Exception $e) { - echo 'Exception when calling UsersApi->deleteUser: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | - -### Return type - -void (empty response body) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) - -## `getUser()` - -```php -getUser($app_id, $user_id): \OpenAPI\Client\Model\UserResponse -``` - -Get User - -Get information about a user. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UsersApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID - -try { - $result = $apiInstance->getUser($app_id, $user_id); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling UsersApi->getUser: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | - -### Return type - -[**\OpenAPI\Client\Model\UserResponse**](../Model/UserResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md) - -## `updateUser()` - -```php -updateUser($app_id, $user_id, $update_user_request): \OpenAPI\Client\Model\UserResponse -``` - -Update User - -Update a user's information. - -### Example - -```php -setAccessToken('YOUR_ACCESS_TOKEN'); - - -$apiInstance = new OpenAPI\Client\Api\UsersApi( - // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. - // This is optional, `GuzzleHttp\Client` will be used as default. - new GuzzleHttp\Client(), - $config -); -$app_id = 'app_id_example'; // string | App ID -$user_id = 'user_id_example'; // string | User ID -$update_user_request = new \OpenAPI\Client\Model\UpdateUserRequest(); // \OpenAPI\Client\Model\UpdateUserRequest | user settings - -try { - $result = $apiInstance->updateUser($app_id, $user_id, $update_user_request); - print_r($result); -} catch (Exception $e) { - echo 'Exception when calling UsersApi->updateUser: ', $e->getMessage(), PHP_EOL; -} -``` - -### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **app_id** | **string**| App ID | | -| **user_id** | **string**| User ID | | -| **update_user_request** | [**\OpenAPI\Client\Model\UpdateUserRequest**](../Model/UpdateUserRequest.md)| user settings | | - -### Return type - -[**\OpenAPI\Client\Model\UserResponse**](../Model/UserResponse.md) - -### Authorization - -[bearerAuth](../../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: `application/json` -- **Accept**: `application/json` - -[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) -[[Back to Model list]](../../README.md#models) -[[Back to README]](../../README.md)