workos 2.16.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cbb0a53c0c7c21c1d8cb22a6d3d2679421da8fbeb237009bcd31c1f679c1586
-  data.tar.gz: 914321349e893fb0d9e7c955c6bff5c92851f5946d2f2bc278de6cad01295ae2
+  metadata.gz: 8a7377543b69e5754e2754e56bd4c43683ffe6177d678449150b41178cddc2b0
+  data.tar.gz: 8e0c5d4ee45c39f8084d4b5c31b0e8058ba52ba7d3a7ca56e0146491af723d10
 SHA512:
-  metadata.gz: 777ab4dd91a7ce30ce709dd4578018abf4cde6b1c3d213588b1d1cc0d0b5c0c503ecd79e9c8fa30ff6d8d597fcb92ca027527b46e96d93fdbbb060b916830f90
-  data.tar.gz: 63ee003031a51bfa309e0095d2e4a6abb7caee9c6b3202efda809b7b6922a782fe04214af94a5647863bf059eca7f9228d91cdebc86e1800e3ae1caf9aeedbff
+  metadata.gz: d987073ab5dfe9eac87cf279ac8b5e75aff23fd56faf2c4b16f0c6acb43054112042915f1662685af16ec80d172c11b8b6c0bf5a02f44440ac9bf2d973f036ea
+  data.tar.gz: 1627133ce7178bd72df4a6b0d710a842c9a66926d83ff05283836d3ff9afd958d10b8512c3f119621b4cc8ada2445e1854ae1d237f30e7430468b6dd2a90c6b1

data/.gitignore

@@ -47,3 +47,5 @@
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+
+.vscode

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.16.0)
+    workos (3.0.0)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -67,19 +67,11 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
-    sorbet (0.5.10346)
-      sorbet-static (= 0.5.10346)
+    sorbet (0.5.11132)
+      sorbet-static (= 0.5.11132)
     sorbet-runtime (0.5.10484)
-    sorbet-static (0.5.10346-universal-darwin-14)
-    sorbet-static (0.5.10346-universal-darwin-15)
-    sorbet-static (0.5.10346-universal-darwin-16)
-    sorbet-static (0.5.10346-universal-darwin-17)
-    sorbet-static (0.5.10346-universal-darwin-18)
-    sorbet-static (0.5.10346-universal-darwin-19)
-    sorbet-static (0.5.10346-universal-darwin-20)
-    sorbet-static (0.5.10346-universal-darwin-21)
-    sorbet-static (0.5.10346-universal-darwin-22)
-    sorbet-static (0.5.10346-x86_64-linux)
+    sorbet-static (0.5.11132-universal-darwin)
+    sorbet-static (0.5.11132-x86_64-linux)
     spoom (1.1.15)
       sorbet (>= 0.5.10187)
       sorbet-runtime (>= 0.5.9204)
@@ -121,7 +113,6 @@ DEPENDENCIES
   vcr (~> 5.0.0)
   webmock
   workos!
-  yard
 
 BUNDLED WITH
    2.2.33

data/lib/workos/authentication_factor_and_challenge.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The AuthenticationFactorAndChallenge class represents
+  # an authentication factor and challenge for a given user.
+  class AuthenticationFactorAndChallenge
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :authentication_factor, :authentication_challenge
+
+    sig { params(authentication_response_json: String).void }
+    def initialize(authentication_response_json)
+      json = JSON.parse(authentication_response_json, symbolize_names: true)
+      @authentication_factor = WorkOS::Factor.new(
+        json[:authentication_factor].to_json,
+      )
+      @authentication_challenge = WorkOS::Challenge.new(
+        json[:authentication_challenge].to_json,
+      )
+    end
+
+    def to_json(*)
+      {
+        authentication_factor: authentication_factor.to_json,
+        authentication_challenge: authentication_challenge.to_json,
+      }
+    end
+  end
+end

data/lib/workos/authentication_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The AuthenticationResponse class represents an Authentication Response as well as an corresponding
+  # response data that can later be appended on.
+  class AuthenticationResponse
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :user, :organization_id
+
+    sig { params(authentication_response_json: String).void }
+    def initialize(authentication_response_json)
+      json = JSON.parse(authentication_response_json, symbolize_names: true)
+      @user = WorkOS::User.new(json[:user].to_json)
+      @organization_id = T.let(json[:organization_id], T.nilable(String))
+    end
+
+    def to_json(*)
+      {
+        user: user.to_json,
+        organization_id: organization_id,
+      }
+    end
+  end
+end

data/lib/workos/client.rb

@@ -9,7 +9,7 @@ module WorkOS
 
     sig { returns(Net::HTTP) }
     def client
-      Net::HTTP.new(WorkOS::API_HOSTNAME, 443).tap do |http_client|
+      Net::HTTP.new(WorkOS.config.api_hostname, 443).tap do |http_client|
         http_client.use_ssl = true
         http_client.open_timeout = WorkOS.config.timeout
         http_client.read_timeout = WorkOS.config.timeout

data/lib/workos/configuration.rb

@@ -4,7 +4,7 @@
 module WorkOS
   # Configuration class sets config initializer
   class Configuration
-    attr_accessor :timeout, :key
+    attr_accessor :api_hostname, :timeout, :key
 
     def initialize
       @timeout = 60

data/lib/workos/invitation.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The Invitation class provides a lightweight wrapper around a WorkOS Invitation
+  # resource. This class is not meant to be instantiated in a user space,
+  # and is instantiated internally but exposed.
+  class Invitation
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :id, :email, :state, :accepted_at, :revoked_at,
+                  :expires_at, :token, :organization_id, :created_at, :updated_at
+
+    # rubocop:disable Metrics/AbcSize
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+
+      @id = T.let(raw.id, String)
+      @email = T.let(raw.email, String)
+      @state = T.let(raw.state, String)
+      @token = T.let(raw.token, String)
+      @organization_id = T.let(raw.organization_id, T.nilable(String))
+      @accepted_at = T.let(raw.accepted_at, T.nilable(String))
+      @revoked_at = T.let(raw.revoked_at, T.nilable(String))
+      @expires_at = T.let(raw.expires_at, String)
+      @created_at = T.let(raw.created_at, String)
+      @updated_at = T.let(raw.updated_at, String)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def to_json(*)
+      {
+        id: id,
+        email: email,
+        state: state,
+        token: token,
+        organization_id: organization_id,
+        accepted_at: accepted_at,
+        revoked_at: revoked_at,
+        expires_at: expires_at,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    private
+
+    sig { params(json_string: String).returns(WorkOS::Types::InvitationStruct) }
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::InvitationStruct.new(
+        id: hash[:id],
+        email: hash[:email],
+        state: hash[:state],
+        token: hash[:token],
+        organization_id: hash[:organization_id],
+        accepted_at: hash[:accepted_at],
+        revoked_at: hash[:revoked_at],
+        expires_at: hash[:expires_at],
+        created_at: hash[:created_at],
+        updated_at: hash[:updated_at],
+      )
+    end
+  end
+end

data/lib/workos/organization_membership.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The OrganizationMembership class provides a lightweight wrapper around a WorkOS OrganizationMembership
+  # resource. This class is not meant to be instantiated in a user space,
+  # and is instantiated internally but exposed.
+  class OrganizationMembership
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :id, :user_id, :organization_id, :created_at, :updated_at
+
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+
+      @id = T.let(raw.id, String)
+      @user_id = T.let(raw.user_id, String)
+      @organization_id = raw.organization_id
+      @created_at = T.let(raw.created_at, String)
+      @updated_at = T.let(raw.updated_at, String)
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        user_id: user_id,
+        organization_id: organization_id,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    private
+
+    sig { params(json_string: String).returns(WorkOS::Types::OrganizationMembershipStruct) }
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::OrganizationMembershipStruct.new(
+        id: hash[:id],
+        user_id: hash[:user_id],
+        organization_id: hash[:organization_id],
+        created_at: hash[:created_at],
+        updated_at: hash[:updated_at],
+      )
+    end
+  end
+end

data/lib/workos/sso.rb

@@ -104,7 +104,7 @@ module WorkOS
           organization: organization,
         }.compact)
 
-        "https://#{WorkOS::API_HOSTNAME}/sso/authorize?#{query}"
+        "https://#{WorkOS.config.api_hostname}/sso/authorize?#{query}"
       end
       # rubocop:enable Metrics/ParameterLists
 

data/lib/workos/types/invitation_struct.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This InvitationStruct acts as a typed interface for the Invitation class
+    class InvitationStruct < T::Struct
+      const :id, String
+      const :email, String
+      const :state, String
+      const :token, String
+      const :organization_id, T.nilable(String)
+      const :accepted_at, T.nilable(String)
+      const :revoked_at, T.nilable(String)
+      const :expires_at, String
+      const :created_at, String
+      const :updated_at, String
+    end
+  end
+end

data/lib/workos/types/magic_auth_challenge_struct.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  module Types
+    # This MagicAuthChallengeStruct acts as a typed interface for the
+    # MagicAuthChallenge class
+    class MagicAuthChallengeStruct < T::Struct
+      const :id, String
+    end
+  end
+end

data/lib/workos/types/organization_membership_struct.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This OrganizationMembershipStruct acts as a typed interface for the OrganizationMembership class
+    class OrganizationMembershipStruct < T::Struct
+      const :id, String
+      const :user_id, String
+      const :organization_id, String
+      const :created_at, String
+      const :updated_at, String
+    end
+  end
+end

data/lib/workos/types/provider_enum.rb

@@ -7,6 +7,7 @@ module WorkOS
     # fixed set of values for SSO Providers.
     class Provider < T::Enum
       enums do
+        GitHub = new('GitHubOAuth')
         Google = new('GoogleOAuth')
         Microsoft = new('MicrosoftOAuth')
       end

data/lib/workos/types/user_struct.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This UserStruct acts as a typed interface for the User class
+    class UserStruct < T::Struct
+      const :id, String
+      const :email, String
+      const :first_name, T.nilable(String)
+      const :last_name, T.nilable(String)
+      const :email_verified, T::Boolean
+      const :created_at, String
+      const :updated_at, String
+    end
+  end
+end

data/lib/workos/types.rb

@@ -6,20 +6,24 @@ module WorkOS
   # so we're using Sorbet throughout this Ruby gem.
   module Types
     require_relative 'types/audit_log_export_struct'
+    require_relative 'types/challenge_struct'
     require_relative 'types/connection_struct'
-    require_relative 'types/directory_struct'
     require_relative 'types/directory_group_struct'
+    require_relative 'types/directory_struct'
+    require_relative 'types/directory_user_struct'
     require_relative 'types/event_struct'
+    require_relative 'types/factor_struct'
     require_relative 'types/intent_enum'
+    require_relative 'types/invitation_struct'
     require_relative 'types/list_struct'
+    require_relative 'types/magic_auth_challenge_struct'
     require_relative 'types/organization_struct'
+    require_relative 'types/organization_membership_struct'
     require_relative 'types/passwordless_session_struct'
     require_relative 'types/profile_struct'
     require_relative 'types/provider_enum'
-    require_relative 'types/directory_user_struct'
-    require_relative 'types/webhook_struct'
-    require_relative 'types/factor_struct'
-    require_relative 'types/challenge_struct'
+    require_relative 'types/user_struct'
     require_relative 'types/verify_challenge_struct'
+    require_relative 'types/webhook_struct'
   end
 end

data/lib/workos/user.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The User class provides a lightweight wrapper around a WorkOS User
+  # resource. This class is not meant to be instantiated in a user space,
+  # and is instantiated internally but exposed.
+  class User
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :id, :email, :first_name, :last_name, :email_verified,
+                  :created_at, :updated_at
+
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+
+      @id = T.let(raw.id, String)
+      @email = T.let(raw.email, String)
+      @first_name = raw.first_name
+      @last_name = raw.last_name
+      @email_verified = raw.email_verified
+      @created_at = T.let(raw.created_at, String)
+      @updated_at = T.let(raw.updated_at, String)
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        email: email,
+        first_name: first_name,
+        last_name: last_name,
+        email_verified: email_verified,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    private
+
+    sig { params(json_string: String).returns(WorkOS::Types::UserStruct) }
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::UserStruct.new(
+        id: hash[:id],
+        email: hash[:email],
+        first_name: hash[:first_name],
+        last_name: hash[:last_name],
+        email_verified: hash[:email_verified],
+        created_at: hash[:created_at],
+        updated_at: hash[:updated_at],
+      )
+    end
+  end
+end

data/lib/workos/user_and_token.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The UserAndToken class represents a User and a corresponding Token. This
+  # class is not meant to be instantiated in user space, and is instantiated
+  # internally but exposed.
+  class UserAndToken
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :token, :user
+
+    sig { params(user_and_token_json: String).void }
+    def initialize(user_and_token_json)
+      json = JSON.parse(user_and_token_json, symbolize_names: true)
+
+      @token = T.let(json[:token], String)
+      @user = WorkOS::User.new(json[:user].to_json)
+    end
+
+    def to_json(*)
+      {
+        token: token,
+        user: user.to_json,
+      }
+    end
+  end
+end