torii-backend 0.0.9 → 0.0.11

data/src/torii/backend/generated/lib/torii_backend_generated/models/server_user_organization_response.rb

@@ -0,0 +1,324 @@
+=begin
+#Torii Backend API
+
+#Server-to-server API (BAPI) for backend SDKs. Authenticated with a secret key (Bearer sk_live_* / sk_test_*).
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ToriiBackendGenerated
+  class ServerUserOrganizationResponse < ApiModelBase
+    attr_accessor :organization_id
+
+    # The organization's display name.
+    attr_accessor :name
+
+    # The organization's slug, when it has one.
+    attr_accessor :slug
+
+    # This user's role key in the organization (e.g. org:administrator).
+    attr_accessor :role
+
+    # Display name of that role, from the organization's bound role set. Null when the organization has no bound set or the key is not in it.
+    attr_accessor :role_name
+
+    # The MEMBERSHIP's public metadata bag, not the organization's.
+    attr_accessor :public_metadata
+
+    # The MEMBERSHIP's private metadata bag, not the organization's. Server-only, never exposed to the SDK.
+    attr_accessor :private_metadata
+
+    attr_accessor :joined_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'organization_id' => :'organizationId',
+        :'name' => :'name',
+        :'slug' => :'slug',
+        :'role' => :'role',
+        :'role_name' => :'roleName',
+        :'public_metadata' => :'publicMetadata',
+        :'private_metadata' => :'privateMetadata',
+        :'joined_at' => :'joinedAt'
+      }
+    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
+      {
+        :'organization_id' => :'String',
+        :'name' => :'String',
+        :'slug' => :'String',
+        :'role' => :'String',
+        :'role_name' => :'String',
+        :'public_metadata' => :'Hash<String, Object>',
+        :'private_metadata' => :'Hash<String, Object>',
+        :'joined_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'slug',
+        :'role_name',
+      ])
+    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 `ToriiBackendGenerated::ServerUserOrganizationResponse` 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 `ToriiBackendGenerated::ServerUserOrganizationResponse`. 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?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      else
+        self.organization_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
+      if attributes.key?(:'role')
+        self.role = attributes[:'role']
+      else
+        self.role = nil
+      end
+
+      if attributes.key?(:'role_name')
+        self.role_name = attributes[:'role_name']
+      end
+
+      if attributes.key?(:'public_metadata')
+        if (value = attributes[:'public_metadata']).is_a?(Hash)
+          self.public_metadata = value
+        end
+      else
+        self.public_metadata = nil
+      end
+
+      if attributes.key?(:'private_metadata')
+        if (value = attributes[:'private_metadata']).is_a?(Hash)
+          self.private_metadata = value
+        end
+      else
+        self.private_metadata = nil
+      end
+
+      if attributes.key?(:'joined_at')
+        self.joined_at = attributes[:'joined_at']
+      else
+        self.joined_at = 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 @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @role.nil?
+        invalid_properties.push('invalid value for "role", role cannot be nil.')
+      end
+
+      if @public_metadata.nil?
+        invalid_properties.push('invalid value for "public_metadata", public_metadata cannot be nil.')
+      end
+
+      if @private_metadata.nil?
+        invalid_properties.push('invalid value for "private_metadata", private_metadata cannot be nil.')
+      end
+
+      if @joined_at.nil?
+        invalid_properties.push('invalid value for "joined_at", joined_at 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 @organization_id.nil?
+      return false if @name.nil?
+      return false if @role.nil?
+      return false if @public_metadata.nil?
+      return false if @private_metadata.nil?
+      return false if @joined_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] organization_id Value to be assigned
+    def organization_id=(organization_id)
+      if organization_id.nil?
+        fail ArgumentError, 'organization_id cannot be nil'
+      end
+
+      @organization_id = organization_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] role Value to be assigned
+    def role=(role)
+      if role.nil?
+        fail ArgumentError, 'role cannot be nil'
+      end
+
+      @role = role
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] public_metadata Value to be assigned
+    def public_metadata=(public_metadata)
+      if public_metadata.nil?
+        fail ArgumentError, 'public_metadata cannot be nil'
+      end
+
+      @public_metadata = public_metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] private_metadata Value to be assigned
+    def private_metadata=(private_metadata)
+      if private_metadata.nil?
+        fail ArgumentError, 'private_metadata cannot be nil'
+      end
+
+      @private_metadata = private_metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] joined_at Value to be assigned
+    def joined_at=(joined_at)
+      if joined_at.nil?
+        fail ArgumentError, 'joined_at cannot be nil'
+      end
+
+      @joined_at = joined_at
+    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 &&
+          organization_id == o.organization_id &&
+          name == o.name &&
+          slug == o.slug &&
+          role == o.role &&
+          role_name == o.role_name &&
+          public_metadata == o.public_metadata &&
+          private_metadata == o.private_metadata &&
+          joined_at == o.joined_at
+    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
+      [organization_id, name, slug, role, role_name, public_metadata, private_metadata, joined_at].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
+
+    # 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
+
+  end
+
+end

data/src/torii/backend/generated/lib/torii_backend_generated/models/server_user_search_request.rb

@@ -37,6 +37,9 @@ module ToriiBackendGenerated
     # Only return users created at or before this instant (ISO-8601 UTC).
     attr_accessor :created_before
 
+    # Only return members of this organization. An organization from another environment matches nobody. Not an id-selector: it is applied as a membership semi-join, so it is never capped and always ANDs with the rest of the filters.
+    attr_accessor :organization_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -68,7 +71,8 @@ module ToriiBackendGenerated
         :'email' => :'email',
         :'statuses' => :'statuses',
         :'created_after' => :'createdAfter',
-        :'created_before' => :'createdBefore'
+        :'created_before' => :'createdBefore',
+        :'organization_id' => :'organizationId'
       }
     end
 
@@ -91,7 +95,8 @@ module ToriiBackendGenerated
         :'email' => :'String',
         :'statuses' => :'Array<String>',
         :'created_after' => :'Time',
-        :'created_before' => :'Time'
+        :'created_before' => :'Time',
+        :'organization_id' => :'String'
       }
     end
 
@@ -101,7 +106,8 @@ module ToriiBackendGenerated
         :'name',
         :'email',
         :'created_after',
-        :'created_before'
+        :'created_before',
+        :'organization_id'
       ])
     end
 
@@ -154,6 +160,10 @@ module ToriiBackendGenerated
       if attributes.key?(:'created_before')
         self.created_before = attributes[:'created_before']
       end
+
+      if attributes.key?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -182,7 +192,8 @@ module ToriiBackendGenerated
           email == o.email &&
           statuses == o.statuses &&
           created_after == o.created_after &&
-          created_before == o.created_before
+          created_before == o.created_before &&
+          organization_id == o.organization_id
     end
 
     # @see the `==` method
@@ -194,7 +205,7 @@ module ToriiBackendGenerated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, user_ids, email_addresses, email, statuses, created_after, created_before].hash
+      [name, user_ids, email_addresses, email, statuses, created_after, created_before, organization_id].hash
     end
 
     # Builds the object from hash

data/src/torii/backend/generated/lib/torii_backend_generated/models/update_organization_metadata_request.rb

@@ -0,0 +1,162 @@
+=begin
+#Torii Backend API
+
+#Server-to-server API (BAPI) for backend SDKs. Authenticated with a secret key (Bearer sk_live_* / sk_test_*).
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ToriiBackendGenerated
+  class UpdateOrganizationMetadataRequest < ApiModelBase
+    # Public metadata bag. An organization's bag is readable over the client API by any member; a MEMBERSHIP's bags are server-plane only and are never returned on a client-facing read. Capped at 8 KB on its own.
+    attr_accessor :public_metadata
+
+    # Private metadata bag: server-only. Never exposed to the SDK, never in a JWT. Capped at 8 KB on its own.
+    attr_accessor :private_metadata
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'public_metadata' => :'publicMetadata',
+        :'private_metadata' => :'privateMetadata'
+      }
+    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
+      {
+        :'public_metadata' => :'Hash<String, Object>',
+        :'private_metadata' => :'Hash<String, 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 `ToriiBackendGenerated::UpdateOrganizationMetadataRequest` 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 `ToriiBackendGenerated::UpdateOrganizationMetadataRequest`. 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?(:'public_metadata')
+        if (value = attributes[:'public_metadata']).is_a?(Hash)
+          self.public_metadata = value
+        end
+      end
+
+      if attributes.key?(:'private_metadata')
+        if (value = attributes[:'private_metadata']).is_a?(Hash)
+          self.private_metadata = value
+        end
+      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 &&
+          public_metadata == o.public_metadata &&
+          private_metadata == o.private_metadata
+    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
+      [public_metadata, private_metadata].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
+
+    # 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
+
+  end
+
+end

data/src/torii/backend/generated/lib/torii_backend_generated/models/user_session_response.rb

@@ -40,7 +40,7 @@ module ToriiBackendGenerated
     # When this session was last seen by the API (ISO-8601 UTC).
     attr_accessor :last_used_at
 
-    # Active organization pinned to this session (`org_id` claim on re-mint).
+    # Active organization pinned to this session (the `o` claim on re-mint).
     attr_accessor :active_organization_id
 
     # Platform user behind this session when it was established via impersonation; null for normal sign-ins.

data/src/torii/backend/generated/lib/torii_backend_generated.rb

@@ -22,14 +22,21 @@ require 'torii_backend_generated/models/allowed_origins_response'
 require 'torii_backend_generated/models/create_environment_invitation_server_request'
 require 'torii_backend_generated/models/create_user_request'
 require 'torii_backend_generated/models/cursor_page_response_environment_invitation_response'
+require 'torii_backend_generated/models/cursor_page_response_server_organization_member_response'
+require 'torii_backend_generated/models/cursor_page_response_server_organization_response'
+require 'torii_backend_generated/models/cursor_page_response_server_user_organization_response'
 require 'torii_backend_generated/models/cursor_page_response_server_user_response'
 require 'torii_backend_generated/models/environment_invitation_response'
 require 'torii_backend_generated/models/problem_detail'
 require 'torii_backend_generated/models/server_impersonation_token_request'
 require 'torii_backend_generated/models/server_impersonation_token_response'
+require 'torii_backend_generated/models/server_organization_member_response'
+require 'torii_backend_generated/models/server_organization_response'
+require 'torii_backend_generated/models/server_user_organization_response'
 require 'torii_backend_generated/models/server_user_response'
 require 'torii_backend_generated/models/server_user_search_request'
 require 'torii_backend_generated/models/set_allowed_origins_request'
+require 'torii_backend_generated/models/update_organization_metadata_request'
 require 'torii_backend_generated/models/update_user_metadata_request'
 require 'torii_backend_generated/models/update_user_request'
 require 'torii_backend_generated/models/user_session_response'
@@ -38,6 +45,7 @@ require 'torii_backend_generated/models/user_session_response'
 require 'torii_backend_generated/api/allowed_origins_api'
 require 'torii_backend_generated/api/invitations_api'
 require 'torii_backend_generated/api/server_impersonation_api'
+require 'torii_backend_generated/api/server_organizations_api'
 require 'torii_backend_generated/api/server_sessions_api'
 require 'torii_backend_generated/api/server_users_api'
 

data/src/torii/backend/generated/spec/api/server_organizations_api_spec.rb

@@ -0,0 +1,102 @@
+=begin
+#Torii Backend API
+
+#Server-to-server API (BAPI) for backend SDKs. Authenticated with a secret key (Bearer sk_live_* / sk_test_*).
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ToriiBackendGenerated::ServerOrganizationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ServerOrganizationsApi' do
+  before do
+    # run before each test
+    @api_instance = ToriiBackendGenerated::ServerOrganizationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ServerOrganizationsApi' do
+    it 'should create an instance of ServerOrganizationsApi' do
+      expect(@api_instance).to be_instance_of(ToriiBackendGenerated::ServerOrganizationsApi)
+    end
+  end
+
+  # unit tests for get_organization
+  # Get an organization
+  # One organization with both metadata bags.
+  # @param organization_id 
+  # @param [Hash] opts the optional parameters
+  # @return [ServerOrganizationResponse]
+  describe 'get_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_members
+  # List organization members
+  # Cursor-paginated page of the organization's USER memberships, each with both metadata bags. Ordered by member user id ascending (a creation-ordered uuid v7, which is also the seek key), NOT by join time.
+  # @param organization_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Maximum number of items in the returned page (default 20; values outside 1-100 are clamped).
+  # @option opts [String] :cursor Opaque cursor returned by the previous page's `nextCursor`. Omit to fetch the first page.
+  # @return [CursorPageResponseServerOrganizationMemberResponse]
+  describe 'list_members test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_organizations
+  # List organizations
+  # Cursor-paginated page of the environment's organizations, with both metadata bags. Optional `name` filter is a case-insensitive substring match.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name Case-insensitive substring filter on the organization name.
+  # @option opts [Integer] :limit Maximum number of items in the returned page (default 20; values outside 1-100 are clamped).
+  # @option opts [String] :cursor Opaque cursor returned by the previous page's `nextCursor`. Omit to fetch the first page.
+  # @return [CursorPageResponseServerOrganizationResponse]
+  describe 'list_organizations test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_member_metadata
+  # Update organization membership metadata
+  # Deep-merges into either bag on one membership, with the same tri-state contract as the organization endpoint. Each bag on the membership has its own 8 KB budget, separate from the organization's bags.
+  # @param organization_id 
+  # @param member_user_id 
+  # @param update_organization_metadata_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ServerOrganizationMemberResponse]
+  describe 'update_member_metadata test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_organization_metadata
+  # Update organization metadata
+  # Deep-merges into either metadata bag. Each bag is tri-state: omit the key to leave the bag unchanged, or send an object to deep-merge into it (a key set to null removes it). Each bag is capped at 8 KB on its own, measured on the merged result rather than on the patch you send. A request naming neither bag is a 400.
+  # @param organization_id 
+  # @param update_organization_metadata_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ServerOrganizationResponse]
+  describe 'update_organization_metadata test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end