workos 9.5.0 → 10.0.0

data/lib/workos/pipes/{data_integration_credentials_dto.rb → data_integration_credentials_input.rb}

@@ -3,7 +3,7 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  class DataIntegrationCredentialsDto < WorkOS::Types::BaseModel
+  class DataIntegrationCredentialsInput < WorkOS::Types::BaseModel
     HASH_ATTRS = {
       type: :type,
       client_id: :client_id,

data/lib/workos/pipes/data_integration_installation.rb

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

data/lib/workos/pipes/data_integrations_upsert_api_key_request.rb

@@ -3,23 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  class DataIntegrationsUpsertApiKeyRequest < WorkOS::Types::BaseModel
-    HASH_ATTRS = {
-      user_id: :user_id,
-      organization_id: :organization_id,
-      secret: :secret
-    }.freeze
-
-    attr_accessor \
-      :user_id,
-      :organization_id,
-      :secret
-
-    def initialize(json)
-      hash = self.class.normalize(json)
-      @user_id = hash[:user_id]
-      @organization_id = hash[:organization_id]
-      @secret = hash[:secret]
-    end
-  end
+  DataIntegrationsUpsertApiKeyRequest = ApiKeyInstallation
 end

data/lib/workos/pipes/update_data_integration.rb

@@ -9,6 +9,7 @@ module WorkOS
       enabled: :enabled,
       scopes: :scopes,
       credentials: :credentials,
+      api_key: :api_key,
       custom_provider: :custom_provider
     }.freeze
 
@@ -17,6 +18,7 @@ module WorkOS
       :enabled,
       :scopes,
       :credentials,
+      :api_key,
       :custom_provider
 
     def initialize(json)
@@ -24,7 +26,8 @@ module WorkOS
       @description = hash[:description]
       @enabled = hash[:enabled]
       @scopes = hash[:scopes] || []
-      @credentials = hash[:credentials] ? WorkOS::DataIntegrationCredentialsDto.new(hash[:credentials]) : nil
+      @credentials = hash[:credentials] ? WorkOS::DataIntegrationCredentialsInput.new(hash[:credentials]) : nil
+      @api_key = hash[:api_key] ? WorkOS::ApiKeyInstallation.new(hash[:api_key]) : nil
       @custom_provider = hash[:custom_provider] ? WorkOS::UpdateCustomProviderDefinition.new(hash[:custom_provider]) : nil
     end
   end

data/lib/workos/pipes.rb

@@ -59,27 +59,33 @@ module WorkOS
     # @param description [String, nil] An optional description of the Data Integration.
     # @param enabled [Boolean, nil] Whether the Data Integration is enabled. Defaults to `false`.
     # @param scopes [Array<String>, nil] The OAuth scopes to request for the Data Integration. Defaults to the provider's configured scopes when omitted.
-    # @param credentials [WorkOS::DataIntegrationCredentialsDto, nil] The credentials to configure for the Data Integration. Required for both built-in and custom providers.
+    # @param auth_methods [Array<WorkOS::Types::CreateDataIntegrationAuthMethods>, nil] How accounts authenticate with the provider. Defaults to `["oauth"]`. Use `["api_key"]` to declare an API key integration; `credentials` is then not required and keys are supplied per-tenant (optionally via `api_key` on this request).
+    # @param credentials [WorkOS::DataIntegrationCredentialsInput, nil] The OAuth credentials to configure for the Data Integration. Required for OAuth integrations; omit when `auth_methods` is `["api_key"]`.
+    # @param api_key [WorkOS::ApiKeyInstallation, nil] An optional API key to install for the first tenant on an `api_key` integration. Omit to declare a keyless integration; tenants can be added later via the per-installation API key path.
     # @param custom_provider [WorkOS::CustomProviderDefinition, nil] The OAuth definition for a custom provider. Supply this to define a custom provider; omit it to create an integration for a built-in provider.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::DataIntegration]
     def create_data_integration(
       provider:,
-      description: nil,
+      description: WorkOS::OMIT,
       enabled: nil,
-      scopes: nil,
+      scopes: WorkOS::OMIT,
+      auth_methods: nil,
       credentials: nil,
+      api_key: nil,
       custom_provider: nil,
       request_options: {}
     )
       body = {
         "provider" => provider,
-        "description" => description,
         "enabled" => enabled,
-        "scopes" => scopes,
+        "auth_methods" => auth_methods,
         "credentials" => credentials,
+        "api_key" => api_key,
         "custom_provider" => custom_provider
       }.compact
+      body["description"] = description unless description.equal?(WorkOS::OMIT)
+      body["scopes"] = scopes unless scopes.equal?(WorkOS::OMIT)
       response = @client.request(
         method: :post,
         path: "/data-integrations",
@@ -116,26 +122,29 @@ module WorkOS
     # @param description [String, nil] An optional description of the Data Integration.
     # @param enabled [Boolean, nil] Whether the Data Integration is enabled.
     # @param scopes [Array<String>, nil] The OAuth scopes to request for the Data Integration. Pass `null` to reset to the provider's configured scopes.
-    # @param credentials [WorkOS::DataIntegrationCredentialsDto, nil] New credentials for the Data Integration. When provided, rotates the stored client secret.
+    # @param credentials [WorkOS::DataIntegrationCredentialsInput, nil] New OAuth credentials for the Data Integration. When provided, rotates the stored client secret. Mutually exclusive with `api_key`.
+    # @param api_key [WorkOS::ApiKeyInstallation, nil] An API key to install or rotate for a tenant on an `api_key` integration. Upserts the tenant installation identified by `user_id` (and optional `organization_id`).
     # @param custom_provider [WorkOS::UpdateCustomProviderDefinition, nil] Updates to a custom provider's OAuth definition. Only valid for custom-provider integrations.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::DataIntegration]
     def update_data_integration(
       slug:,
-      description: nil,
+      description: WorkOS::OMIT,
       enabled: nil,
-      scopes: nil,
+      scopes: WorkOS::OMIT,
       credentials: nil,
+      api_key: nil,
       custom_provider: nil,
       request_options: {}
     )
       body = {
-        "description" => description,
         "enabled" => enabled,
-        "scopes" => scopes,
         "credentials" => credentials,
+        "api_key" => api_key,
         "custom_provider" => custom_provider
       }.compact
+      body["description"] = description unless description.equal?(WorkOS::OMIT)
+      body["scopes"] = scopes unless scopes.equal?(WorkOS::OMIT)
       response = @client.request(
         method: :put,
         path: "/data-integrations/#{WorkOS::Util.encode_path(slug)}",
@@ -264,13 +273,13 @@ module WorkOS
     def get_access_token(
       provider:,
       user_id:,
-      organization_id: nil,
+      organization_id: WorkOS::OMIT,
       request_options: {}
     )
       body = {
-        "user_id" => user_id,
-        "organization_id" => organization_id
-      }.compact
+        "user_id" => user_id
+      }
+      body["organization_id"] = organization_id unless organization_id.equal?(WorkOS::OMIT)
       response = @client.request(
         method: :post,
         path: "/data-integrations/#{WorkOS::Util.encode_path(provider)}/token",
@@ -317,7 +326,7 @@ module WorkOS
     # @param refresh_token [String, nil] The OAuth refresh token for the connected account.
     # @param expires_at [String, nil] The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire.
     # @param scopes [Array<String>, nil] The OAuth scopes granted for this connection.
-    # @param state [WorkOS::Types::ConnectedAccountState, nil] Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
+    # @param state [WorkOS::Types::ConnectedAccountInputState, nil] Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
     # @param organization_id [String, nil] An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::ConnectedAccount]
@@ -362,7 +371,7 @@ module WorkOS
     # @param refresh_token [String, nil] The OAuth refresh token for the connected account.
     # @param expires_at [String, nil] The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire.
     # @param scopes [Array<String>, nil] The OAuth scopes granted for this connection.
-    # @param state [WorkOS::Types::ConnectedAccountState, nil] Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
+    # @param state [WorkOS::Types::ConnectedAccountInputState, nil] Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
     # @param organization_id [String, nil] An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::ConnectedAccount]

data/lib/workos/pipes_provider.rb

@@ -42,17 +42,17 @@ module WorkOS
       organization_id:,
       slug:,
       enabled: nil,
-      scopes: nil,
+      scopes: WorkOS::OMIT,
       client_id: nil,
       client_secret: nil,
       request_options: {}
     )
       body = {
         "enabled" => enabled,
-        "scopes" => scopes,
         "client_id" => client_id,
         "client_secret" => client_secret
       }.compact
+      body["scopes"] = scopes unless scopes.equal?(WorkOS::OMIT)
       response = @client.request(
         method: :put,
         path: "/organizations/#{WorkOS::Util.encode_path(organization_id)}/data_integration_configurations/#{WorkOS::Util.encode_path(slug)}",

data/lib/workos/shared/access_token_agent_registration_credential_issued_data_detail.rb

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

data/lib/workos/shared/agent_registration_claim_attempt_created.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationClaimAttemptCreated < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      event: :event,
+      data: :data,
+      created_at: :created_at,
+      context: :context
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :event,
+      :data,
+      :created_at,
+      :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::AgentRegistrationClaimAttemptCreatedData.new(hash[:data]) : nil
+      @created_at = hash[:created_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
+    end
+  end
+end

data/lib/workos/shared/agent_registration_claim_attempt_created_data.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationClaimAttemptCreatedData < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      agent_registration_id: :agent_registration_id,
+      agent_registration_claim_id: :agent_registration_claim_id,
+      login_hint: :login_hint,
+      expires_at: :expires_at,
+      created_at: :created_at,
+      updated_at: :updated_at
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :agent_registration_id,
+      :agent_registration_claim_id,
+      :login_hint,
+      :expires_at,
+      :created_at,
+      :updated_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @agent_registration_id = hash[:agent_registration_id]
+      @agent_registration_claim_id = hash[:agent_registration_claim_id]
+      @login_hint = hash[:login_hint]
+      @expires_at = hash[:expires_at]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+    end
+  end
+end

data/lib/workos/shared/agent_registration_claim_completed.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationClaimCompleted < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      event: :event,
+      data: :data,
+      created_at: :created_at,
+      context: :context
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :event,
+      :data,
+      :created_at,
+      :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::AgentRegistrationClaimCompletedData.new(hash[:data]) : nil
+      @created_at = hash[:created_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
+    end
+  end
+end

data/lib/workos/shared/agent_registration_claim_completed_data.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationClaimCompletedData < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      agent_registration_id: :agent_registration_id,
+      completed_by_attempt_id: :completed_by_attempt_id,
+      claimed_by: :claimed_by,
+      completed_at: :completed_at,
+      created_at: :created_at,
+      updated_at: :updated_at
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :agent_registration_id,
+      :completed_by_attempt_id,
+      :claimed_by,
+      :completed_at,
+      :created_at,
+      :updated_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @agent_registration_id = hash[:agent_registration_id]
+      @completed_by_attempt_id = hash[:completed_by_attempt_id]
+      @claimed_by = hash[:claimed_by] ? WorkOS::AgentRegistrationClaimCompletedDataClaimedBy.new(hash[:claimed_by]) : nil
+      @completed_at = hash[:completed_at]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+    end
+  end
+end

data/lib/workos/shared/agent_registration_claim_completed_data_claimed_by.rb

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

data/lib/workos/shared/agent_registration_created.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationCreated < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      event: :event,
+      data: :data,
+      created_at: :created_at,
+      context: :context
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :event,
+      :data,
+      :created_at,
+      :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::AgentRegistrationCreatedData.new(hash[:data]) : nil
+      @created_at = hash[:created_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
+    end
+  end
+end

data/lib/workos/{organization_domains/organization_domain_stand_alone.rb → shared/agent_registration_created_data.rb}

@@ -3,16 +3,15 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  class OrganizationDomainStandAlone < WorkOS::Types::BaseModel
+  class AgentRegistrationCreatedData < WorkOS::Types::BaseModel
     HASH_ATTRS = {
       object: :object,
       id: :id,
+      agent_identity: :agent_identity,
       organization_id: :organization_id,
-      domain: :domain,
-      state: :state,
-      verification_prefix: :verification_prefix,
-      verification_token: :verification_token,
-      verification_strategy: :verification_strategy,
+      status: :status,
+      kind: :kind,
+      method: :method,
       created_at: :created_at,
       updated_at: :updated_at
     }.freeze
@@ -20,12 +19,11 @@ module WorkOS
     attr_accessor \
       :object,
       :id,
+      :agent_identity,
       :organization_id,
-      :domain,
-      :state,
-      :verification_prefix,
-      :verification_token,
-      :verification_strategy,
+      :status,
+      :kind,
+      :method,
       :created_at,
       :updated_at
 
@@ -33,12 +31,11 @@ module WorkOS
       hash = self.class.normalize(json)
       @object = hash[:object]
       @id = hash[:id]
+      @agent_identity = hash[:agent_identity] ? WorkOS::AgentRegistrationCreatedDataAgentIdentity.new(hash[:agent_identity]) : nil
       @organization_id = hash[:organization_id]
-      @domain = hash[:domain]
-      @state = hash[:state]
-      @verification_prefix = hash[:verification_prefix]
-      @verification_token = hash[:verification_token]
-      @verification_strategy = hash[:verification_strategy]
+      @status = hash[:status]
+      @kind = hash[:kind]
+      @method = hash[:method]
       @created_at = hash[:created_at]
       @updated_at = hash[:updated_at]
     end

data/lib/workos/shared/agent_registration_created_data_agent_identity.rb

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

data/lib/workos/shared/agent_registration_credential_issued.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationCredentialIssued < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      event: :event,
+      data: :data,
+      created_at: :created_at,
+      context: :context
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :event,
+      :data,
+      :created_at,
+      :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::AgentRegistrationCredentialIssuedData.new(hash[:data]) : nil
+      @created_at = hash[:created_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
+    end
+  end
+end

data/lib/workos/shared/agent_registration_credential_issued_data.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationCredentialIssuedData < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      agent_registration_id: :agent_registration_id,
+      detail: :detail,
+      created_at: :created_at,
+      updated_at: :updated_at
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :agent_registration_id,
+      :detail,
+      :created_at,
+      :updated_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @agent_registration_id = hash[:agent_registration_id]
+      @detail = hash[:detail] ? (case hash[:detail][:kind] when "api_key" then WorkOS::AgentRegistrationCredentialIssuedDataDetail.new(hash[:detail]) when "access_token" then WorkOS::AccessTokenAgentRegistrationCredentialIssuedDataDetail.new(hash[:detail]) else hash[:detail] end) : nil
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+    end
+  end
+end

data/lib/workos/shared/agent_registration_credential_issued_data_detail.rb

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

data/lib/workos/shared/agent_registration_deleted.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentRegistrationDeleted < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      event: :event,
+      data: :data,
+      created_at: :created_at,
+      context: :context
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :event,
+      :data,
+      :created_at,
+      :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::AgentRegistrationDeletedData.new(hash[:data]) : nil
+      @created_at = hash[:created_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
+    end
+  end
+end