workos 8.0.1 → 9.0.0

data/lib/workos/user_management.rb

@@ -20,18 +20,6 @@ module WorkOS
     #   @return [WorkOS::Types::CreateUserPasswordHashType]
     PasswordHashed = Data.define(:password_hash, :password_hash_type)
 
-    # Identifies the role (single variant).
-    #
-    # @!attribute [r] role_slug
-    #   @return [String]
-    RoleSingle = Data.define(:role_slug)
-
-    # Identifies the role (multiple variant).
-    #
-    # @!attribute [r] role_slugs
-    #   @return [Array<String>]
-    RoleMultiple = Data.define(:role_slugs)
-
     def initialize(client)
       @client = client
     end
@@ -1227,207 +1215,6 @@ module WorkOS
       result
     end
 
-    # List organization memberships
-    # @param before [String, nil] An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`.
-    # @param after [String, nil] An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`.
-    # @param limit [Integer, nil] Upper limit on the number of objects to return, between `1` and `100`.
-    # @param order [WorkOS::Types::PaginationOrder, nil] Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending.
-    # @param organization_id [String, nil] The ID of the [organization](https://workos.com/docs/reference/organization) which the user belongs to.
-    # @param statuses [Array<WorkOS::Types::UserManagementOrganizationMembershipStatuses>, nil] Filter by the status of the organization membership. Array including any of `active`, `inactive`, or `pending`.
-    # @param user_id [String, nil] The ID of the [user](https://workos.com/docs/reference/authkit/user).
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::Types::ListStruct<WorkOS::UserOrganizationMembership>]
-    def list_organization_memberships(
-      before: nil,
-      after: nil,
-      limit: 10,
-      order: "desc",
-      organization_id: nil,
-      statuses: nil,
-      user_id: nil,
-      request_options: {}
-    )
-      params = {
-        "before" => before,
-        "after" => after,
-        "limit" => limit,
-        "order" => order,
-        "organization_id" => organization_id,
-        "statuses" => statuses,
-        "user_id" => user_id
-      }.compact
-      response = @client.request(
-        method: :get,
-        path: "/user_management/organization_memberships",
-        auth: true,
-        params: params,
-        request_options: request_options
-      )
-      fetch_next = ->(cursor) {
-        list_organization_memberships(
-          before: before,
-          after: cursor,
-          limit: limit,
-          order: order,
-          organization_id: organization_id,
-          statuses: statuses,
-          user_id: user_id,
-          request_options: request_options
-        )
-      }
-      WorkOS::Types::ListStruct.from_response(
-        response,
-        model: WorkOS::UserOrganizationMembership,
-        filters: {before: before, limit: limit, order: order, organization_id: organization_id, statuses: statuses, user_id: user_id},
-        fetch_next: fetch_next
-      )
-    end
-
-    # Create an organization membership
-    # @param user_id [String] The ID of the [user](https://workos.com/docs/reference/authkit/user).
-    # @param organization_id [String] The ID of the [organization](https://workos.com/docs/reference/organization) which the user belongs to.
-    # @param role [WorkOS::UserManagement::RoleSingle, WorkOS::UserManagement::RoleMultiple, nil] Identifies the role.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::OrganizationMembership]
-    def create_organization_membership(
-      user_id:,
-      organization_id:,
-      role: nil,
-      request_options: {}
-    )
-      body = {
-        "user_id" => user_id,
-        "organization_id" => organization_id
-      }
-      if role
-        case role
-        when WorkOS::UserManagement::RoleSingle
-          body["role_slug"] = role.role_slug
-        when WorkOS::UserManagement::RoleMultiple
-          body["role_slugs"] = role.role_slugs
-        else
-          raise ArgumentError, "expected role to be one of: WorkOS::UserManagement::RoleSingle, WorkOS::UserManagement::RoleMultiple, got #{role.class}"
-        end
-      end
-      response = @client.request(
-        method: :post,
-        path: "/user_management/organization_memberships",
-        auth: true,
-        body: body,
-        request_options: request_options
-      )
-      result = WorkOS::OrganizationMembership.new(response.body)
-      result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
-      result
-    end
-
-    # Get an organization membership
-    # @param id [String] The unique ID of the organization membership.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::UserOrganizationMembership]
-    def get_organization_membership(
-      id:,
-      request_options: {}
-    )
-      response = @client.request(
-        method: :get,
-        path: "/user_management/organization_memberships/#{WorkOS::Util.encode_path(id)}",
-        auth: true,
-        request_options: request_options
-      )
-      result = WorkOS::UserOrganizationMembership.new(response.body)
-      result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
-      result
-    end
-
-    # Update an organization membership
-    # @param id [String] The unique ID of the organization membership.
-    # @param role [WorkOS::UserManagement::RoleSingle, WorkOS::UserManagement::RoleMultiple, nil] Identifies the role.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::UserOrganizationMembership]
-    def update_organization_membership(
-      id:,
-      role: nil,
-      request_options: {}
-    )
-      body = {}
-      if role
-        case role
-        when WorkOS::UserManagement::RoleSingle
-          body["role_slug"] = role.role_slug
-        when WorkOS::UserManagement::RoleMultiple
-          body["role_slugs"] = role.role_slugs
-        else
-          raise ArgumentError, "expected role to be one of: WorkOS::UserManagement::RoleSingle, WorkOS::UserManagement::RoleMultiple, got #{role.class}"
-        end
-      end
-      response = @client.request(
-        method: :put,
-        path: "/user_management/organization_memberships/#{WorkOS::Util.encode_path(id)}",
-        auth: true,
-        body: body,
-        request_options: request_options
-      )
-      result = WorkOS::UserOrganizationMembership.new(response.body)
-      result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
-      result
-    end
-
-    # Delete an organization membership
-    # @param id [String] The unique ID of the organization membership.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [void]
-    def delete_organization_membership(
-      id:,
-      request_options: {}
-    )
-      @client.request(
-        method: :delete,
-        path: "/user_management/organization_memberships/#{WorkOS::Util.encode_path(id)}",
-        auth: true,
-        request_options: request_options
-      )
-      nil
-    end
-
-    # Deactivate an organization membership
-    # @param id [String] The unique ID of the organization membership.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::OrganizationMembership]
-    def deactivate_organization_membership(
-      id:,
-      request_options: {}
-    )
-      response = @client.request(
-        method: :put,
-        path: "/user_management/organization_memberships/#{WorkOS::Util.encode_path(id)}/deactivate",
-        auth: true,
-        request_options: request_options
-      )
-      result = WorkOS::OrganizationMembership.new(response.body)
-      result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
-      result
-    end
-
-    # Reactivate an organization membership
-    # @param id [String] The unique ID of the organization membership.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::UserOrganizationMembership]
-    def reactivate_organization_membership(
-      id:,
-      request_options: {}
-    )
-      response = @client.request(
-        method: :put,
-        path: "/user_management/organization_memberships/#{WorkOS::Util.encode_path(id)}/reactivate",
-        auth: true,
-        request_options: request_options
-      )
-      result = WorkOS::UserOrganizationMembership.new(response.body)
-      result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
-      result
-    end
-
     # Create a redirect URI
     # @param uri [String] The redirect URI to create.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
@@ -1573,6 +1360,7 @@ module WorkOS
     # @param name [String] A descriptive name for the API key.
     # @param organization_id [String] The ID of the organization the user API key is associated with. The user must have an active membership in this organization.
     # @param permissions [Array<String>, nil] The permission slugs to assign to the API key. Each permission must be enabled for user API keys.
+    # @param expires_at [String, nil] The timestamp when the API key should expire. Must be a future timestamp. If omitted, the key does not expire.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::UserApiKeyWithValue]
     def create_user_api_key(
@@ -1580,12 +1368,14 @@ module WorkOS
       name:,
       organization_id:,
       permissions: nil,
+      expires_at: nil,
       request_options: {}
     )
       body = {
         "name" => name,
         "organization_id" => organization_id,
-        "permissions" => permissions
+        "permissions" => permissions,
+        "expires_at" => expires_at
       }.compact
       response = @client.request(
         method: :post,

data/lib/workos/vault/actor.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class Actor < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      id: :id,
+      name: :name
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :name
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @name = hash[:name]
+    end
+  end
+end

data/lib/workos/vault/create_data_key_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class CreateDataKeyRequest < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      context: :context
+    }.freeze
+
+    attr_accessor :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @context = hash[:context] || {}
+    end
+  end
+end

data/lib/workos/vault/create_data_key_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class CreateDataKeyResponse < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      context: :context,
+      data_key: :data_key,
+      encrypted_keys: :encrypted_keys,
+      id: :id
+    }.freeze
+
+    attr_accessor \
+      :context,
+      :data_key,
+      :encrypted_keys,
+      :id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @context = hash[:context] || {}
+      @data_key = hash[:data_key]
+      @encrypted_keys = hash[:encrypted_keys]
+      @id = hash[:id]
+    end
+  end
+end

data/lib/workos/vault/create_object_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class CreateObjectRequest < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      key_context: :key_context,
+      name: :name,
+      value: :value
+    }.freeze
+
+    attr_accessor \
+      :key_context,
+      :name,
+      :value
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @key_context = hash[:key_context] || {}
+      @name = hash[:name]
+      @value = hash[:value]
+    end
+  end
+end

data/lib/workos/vault/decrypt_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class DecryptRequest < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      keys: :keys
+    }.freeze
+
+    attr_accessor :keys
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @keys = hash[:keys]
+    end
+  end
+end

data/lib/workos/vault/decrypt_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class DecryptResponse < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      data_key: :data_key,
+      id: :id
+    }.freeze
+
+    attr_accessor \
+      :data_key,
+      :id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @data_key = hash[:data_key]
+      @id = hash[:id]
+    end
+  end
+end

data/lib/workos/vault/delete_object_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class DeleteObjectResponse < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      name: :name,
+      success: :success
+    }.freeze
+
+    attr_accessor \
+      :name,
+      :success
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @name = hash[:name]
+      @success = hash[:success]
+    end
+  end
+end

data/lib/workos/vault/object.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class ObjectModel < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      id: :id,
+      metadata: :metadata,
+      name: :name,
+      value: :value
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :metadata,
+      :name,
+      :value
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @metadata = hash[:metadata] ? WorkOS::ObjectMetadata.new(hash[:metadata]) : nil
+      @name = hash[:name]
+      @value = hash[:value]
+    end
+  end
+end

data/lib/workos/vault/object_metadata.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class ObjectMetadata < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      context: :context,
+      environment_id: :environment_id,
+      id: :id,
+      key_id: :key_id,
+      updated_at: :updated_at,
+      updated_by: :updated_by,
+      version_id: :version_id
+    }.freeze
+
+    attr_accessor \
+      :context,
+      :environment_id,
+      :id,
+      :key_id,
+      :updated_at,
+      :updated_by,
+      :version_id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @context = hash[:context] || {}
+      @environment_id = hash[:environment_id]
+      @id = hash[:id]
+      @key_id = hash[:key_id]
+      @updated_at = hash[:updated_at]
+      @updated_by = hash[:updated_by] ? WorkOS::Actor.new(hash[:updated_by]) : nil
+      @version_id = hash[:version_id]
+    end
+  end
+end

data/lib/workos/{audit_logs/audit_log_action_json.rb → vault/object_summary.rb}

@@ -3,28 +3,22 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  class AuditLogActionJson < WorkOS::Types::BaseModel
+  class ObjectSummary < WorkOS::Types::BaseModel
     HASH_ATTRS = {
-      object: :object,
+      id: :id,
       name: :name,
-      schema: :schema,
-      created_at: :created_at,
       updated_at: :updated_at
     }.freeze
 
     attr_accessor \
-      :object,
+      :id,
       :name,
-      :schema,
-      :created_at,
       :updated_at
 
     def initialize(json)
       hash = self.class.normalize(json)
-      @object = hash[:object]
+      @id = hash[:id]
       @name = hash[:name]
-      @schema = hash[:schema] ? WorkOS::AuditLogSchemaJson.new(hash[:schema]) : nil
-      @created_at = hash[:created_at]
       @updated_at = hash[:updated_at]
     end
   end

data/lib/workos/vault/object_version.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class ObjectVersion < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      created_at: :created_at,
+      current_version: :current_version,
+      etag: :etag,
+      id: :id,
+      size: :size
+    }.freeze
+
+    attr_accessor \
+      :created_at,
+      :current_version,
+      :etag,
+      :id,
+      :size
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @created_at = hash[:created_at]
+      @current_version = hash[:current_version]
+      @etag = hash[:etag]
+      @id = hash[:id]
+      @size = hash[:size]
+    end
+  end
+end

data/lib/workos/vault/object_without_value.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class ObjectWithoutValue < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      id: :id,
+      metadata: :metadata,
+      name: :name
+    }.freeze
+
+    attr_accessor \
+      :id,
+      :metadata,
+      :name
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @id = hash[:id]
+      @metadata = hash[:metadata] ? WorkOS::ObjectMetadata.new(hash[:metadata]) : nil
+      @name = hash[:name]
+    end
+  end
+end

data/lib/workos/vault/rekey_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class RekeyRequest < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      context: :context,
+      encrypted_keys: :encrypted_keys
+    }.freeze
+
+    attr_accessor \
+      :context,
+      :encrypted_keys
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @context = hash[:context] || {}
+      @encrypted_keys = hash[:encrypted_keys]
+    end
+  end
+end

data/lib/workos/vault/update_object_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class UpdateObjectRequest < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      value: :value,
+      version_check: :version_check
+    }.freeze
+
+    attr_accessor \
+      :value,
+      :version_check
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @value = hash[:value]
+      @version_check = hash[:version_check]
+    end
+  end
+end

data/lib/workos/vault/vault_byok_key_deleted.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class VaultByokKeyDeleted < WorkOS::Types::BaseModel
     HASH_ATTRS = {
+      object: :object,
       id: :id,
       event: :event,
       data: :data,
       created_at: :created_at,
-      context: :context,
-      object: :object
+      context: :context
     }.freeze
 
     attr_accessor \
+      :object,
       :id,
       :event,
       :data,
       :created_at,
-      :context,
-      :object
+      :context
 
     def initialize(json)
       hash = self.class.normalize(json)
+      @object = hash[:object]
       @id = hash[:id]
       @event = hash[:event]
       @data = hash[:data] ? WorkOS::VaultByokKeyDeletedData.new(hash[:data]) : nil
       @created_at = hash[:created_at]
       @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
-      @object = hash[:object]
     end
   end
 end

data/lib/workos/vault/vault_byok_key_verification_completed.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class VaultByokKeyVerificationCompleted < WorkOS::Types::BaseModel
     HASH_ATTRS = {
+      object: :object,
       id: :id,
       event: :event,
       data: :data,
       created_at: :created_at,
-      context: :context,
-      object: :object
+      context: :context
     }.freeze
 
     attr_accessor \
+      :object,
       :id,
       :event,
       :data,
       :created_at,
-      :context,
-      :object
+      :context
 
     def initialize(json)
       hash = self.class.normalize(json)
+      @object = hash[:object]
       @id = hash[:id]
       @event = hash[:event]
       @data = hash[:data] ? WorkOS::VaultByokKeyVerificationCompletedData.new(hash[:data]) : nil
       @created_at = hash[:created_at]
       @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
-      @object = hash[:object]
     end
   end
 end