authress-sdk 2.0.36.0 → 2.0.39.0

data/lib/authress-sdk/api/users_api.rb

@@ -0,0 +1,134 @@
+=begin
+
+=end
+
+module AuthressSdk
+  class UsersApi
+    attr_accessor :authress_client
+
+    def initialize(authress_client = AuthressClient.default)
+      @authress_client = authress_client
+    end
+
+    # Retrieve a user
+    # Get the user data associated with a user. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties.
+    # @param user_id The user identifier.
+    # @param [Hash] opts the optional parameters
+    # @return [UserIdentity]
+    def get_user(user_id, opts = {})
+      data, _status_code, _headers = get_user_with_http_info(user_id, opts)
+      data
+    end
+
+    # Retrieve a user
+    # Get the user data associated with a user. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties.
+    # @param user_id The user identifier.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserIdentity, Integer, Hash)>] UserIdentity data, response status code and response headers
+    def get_user_with_http_info(user_id, opts = {})
+      if @authress_client.config[:debugging]
+        @authress_client.config[:logger].debug 'Calling API: UsersApi.get_user ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @authress_client.config[:client_side_validation] && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user"
+      end
+      # resource path
+      local_var_path = '/v1/users/{userId}'.sub('{' + 'userId' + '}', user_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'] = @authress_client.select_header_accept(['application/links+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'UserIdentity' 
+
+      auth_names = opts[:auth_names] || ['oauth2']
+      data, status_code, headers = @authress_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @authress_client.config[:debugging]
+        @authress_client.config[:logger].debug "API called: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List users
+    # Returns a paginated user list for the account. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Max number of results to return (default to 100)
+    # @option opts [String] :cursor Continuation cursor for paging (will automatically be set)
+    # @option opts [String] :filter Filter to search users by. This is a case insensitive search through every text field.
+    # @option opts [String] :tenant_id Return only users that are part of the specified tenant. Users can only be part of one tenant, using this parameter will limit returned users that have logged into this tenant.
+    # @return [UserIdentityCollection]
+    def get_users(opts = {})
+      data, _status_code, _headers = get_users_with_http_info(opts)
+      data
+    end
+
+    # List users
+    # Returns a paginated user list for the account. The data returned by this endpoint is highly variable based on the source OAuth provider. Avoid depending on undocumented properties.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Max number of results to return (default to 100)
+    # @option opts [String] :cursor Continuation cursor for paging (will automatically be set)
+    # @option opts [String] :filter Filter to search users by. This is a case insensitive search through every text field.
+    # @option opts [String] :tenant_id Return only users that are part of the specified tenant. Users can only be part of one tenant, using this parameter will limit returned users that have logged into this tenant.
+    # @return [Array<(UserIdentityCollection, Integer, Hash)>] UserIdentityCollection data, response status code and response headers
+    def get_users_with_http_info(opts = {})
+      if @authress_client.config[:debugging]
+        @authress_client.config[:logger].debug 'Calling API: UsersApi.get_users ...'
+      end
+
+      # resource path
+      local_var_path = '/v1/users'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'tenantId'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @authress_client.select_header_accept(['application/links+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'UserIdentityCollection' 
+
+      auth_names = opts[:auth_names] || ['oauth2']
+      data, status_code, headers = @authress_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @authress_client.config[:debugging]
+        @authress_client.config[:logger].debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/authress-sdk/models/{permission_response.rb → permission_collection.rb}

@@ -6,7 +6,7 @@ require 'date'
 
 module AuthressSdk
   # A collect of permissions that the user has to a resource.
-  class PermissionResponse
+  class PermissionCollection
     attr_accessor :account
 
     attr_accessor :user_id
@@ -42,13 +42,13 @@ module AuthressSdk
     # @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 `AuthressSdk::PermissionResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AuthressSdk::PermissionCollection` 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 `AuthressSdk::PermissionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AuthressSdk::PermissionCollection`. 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
       }

data/lib/authress-sdk/models/{v1resourcesresource_uri_permissions.rb → user_identity.rb}

@@ -5,10 +5,19 @@
 require 'date'
 
 module AuthressSdk
-  class V1resourcesresourceUriPermissions
-    attr_accessor :action
+  # The access record which links users to roles.
+  class UserIdentity
+    # The user identifier.
+    attr_accessor :user_id
 
-    attr_accessor :allow
+    # The user's formatted display name.
+    attr_accessor :name
+
+    # A url that resolves to a picture that can be rendered.
+    attr_accessor :picture
+
+    # The user's verified email address sourced from their SSO IdP.
+    attr_accessor :email
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -35,16 +44,20 @@ module AuthressSdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'action' => :'action',
-        :'allow' => :'allow'
+        :'user_id' => :'userId',
+        :'name' => :'name',
+        :'picture' => :'picture',
+        :'email' => :'email'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'action' => :'Object',
-        :'allow' => :'Object'
+        :'user_id' => :'Object',
+        :'name' => :'Object',
+        :'picture' => :'Object',
+        :'email' => :'Object'
       }
     end
 
@@ -58,23 +71,31 @@ module AuthressSdk
     # @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 `AuthressSdk::V1resourcesresourceUriPermissions` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AuthressSdk::UserIdentity` 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 `AuthressSdk::V1resourcesresourceUriPermissions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AuthressSdk::UserIdentity`. 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?(:'action')
-        self.action = attributes[:'action']
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'allow')
-        self.allow = attributes[:'allow']
+      if attributes.key?(:'picture')
+        self.picture = attributes[:'picture']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
       end
     end
 
@@ -82,44 +103,25 @@ module AuthressSdk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @action.nil?
-        invalid_properties.push('invalid value for "action", action cannot be nil.')
-      end
-
-      if @allow.nil?
-        invalid_properties.push('invalid value for "allow", allow 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?
-      return false if @action.nil?
-      action_validator = EnumAttributeValidator.new('Object', ['CLAIM', 'PUBLIC'])
-      return false unless action_validator.valid?(@action)
-      return false if @allow.nil?
+      return false if @user_id.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] action Object to be assigned
-    def action=(action)
-      validator = EnumAttributeValidator.new('Object', ['CLAIM', 'PUBLIC'])
-      unless validator.valid?(action)
-        fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
-      end
-      @action = action
-    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 &&
-          action == o.action &&
-          allow == o.allow
+          user_id == o.user_id &&
+          name == o.name &&
+          picture == o.picture &&
+          email == o.email
     end
 
     # @see the `==` method
@@ -131,7 +133,7 @@ module AuthressSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, allow].hash
+      [user_id, name, picture, email].hash
     end
 
     # Builds the object from hash

data/lib/authress-sdk/models/{inline_response_200_6.rb → user_identity_collection.rb}

@@ -5,9 +5,9 @@
 require 'date'
 
 module AuthressSdk
-  # A collection of users with explicit permission to a resource.
-  class InlineResponse2006
-    # A list of users
+  # A collection of user identities
+  class UserIdentityCollection
+    # A list of user identities
     attr_accessor :users
 
     attr_accessor :links
@@ -38,13 +38,13 @@ module AuthressSdk
     # @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 `AuthressSdk::InlineResponse2006` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AuthressSdk::UserIdentityCollection` 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 `AuthressSdk::InlineResponse2006`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `AuthressSdk::UserIdentityCollection`. 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
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authress-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.36.0
+  version: 2.0.39.0
 platform: ruby
 authors:
 - Authress
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -120,6 +120,7 @@ files:
 - lib/authress-sdk/api/roles_api.rb
 - lib/authress-sdk/api/service_clients_api.rb
 - lib/authress-sdk/api/user_permissions_api.rb
+- lib/authress-sdk/api/users_api.rb
 - lib/authress-sdk/api_error.rb
 - lib/authress-sdk/authress_client.rb
 - lib/authress-sdk/constant_token_provider.rb
@@ -138,26 +139,11 @@ files:
 - lib/authress-sdk/models/identity_collection.rb
 - lib/authress-sdk/models/identity_collection_identities.rb
 - lib/authress-sdk/models/identity_request.rb
-- lib/authress-sdk/models/inline_response_200.rb
-- lib/authress-sdk/models/inline_response_200_1.rb
-- lib/authress-sdk/models/inline_response_200_10.rb
-- lib/authress-sdk/models/inline_response_200_11.rb
-- lib/authress-sdk/models/inline_response_200_12.rb
-- lib/authress-sdk/models/inline_response_200_13.rb
-- lib/authress-sdk/models/inline_response_200_14.rb
-- lib/authress-sdk/models/inline_response_200_15.rb
-- lib/authress-sdk/models/inline_response_200_2.rb
-- lib/authress-sdk/models/inline_response_200_3.rb
-- lib/authress-sdk/models/inline_response_200_4.rb
-- lib/authress-sdk/models/inline_response_200_5.rb
-- lib/authress-sdk/models/inline_response_200_6.rb
-- lib/authress-sdk/models/inline_response_200_7.rb
-- lib/authress-sdk/models/inline_response_200_9.rb
 - lib/authress-sdk/models/invite.rb
 - lib/authress-sdk/models/link.rb
 - lib/authress-sdk/models/metadata_object.rb
+- lib/authress-sdk/models/permission_collection.rb
 - lib/authress-sdk/models/permission_object.rb
-- lib/authress-sdk/models/permission_response.rb
 - lib/authress-sdk/models/resource_permission.rb
 - lib/authress-sdk/models/resource_permission_collection.rb
 - lib/authress-sdk/models/resource_permission_collection_links.rb
@@ -168,21 +154,13 @@ files:
 - lib/authress-sdk/models/statement.rb
 - lib/authress-sdk/models/token_request.rb
 - lib/authress-sdk/models/user.rb
+- lib/authress-sdk/models/user_identity.rb
+- lib/authress-sdk/models/user_identity_collection.rb
 - lib/authress-sdk/models/user_resources.rb
 - lib/authress-sdk/models/user_resources_resources.rb
 - lib/authress-sdk/models/user_token.rb
 - lib/authress-sdk/models/user_token_links.rb
 - lib/authress-sdk/models/user_token_links_self.rb
-- lib/authress-sdk/models/v1clients_options.rb
-- lib/authress-sdk/models/v1records_account.rb
-- lib/authress-sdk/models/v1records_links.rb
-- lib/authress-sdk/models/v1records_links_self.rb
-- lib/authress-sdk/models/v1records_users.rb
-- lib/authress-sdk/models/v1resourcesresource_uri_permissions.rb
-- lib/authress-sdk/models/v1roles_permissions.rb
-- lib/authress-sdk/models/v1usersuser_idresourcesresource_urimetadata_account.rb
-- lib/authress-sdk/models/v1usersuser_idtokens_resources.rb
-- lib/authress-sdk/models/v1usersuser_idtokens_statements.rb
 - lib/authress-sdk/omniauth.rb
 - lib/authress-sdk/service_client_token_provider.rb
 - lib/authress-sdk/token_validator.rb

data/lib/authress-sdk/models/inline_response_200.rb

@@ -1,240 +0,0 @@
-=begin
-
-=end
-
-require 'date'
-
-module AuthressSdk
-  # A collect of permissions that the user has to a resource.
-  class InlineResponse200
-    attr_accessor :account
-
-    attr_accessor :user_id
-
-    # A list of the resources the user has some permission to.
-    attr_accessor :resources
-
-    attr_accessor :links
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'account' => :'account',
-        :'user_id' => :'userId',
-        :'resources' => :'resources',
-        :'links' => :'links'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'account' => :'Object',
-        :'user_id' => :'Object',
-        :'resources' => :'Object',
-        :'links' => :'Object'
-      }
-    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 `AuthressSdk::InlineResponse200` 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 `AuthressSdk::InlineResponse200`. 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?(:'account')
-        self.account = attributes[:'account']
-      end
-
-      if attributes.key?(:'user_id')
-        self.user_id = attributes[:'user_id']
-      end
-
-      if attributes.key?(:'resources')
-        if (value = attributes[:'resources']).is_a?(Array)
-          self.resources = value
-        end
-      end
-
-      if attributes.key?(:'links')
-        self.links = attributes[:'links']
-      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
-      invalid_properties = Array.new
-      if @user_id.nil?
-        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
-      end
-
-      if @links.nil?
-        invalid_properties.push('invalid value for "links", links 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?
-      return false if @user_id.nil?
-      return false if @links.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 &&
-          account == o.account &&
-          user_id == o.user_id &&
-          resources == o.resources &&
-          links == o.links
-    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
-      [account, user_id, resources, links].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)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if 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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.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
-        AuthressSdk.const_get(type).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