workos 6.1.0 → 7.0.0

data/lib/workos/organizations.rb

@@ -1,288 +1,220 @@
 # frozen_string_literal: true
 
-require 'net/http'
+# This file is auto-generated by oagen. Do not edit.
 
-module WorkOS
-  # The Organizations module provides resource methods for working with Organizations
-  module Organizations
-    class << self
-      include Client
-      include Deprecation
-
-      # Retrieve a list of organizations that have connections configured
-      # within your WorkOS dashboard.
-      #
-      # @param [Array<String>] domains Filter organizations to only return those
-      #  that are associated with the provided domains.
-      # @param [String] before A pagination argument used to request
-      #  organizations before the provided Organization ID.
-      # @param [String] after A pagination argument used to request
-      #  organizations after the provided Organization ID.
-      # @param [Integer] limit A pagination argument used to limit the number
-      # @param [String] order The order in which to paginate records
-      #  of listed Organizations that are returned.
-      def list_organizations(options = {})
-        options[:order] ||= 'desc'
-        response = execute_request(
-          request: get_request(
-            path: '/organizations',
-            auth: true,
-            params: options,
-          ),
-        )
-
-        parsed_response = JSON.parse(response.body)
-
-        organizations = parsed_response['data'].map do |organization|
-          ::WorkOS::Organization.new(organization.to_json)
-        end
-
-        WorkOS::Types::ListStruct.new(
-          data: organizations,
-          list_metadata: parsed_response['listMetadata'],
-        )
-      end
+require "json"
 
-      # Get an Organization
-      #
-      # @param [String] id Organization unique identifier
-      #
-      # @example
-      #   WorkOS::Portal.get_organization(id: 'org_02DRA1XNSJDZ19A31F183ECQW9')
-      #   => #<WorkOS::Organization:0x00007fb6e4193d20
-      #         @id="org_02DRA1XNSJDZ19A31F183ECQW9",
-      #         @name="Foo Corp",
-      #         @domains=
-      #          [{:object=>"organization_domain",
-      #            :id=>"org_domain_01E6PK9N3XMD8RHWF7S66380AR",
-      #            :domain=>"foo-corp.com"}]>
-      #
-      # @return [WorkOS::Organization]
-      def get_organization(id:)
-        request = get_request(
-          auth: true,
-          path: "/organizations/#{id}",
-        )
-
-        response = execute_request(request: request)
-
-        WorkOS::Organization.new(response.body)
-      end
+module WorkOS
+  class Organizations
+    def initialize(client)
+      @client = client
+    end
 
-      # Create an organization
-      #
-      # @param [Array<Hash>] domain_data List of domain hashes describing an organization domain.
-      # @option domain_data [String] domain The domain that belongs to the organization.
-      # @option domain_data [String] state The state of the domain. "verified" or "pending"
-      # @param [String] name A unique, descriptive name for the organization
-      # @param [String] external_id The organization's external ID.
-      # @param [String] idempotency_key An idempotency key
-      # @param [Boolean, nil] allow_profiles_outside_organization Whether Connections
-      #   within the Organization allow profiles that are outside of the Organization's configured User Email Domains.
-      #   Deprecated: If you need to allow sign-ins from any email domain, contact suppport@workos.com.
-      # @param [Array<String>] domains List of domains that belong to the organization.
-      #   Deprecated: Use domain_data instead.
-      def create_organization(
-        domain_data: nil,
-        domains: nil,
-        name:,
-        external_id: nil,
-        allow_profiles_outside_organization: nil,
-        idempotency_key: nil
+    # List Organizations
+    # @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::OrganizationsOrder, 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 domains [Array<String>, nil] The domains of an Organization. Any Organization with a matching domain will be returned.
+    # @param search [String, nil] Searchable text for an Organization. Matches against the organization name.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Types::ListStruct<WorkOS::Organization>]
+    def list_organizations(
+      before: nil,
+      after: nil,
+      limit: nil,
+      order: "desc",
+      domains: nil,
+      search: nil,
+      request_options: {}
+    )
+      params = {
+        "before" => before,
+        "after" => after,
+        "limit" => limit,
+        "order" => order,
+        "domains" => domains,
+        "search" => search
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/organizations",
+        auth: true,
+        params: params,
+        request_options: request_options
       )
-        body = { name: name }
-        body[:domain_data] = domain_data if domain_data
-        body[:external_id] = external_id if external_id
-
-        if domains
-          warn_deprecation '`domains` is deprecated. Use `domain_data` instead.'
-          body[:domains] = domains
-        end
-
-        unless allow_profiles_outside_organization.nil?
-          warn_deprecation '`allow_profiles_outside_organization` is deprecated. ' \
-                           'If you need to allow sign-ins from any email domain, contact support@workos.com.'
-          body[:allow_profiles_outside_organization] = allow_profiles_outside_organization
-        end
-
-        request = post_request(
-          auth: true,
-          body: body,
-          path: '/organizations',
-          idempotency_key: idempotency_key,
+      fetch_next = ->(cursor) {
+        list_organizations(
+          before: before,
+          after: cursor,
+          limit: limit,
+          order: order,
+          domains: domains,
+          search: search,
+          request_options: request_options
         )
-
-        response = execute_request(request: request)
-        check_and_raise_organization_error(response: response)
-
-        WorkOS::Organization.new(response.body)
-      end
-
-      # Update an organization
-      #
-      # @param [String] organization Organization unique identifier
-      # @param [Array<Hash>] domain_data List of domain hashes describing an organization domain.
-      # @option domain_data [String] domain The domain that belongs to the organization.
-      # @option domain_data [String] state The state of the domain. "verified" or "pending"
-      # @param [String] stripe_customer_id The Stripe customer ID associated with this organization.
-      # @param [String] name A unique, descriptive name for the organization
-      # @param [String] external_id The organization's external ID.
-      # @param [Boolean, nil] allow_profiles_outside_organization Whether Connections
-      #   within the Organization allow profiles that are outside of the Organization's configured User Email Domains.
-      #   Deprecated: If you need to allow sign-ins from any email domain, contact suppport@workos.com.
-      # @param [Array<String>] domains List of domains that belong to the organization.
-      #   Deprecated: Use domain_data instead.
-      # rubocop:disable Metrics/ParameterLists
-      def update_organization(
-        organization:,
-        stripe_customer_id: nil,
-        domain_data: nil,
-        domains: nil,
-        name: nil,
-        external_id: :not_set,
-        allow_profiles_outside_organization: nil
+      }
+      WorkOS::Types::ListStruct.from_response(
+        response,
+        model: WorkOS::Organization,
+        filters: {before: before, limit: limit, order: order, domains: domains, search: search},
+        fetch_next: fetch_next
       )
-        body = { name: name }
-        body[:domain_data] = domain_data if domain_data
-        body[:stripe_customer_id] = stripe_customer_id if stripe_customer_id
-        body[:external_id] = external_id if external_id != :not_set
-
-        if domains
-          warn_deprecation '`domains` is deprecated. Use `domain_data` instead.'
-          body[:domains] = domains
-        end
-
-        unless allow_profiles_outside_organization.nil?
-          warn_deprecation '`allow_profiles_outside_organization` is deprecated. ' \
-                           'If you need to allow sign-ins from any email domain, contact support@workos.com.'
-          body[:allow_profiles_outside_organization] = allow_profiles_outside_organization
-        end
-
-        request = put_request(
-          auth: true,
-          body: body,
-          path: "/organizations/#{organization}",
-        )
-
-        response = execute_request(request: request)
-        check_and_raise_organization_error(response: response)
-
-        WorkOS::Organization.new(response.body)
-      end
-      # rubocop:enable Metrics/ParameterLists
-
-      # Delete an Organization
-      #
-      # @param [String] id Organization unique identifier
-      #
-      # @example
-      #   WorkOS::SSO.delete_organization(id: 'org_01EHZNVPK3SFK441A1RGBFSHRT')
-      #   => true
-      #
-      # @return [Bool] - returns `true` if successful
-      def delete_organization(id:)
-        request = delete_request(
-          auth: true,
-          path: "/organizations/#{id}",
-        )
-
-        response = execute_request(request: request)
-
-        response.is_a? Net::HTTPSuccess
-      end
-
-      # Retrieve a list of roles for the given organization.
-      #
-      # @param [String] organization_id The ID of the organization to fetch roles for.
-      #
-      # @example
-      #   WorkOS::Organizations.list_organization_roles(organization_id: 'org_01EHZNVPK3SFK441A1RGBFSHRT')
-      #   => #<WorkOS::Types::ListStruct data=[#<WorkOS::Role id="role_123" name="Admin" slug="admin"
-      #                                         permissions=["admin:all"] ...>] ...>
-      #
-      # @return [WorkOS::Types::ListStruct] - Collection of Role objects, each including permissions array
-      def list_organization_roles(organization_id:)
-        response = execute_request(
-          request: get_request(
-            path: "/organizations/#{organization_id}/roles",
-            auth: true,
-          ),
-        )
-
-        parsed_response = JSON.parse(response.body)
-
-        roles = parsed_response['data'].map do |role|
-          WorkOS::Role.new(role.to_json)
-        end
-
-        WorkOS::Types::ListStruct.new(
-          data: roles,
-          list_metadata: {
-            after: nil,
-            before: nil,
-          },
-        )
-      end
-
-      # Retrieve a list of feature flags for the given organization.
-      #
-      # @param [String] organization_id The ID of the organization to fetch feature flags for.
-      # @param [Hash] options
-      # @option options [String] before A pagination argument used to request
-      #  feature flags before the provided FeatureFlag ID.
-      # @option options [String] after A pagination argument used to request
-      #  feature flags after the provided FeatureFlag ID.
-      # @option options [Integer] limit A pagination argument used to limit the number
-      #  of listed FeatureFlags that are returned.
-      # @option options [String] order The order in which to paginate records
-      #
-      # @example
-      #   WorkOS::Organizations.list_organization_feature_flags(organization_id: 'org_01EHZNVPK3SFK441A1RGBFSHRT')
-      #   => #<WorkOS::Types::ListStruct data=[#<WorkOS::FeatureFlag id="flag_123" slug="new-feature"
-      #                                         enabled=true ...>] ...>
-      #
-      # @return [WorkOS::Types::ListStruct] - Collection of FeatureFlag objects
-      def list_organization_feature_flags(organization_id:, options: {})
-        options[:order] ||= 'desc'
-        response = execute_request(
-          request: get_request(
-            path: "/organizations/#{organization_id}/feature-flags",
-            auth: true,
-            params: options,
-          ),
-        )
-
-        parsed_response = JSON.parse(response.body)
+    end
 
-        feature_flags = parsed_response['data'].map do |feature_flag|
-          WorkOS::FeatureFlag.new(feature_flag.to_json)
-        end
+    # 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 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.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Organization]
+    def create_organization(
+      name:,
+      allow_profiles_outside_organization: nil,
+      domains: nil,
+      domain_data: nil,
+      metadata: nil,
+      external_id: nil,
+      request_options: {}
+    )
+      body = {
+        "name" => name,
+        "allow_profiles_outside_organization" => allow_profiles_outside_organization,
+        "domains" => domains,
+        "domain_data" => domain_data,
+        "metadata" => metadata,
+        "external_id" => external_id
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/organizations",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::Organization.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::Types::ListStruct.new(
-          data: feature_flags,
-          list_metadata: parsed_response['list_metadata']&.transform_keys(&:to_sym),
-        )
-      end
+    # Get an Organization by External ID
+    # @param external_id [String] The external ID of the Organization.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Organization]
+    def get_organization_by_external_id(
+      external_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/organizations/external_id/#{WorkOS::Util.encode_path(external_id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = WorkOS::Organization.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
 
-      private
+    # Get an Organization
+    # @param id [String] Unique identifier of the Organization.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Organization]
+    def get_organization(
+      id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/organizations/#{WorkOS::Util.encode_path(id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = WorkOS::Organization.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
 
-      def check_and_raise_organization_error(response:)
-        begin
-          body = JSON.parse(response.body)
-          return unless body['message']
+    # Update an Organization
+    # @param id [String] Unique identifier of the Organization.
+    # @param name [String, nil] 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] (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 stripe_customer_id [String, nil] The Stripe customer ID associated with the organization.
+    # @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.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::Organization]
+    def update_organization(
+      id:,
+      name: nil,
+      allow_profiles_outside_organization: nil,
+      domains: nil,
+      domain_data: nil,
+      stripe_customer_id: nil,
+      metadata: nil,
+      external_id: nil,
+      request_options: {}
+    )
+      body = {
+        "name" => name,
+        "allow_profiles_outside_organization" => allow_profiles_outside_organization,
+        "domains" => domains,
+        "domain_data" => domain_data,
+        "stripe_customer_id" => stripe_customer_id,
+        "metadata" => metadata,
+        "external_id" => external_id
+      }.compact
+      response = @client.request(
+        method: :put,
+        path: "/organizations/#{WorkOS::Util.encode_path(id)}",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = WorkOS::Organization.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
 
-          message = body['message']
-          request_id = response['x-request-id']
-        rescue StandardError
-          message = 'Something went wrong'
-        end
+    # Delete an Organization
+    # @param id [String] Unique identifier of the Organization.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [void]
+    def delete_organization(
+      id:,
+      request_options: {}
+    )
+      @client.request(
+        method: :delete,
+        path: "/organizations/#{WorkOS::Util.encode_path(id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
 
-        raise APIError.new(
-          message: message,
-          http_status: nil,
-          request_id: request_id,
-        )
-      end
+    # Get Audit Log Configuration
+    # @param id [String] Unique identifier of the Organization.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::AuditLogConfiguration]
+    def get_audit_log_configuration(
+      id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/organizations/#{WorkOS::Util.encode_path(id)}/audit_log_configuration",
+        auth: true,
+        request_options: request_options
+      )
+      result = WorkOS::AuditLogConfiguration.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/passwordless.rb

@@ -1,71 +1,76 @@
 # frozen_string_literal: true
 
-require 'net/http'
+# @oagen-ignore-file
+# Hand-maintained: Passwordless session endpoints are not yet in the OpenAPI
+# spec, so this module wraps them until they are.
+# See https://workos.com/docs/reference/magic-link.
+require "json"
 
 module WorkOS
-  # The Passwordless module provides convenience methods for working with
-  # passwordless sessions including the WorkOS Magic Link. You'll need a valid
-  # API key.
+  # Passwordless authentication sessions (magic-link).
   #
-  # @see https://workos.com/docs/sso/configuring-magic-link
-  module Passwordless
-    class << self
-      include Client
-
-      # Create a Passwordless Session.
-      #
-      # @param [Hash] options A hash with options for the session
-      # @option options [String] email The email of the user to authenticate.
-      # @option options [String] state Optional parameter that the redirect URI
-      #  received from WorkOS will contain. The state parameter can be used to
-      #  encode arbitrary information to help restore application state between
-      #  redirects.
-      # @option options [String] connection Optional parameter for the ID of a
-      #  specific connection. This can be used to create a Passwordless Session
-      #  for a specific connection rather than using the domain from the email
-      #  to determine the Organization and Connection.
-      # @option options [String] type The type of Passwordless Session to
-      #  create. Currently, the only supported value is 'MagicLink'.
-      # @option options [String] redirect_uri The URI where users are directed
-      #  after completing the authentication step. Must match a
-      #  configured redirect URI on your WorkOS dashboard.
-      #
-      # @return Hash
-      def create_session(options)
-        response = execute_request(
-          request: post_request(
-            path: '/passwordless/sessions',
-            auth: true,
-            body: options,
-          ),
+  #   session = client.passwordless.create_session(email: "user@example.com")
+  #   client.passwordless.send_session(session.id)
+  class Passwordless
+    PasswordlessSession = Struct.new(:id, :email, :expires_at, :link, :object, keyword_init: true) do
+      def self.from_hash(hash)
+        new(
+          id: hash["id"],
+          email: hash["email"],
+          expires_at: hash["expires_at"],
+          link: hash["link"],
+          object: hash["object"] || "passwordless_session"
         )
+      end
 
-        hash = JSON.parse(response.body)
-
-        WorkOS::Types::PasswordlessSessionStruct.new(
-          id: hash['id'],
-          email: hash['email'],
-          expires_at: Date.parse(hash['expires_at']),
-          link: hash['link'],
-        )
+      def to_h
+        super.compact
       end
+    end
 
-      # Send a Passwordless Session via email.
-      #
-      # @param [String] session_id The unique identifier of the Passwordless
-      #  Session to send an email for.
-      #
-      # @return Hash
-      def send_session(session_id)
-        response = execute_request(
-          request: post_request(
-            path: "/passwordless/sessions/#{session_id}/send",
-            auth: true,
-          ),
-        )
+    def initialize(client)
+      @client = client
+    end
 
-        JSON.parse(response.body)
-      end
+    # Create a passwordless session.
+    #
+    # @param email [String] Email of the user to authenticate.
+    # @param type [String] Session type. Currently only "MagicLink" is supported.
+    # @param redirect_uri [String, nil] Where to redirect the user after auth.
+    # @param state [String, nil] Arbitrary state echoed back on redirect.
+    # @param connection [String, nil] Specific connection ID to use.
+    # @param expires_in [Integer, nil] Lifetime in seconds.
+    # @param request_options [Hash] Per-request overrides.
+    # @return [PasswordlessSession]
+    def create_session(email:, type: "MagicLink", redirect_uri: nil, state: nil, connection: nil, expires_in: nil, request_options: {})
+      body = {
+        "email" => email,
+        "type" => type,
+        "redirect_uri" => redirect_uri,
+        "state" => state,
+        "connection" => connection,
+        "expires_in" => expires_in
+      }.compact
+      response = @client.request(method: :post, path: "/passwordless/sessions", auth: true, body: body, request_options: request_options)
+      PasswordlessSession.from_hash(JSON.parse(response.body))
+    end
+
+    # Send the magic-link email for an existing passwordless session.
+    #
+    # @param session_id [String] Unique identifier of the passwordless session.
+    # @param request_options [Hash] Per-request overrides.
+    # @return [Hash] Server response payload.
+    def send_session(session_id, request_options: {})
+      response = @client.request(
+        method: :post,
+        path: "/passwordless/sessions/#{WorkOS::Util.encode_path(session_id)}/send",
+        auth: true,
+        body: {},
+        request_options: request_options
+      )
+      JSON.parse(response.body || "{}")
+    rescue JSON::ParserError
+      {}
     end
   end
 end

data/lib/workos/pipes/connected_account.rb

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