trinsic_api 3.0.0 → 3.0.2.pre.preview

data/docs/VerificationProfilesApi.md

@@ -35,6 +35,8 @@ opts = {
   primary_color: 'primary_color_example', # String | The primary color of the verification profile. Must be a 6-character hex string prefixed with a '#' character. Example: #000000
   providers: ['inner_example'], # Array<String> | The list of providers you'd like to select for this profile. We will not currently enable any providers.
   logo: File.new('/path/to/some/file'), # File | The logo of the verification profile.
+  redaction_period: 'redaction_period_example', # String | The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days.
+  session_expiration: 'session_expiration_example', # String | The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified.
   is_production_usage: true # Boolean | Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo).
 }
 
@@ -74,6 +76,8 @@ end
 | **primary_color** | **String** | The primary color of the verification profile. Must be a 6-character hex string prefixed with a &#39;#&#39; character. Example: #000000 | [optional] |
 | **providers** | [**Array&lt;String&gt;**](String.md) | The list of providers you&#39;d like to select for this profile. We will not currently enable any providers. | [optional] |
 | **logo** | **File** | The logo of the verification profile. | [optional] |
+| **redaction_period** | **String** | The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days. | [optional] |
+| **session_expiration** | **String** | The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified. | [optional] |
 | **is_production_usage** | **Boolean** | Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo). | [optional] |
 
 ### Return type

data/docs/YotiDeeplinkProviderOutput.md

@@ -0,0 +1,40 @@
+# TrinsicApi::YotiDeeplinkProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remember_me_id** | **String** | The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service. | [optional] |
+| **email** | **String** | The email address of the individual | [optional] |
+| **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
+| **family_name** | **String** | The family name of the individual | [optional] |
+| **full_name** | **String** | Full name of the individual which is composed of the given and family name. Unverified full name may be safe to use. For example, Aadhaar card provides full name, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
+| **gender** | **String** | The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes.              Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". In some countries Possible values: - \"MALE\" - \"FEMALE\" - \"TRANSGENDER\" - \"OTHER\" | [optional] |
+| **nationality** | **String** | The nationality of the individual as a ISO alpha-3 code | [optional] |
+| **mobile_number** | **String** | The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user's identity. | [optional] |
+| **structured_postal_address** | [**YotiStructuredPostalAddress**](YotiStructuredPostalAddress.md) | A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
+| **postal_address** | **String** | The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". The format of this will be different for each country. Refer to `StructuredPostalAddress` for a detailed version of the address. | [optional] |
+| **document_details** | [**YotiDocumentDetails**](YotiDocumentDetails.md) | The details of the underlying document used to help create the Yoti credential | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::YotiDeeplinkProviderOutput.new(
+  remember_me_id: 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  email: johndoe@example.com,
+  given_name: John Alvin,
+  family_name: Doe,
+  full_name: John Alvin Doe,
+  date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
+  gender: MALE,
+  nationality: GBR,
+  mobile_number: +447777123456,
+  structured_postal_address: null,
+  postal_address: 6th Floor, 107 Leadenhall St, London, EC3A 4AF,
+  document_details: null
+)
+```
+

data/lib/trinsic_api/api/providers_api.rb

@@ -19,6 +19,69 @@ module TrinsicApi
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get Provider
+    # Get a single identity provider by ID, including its license status.
+    # @param provider_id [String] The ID of the provider to retrieve
+    # @param [Hash] opts the optional parameters
+    # @return [GetProviderResponse]
+    def get_provider(provider_id, opts = {})
+      data, _status_code, _headers = get_provider_with_http_info(provider_id, opts)
+      data
+    end
+
+    # Get Provider
+    # Get a single identity provider by ID, including its license status.
+    # @param provider_id [String] The ID of the provider to retrieve
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetProviderResponse, Integer, Hash)>] GetProviderResponse data, response status code and response headers
+    def get_provider_with_http_info(provider_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProvidersApi.get_provider ...'
+      end
+      # verify the required parameter 'provider_id' is set
+      if @api_client.config.client_side_validation && provider_id.nil?
+        fail ArgumentError, "Missing the required parameter 'provider_id' when calling ProvidersApi.get_provider"
+      end
+      # resource path
+      local_var_path = '/api/v1/providers/{providerId}'.sub('{' + 'providerId' + '}', CGI.escape(provider_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetProviderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Bearer']
+
+      new_options = opts.merge(
+        :operation => :"ProvidersApi.get_provider",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProvidersApi#get_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Providers
     # List all identity providers available to your Organization, including their license status.
     # @param [Hash] opts the optional parameters

data/lib/trinsic_api/api/verification_profiles_api.rb

@@ -27,6 +27,8 @@ module TrinsicApi
     # @option opts [String] :primary_color The primary color of the verification profile. Must be a 6-character hex string prefixed with a '#' character. Example: #000000
     # @option opts [Array<String>] :providers The list of providers you&#39;d like to select for this profile. We will not currently enable any providers.
     # @option opts [File] :logo The logo of the verification profile.
+    # @option opts [String] :redaction_period The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days.
+    # @option opts [String] :session_expiration The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified.
     # @option opts [Boolean] :is_production_usage Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo).
     # @return [CreateVerificationProfileResponse]
     def create_verification_profile(_alias, brand_name, opts = {})
@@ -42,6 +44,8 @@ module TrinsicApi
     # @option opts [String] :primary_color The primary color of the verification profile. Must be a 6-character hex string prefixed with a &#39;#&#39; character. Example: #000000
     # @option opts [Array<String>] :providers The list of providers you&#39;d like to select for this profile. We will not currently enable any providers.
     # @option opts [File] :logo The logo of the verification profile.
+    # @option opts [String] :redaction_period The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days.
+    # @option opts [String] :session_expiration The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified.
     # @option opts [Boolean] :is_production_usage Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo).
     # @return [Array<(CreateVerificationProfileResponse, Integer, Hash)>] CreateVerificationProfileResponse data, response status code and response headers
     def create_verification_profile_with_http_info(_alias, brand_name, opts = {})
@@ -103,6 +107,8 @@ module TrinsicApi
       form_params['PrimaryColor'] = opts[:'primary_color'] if !opts[:'primary_color'].nil?
       form_params['Providers'] = @api_client.build_collection_param(opts[:'providers'], :multi) if !opts[:'providers'].nil?
       form_params['Logo'] = opts[:'logo'] if !opts[:'logo'].nil?
+      form_params['RedactionPeriod'] = opts[:'redaction_period'] if !opts[:'redaction_period'].nil?
+      form_params['SessionExpiration'] = opts[:'session_expiration'] if !opts[:'session_expiration'].nil?
       form_params['IsProductionUsage'] = opts[:'is_production_usage'] if !opts[:'is_production_usage'].nil?
 
       # http body (model)

data/lib/trinsic_api/models/aadhaar_claims.rb

@@ -0,0 +1,376 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class AadhaarClaims
+    # The full name.
+    attr_accessor :name
+
+    # The date of birth.              The format is YYYY-MM-DD.
+    attr_accessor :date_of_birth
+
+    # The gender of the individual.              Possible values: - M (Male) - F (Female) - T (Transgender)
+    attr_accessor :gender
+
+    # The address's care-of field. This indicates that mail should be delivered to an individual through another person or entity who is a known resident at the address.
+    attr_accessor :care_of
+
+    # The address's country.              This is formatted as an alpha-2 country code.
+    attr_accessor :country
+
+    # The address's district.
+    attr_accessor :district
+
+    # The identifier for the house address.
+    attr_accessor :house
+
+    # The location or locality that helps identify where the address is within a city.
+    attr_accessor :location
+
+    # A landmark near the address.
+    attr_accessor :landmark
+
+    # The address's postal code.
+    attr_accessor :postal_code
+
+    # The address's post office.
+    attr_accessor :post_office
+
+    # The address's state or union territory.
+    attr_accessor :state
+
+    # The address's street name.
+    attr_accessor :street
+
+    # The address's subdistrict.
+    attr_accessor :subdistrict
+
+    # The address's village/town/city.
+    attr_accessor :village_town_city
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'date_of_birth' => :'dateOfBirth',
+        :'gender' => :'gender',
+        :'care_of' => :'careOf',
+        :'country' => :'country',
+        :'district' => :'district',
+        :'house' => :'house',
+        :'location' => :'location',
+        :'landmark' => :'landmark',
+        :'postal_code' => :'postalCode',
+        :'post_office' => :'postOffice',
+        :'state' => :'state',
+        :'street' => :'street',
+        :'subdistrict' => :'subdistrict',
+        :'village_town_city' => :'villageTownCity'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'gender' => :'String',
+        :'care_of' => :'String',
+        :'country' => :'String',
+        :'district' => :'String',
+        :'house' => :'String',
+        :'location' => :'String',
+        :'landmark' => :'String',
+        :'postal_code' => :'String',
+        :'post_office' => :'String',
+        :'state' => :'String',
+        :'street' => :'String',
+        :'subdistrict' => :'String',
+        :'village_town_city' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'date_of_birth',
+        :'gender',
+        :'care_of',
+        :'country',
+        :'district',
+        :'house',
+        :'location',
+        :'landmark',
+        :'postal_code',
+        :'post_office',
+        :'state',
+        :'street',
+        :'subdistrict',
+        :'village_town_city'
+      ])
+    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 `TrinsicApi::AadhaarClaims` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::AadhaarClaims`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'care_of')
+        self.care_of = attributes[:'care_of']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'district')
+        self.district = attributes[:'district']
+      end
+
+      if attributes.key?(:'house')
+        self.house = attributes[:'house']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'landmark')
+        self.landmark = attributes[:'landmark']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'post_office')
+        self.post_office = attributes[:'post_office']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'street')
+        self.street = attributes[:'street']
+      end
+
+      if attributes.key?(:'subdistrict')
+        self.subdistrict = attributes[:'subdistrict']
+      end
+
+      if attributes.key?(:'village_town_city')
+        self.village_town_city = attributes[:'village_town_city']
+      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
+      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'
+      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 &&
+          name == o.name &&
+          date_of_birth == o.date_of_birth &&
+          gender == o.gender &&
+          care_of == o.care_of &&
+          country == o.country &&
+          district == o.district &&
+          house == o.house &&
+          location == o.location &&
+          landmark == o.landmark &&
+          postal_code == o.postal_code &&
+          post_office == o.post_office &&
+          state == o.state &&
+          street == o.street &&
+          subdistrict == o.subdistrict &&
+          village_town_city == o.village_town_city
+    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
+      [name, date_of_birth, gender, care_of, country, district, house, location, landmark, postal_code, post_office, state, street, subdistrict, village_town_city].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 = TrinsicApi.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