workos 6.2.0 → 7.1.0

data/lib/workos/audit_logs.rb

@@ -1,88 +1,268 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'uri'
+# This file is auto-generated by oagen. Do not edit.
 
-module WorkOS
-  # The Audit Logs module provides convenience methods for working with the
-  # WorkOS Audit Logs platform. You'll need a valid API key.
-  module AuditLogs
-    class << self
-      include Client
-
-      # Create an Audit Log Event.
-      #
-      # @param [String] organization An Organization ID
-      # @param [Hash] event An Audit Log Event
-      # @param [String] idempotency_key An idempotency key
-      #
-      # @return [nil]
-      def create_event(organization:, event:, idempotency_key: nil)
-        request = post_request(
-          path: '/audit_logs/events',
-          auth: true,
-          idempotency_key: idempotency_key,
-          body: {
-            organization_id: organization,
-            event: event,
-          },
-        )
+require "json"
 
-        execute_request(request: request)
-      end
+module WorkOS
+  class AuditLogs
+    def initialize(client)
+      @client = client
+    end
 
-      # Create an Export of Audit Log Events.
-      #
-      # @param [String] organization An Organization ID
-      # @param [String] range_start ISO-8601 datetime
-      # @param [String] range_end ISO-8601 datetime
-      # @param [Array<String>] actions A list of actions to filter by
-      # @param [Array<String>] @deprecated use `actor_names` instead
-      # @param [Array<String>] actor_names A list of actor names to filter by
-      # @param [Array<String>] actor_ids A list of actor ids to filter by
-      # @param [Array<String>] targets A list of target types to filter by
-      #
-      # @return [WorkOS::AuditLogExport]
-      def create_export(organization:, range_start:, range_end:, actions: nil, # rubocop:disable Metrics/ParameterLists
-                        actors: nil, targets: nil, actor_names: nil, actor_ids: nil)
-        body = {
-          organization_id: organization,
-          range_start: range_start,
-          range_end: range_end,
-        }
+    # Get Retention
+    # @param id [String] Unique identifier of the Organization.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::AuditLogsRetentionJson]
+    def get_organization_audit_logs_retention(
+      id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/organizations/#{WorkOS::Util.encode_path(id)}/audit_logs_retention",
+        auth: true,
+        request_options: request_options
+      )
+      result = WorkOS::AuditLogsRetentionJson.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
 
-        body['actions'] = actions unless actions.nil?
-        body['actors'] = actors unless actors.nil?
-        body['actor_names'] = actor_names unless actor_names.nil?
-        body['actor_ids'] = actor_ids unless actor_ids.nil?
-        body['targets'] = targets unless targets.nil?
+    # Set Retention
+    # @param id [String] Unique identifier of the Organization.
+    # @param retention_period_in_days [Integer] The number of days Audit Log events will be retained. Valid values are `30` and `365`.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::AuditLogsRetentionJson]
+    def update_organization_audit_logs_retention(
+      id:,
+      retention_period_in_days:,
+      request_options: {}
+    )
+      body = {
+        "retention_period_in_days" => retention_period_in_days
+      }.compact
+      response = @client.request(
+        method: :put,
+        path: "/organizations/#{WorkOS::Util.encode_path(id)}/audit_logs_retention",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::AuditLogsRetentionJson.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
 
-        request = post_request(
-          path: '/audit_logs/exports',
-          auth: true,
-          body: body,
+    # List Actions
+    # @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::AuditLogsOrder, nil] Order the results by the creation time.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Types::ListStruct<WorkOS::AuditLogActionJson>]
+    def list_actions(
+      before: nil,
+      after: nil,
+      limit: nil,
+      order: "desc",
+      request_options: {}
+    )
+      params = {
+        "before" => before,
+        "after" => after,
+        "limit" => limit,
+        "order" => order
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/audit_logs/actions",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list_actions(
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          request_options: request_options
         )
+      }
+      WorkOS::Types::ListStruct.from_response(
+        response,
+        model: WorkOS::AuditLogActionJson,
+        filters: {before: before, limit: limit, order: order},
+        fetch_next: fetch_next
+      )
+    end
 
-        response = execute_request(request: request)
+    # List Schemas
+    # @param action_name [String] The name of the Audit Log action.
+    # @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::AuditLogsOrder, nil] Order the results by the creation time.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Types::ListStruct<WorkOS::AuditLogSchemaJson>]
+    def list_action_schemas(
+      action_name:,
+      before: nil,
+      after: nil,
+      limit: nil,
+      order: "desc",
+      request_options: {}
+    )
+      params = {
+        "before" => before,
+        "after" => after,
+        "limit" => limit,
+        "order" => order
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/audit_logs/actions/#{WorkOS::Util.encode_path(action_name)}/schemas",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list_action_schemas(
+          action_name: action_name,
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          request_options: request_options
+        )
+      }
+      WorkOS::Types::ListStruct.from_response(
+        response,
+        model: WorkOS::AuditLogSchemaJson,
+        filters: {action_name: action_name, before: before, limit: limit, order: order},
+        fetch_next: fetch_next
+      )
+    end
 
-        WorkOS::AuditLogExport.new(response.body)
-      end
+    # Create Schema
+    # @param action_name [String] The name of the Audit Log action.
+    # @param actor [WorkOS::AuditLogSchemaActor, nil] The metadata schema for the actor.
+    # @param targets [Array<WorkOS::AuditLogSchemaTarget>] The list of targets for the schema.
+    # @param metadata [Hash{String => Object}, nil] Optional JSON schema for event metadata.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::AuditLogSchemaJson]
+    def create_schema(
+      action_name:,
+      targets:,
+      actor: nil,
+      metadata: nil,
+      request_options: {}
+    )
+      body = {
+        "actor" => actor,
+        "targets" => targets,
+        "metadata" => metadata
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/audit_logs/actions/#{WorkOS::Util.encode_path(action_name)}/schemas",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::AuditLogSchemaJson.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
 
-      # Retrieves an Export of Audit Log Events
-      #
-      # @param [String] id An Audit Log Export ID
-      #
-      # @return [WorkOS::AuditLogExport]
-      def get_export(id:)
-        request = get_request(
-          auth: true,
-          path: "/audit_logs/exports/#{id}",
-        )
+    # Create Event
+    # @param organization_id [String] The unique ID of the Organization.
+    # @param event [WorkOS::AuditLogEvent] The audit log event to create.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::AuditLogEventCreateResponse]
+    def create_event(
+      organization_id:,
+      event:,
+      request_options: {}
+    )
+      body = {
+        "organization_id" => organization_id,
+        "event" => event
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/audit_logs/events",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::AuditLogEventCreateResponse.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
 
-        response = execute_request(request: request)
+    # Create Export
+    # @param organization_id [String] The unique ID of the Organization.
+    # @param range_start [String] ISO-8601 value for start of the export range.
+    # @param range_end [String] ISO-8601 value for end of the export range.
+    # @param actions [Array<String>, nil] List of actions to filter against.
+    # @param actors [Array<String>, nil] (deprecated) Deprecated. Use `actor_names` instead.
+    # @param actor_names [Array<String>, nil] List of actor names to filter against.
+    # @param actor_ids [Array<String>, nil] List of actor IDs to filter against.
+    # @param targets [Array<String>, nil] List of target types to filter against.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::AuditLogExportJson]
+    def create_export(
+      organization_id:,
+      range_start:,
+      range_end:,
+      actions: nil,
+      actors: nil,
+      actor_names: nil,
+      actor_ids: nil,
+      targets: nil,
+      request_options: {}
+    )
+      body = {
+        "organization_id" => organization_id,
+        "range_start" => range_start,
+        "range_end" => range_end,
+        "actions" => actions,
+        "actors" => actors,
+        "actor_names" => actor_names,
+        "actor_ids" => actor_ids,
+        "targets" => targets
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/audit_logs/exports",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::AuditLogExportJson.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
 
-        WorkOS::AuditLogExport.new(response.body)
-      end
+    # Get Export
+    # @param audit_log_export_id [String] The unique ID of the Audit Log Export.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::AuditLogExportJson]
+    def get_export(
+      audit_log_export_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/audit_logs/exports/#{WorkOS::Util.encode_path(audit_log_export_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = WorkOS::AuditLogExportJson.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/authorization/add_role_permission.rb

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

data/lib/workos/authorization/assign_role.rb

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

data/lib/workos/authorization/authorization_check.rb

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

data/lib/workos/authorization/authorization_permission.rb

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

data/lib/workos/authorization/authorization_resource.rb

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

data/lib/workos/authorization/check_authorization.rb

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

data/lib/workos/authorization/create_authorization_permission.rb

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

data/lib/workos/authorization/create_authorization_resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class CreateAuthorizationResource < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      external_id: :external_id,
+      name: :name,
+      description: :description,
+      resource_type_slug: :resource_type_slug,
+      organization_id: :organization_id,
+      parent_resource_id: :parent_resource_id,
+      parent_resource_external_id: :parent_resource_external_id,
+      parent_resource_type_slug: :parent_resource_type_slug
+    }.freeze
+
+    attr_accessor \
+      :external_id,
+      :name,
+      :description,
+      :resource_type_slug,
+      :organization_id,
+      :parent_resource_id,
+      :parent_resource_external_id,
+      :parent_resource_type_slug
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @external_id = hash[:external_id]
+      @name = hash[:name]
+      @description = hash[:description]
+      @resource_type_slug = hash[:resource_type_slug]
+      @organization_id = hash[:organization_id]
+      @parent_resource_id = hash[:parent_resource_id]
+      @parent_resource_external_id = hash[:parent_resource_external_id]
+      @parent_resource_type_slug = hash[:parent_resource_type_slug]
+    end
+  end
+end

data/lib/workos/authorization/create_organization_role.rb

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

data/lib/workos/authorization/create_role.rb

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

data/lib/workos/authorization/permission.rb

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

data/lib/workos/authorization/permission_created.rb

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