workos 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286a2f14af16bfc7b9c77e7938c2b8d7366f4a03f9fca4c7892f85f60562e433
-  data.tar.gz: 8970807084e7022beb9bb1523c270e645c340e42e452d7f0d7ea0d64958cf1ea
+  metadata.gz: f7abb4f1d075ea976bbc8577247d36ff763a21dd1b18335daac39a8c80d6acea
+  data.tar.gz: 4c8e6326e7b80773a292754a7030033773470dc12228571cad8b0198a3c8342b
 SHA512:
-  metadata.gz: e4d3af795ee51a5cb807fda2bdffc2217e0150ec2f4ffe51fb86daab6e376ecd240f03f1b204db2a72265ebc61d5a9c227a13924a262bb6cf7011ce9c87df177
-  data.tar.gz: a8977f9bff244978c9c1935e46a411e4e564a86ed51d7523780feab31212857771813190c523f64d5640f13b393ba5f5a3df3ced5729a7ad34df0cdfa3b6014e
+  metadata.gz: 7d4c51f21848cb44e0f0326deab050040989811f829b4bbf1c317aca9d08e113c47bd4dbd822faac3f195d8695204fd3acb9a797638a0d9c4f951100964a53e7
+  data.tar.gz: 2b25fd19c5008c27d03a9ab73f6dcb02ba2cd7f133d0726ce46ccadb4928e2805dca1f63dbefd9552ea7ee8ea9acf122a7641dabf48e5199f4f607dcb8754c46

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.2.1)
+    workos (2.3.0)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -60,7 +60,7 @@ GEM
     simplecov_json_formatter (0.1.2)
     sorbet (0.5.6388)
       sorbet-static (= 0.5.6388)
-    sorbet-runtime (0.5.9944)
+    sorbet-runtime (0.5.10090)
     sorbet-static (0.5.6388-universal-darwin-14)
     sorbet-static (0.5.6388-universal-darwin-15)
     sorbet-static (0.5.6388-universal-darwin-16)

data/lib/workos/audit_trail.rb

@@ -65,6 +65,7 @@ module WorkOS
       # @option options [String] before Event ID to look before
       # @option options [String] after Event ID to look after
       # @option options [Integer] limit Number of Events to return
+      # @option options [String] order The order in which to paginate records
       # @option options [Array<String>] group List of Groups to filter for
       # @option options [Array<String>] action List of Actions to filter for
       # @option options [Array<String>] action_type List of Action Types to

data/lib/workos/challenge.rb

@@ -16,7 +16,7 @@ module WorkOS
       raw = parse_json(json)
       @id = T.let(raw.id, String)
       @object = T.let(raw.object, String)
-      @expires_at = raw.expires_at
+      @expires_at = T.let(raw.expires_at, String)
       @code = raw.code
       @authentication_factor_id = T.let(raw.authentication_factor_id, String)
       @created_at = T.let(raw.created_at, String)

data/lib/workos/directory_group.rb

@@ -9,22 +9,34 @@ module WorkOS
     include HashProvider
     extend T::Sig
 
-    attr_accessor :id, :name, :custom_attributes, :raw_attributes
+    attr_accessor :id, :directory_id, :idp_id, :name, :created_at, :updated_at, :raw_attributes
 
+    # rubocop:disable Metrics/AbcSize
     sig { params(json: String).void }
     def initialize(json)
       raw = parse_json(json)
 
       @id = T.let(raw.id, String)
+      @directory_id = T.let(raw.directory_id, String)
+      @idp_id = T.let(raw.idp_id, String)
       @name = T.let(raw.name, String)
+      @created_at = T.let(raw.created_at, String)
+      @updated_at = T.let(raw.updated_at, String)
+      @raw_attributes = raw.raw_attributes
 
       replace_without_warning(to_json)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def to_json(*)
       {
         id: id,
+        directory_id: directory_id,
+        idp_id: idp_id,
         name: name,
+        created_at: created_at,
+        updated_at: updated_at,
+        raw_attributes: raw_attributes,
       }
     end
 
@@ -40,7 +52,12 @@ module WorkOS
 
       WorkOS::Types::DirectoryGroupStruct.new(
         id: hash[:id],
+        directory_id: hash[:directory_id],
+        idp_id: hash[:idp_id],
         name: hash[:name],
+        created_at: hash[:created_at],
+        updated_at: hash[:updated_at],
+        raw_attributes: hash[:raw_attributes],
       )
     end
   end

data/lib/workos/directory_sync.rb

@@ -22,6 +22,7 @@ module WorkOS
       #  retrieved.
       # @option options [String] search A search term for direcory names.
       # @option options [String] limit Maximum number of records to return.
+      # @option options [String] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Directory ID.
       # @option options [String] after Pagination cursor to receive records
@@ -91,6 +92,7 @@ module WorkOS
       # @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] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Directory Group ID.
       # @option options [String] after Pagination cursor to receive records
@@ -130,6 +132,7 @@ module WorkOS
       # @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] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Directory User ID.
       # @option options [String] after Pagination cursor to receive records

data/lib/workos/directory_user.rb

@@ -47,6 +47,11 @@ module WorkOS
       }
     end
 
+    def primary_email
+      primary_email = (emails || []).find { |email| email[:primary] }
+      return primary_email[:value] if primary_email
+    end
+
     private
 
     sig do

data/lib/workos/factor.rb

@@ -7,15 +7,13 @@ module WorkOS
   # in DirectoryUser space, and is instantiated internally but exposed.
   class Factor
     include HashProvider
-    # rubocop:disable Metrics/AbcSize
     extend T::Sig
-    attr_accessor :id, :environment_id, :object, :type, :sms, :totp, :updated_at, :created_at
+    attr_accessor :id, :object, :type, :sms, :totp, :updated_at, :created_at
 
     sig { params(json: String).void }
     def initialize(json)
       raw = parse_json(json)
       @id = T.let(raw.id, String)
-      @environment_id = T.let(raw.environment_id, String)
       @object = T.let(raw.object, String)
       @type = T.let(raw.type, String)
       @created_at = T.let(raw.created_at, String)
@@ -27,7 +25,6 @@ module WorkOS
     def to_json(*)
       {
         id: id,
-        environment_id: environment_id,
         object: object,
         type: type,
         totp: totp,
@@ -45,7 +42,6 @@ module WorkOS
 
       WorkOS::Types::FactorStruct.new(
         id: hash[:id],
-        environment_id: hash[:environment_id],
         object: hash[:object],
         type: hash[:type],
         totp: hash[:totp],
@@ -54,6 +50,5 @@ module WorkOS
         updated_at: hash[:updated_at],
       )
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/workos/organizations.rb

@@ -21,6 +21,7 @@ module WorkOS
       # @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.
       sig do
         params(

data/lib/workos/sso.rb

@@ -163,6 +163,7 @@ module WorkOS
       # @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] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Connection ID.
       # @option options [String] after Pagination cursor to receive records

data/lib/workos/types/challenge_struct.rb

@@ -8,7 +8,7 @@ module WorkOS
     class ChallengeStruct < T::Struct
       const :id, String
       const :object, String
-      const :expires_at, T.nilable(String)
+      const :expires_at, String
       const :code, T.nilable(String)
       const :authentication_factor_id, String
       const :created_at, String

data/lib/workos/types/directory_group_struct.rb

@@ -7,7 +7,12 @@ module WorkOS
     # for the DirectoryGroup class
     class DirectoryGroupStruct < T::Struct
       const :id, String
+      const :directory_id, String
+      const :idp_id, String
       const :name, String
+      const :created_at, String
+      const :updated_at, String
+      const :raw_attributes, T::Hash[Symbol, Object]
     end
   end
 end

data/lib/workos/types/factor_struct.rb

@@ -7,7 +7,6 @@ module WorkOS
     # for the Factor class
     class FactorStruct < T::Struct
       const :id, String
-      const :environment_id, String
       const :object, String
       const :type, String
       const :totp, T.nilable(T::Hash[Symbol, Object])

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/spec/lib/workos/directory_sync_spec.rb

@@ -189,7 +189,7 @@ describe WorkOS::DirectorySync do
     context 'with directory option' do
       it 'forms the proper request to the API' do
         request_args = [
-          '/directory_groups?directory=directory_01EK2YEMVTWGX27STRDR0N3MP9',
+          '/directory_groups?directory=directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           'Content-Type' => 'application/json'
         ]
 
@@ -200,7 +200,7 @@ describe WorkOS::DirectorySync do
 
         VCR.use_cassette 'directory_sync/list_groups/with_directory' do
           groups = described_class.list_groups(
-            directory: 'directory_01EK2YEMVTWGX27STRDR0N3MP9',
+            directory: 'directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           )
 
           expect(groups.data.size).to eq(10)
@@ -212,7 +212,7 @@ describe WorkOS::DirectorySync do
     context 'with user option' do
       it 'forms the proper request to the API' do
         request_args = [
-          '/directory_groups?user=directory_user_01EK2YFBC3R10MPB4W49G5QDXG',
+          '/directory_groups?user=directory_user_01G2Z8D4FDB28ZNSRRBVCF2E0P',
           'Content-Type' => 'application/json'
         ]
 
@@ -223,7 +223,7 @@ describe WorkOS::DirectorySync do
 
         VCR.use_cassette 'directory_sync/list_groups/with_user' do
           groups = described_class.list_groups(
-            user: 'directory_user_01EK2YFBC3R10MPB4W49G5QDXG',
+            user: 'directory_user_01G2Z8D4FDB28ZNSRRBVCF2E0P',
           )
 
           expect(groups.data.size).to eq(3)
@@ -234,8 +234,8 @@ describe WorkOS::DirectorySync do
     context 'with the before option' do
       it 'forms the proper request to the API' do
         request_args = [
-          '/directory_groups?before=before-id&' \
-          'directory=directory_01EK2YEMVTWGX27STRDR0N3MP9',
+          '/directory_groups?before=directory_group_01G2Z8D4ZR8RJ03Y1W7P9K8NMG&' \
+          'directory=directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           'Content-Type' => 'application/json'
         ]
 
@@ -246,11 +246,11 @@ describe WorkOS::DirectorySync do
 
         VCR.use_cassette 'directory_sync/list_groups/with_before' do
           groups = described_class.list_groups(
-            before: 'before-id',
-            directory: 'directory_01EK2YEMVTWGX27STRDR0N3MP9',
+            before: 'directory_group_01G2Z8D4ZR8RJ03Y1W7P9K8NMG',
+            directory: 'directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           )
 
-          expect(groups.data.size).to eq(2)
+          expect(groups.data.size).to eq(10)
         end
       end
     end
@@ -258,8 +258,8 @@ describe WorkOS::DirectorySync do
     context 'with the after option' do
       it 'forms the proper request to the API' do
         request_args = [
-          '/directory_groups?after=after-id&' \
-          'directory=directory_01EK2YEMVTWGX27STRDR0N3MP9',
+          '/directory_groups?after=directory_group_01G2Z8D4ZR8RJ03Y1W7P9K8NMG&' \
+          'directory=directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           'Content-Type' => 'application/json'
         ]
 
@@ -270,11 +270,11 @@ describe WorkOS::DirectorySync do
 
         VCR.use_cassette 'directory_sync/list_groups/with_after' do
           groups = described_class.list_groups(
-            after: 'after-id',
-            directory: 'directory_01EK2YEMVTWGX27STRDR0N3MP9',
+            after: 'directory_group_01G2Z8D4ZR8RJ03Y1W7P9K8NMG',
+            directory: 'directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           )
 
-          expect(groups.data.size).to eq(10)
+          expect(groups.data.size).to eq(9)
         end
       end
     end
@@ -283,7 +283,7 @@ describe WorkOS::DirectorySync do
       it 'forms the proper request to the API' do
         request_args = [
           '/directory_groups?limit=2&' \
-          'directory=directory_01EK2YEMVTWGX27STRDR0N3MP9',
+          'directory=directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           'Content-Type' => 'application/json'
         ]
 
@@ -295,7 +295,7 @@ describe WorkOS::DirectorySync do
         VCR.use_cassette 'directory_sync/list_groups/with_limit' do
           groups = described_class.list_groups(
             limit: 2,
-            directory: 'directory_01EK2YEMVTWGX27STRDR0N3MP9',
+            directory: 'directory_01G2Z8ADK5NPMVTWF48MVVE4HT',
           )
 
           expect(groups.data.size).to eq(2)
@@ -438,11 +438,15 @@ describe WorkOS::DirectorySync do
       it 'returns a group' do
         VCR.use_cassette('directory_sync/get_group') do
           group = WorkOS::DirectorySync.get_group(
-            'directory_grp_01E64QTDNS0EGJ0FMCVY9BWGZT',
+            'directory_group_01G2Z8D4ZR8RJ03Y1W7P9K8NMG',
           )
 
-          expect(group['name']).to eq('Walrus')
-          expect(group.name).to eq('Walrus')
+          expect(group['directory_id']).to eq('directory_01G2Z8ADK5NPMVTWF48MVVE4HT')
+          expect(group['idp_id']).to eq('01jlao4614two3d')
+          expect(group['name']).to eq('Sales')
+          expect(group.name).to eq('Sales')
+          expect(group['created_at']).to eq('2022-05-13T17:45:31.732Z')
+          expect(group['updated_at']).to eq('2022-06-07T17:45:35.739Z')
         end
       end
     end

data/spec/lib/workos/directory_user_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::DirectoryUser do
+  # rubocop:disable Layout/LineLength
+  describe '.get_primary_email' do
+    context 'with one primary email' do
+      it 'returns the primary email' do
+        user = WorkOS::DirectoryUser.new('{"object":"directory_user","id":"directory_user_01FAZYNPC8M0HRYTKFP2GNX852","directory_id":"directory_01FAZYMST676QMTFN1DDJZZX87","idp_id":"6092c280a3f1e19ef6d8cef8","username":"logan@workos.com","emails":[{"primary":true,"value":"logan@workos.com"}, {"primary":false,"value":"logan@gmail.com"}],"first_name":"Logan","last_name":"Gingerich","state":"active","raw_attributes":{},"custom_attributes":{},"groups":[]}')
+        expect(user.primary_email).to eq('logan@workos.com')
+      end
+    end
+
+    context 'with multiple primary emails' do
+      it 'returns the first email marked as primary' do
+        user = WorkOS::DirectoryUser.new('{"object":"directory_user","id":"directory_user_01FAZYNPC8M0HRYTKFP2GNX852","directory_id":"directory_01FAZYMST676QMTFN1DDJZZX87","idp_id":"6092c280a3f1e19ef6d8cef8","username":"logan@workos.com","emails":[{"primary":true,"value":"logan@workos.com"}, {"primary":true,"value":"logan@gmail.com"}],"first_name":"Logan","last_name":"Gingerich","state":"active","raw_attributes":{},"custom_attributes":{},"groups":[]}')
+        expect(user.primary_email).to eq('logan@workos.com')
+      end
+    end
+
+    context 'with no primary emails' do
+      it 'returns nil' do
+        user = WorkOS::DirectoryUser.new('{"object":"directory_user","id":"directory_user_01FAZYNPC8M0HRYTKFP2GNX852","directory_id":"directory_01FAZYMST676QMTFN1DDJZZX87","idp_id":"6092c280a3f1e19ef6d8cef8","username":"logan@workos.com","emails":[{"primary":false,"value":"logan@gmail.com"}],"first_name":"Logan","last_name":"Gingerich","state":"active","raw_attributes":{},"custom_attributes":{},"groups":[]}')
+        expect(user.primary_email).to eq(nil)
+      end
+    end
+
+    context 'with an empty email array' do
+      it 'returns nil' do
+        user = WorkOS::DirectoryUser.new('{"object":"directory_user","id":"directory_user_01FAZYNPC8M0HRYTKFP2GNX852","directory_id":"directory_01FAZYMST676QMTFN1DDJZZX87","idp_id":"6092c280a3f1e19ef6d8cef8","username":"logan@workos.com","emails":[],"first_name":"Logan","last_name":"Gingerich","state":"active","raw_attributes":{},"custom_attributes":{},"groups":[]}')
+        expect(user.primary_email).to eq(nil)
+      end
+    end
+  end
+  # rubocop:enable Layout/LineLength
+end

data/spec/support/fixtures/vcr_cassettes/directory_sync/get_group.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.workos.com/directory_groups/directory_grp_01E64QTDNS0EGJ0FMCVY9BWGZT
+    uri: https://api.workos.com/directory_groups/directory_group_01G2Z8D4ZR8RJ03Y1W7P9K8NMG
     body:
       encoding: US-ASCII
       string: ''
@@ -14,7 +14,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - WorkOS; ruby/2.7.1; x86_64-darwin19; v0.2.3
+      - WorkOS; ruby/3.0.2; x86_64-darwin19; v2.1.1
       Authorization:
       - Bearer <API_KEY>
   response:
@@ -22,41 +22,61 @@ http_interactions:
       code: 200
       message: OK
     headers:
-      Server:
-      - Cowboy
+      Date:
+      - Tue, 07 Jun 2022 22:28:37 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
       Connection:
       - keep-alive
-      Vary:
-      - Origin, Accept-Encoding
       Access-Control-Allow-Credentials:
       - 'true'
-      X-Dns-Prefetch-Control:
-      - 'off'
-      X-Frame-Options:
-      - SAMEORIGIN
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Etag:
+      - W/"244-4TugYfq6OLpdb2GYu9NN0Z83S0g"
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
       Strict-Transport-Security:
       - max-age=15552000; includeSubDomains
-      X-Download-Options:
-      - noopen
+      Vary:
+      - Origin, Accept-Encoding
+      Via:
+      - 1.1 spaces-router (664a92218d61)
       X-Content-Type-Options:
       - nosniff
-      X-Xss-Protection:
-      - 1; mode=block
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
       X-Request-Id:
-      - 4fb94ab3-ecff-4cea-b0b7-d4d1b3ffad3a
-      Content-Type:
-      - application/json; charset=utf-8
-      Content-Length:
-      - '65'
-      Etag:
-      - W/"41-QrnAKhorJuUwAsR1OyMpfB8q1Kc"
-      Date:
-      - Thu, 30 Apr 2020 04:47:49 GMT
-      Via:
-      - 1.1 vegur
+      - 4a7bfd77-da6c-b1ae-bc39-35a1c175ecf2
+      X-Xss-Protection:
+      - '0'
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=9nQ%2FpfKZE%2BT1W4WrbQGusRS%2FxZHEG7sB0Ps3PUXt4lmPSmC%2FZHLV6KW90D74Y9VQ0QT7q3OIF47yVIwX5fwPKOHMwcOYQv0eyKUrFYxKkNf6QALpJE7%2BVNSUBiEmv3cZ1zOXUFCiuMl2MYygsw%3D%3D"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 717cd26458fd671d-DFW
+      Alt-Svc:
+      - h3=":443"; ma=86400, h3-29=":443"; ma=86400
     body:
-      encoding: UTF-8
-      string: '{"id":"directory_grp_01E64QTDNS0EGJ0FMCVY9BWGZT","name":"Walrus"}'
+      encoding: ASCII-8BIT
+      string: '{"object":"directory_group","id":"directory_group_01G2Z8D4ZR8RJ03Y1W7P9K8NMG","idp_id":"01jlao4614two3d","directory_id":"directory_01G2Z8ADK5NPMVTWF48MVVE4HT","name":"Sales","created_at":"2022-05-13T17:45:31.732Z","updated_at":"2022-06-07T17:45:35.739Z","raw_attributes":{"id":"01jlao4614two3d","etag":"\"DaDAXuEwpvygu_Ul-89tlT4iVJBEvO3LZpQ0lrbYRrc/uLYJ0Hrx1gXXVg9z-zGLBZET2Wo\"","kind":"admin#directory#group","name":"Sales","email":"sales@foo-corp.com","description":"","adminCreated":true,"directMembersCount":"1","nonEditableAliases":["sales@foo-corp.com.test-google-a.com"]}}'
     http_version:
-  recorded_at: Thu, 30 Apr 2020 04:47:49 GMT
+  recorded_at: Tue, 07 Jun 2022 22:28:37 GMT
 recorded_with: VCR 5.0.0