workos 10.2.1 → 10.3.0

data/lib/workos/organizations/update_audit_logs_retention.rb

@@ -5,13 +5,25 @@
 module WorkOS
   class UpdateAuditLogsRetention < WorkOS::Types::BaseModel
     HASH_ATTRS = {
+      retention_period: :retention_period,
       retention_period_in_days: :retention_period_in_days
     }.freeze
 
-    attr_accessor :retention_period_in_days
+    # @!attribute retention_period_in_days
+    #   @deprecated The number of days Audit Log events will be retained. Valid values are `30` through `330` in 30-day increments and `365` through `3650` in 365-day increments. Deprecated: use `retention_period` instead. Mutually exclusive with `retention_period`.
+
+    attr_accessor :retention_period
+
+    def retention_period_in_days
+      warn "[DEPRECATION] `retention_period_in_days` is deprecated and will be removed in a future version.", uplevel: 1
+      @retention_period_in_days
+    end
+
+    attr_writer :retention_period_in_days
 
     def initialize(json)
       hash = self.class.normalize(json)
+      @retention_period = hash[:retention_period]
       @retention_period_in_days = hash[:retention_period_in_days]
     end
   end

data/lib/workos/organizations.rb

@@ -65,7 +65,7 @@ module WorkOS
     # Create an Organization
     # @param name [String] The name of the organization.
     # @param allow_profiles_outside_organization [Boolean, nil] Whether the organization allows profiles from outside the organization to sign in.
-    # @param domains [Array<String>, nil] The domains associated with the organization. Deprecated in favor of `domain_data`.
+    # @param domains [Array<String>, nil] (deprecated) The domains associated with the organization. Deprecated in favor of `domain_data`.
     # @param domain_data [Array<WorkOS::OrganizationDomainData>, nil] The domains associated with the organization, including verification state.
     # @param metadata [Hash{String => String}, nil] Object containing [metadata](https://workos.com/docs/authkit/metadata) key/value pairs associated with the Organization.
     # @param external_id [String, nil] An external identifier for the Organization.
@@ -263,5 +263,114 @@ module WorkOS
         fetch_next: fetch_next
       )
     end
+
+    # List IT contacts
+    # @param organization_id [String] The ID of the organization.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Types::ListStruct<WorkOS::ItContact>]
+    def list_it_contacts(
+      organization_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/organizations/#{WorkOS::Util.encode_path(organization_id)}/it_contacts",
+        auth: true,
+        request_options: request_options
+      )
+      WorkOS::Types::ListStruct.from_response(
+        response,
+        model: WorkOS::ItContact,
+        filters: {organization_id: organization_id}
+      )
+    end
+
+    # Create an IT contact
+    # @param organization_id [String] The ID of the organization.
+    # @param email [String] The email address of the IT contact.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::ItContact]
+    def create_it_contact(
+      organization_id:,
+      email:,
+      request_options: {}
+    )
+      body = {
+        "email" => email
+      }
+      response = @client.request(
+        method: :post,
+        path: "/organizations/#{WorkOS::Util.encode_path(organization_id)}/it_contacts",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::ItContact.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 IT contact
+    # @param organization_id [String] The ID of the organization.
+    # @param contact_id [String] The ID of the IT contact.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [void]
+    def delete_it_contact(
+      organization_id:,
+      contact_id:,
+      request_options: {}
+    )
+      @client.request(
+        method: :delete,
+        path: "/organizations/#{WorkOS::Util.encode_path(organization_id)}/it_contacts/#{WorkOS::Util.encode_path(contact_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+
+    # Invite an IT contact
+    # @param organization_id [String] The ID of the organization.
+    # @param contact_id [String] The ID of the IT contact.
+    # @param intents [Array<WorkOS::Types::InviteItContactIntents>] The Admin Portal features that the IT contact can configure.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [void]
+    def invite_it_contact(
+      organization_id:,
+      contact_id:,
+      intents:,
+      request_options: {}
+    )
+      body = {
+        "intents" => intents
+      }
+      @client.request(
+        method: :post,
+        path: "/organizations/#{WorkOS::Util.encode_path(organization_id)}/it_contacts/#{WorkOS::Util.encode_path(contact_id)}/invite",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      nil
+    end
+
+    # Revoke an IT contact's invitation
+    # @param organization_id [String] The ID of the organization.
+    # @param contact_id [String] The ID of the IT contact.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [void]
+    def revoke_it_contact(
+      organization_id:,
+      contact_id:,
+      request_options: {}
+    )
+      @client.request(
+        method: :post,
+        path: "/organizations/#{WorkOS::Util.encode_path(organization_id)}/it_contacts/#{WorkOS::Util.encode_path(contact_id)}/revoke",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
   end
 end

data/lib/workos/platform_teams/create_team.rb

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

data/lib/workos/platform_teams/team.rb

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

data/lib/workos/platform_teams.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "json"
+
+module WorkOS
+  class PlatformTeams
+    def initialize(client)
+      @client = client
+    end
+
+    # Create a team
+    # @param admin_email [String] The email address of the person who will administer the team. An invitation is sent to this address.
+    # @param name [String] Name of the team.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Team]
+    def create_team(
+      admin_email:,
+      name:,
+      request_options: {}
+    )
+      body = {
+        "admin_email" => admin_email,
+        "name" => name
+      }
+      response = @client.request(
+        method: :post,
+        path: "/platform/teams",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::Team.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 a team
+    # @param team_id [String] The ID of the team.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Team]
+    def get_team(
+      team_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/platform/teams/#{WorkOS::Util.encode_path(team_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = WorkOS::Team.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
+  end
+end

data/lib/workos/shared/agent_blueprint_created.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentBlueprintCreated < 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::AgentBlueprintCreatedData.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_blueprint_created_data.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentBlueprintCreatedData < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      name: :name,
+      description: :description,
+      permissions: :permissions,
+      invocable_by: :invocable_by,
+      session_settings: :session_settings,
+      created_at: :created_at,
+      updated_at: :updated_at
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :name,
+      :description,
+      :permissions,
+      :invocable_by,
+      :session_settings,
+      :created_at,
+      :updated_at
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @name = hash[:name]
+      @description = hash[:description]
+      @permissions = hash[:permissions] || []
+      @invocable_by = hash[:invocable_by] ? WorkOS::AgentBlueprintCreatedDataInvocableBy.new(hash[:invocable_by]) : nil
+      @session_settings = hash[:session_settings] ? WorkOS::AgentBlueprintCreatedDataSessionSetting.new(hash[:session_settings]) : nil
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+    end
+  end
+end

data/lib/workos/shared/agent_blueprint_created_data_invocable_by.rb

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

data/lib/workos/shared/agent_blueprint_created_data_session_setting.rb

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

data/lib/workos/shared/agent_blueprint_deleted.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentBlueprintDeleted < 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::AgentBlueprintDeletedData.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_blueprint_deleted_data.rb

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

data/lib/workos/shared/agent_blueprint_updated.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentBlueprintUpdated < 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::AgentBlueprintUpdatedData.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_blueprint_updated_data.rb

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

data/lib/workos/shared/agent_blueprint_updated_data_invocable_by.rb

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

data/lib/workos/shared/agent_blueprint_updated_data_session_setting.rb

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

data/lib/workos/shared/agent_instance_created.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentInstanceCreated < 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::AgentInstanceCreatedData.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_instance_created_data.rb

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

data/lib/workos/shared/agent_instance_deleted.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class AgentInstanceDeleted < 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::AgentInstanceDeletedData.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_instance_deleted_data.rb

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