workos 8.0.0 → 9.0.0

data/lib/workos/organization_membership_service.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "json"
+
+module WorkOS
+  class OrganizationMembershipService
+    # 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
+
+    # 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::OrganizationMembershipService::RoleSingle, WorkOS::OrganizationMembershipService::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::OrganizationMembershipService::RoleSingle
+          body["role_slug"] = role.role_slug
+        when WorkOS::OrganizationMembershipService::RoleMultiple
+          body["role_slugs"] = role.role_slugs
+        else
+          raise ArgumentError, "expected role to be one of: WorkOS::OrganizationMembershipService::RoleSingle, WorkOS::OrganizationMembershipService::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::OrganizationMembershipService::RoleSingle, WorkOS::OrganizationMembershipService::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::OrganizationMembershipService::RoleSingle
+          body["role_slug"] = role.role_slug
+        when WorkOS::OrganizationMembershipService::RoleMultiple
+          body["role_slugs"] = role.role_slugs
+        else
+          raise ArgumentError, "expected role to be one of: WorkOS::OrganizationMembershipService::RoleSingle, WorkOS::OrganizationMembershipService::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
+
+    # List groups
+    # @param om_id [String] Unique identifier of the Organization Membership.
+    # @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 request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Types::ListStruct<WorkOS::Group>]
+    def list_organization_membership_groups(
+      om_id:,
+      before: nil,
+      after: nil,
+      limit: 10,
+      order: "desc",
+      request_options: {}
+    )
+      params = {
+        "before" => before,
+        "after" => after,
+        "limit" => limit,
+        "order" => order
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/user_management/organization_memberships/#{WorkOS::Util.encode_path(om_id)}/groups",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      fetch_next = ->(cursor) {
+        list_organization_membership_groups(
+          om_id: om_id,
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          request_options: request_options
+        )
+      }
+      WorkOS::Types::ListStruct.from_response(
+        response,
+        model: WorkOS::Group,
+        filters: {om_id: om_id, before: before, limit: limit, order: order},
+        fetch_next: fetch_next
+      )
+    end
+  end
+end

data/lib/workos/organizations/audit_logs_retention.rb

@@ -2,12 +2,8 @@
 
 # This file is auto-generated by oagen. Do not edit.
 
-require "json"
-
 module WorkOS
-  class AuditLogsRetention
-    include HashProvider
-
+  class AuditLogsRetention < WorkOS::Types::BaseModel
     HASH_ATTRS = {
       retention_period_in_days: :retention_period_in_days
     }.freeze
@@ -15,8 +11,7 @@ module WorkOS
     attr_accessor :retention_period_in_days
 
     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)
       @retention_period_in_days = hash[:retention_period_in_days]
     end
   end

data/lib/workos/organizations/organization_created.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationCreated < 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::OrganizationCreatedData.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/organizations/organization_deleted.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationDeleted < 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::OrganizationDeletedData.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/organizations/organization_membership_created.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationMembershipCreated < 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::OrganizationMembershipCreatedData.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/organizations/organization_membership_deleted.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationMembershipDeleted < 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::OrganizationMembershipDeletedData.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/organizations/organization_membership_updated.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationMembershipUpdated < 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::OrganizationMembershipUpdatedData.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/organizations/organization_role_created.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationRoleCreated < 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::OrganizationRoleCreatedData.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/organizations/organization_role_deleted.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationRoleDeleted < 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::OrganizationRoleDeletedData.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/organizations/organization_role_updated.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationRoleUpdated < 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::OrganizationRoleUpdatedData.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/organizations/organization_updated.rb

@@ -5,30 +5,30 @@
 module WorkOS
   class OrganizationUpdated < 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::OrganizationUpdatedData.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/radar/radar_standalone_assess_request.rb

@@ -9,9 +9,7 @@ module WorkOS
       user_agent: :user_agent,
       email: :email,
       auth_method: :auth_method,
-      action: :action,
-      device_fingerprint: :device_fingerprint,
-      bot_score: :bot_score
+      action: :action
     }.freeze
 
     attr_accessor \
@@ -19,9 +17,7 @@ module WorkOS
       :user_agent,
       :email,
       :auth_method,
-      :action,
-      :device_fingerprint,
-      :bot_score
+      :action
 
     def initialize(json)
       hash = self.class.normalize(json)
@@ -30,8 +26,6 @@ module WorkOS
       @email = hash[:email]
       @auth_method = hash[:auth_method]
       @action = hash[:action]
-      @device_fingerprint = hash[:device_fingerprint]
-      @bot_score = hash[:bot_score]
     end
   end
 end