passageidentity 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5fad890a1b4da5a9bda57cf0441dbfb76e7b5275c6e63b97ea001897f146847
-  data.tar.gz: f5008109d3d726a62312ee8ff85b008ecce5fc993b5f89d963cb44d0f7d21775
+  metadata.gz: 3e054f6f2f16c809e2837abab2c504fdc74a72efc17637684fa16d7df46cb711
+  data.tar.gz: 7a2fdf636d8c50c6608f6bdf8f136c738ebc4a5778994ee571feaa04d480e640
 SHA512:
-  metadata.gz: 1beabd989e6a3357f42326c974cf61a118d8cc076be7ba2df4adccbcd0d90877c1052b03d331b3d20d6defc2d74c285ed38664943810358960dcfe02064431e3
-  data.tar.gz: 60811539a0ae157adcb4f4f4fcbab795bbd3041cbee5c80710a4793a95dae1d0485e9b68f58b24f3a02f1e6ccf8bd6a237d673d03305c65f43031fdac7cfc76e
+  metadata.gz: 4e2c9626cbf491d68743c64ec42559dcfff2f9e555775937f89ba63f56e42ab3f98517f9aebac6b93ec84a145260374934b98dab1041051470663e0b429c6285
+  data.tar.gz: e4d50ed30523768f29e90fff59f864fbef471e59bc09dd33ad297ab287f2ff79966c187977212fd0ba8ff33bf63bc492150d96e9dd53266aa14c3414c49353c6

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2024-01-30
+
+### Added
+
+- `AppleUserSocialConnection` model has been added
+
+### Changed
+
+- `UserEventInfo` has been renamed to `UserRecentEvent`
+- Docs have been moved to `/docs`
+- `GithubSocialConnection` has been renamed to `GithubUserSocialConnection`
+- `GoogleSocialConnection` has been renamed to `GoogleUserSocialConnection`
+
+## [0.4.0] - 2024-01-18
+
+### Added
+
+- The `UserInfo` class has a new `'social_connections' =>:'UserSocialConnections'` field for GitHub and Google
+
 ## [0.3.0] - 2023-12-06
 
 ### Added

data/docs/generated/AppleUserSocialConnection.md

@@ -0,0 +1,24 @@
+# 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
+)
+```
+

data/docs/generated/GithubUserSocialConnection.md

@@ -0,0 +1,24 @@
+# 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
+)
+```
+

data/docs/generated/GoogleUserSocialConnection.md

@@ -0,0 +1,24 @@
+# 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
+)
+```
+

data/docs/generated/README.md

@@ -0,0 +1,153 @@
+# 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
+- 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::AppsApi.new
+app_id = 'app_id_example' # String | App ID
+
+begin
+  #Get App
+  result = api_instance.get_app(app_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling AppsApi->get_app: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.passage.id/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OpenapiClient::AppsApi* | [**get_app**](docs/AppsApi.md#get_app) | **GET** /apps/{app_id} | Get App
+*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* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User
+
+
+## Documentation for Models
+
+ - [OpenapiClient::AppInfo](docs/AppInfo.md)
+ - [OpenapiClient::AppResponse](docs/AppResponse.md)
+ - [OpenapiClient::AppleUserSocialConnection](docs/AppleUserSocialConnection.md)
+ - [OpenapiClient::AuthMethods](docs/AuthMethods.md)
+ - [OpenapiClient::CreateMagicLinkRequest](docs/CreateMagicLinkRequest.md)
+ - [OpenapiClient::CreateUserRequest](docs/CreateUserRequest.md)
+ - [OpenapiClient::ElementCustomization](docs/ElementCustomization.md)
+ - [OpenapiClient::FontFamily](docs/FontFamily.md)
+ - [OpenapiClient::GithubUserSocialConnection](docs/GithubUserSocialConnection.md)
+ - [OpenapiClient::GoogleUserSocialConnection](docs/GoogleUserSocialConnection.md)
+ - [OpenapiClient::LayoutConfig](docs/LayoutConfig.md)
+ - [OpenapiClient::Layouts](docs/Layouts.md)
+ - [OpenapiClient::ListDevicesResponse](docs/ListDevicesResponse.md)
+ - [OpenapiClient::MagicLink](docs/MagicLink.md)
+ - [OpenapiClient::MagicLinkAuthMethod](docs/MagicLinkAuthMethod.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::Model404Error](docs/Model404Error.md)
+ - [OpenapiClient::Model500Error](docs/Model500Error.md)
+ - [OpenapiClient::OtpAuthMethod](docs/OtpAuthMethod.md)
+ - [OpenapiClient::PasskeysAuthMethod](docs/PasskeysAuthMethod.md)
+ - [OpenapiClient::Technologies](docs/Technologies.md)
+ - [OpenapiClient::TtlDisplayUnit](docs/TtlDisplayUnit.md)
+ - [OpenapiClient::UpdateMagicLinkAuthMethod](docs/UpdateMagicLinkAuthMethod.md)
+ - [OpenapiClient::UpdateOtpAuthMethod](docs/UpdateOtpAuthMethod.md)
+ - [OpenapiClient::UpdatePasskeysAuthMethod](docs/UpdatePasskeysAuthMethod.md)
+ - [OpenapiClient::UpdateUserRequest](docs/UpdateUserRequest.md)
+ - [OpenapiClient::UserInfo](docs/UserInfo.md)
+ - [OpenapiClient::UserMetadataField](docs/UserMetadataField.md)
+ - [OpenapiClient::UserMetadataFieldType](docs/UserMetadataFieldType.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)
+

data/docs/generated/UserInfo.md

@@ -12,7 +12,8 @@
 | **login_count** | **Integer** |  |  |
 | **phone** | **String** |  |  |
 | **phone_verified** | **Boolean** |  |  |
-| **recent_events** | [**Array<UserEventInfo>**](UserEventInfo.md) |  |  |
+| **recent_events** | [**Array<UserRecentEvent>**](UserRecentEvent.md) |  |  |
+| **social_connections** | [**UserSocialConnections**](UserSocialConnections.md) |  |  |
 | **status** | [**UserStatus**](UserStatus.md) |  |  |
 | **updated_at** | **Time** |  |  |
 | **user_metadata** | **Object** |  |  |
@@ -35,6 +36,7 @@ instance = OpenapiClient::UserInfo.new(
   phone: null,
   phone_verified: null,
   recent_events: null,
+  social_connections: null,
   status: null,
   updated_at: null,
   user_metadata: null,

data/docs/generated/{UserEventInfo.md → UserRecentEvent.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::UserEventInfo
+# OpenapiClient::UserRecentEvent
 
 ## Properties
 
@@ -15,7 +15,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::UserEventInfo.new(
+instance = OpenapiClient::UserRecentEvent.new(
   created_at: null,
   id: null,
   ip_addr: null,

data/docs/generated/UserSocialConnections.md

@@ -0,0 +1,22 @@
+# 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
+)
+```
+

data/lib/openapi_client/models/apple_user_social_connection.rb

@@ -0,0 +1,271 @@
+=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 'date'
+require 'time'
+
+module OpenapiClient
+  class AppleUserSocialConnection
+    # The external ID of the Social Connection.
+    attr_accessor :provider_id
+
+    attr_accessor :created_at
+
+    attr_accessor :last_login_at
+
+    # The email of connected social user.
+    attr_accessor :provider_identifier
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'provider_id' => :'provider_id',
+        :'created_at' => :'created_at',
+        :'last_login_at' => :'last_login_at',
+        :'provider_identifier' => :'provider_identifier'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'provider_id' => :'String',
+        :'created_at' => :'Time',
+        :'last_login_at' => :'Time',
+        :'provider_identifier' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AppleUserSocialConnection` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AppleUserSocialConnection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'provider_id')
+        self.provider_id = attributes[:'provider_id']
+      else
+        self.provider_id = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'last_login_at')
+        self.last_login_at = attributes[:'last_login_at']
+      else
+        self.last_login_at = nil
+      end
+
+      if attributes.key?(:'provider_identifier')
+        self.provider_identifier = attributes[:'provider_identifier']
+      else
+        self.provider_identifier = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @provider_id.nil?
+        invalid_properties.push('invalid value for "provider_id", provider_id cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @last_login_at.nil?
+        invalid_properties.push('invalid value for "last_login_at", last_login_at cannot be nil.')
+      end
+
+      if @provider_identifier.nil?
+        invalid_properties.push('invalid value for "provider_identifier", provider_identifier cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @provider_id.nil?
+      return false if @created_at.nil?
+      return false if @last_login_at.nil?
+      return false if @provider_identifier.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          provider_id == o.provider_id &&
+          created_at == o.created_at &&
+          last_login_at == o.last_login_at &&
+          provider_identifier == o.provider_identifier
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [provider_id, created_at, last_login_at, provider_identifier].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = OpenapiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end