workos 7.1.2 → 9.5.0

data/lib/workos/api_keys/api_key_created.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class ApiKeyCreated < 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::ApiKeyCreatedData.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/api_keys/api_key_created_data.rb

@@ -11,6 +11,7 @@ module WorkOS
       name: :name,
       obfuscated_value: :obfuscated_value,
       last_used_at: :last_used_at,
+      expires_at: :expires_at,
       permissions: :permissions,
       created_at: :created_at,
       updated_at: :updated_at
@@ -23,6 +24,7 @@ module WorkOS
       :name,
       :obfuscated_value,
       :last_used_at,
+      :expires_at,
       :permissions,
       :created_at,
       :updated_at
@@ -31,10 +33,11 @@ module WorkOS
       hash = self.class.normalize(json)
       @object = hash[:object]
       @id = hash[:id]
-      @owner = hash[:owner] ? WorkOS::ApiKeyCreatedDataOwner.new(hash[:owner]) : nil
+      @owner = hash[:owner] ? (case hash[:owner][:type] when "organization" then WorkOS::ApiKeyCreatedDataOwner.new(hash[:owner]) when "user" then WorkOS::UserApiKeyCreatedDataOwner.new(hash[:owner]) else hash[:owner] end) : nil
       @name = hash[:name]
       @obfuscated_value = hash[:obfuscated_value]
       @last_used_at = hash[:last_used_at]
+      @expires_at = hash[:expires_at]
       @permissions = hash[:permissions] || []
       @created_at = hash[:created_at]
       @updated_at = hash[:updated_at]

data/lib/workos/api_keys/api_key_revoked.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class ApiKeyRevoked < 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::ApiKeyRevokedData.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/{audit_logs/audit_log_export_json.rb → api_keys/api_key_updated.rb}

@@ -3,32 +3,32 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  class AuditLogExportJson < WorkOS::Types::BaseModel
+  class ApiKeyUpdated < WorkOS::Types::BaseModel
     HASH_ATTRS = {
       object: :object,
       id: :id,
-      state: :state,
-      url: :url,
+      event: :event,
+      data: :data,
       created_at: :created_at,
-      updated_at: :updated_at
+      context: :context
     }.freeze
 
     attr_accessor \
       :object,
       :id,
-      :state,
-      :url,
+      :event,
+      :data,
       :created_at,
-      :updated_at
+      :context
 
     def initialize(json)
       hash = self.class.normalize(json)
       @object = hash[:object]
       @id = hash[:id]
-      @state = hash[:state]
-      @url = hash[:url]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::ApiKeyUpdatedData.new(hash[:data]) : nil
       @created_at = hash[:created_at]
-      @updated_at = hash[:updated_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
     end
   end
 end

data/lib/workos/api_keys/api_key_updated_data.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class ApiKeyUpdatedData < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      owner: :owner,
+      name: :name,
+      obfuscated_value: :obfuscated_value,
+      last_used_at: :last_used_at,
+      expires_at: :expires_at,
+      permissions: :permissions,
+      created_at: :created_at,
+      updated_at: :updated_at,
+      previous_attributes: :previous_attributes
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :owner,
+      :name,
+      :obfuscated_value,
+      :last_used_at,
+      :expires_at,
+      :permissions,
+      :created_at,
+      :updated_at,
+      :previous_attributes
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @owner = hash[:owner] ? (case hash[:owner][:type] when "organization" then WorkOS::ApiKeyUpdatedDataOwner.new(hash[:owner]) when "user" then WorkOS::UserApiKeyUpdatedDataOwner.new(hash[:owner]) else hash[:owner] end) : nil
+      @name = hash[:name]
+      @obfuscated_value = hash[:obfuscated_value]
+      @last_used_at = hash[:last_used_at]
+      @expires_at = hash[:expires_at]
+      @permissions = hash[:permissions] || []
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @previous_attributes = hash[:previous_attributes] ? WorkOS::ApiKeyUpdatedDataPreviousAttribute.new(hash[:previous_attributes]) : nil
+    end
+  end
+end

data/lib/workos/{directory_sync/dsync_deactivated_data_domain.rb → api_keys/api_key_updated_data_owner.rb}

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  DsyncDeactivatedDataDomain = DsyncActivatedDataDomain
+  ApiKeyUpdatedDataOwner = ApiKeyCreatedDataOwner
 end

data/lib/workos/api_keys/api_key_updated_data_previous_attribute.rb

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

data/lib/workos/api_keys/create_organization_api_key.rb

@@ -6,17 +6,20 @@ module WorkOS
   class CreateOrganizationApiKey < WorkOS::Types::BaseModel
     HASH_ATTRS = {
       name: :name,
-      permissions: :permissions
+      permissions: :permissions,
+      expires_at: :expires_at
     }.freeze
 
     attr_accessor \
       :name,
-      :permissions
+      :permissions,
+      :expires_at
 
     def initialize(json)
       hash = self.class.normalize(json)
       @name = hash[:name]
       @permissions = hash[:permissions] || []
+      @expires_at = hash[:expires_at]
     end
   end
 end

data/lib/workos/api_keys/expire_api_key.rb

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

data/lib/workos/api_keys/organization_api_key.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class OrganizationApiKey < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      owner: :owner,
+      name: :name,
+      obfuscated_value: :obfuscated_value,
+      last_used_at: :last_used_at,
+      expires_at: :expires_at,
+      permissions: :permissions,
+      created_at: :created_at,
+      updated_at: :updated_at
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :owner,
+      :name,
+      :obfuscated_value,
+      :last_used_at,
+      :expires_at,
+      :permissions,
+      :created_at,
+      :updated_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @owner = hash[:owner] ? WorkOS::OrganizationApiKeyOwner.new(hash[:owner]) : nil
+      @name = hash[:name]
+      @obfuscated_value = hash[:obfuscated_value]
+      @last_used_at = hash[:last_used_at]
+      @expires_at = hash[:expires_at]
+      @permissions = hash[:permissions] || []
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+    end
+  end
+end

data/lib/workos/{types/events_order.rb → api_keys/organization_api_key_owner.rb}

@@ -3,7 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  module Types
-    EventsOrder = ApplicationsOrder
-  end
+  OrganizationApiKeyOwner = ApiKeyCreatedDataOwner
 end

data/lib/workos/api_keys/organization_api_key_with_value.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class OrganizationApiKeyWithValue < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      owner: :owner,
+      name: :name,
+      obfuscated_value: :obfuscated_value,
+      last_used_at: :last_used_at,
+      expires_at: :expires_at,
+      permissions: :permissions,
+      created_at: :created_at,
+      updated_at: :updated_at,
+      value: :value
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :owner,
+      :name,
+      :obfuscated_value,
+      :last_used_at,
+      :expires_at,
+      :permissions,
+      :created_at,
+      :updated_at,
+      :value
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @owner = hash[:owner] ? WorkOS::OrganizationApiKeyWithValueOwner.new(hash[:owner]) : nil
+      @name = hash[:name]
+      @obfuscated_value = hash[:obfuscated_value]
+      @last_used_at = hash[:last_used_at]
+      @expires_at = hash[:expires_at]
+      @permissions = hash[:permissions] || []
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @value = hash[:value]
+    end
+  end
+end

data/lib/workos/{types/audit_logs_order.rb → api_keys/organization_api_key_with_value_owner.rb}

@@ -3,7 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  module Types
-    AuditLogsOrder = ApplicationsOrder
-  end
+  OrganizationApiKeyWithValueOwner = ApiKeyCreatedDataOwner
 end

data/lib/workos/api_keys.rb

@@ -10,59 +10,19 @@ module WorkOS
       @client = client
     end
 
-    # Validate API key
-    # @param value [String] The value for an API key.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::ApiKeyValidationResponse]
-    def create_validation(
-      value:,
-      request_options: {}
-    )
-      body = {
-        "value" => value
-      }
-      response = @client.request(
-        method: :post,
-        path: "/api_keys/validations",
-        auth: true,
-        body: body,
-        request_options: request_options
-      )
-      result = WorkOS::ApiKeyValidationResponse.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 API key
-    # @param id [String] The unique ID of the API key.
-    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [void]
-    def delete_api_key(
-      id:,
-      request_options: {}
-    )
-      @client.request(
-        method: :delete,
-        path: "/api_keys/#{WorkOS::Util.encode_path(id)}",
-        auth: true,
-        request_options: request_options
-      )
-      nil
-    end
-
     # List API keys for an organization
     # @param organization_id [String] Unique identifier of the Organization.
     # @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.
     # @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.
     # @param limit [Integer, nil] Upper limit on the number of objects to return, between `1` and `100`.
-    # @param order [WorkOS::Types::OrganizationsApiKeysOrder, nil] Order the results by the creation time.
+    # @param order [WorkOS::Types::PaginationOrder, nil] Order the results by the creation time.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
-    # @return [WorkOS::Types::ListStruct<WorkOS::ApiKey>]
+    # @return [WorkOS::Types::ListStruct<WorkOS::OrganizationApiKey>]
     def list_organization_api_keys(
       organization_id:,
       before: nil,
       after: nil,
-      limit: nil,
+      limit: 10,
       order: "desc",
       request_options: {}
     )
@@ -91,7 +51,7 @@ module WorkOS
       }
       WorkOS::Types::ListStruct.from_response(
         response,
-        model: WorkOS::ApiKey,
+        model: WorkOS::OrganizationApiKey,
         filters: {organization_id: organization_id, before: before, limit: limit, order: order},
         fetch_next: fetch_next
       )
@@ -101,17 +61,20 @@ module WorkOS
     # @param organization_id [String] Unique identifier of the Organization.
     # @param name [String] The name for the API key.
     # @param permissions [Array<String>, nil] The permission slugs to assign to the API key.
+    # @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::ApiKeyWithValue]
+    # @return [WorkOS::OrganizationApiKeyWithValue]
     def create_organization_api_key(
       organization_id:,
       name:,
       permissions: nil,
+      expires_at: nil,
       request_options: {}
     )
       body = {
         "name" => name,
-        "permissions" => permissions
+        "permissions" => permissions,
+        "expires_at" => expires_at
       }.compact
       response = @client.request(
         method: :post,
@@ -120,7 +83,72 @@ module WorkOS
         body: body,
         request_options: request_options
       )
-      result = WorkOS::ApiKeyWithValue.new(response.body)
+      result = WorkOS::OrganizationApiKeyWithValue.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
+
+    # Validate API key
+    # @param value [String] The value for an API key.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::ApiKeyValidationResponse]
+    def create_validation(
+      value:,
+      request_options: {}
+    )
+      body = {
+        "value" => value
+      }
+      response = @client.request(
+        method: :post,
+        path: "/api_keys/validations",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::ApiKeyValidationResponse.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 API key
+    # @param id [String] The unique ID of the API key.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [void]
+    def delete_api_key(
+      id:,
+      request_options: {}
+    )
+      @client.request(
+        method: :delete,
+        path: "/api_keys/#{WorkOS::Util.encode_path(id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+
+    # Expire an API key
+    # @param id [String] The unique ID of the API key.
+    # @param expires_at [String, nil] When the API key should expire. If omitted or in the past, the key expires immediately. Use null to clear a scheduled future expiration.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::ApiKey]
+    def create_api_key_expire(
+      id:,
+      expires_at: nil,
+      request_options: {}
+    )
+      body = {
+        "expires_at" => expires_at
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/api_keys/#{WorkOS::Util.encode_path(id)}/expire",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::ApiKey.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

data/lib/workos/audit_logs/audit_log_action.rb

@@ -2,12 +2,8 @@
 
 # This file is auto-generated by oagen. Do not edit.
 
-require "json"
-
 module WorkOS
-  class AuditLogAction
-    include HashProvider
-
+  class AuditLogAction < WorkOS::Types::BaseModel
     HASH_ATTRS = {
       object: :object,
       name: :name,
@@ -24,8 +20,7 @@ module WorkOS
       :updated_at
 
     def initialize(json)
-      hash = json.is_a?(Hash) ? json : JSON.parse(json, symbolize_names: true)
-      hash = hash.transform_keys(&:to_sym) if hash.keys.first.is_a?(String)
+      hash = self.class.normalize(json)
       @object = hash[:object]
       @name = hash[:name]
       @schema = hash[:schema] ? WorkOS::AuditLogSchema.new(hash[:schema]) : nil

data/lib/workos/audit_logs/audit_log_export.rb

@@ -2,12 +2,8 @@
 
 # This file is auto-generated by oagen. Do not edit.
 
-require "json"
-
 module WorkOS
-  class AuditLogExport
-    include HashProvider
-
+  class AuditLogExport < WorkOS::Types::BaseModel
     HASH_ATTRS = {
       object: :object,
       id: :id,
@@ -26,8 +22,7 @@ module WorkOS
       :updated_at
 
     def initialize(json)
-      hash = json.is_a?(Hash) ? json : JSON.parse(json, symbolize_names: true)
-      hash = hash.transform_keys(&:to_sym) if hash.keys.first.is_a?(String)
+      hash = self.class.normalize(json)
       @object = hash[:object]
       @id = hash[:id]
       @state = hash[:state]

data/lib/workos/audit_logs/audit_log_schema.rb

@@ -5,21 +5,30 @@
 module WorkOS
   class AuditLogSchema < WorkOS::Types::BaseModel
     HASH_ATTRS = {
+      object: :object,
+      version: :version,
       actor: :actor,
       targets: :targets,
-      metadata: :metadata
+      metadata: :metadata,
+      created_at: :created_at
     }.freeze
 
     attr_accessor \
+      :object,
+      :version,
       :actor,
       :targets,
-      :metadata
+      :metadata,
+      :created_at
 
     def initialize(json)
       hash = self.class.normalize(json)
+      @object = hash[:object]
+      @version = hash[:version]
       @actor = hash[:actor] ? WorkOS::AuditLogSchemaActor.new(hash[:actor]) : nil
       @targets = (hash[:targets] || []).map { |item| item ? WorkOS::AuditLogSchemaTarget.new(item) : nil }
       @metadata = hash[:metadata] || {}
+      @created_at = hash[:created_at]
     end
   end
 end

data/lib/workos/audit_logs/audit_log_schema_actor_input.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  AuditLogSchemaActorInput = AuditLogSchemaActor
+end

data/lib/workos/audit_logs/audit_log_schema_input.rb

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