workos 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72c11606b98be63db5dab6a2c68eb69cab12ce9f9afe20b73475ce6948b24794
-  data.tar.gz: c7ea54043041810b71e2390b3efe20152870d8617da9a48a9922c775fb01f5d4
+  metadata.gz: 40285726466960ebdf92e8c851d172bc9387a0941579c1f2e4fb9b1b262ea071
+  data.tar.gz: 3ceb76e02b50a129e077bc99822b0bc79615a2a8f4df1315c210766feb6333cb
 SHA512:
-  metadata.gz: 8721f09bdcabce0772ffd6218b11859bbbdddb096f7d85c1b56b1f1b28816b8e2d86ef45838311e37c5c7bb322ffb2836d4ff355d8268ee15bbfcded71f1f658
-  data.tar.gz: 74b8126bedbd7c2f36da24376af99f2502d5ba3ac062c9067515d1fa6c5c402684ae0c6a3d2cfa42ee0ea61cbf75329b861a6362aa8fd7af361e58f8fff0604d
+  metadata.gz: 27d9e22ba5b80d6dcfdcdd68886c64b720d7f94ee0724007599a4d2410e56b778771978046930e24a480f1bac0de4823d2dd39c1669cdbc36a4629547a84e9f6
+  data.tar.gz: f750566f656fc734d9d112bb99285de9f371e64212fdfa404dae62f77473f97cc735990b157cc03e5f10032fe139a48d9a68533cd0f75b81f98d631408e17685

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Max: 15
 Metrics/ModuleLength:
-  Max: 150
+  Max: 200
 Metrics/ParameterLists:
   Max: 6
 Style/TrailingCommaInArguments:

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.1

data/.semaphore/semaphore.yml

@@ -60,10 +60,16 @@ blocks:
             - sem-version ruby 2.6.5
             - bundle install
             - bundle exec rspec
-        - name: Ruby 2.7.1
+        - name: Ruby 2.7.3
           commands:
             - checkout
-            - sem-version ruby 2.7.1
+            - sem-version ruby 2.7.3
+            - bundle install
+            - bundle exec rspec
+        - name: Ruby 3.0.1
+          commands:
+            - checkout
+            - sem-version ruby 3.0.1
             - bundle install
             - bundle exec rspec
 promotions:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.10.0)
+    workos (0.11.0)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -9,60 +9,73 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    codecov (0.2.8)
+    ast (2.4.2)
+    codecov (0.2.12)
       json
       simplecov
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    hashdiff (1.0.0)
-    jaro_winkler (1.5.4)
-    json (2.3.1)
-    parallel (1.19.1)
-    parser (2.7.0.0)
-      ast (~> 2.4.0)
-    public_suffix (4.0.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    hashdiff (1.0.1)
+    json (2.5.1)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.4)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    simplecov (0.19.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    sorbet (0.5.5560)
-      sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.6189)
-    sorbet-static (0.5.5560-universal-darwin-14)
-    unicode-display_width (1.6.0)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sorbet (0.5.6388)
+      sorbet-static (= 0.5.6388)
+    sorbet-runtime (0.5.6391)
+    sorbet-static (0.5.6388-universal-darwin-14)
+    sorbet-static (0.5.6388-universal-darwin-15)
+    sorbet-static (0.5.6388-universal-darwin-16)
+    sorbet-static (0.5.6388-universal-darwin-17)
+    sorbet-static (0.5.6388-universal-darwin-18)
+    sorbet-static (0.5.6388-universal-darwin-19)
+    sorbet-static (0.5.6388-universal-darwin-20)
+    sorbet-static (0.5.6388-x86_64-linux)
+    unicode-display_width (1.7.0)
     vcr (5.0.0)
-    webmock (3.7.6)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.22)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -80,4 +93,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.16

data/lib/workos/client.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: true
+# typed: false
 
 module WorkOS
   # A Net::HTTP based API client for interacting with the WorkOS API
@@ -102,7 +102,7 @@ module WorkOS
       ].join('; ')
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     sig { params(response: ::T.untyped).void }
     def handle_error_response(response:)
       http_status = response.code.to_i
@@ -139,7 +139,7 @@ module WorkOS
         )
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     private
 

data/lib/workos/connection.rb

@@ -8,7 +8,8 @@ module WorkOS
   class Connection
     extend T::Sig
 
-    attr_accessor :id, :name, :connection_type, :domains
+    attr_accessor :id, :name, :connection_type, :domains, :organization_id,
+                  :status
 
     sig { params(json: String).void }
     def initialize(json)
@@ -18,6 +19,8 @@ module WorkOS
       @name = T.let(raw.name, String)
       @connection_type = T.let(raw.connection_type, String)
       @domains = T.let(raw.domains, Array)
+      @organization_id = T.let(raw.organization_id, String)
+      @status = T.let(raw.status, String)
     end
 
     def to_json(*)
@@ -26,6 +29,8 @@ module WorkOS
         name: name,
         connection_type: connection_type,
         domains: domains,
+        organization_id: organization_id,
+        status: status,
       }
     end
 
@@ -40,6 +45,8 @@ module WorkOS
         name: hash[:name],
         connection_type: hash[:connection_type],
         domains: hash[:domains],
+        organization_id: hash[:organization_id],
+        status: hash[:status],
       )
     end
   end

data/lib/workos/directory.rb

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

data/lib/workos/directory_group.rb

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

data/lib/workos/directory_sync.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: true
+# typed: strict
 
 require 'net/http'
 
@@ -21,12 +21,17 @@ module WorkOS
       # @option options [String] domain The domain of the directory to be
       #  retrieved.
       # @option options [String] search A search term for direcory names.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] before Pagination cursor to receive records
+      #  before a provided Directory ID.
+      # @option options [String] after Pagination cursor to receive records
+      #  before a provided Directory ID.
       #
       # @return [Hash]
       sig do
         params(
           options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+        ).returns(WorkOS::Types::ListStruct)
       end
       def list_directories(options = {})
         response = execute_request(
@@ -37,7 +42,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)['data']
+        parsed_response = JSON.parse(response.body)
+        directories = parsed_response['data'].map do |directory|
+          ::WorkOS::Directory.new(directory.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: directories,
+          list_metadata: parsed_response['listMetadata'],
+        )
       end
 
       # Retrieve directory groups.
@@ -47,12 +60,17 @@ module WorkOS
       #  directory groups will be retrieved.
       # @option options [String] user The ID of the directory user whose
       #  directory groups will be retrieved.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] before Pagination cursor to receive records
+      #  before a provided Directory Group ID.
+      # @option options [String] after Pagination cursor to receive records
+      #  before a provided Directory Group ID.
       #
       # @return [Hash]
       sig do
         params(
           options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+        ).returns(WorkOS::Types::ListStruct)
       end
       def list_groups(options = {})
         response = execute_request(
@@ -63,7 +81,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)['data']
+        parsed_response = JSON.parse(response.body)
+        groups = parsed_response['data'].map do |group|
+          ::WorkOS::DirectoryGroup.new(group.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: groups,
+          list_metadata: parsed_response['listMetadata'],
+        )
       end
 
       # Retrieve directory users.
@@ -73,12 +99,17 @@ module WorkOS
       #  directory users will be retrieved.
       # @option options [String] user The ID of the directory group whose
       #  directory users will be retrieved.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] before Pagination cursor to receive records
+      #  before a provided Directory User ID.
+      # @option options [String] after Pagination cursor to receive records
+      #  before a provided Directory User ID.
       #
       # @return [Hash]
       sig do
         params(
           options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.untyped]])
+        ).returns(WorkOS::Types::ListStruct)
       end
       def list_users(options = {})
         response = execute_request(
@@ -89,7 +120,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)['data']
+        parsed_response = JSON.parse(response.body)
+        users = parsed_response['data'].map do |user|
+          ::WorkOS::DirectoryUser.new(user.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: users,
+          list_metadata: parsed_response['listMetadata'],
+        )
       end
 
       # Retrieve the directory group with the given ID.
@@ -125,6 +164,23 @@ module WorkOS
 
         JSON.parse(response.body)
       end
+
+      # Delete the directory with the given ID.
+      #
+      # @param [String] id The ID of the directory.
+      #
+      # @return Boolean
+      sig { params(id: String).returns(T::Boolean) }
+      def delete_directory(id)
+        request = delete_request(
+          auth: true,
+          path: "/directories/#{id}",
+        )
+
+        response = execute_request(request: request)
+
+        response.is_a? Net::HTTPSuccess
+      end
     end
   end
 end

data/lib/workos/directory_user.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The DirectoryUser class provides a lightweight wrapper around
+  # a WorkOS DirectoryUser resource. This class is not meant to be instantiated
+  # in DirectoryUser space, and is instantiated internally but exposed.
+  class DirectoryUser
+    extend T::Sig
+
+    attr_accessor :id, :emails, :first_name, :last_name, :username, :state,
+                  :raw_attributes
+
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+
+      @id = T.let(raw.id, String)
+      @emails = T.let(raw.emails, Array)
+      @first_name = raw.first_name
+      @last_name = raw.last_name
+      @username = raw.username
+      @state = raw.state
+      @raw_attributes = raw.raw_attributes
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        emails: emails,
+        first_name: first_name,
+        last_name: last_name,
+        username: username,
+        state: state,
+        raw_attributes: raw_attributes,
+      }
+    end
+
+    private
+
+    sig do
+      params(
+        json_string: String,
+      ).returns(WorkOS::Types::DirectoryUserStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::DirectoryUserStruct.new(
+        id: hash[:id],
+        emails: hash[:emails],
+        first_name: hash[:first_name],
+        last_name: hash[:last_name],
+        username: hash[:username],
+        state: hash[:state],
+        raw_attributes: hash[:raw_attributes],
+      )
+    end
+  end
+end

data/lib/workos/portal.rb

@@ -42,7 +42,7 @@ module WorkOS
       # Generate a link to grant access to an organization's Admin Portal
       #
       # @param [String] intent The access scope for the generated Admin Portal
-      #  link. Valid values are: ["sso"]
+      #  link. Valid values are: ["sso", "dsync"]
       # @param [String] organization The ID of the organization the Admin
       #  Portal link will be generated for.
       # @param [String] The URL that the end user will be redirected to upon

data/lib/workos/profile.rb

@@ -13,7 +13,7 @@ module WorkOS
     sig { returns(String) }
     attr_accessor :id, :email, :first_name, :last_name, :connection_id,
                   :connection_type, :idp_id, :raw_attributes
-    # rubocop:disable Metrics/AbcSize
+
     sig { params(profile_json: String).void }
     def initialize(profile_json)
       raw = parse_json(profile_json)
@@ -27,7 +27,6 @@ module WorkOS
       @idp_id = raw.idp_id
       @raw_attributes = raw.raw_attributes
     end
-    # rubocop:enable Metrics/AbcSize
 
     sig { returns(String) }
     def full_name

data/lib/workos/sso.rb

@@ -26,6 +26,8 @@ module WorkOS
       #  required
       # @param [String] provider A provider name for an Identity Provider
       #  configured on your WorkOS dashboard. Only 'Google' is supported.
+      # @param [String] connection The ID for a Connection configured on
+      #  WorkOS.
       # @param [String] client_id The WorkOS client ID for the environment
       #  where you've configured your SSO connection.
       # @param [String] project_id The WorkOS project ID for the project.
@@ -58,15 +60,18 @@ module WorkOS
           client_id: T.nilable(String),
           domain: T.nilable(String),
           provider: T.nilable(String),
+          connection: T.nilable(String),
           state: T.nilable(String),
         ).returns(String)
       end
+      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
       def authorization_url(
         redirect_uri:,
         project_id: nil,
         client_id: nil,
         domain: nil,
         provider: nil,
+        connection: nil,
         state: ''
       )
         if project_id
@@ -75,7 +80,11 @@ module WorkOS
           client_id = project_id
         end
 
-        validate_domain_and_provider(provider: provider, domain: domain)
+        validate_authorization_url_arguments(
+          provider: provider,
+          domain: domain,
+          connection: connection,
+        )
 
         query = URI.encode_www_form({
           client_id: client_id,
@@ -84,10 +93,12 @@ module WorkOS
           state: state,
           domain: domain,
           provider: provider,
+          connection: connection,
         }.compact)
 
         "https://#{WorkOS::API_HOSTNAME}/sso/authorize?#{query}"
       end
+      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
 
       # Fetch the profile details for the authenticated SSO user.
       #
@@ -203,6 +214,8 @@ module WorkOS
       #  provider descriptor.
       # @option options [String] domain The domain of the connection to be
       #  retrieved.
+      # @option options [String] organization_id The id of the organization
+      #  of the connections to be retrieved.
       # @option options [String] limit Maximum number of records to return.
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Connection ID.
@@ -213,7 +226,7 @@ module WorkOS
       sig do
         params(
           options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+        ).returns(WorkOS::Types::ListStruct)
       end
       def list_connections(options = {})
         response = execute_request(
@@ -224,7 +237,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)['data']
+        parsed_response = JSON.parse(response.body)
+        connections = parsed_response['data'].map do |connection|
+          ::WorkOS::Connection.new(connection.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: connections,
+          list_metadata: parsed_response['listMetadata'],
+        )
       end
 
       # Get a Connection
@@ -282,11 +303,17 @@ module WorkOS
         params(
           domain: T.nilable(String),
           provider: T.nilable(String),
+          connection: T.nilable(String),
         ).void
       end
-      def validate_domain_and_provider(domain:, provider:)
-        if [domain, provider].all?(&:nil?)
-          raise ArgumentError, 'Either domain or provider is required.'
+      def validate_authorization_url_arguments(
+        domain:,
+        provider:,
+        connection:
+      )
+        if [domain, provider, connection].all?(&:nil?)
+          raise ArgumentError, 'Either connection, domain, or ' \
+            'provider is required.'
         end
 
         return unless provider && !PROVIDERS.include?(provider)

data/lib/workos/types/connection_struct.rb

@@ -10,6 +10,8 @@ module WorkOS
       const :name, String
       const :connection_type, String
       const :domains, T::Array[T.untyped]
+      const :organization_id, String
+      const :status, String
     end
   end
 end

data/lib/workos/types/directory_group_struct.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This DirectoryGroupStruct acts as a typed interface
+    # for the DirectoryGroup class
+    class DirectoryGroupStruct < T::Struct
+      const :id, String
+      const :name, String
+    end
+  end
+end