workos 2.14.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc295cd8c46339a6d6ecf851da0afc2209f1c69de9b0b9f97f880047fff0213a
-  data.tar.gz: e730de6baf7200c817fa85893939448d541e3740800a892800ec7eee2aad939f
+  metadata.gz: 3cbb0a53c0c7c21c1d8cb22a6d3d2679421da8fbeb237009bcd31c1f679c1586
+  data.tar.gz: 914321349e893fb0d9e7c955c6bff5c92851f5946d2f2bc278de6cad01295ae2
 SHA512:
-  metadata.gz: 8fa02446a42a473799a85091e142dec2b3b9ec8828017638fdba5625160df7e56f01fddd3aca5b86350106d7226c8979f9e556b775aa24086954ce3b2651948c
-  data.tar.gz: 4510685f43bbc1877f2f49e840da87ccb40240a3f6360d0832fb5714228a30d08c17c36d3d499bc3d6ccaffda72c4766d02ccacb8b6808b90231a2ece996a74b
+  metadata.gz: 777ab4dd91a7ce30ce709dd4578018abf4cde6b1c3d213588b1d1cc0d0b5c0c503ecd79e9c8fa30ff6d8d597fcb92ca027527b46e96d93fdbbb060b916830f90
+  data.tar.gz: 63ee003031a51bfa309e0095d2e4a6abb7caee9c6b3202efda809b7b6922a782fe04214af94a5647863bf059eca7f9228d91cdebc86e1800e3ae1caf9aeedbff

data/.rubocop.yml

@@ -11,7 +11,7 @@ Layout/LineLength:
 Metrics/BlockLength:
   ExcludedMethods: ['describe', 'context', 'before']
 Metrics/MethodLength:
-  Max: 15
+  Max: 30
 Metrics/ModuleLength:
   Max: 200
 Metrics/ParameterLists:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.14.0)
+    workos (2.16.0)
       sorbet-runtime (~> 0.5)
 
 GEM

data/devbox.json

@@ -0,0 +1,18 @@
+{
+  "packages": [
+    "ruby@3.0.2"
+  ],
+  "shell": {
+    "init_hook": [
+      "bundle install"
+    ],
+    "scripts": {
+      "test": [
+        "bundle exec rspec"
+      ], 
+      "lint": [
+        "bundle exec rubocop"
+      ]
+    }
+  }
+}

data/devbox.lock

@@ -0,0 +1,11 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "ruby@3.0.2": {
+      "last_modified": "2021-11-01T15:39:33Z",
+      "plugin_version": "0.0.1",
+      "resolved": "github:NixOS/nixpkgs/7053541084bf5ce2921ef307e5585d39d7ba8b3f#ruby_3_0",
+      "version": "3.0.2"
+    }
+  }
+}

data/lib/workos/audit_logs.rb

@@ -46,7 +46,9 @@ module WorkOS
       # @param [String] range_start ISO-8601 datetime
       # @param [String] range_end ISO-8601 datetime
       # @param [Array<String>] actions A list of actions to filter by
-      # @param [Array<String>] actors A list of actor names to filter by
+      # @param [Array<String>] @deprecated use `actor_names` instead
+      # @param [Array<String>] actor_names A list of actor names to filter by
+      # @param [Array<String>] actor_ids A list of actor ids to filter by
       # @param [Array<String>] targets A list of target types to filter by
       #
       # @return [WorkOS::AuditLogExport]
@@ -58,9 +60,12 @@ module WorkOS
           actions: T.nilable(T::Array[String]),
           actors: T.nilable(T::Array[String]),
           targets: T.nilable(T::Array[String]),
+          actor_names: T.nilable(T::Array[String]),
+          actor_ids: T.nilable(T::Array[String]),
         ).returns(WorkOS::AuditLogExport)
       end
-      def create_export(organization:, range_start:, range_end:, actions: nil, actors: nil, targets: nil)
+      def create_export(organization:, range_start:, range_end:, actions: nil, # rubocop:disable Metrics/ParameterLists
+                        actors: nil, targets: nil, actor_names: nil, actor_ids: nil)
         body = {
           organization_id: organization,
           range_start: range_start,
@@ -69,6 +74,8 @@ module WorkOS
 
         body['actions'] = actions unless actions.nil?
         body['actors'] = actors unless actors.nil?
+        body['actor_names'] = actor_names unless actor_names.nil?
+        body['actor_ids'] = actor_ids unless actor_ids.nil?
         body['targets'] = targets unless targets.nil?
 
         request = post_request(

data/lib/workos/directory_user.rb

@@ -13,7 +13,7 @@ module WorkOS
                   :groups, :custom_attributes, :raw_attributes, :directory_id, :organization_id,
                   :created_at, :updated_at
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     sig { params(json: String).void }
     def initialize(json)
       raw = parse_json(json)
@@ -36,9 +36,8 @@ module WorkOS
 
       replace_without_warning(to_json)
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
-    # rubocop:disable Metrics/MethodLength
     def to_json(*)
       {
         id: id,
@@ -58,7 +57,6 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-    # rubocop:enable Metrics/MethodLength
 
     def primary_email
       primary_email = (emails || []).find { |email| email[:primary] }
@@ -67,7 +65,7 @@ module WorkOS
 
     private
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize
     sig do
       params(
         json_string: String,
@@ -94,6 +92,6 @@ module WorkOS
         raw_attributes: hash[:raw_attributes],
       )
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/workos/events.rb

@@ -44,7 +44,7 @@ module WorkOS
 
         WorkOS::Types::ListStruct.new(
           data: events,
-          list_metadata: parsed_response['listMetadata'],
+          list_metadata: parsed_response['list_metadata'],
         )
       end
     end

data/lib/workos/mfa.rb

@@ -76,7 +76,6 @@ module WorkOS
           phone_number: T.nilable(String),
         ).returns(WorkOS::Factor)
       end
-      # rubocop:disable Metrics/MethodLength
       def enroll_factor(
         type:,
         totp_issuer: nil,
@@ -101,7 +100,6 @@ module WorkOS
         ))
         WorkOS::Factor.new(response.body)
       end
-      # rubocop:enable Metrics/MethodLength
 
       sig do
         params(

data/lib/workos/sso.rb

@@ -54,7 +54,7 @@ module WorkOS
       #      "response_type=code&state=%7B%3Anext_page%3D%3E%22%2Fdocs%22%7D"
       #
       # @return [String]
-      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      # rubocop:disable Metrics/ParameterLists
       sig do
         params(
           redirect_uri: String,
@@ -106,7 +106,7 @@ module WorkOS
 
         "https://#{WorkOS::API_HOSTNAME}/sso/authorize?#{query}"
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+      # rubocop:enable Metrics/ParameterLists
 
       sig do
         params(
@@ -271,7 +271,6 @@ module WorkOS
       end
 
       sig { params(response: Net::HTTPResponse).void }
-      # rubocop:disable Metrics/MethodLength
       def check_and_raise_profile_and_token_error(response:)
         begin
           body = JSON.parse(response.body)
@@ -293,7 +292,6 @@ module WorkOS
           request_id: request_id,
         )
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/workos/version.rb

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

data/lib/workos/webhooks.rb

@@ -82,7 +82,7 @@ module WorkOS
           tolerance: Integer,
         ).returns(T::Boolean)
       end
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:disable Metrics/AbcSize
       def verify_header(
         payload:,
         sig_header:,
@@ -120,7 +120,7 @@ module WorkOS
 
         true
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:enable Metrics/AbcSize
 
       # Extracts timestamp and signature hash from WorkOS-Signature header
       #

data/spec/lib/workos/audit_logs_spec.rb

@@ -116,6 +116,8 @@ describe WorkOS::AuditLogs do
             range_end: '2022-08-22T15:04:19.704Z',
             actions: ['user.signed_in'],
             actors: ['Jon Smith'],
+            actor_names: ['Jon Smith'],
+            actor_ids: ['user_123'],
             targets: %w[user team],
           )
 

data/spec/lib/workos/event_spec.rb

@@ -62,10 +62,10 @@ describe WorkOS::Events do
       end
     end
 
-    context 'with the rangeStart and rangeEnd options' do
+    context 'with the range_start and range_end options' do
       it 'forms the proper request to the API' do
         request_args = [
-          '/events?rangeStart=2023-01-01T00%3A00%3A00Z&rangeEnd=2023-01-03T00%3A00%3A00Z',
+          '/events?range_start=2023-01-01T00%3A00%3A00Z&range_end=2023-01-03T00%3A00%3A00Z',
           'Content-Type' => 'application/json'
         ]
 
@@ -76,8 +76,8 @@ describe WorkOS::Events do
 
         VCR.use_cassette 'events/list_events_with_range' do
           events = described_class.list_events(
-            rangeStart: '2023-01-01T00:00:00Z',
-            rangeEnd: '2023-01-03T00:00:00Z',
+            range_start: '2023-01-01T00:00:00Z',
+            range_end: '2023-01-03T00:00:00Z',
           )
 
           expect(events.data.size).to eq(1)

data/spec/support/fixtures/vcr_cassettes/audit_logs/create_export_with_filters.yml

@@ -6,8 +6,7 @@ http_interactions:
       body:
         encoding: UTF-8
         string:
-          '{"organization_id":"org_123","range_start":"2022-06-22T15:04:19.704Z","range_end":"2022-08-22T15:04:19.704Z","actions":["user.signed_in"],"actors":["Jon
-          Smith"],"targets":["user","team"]}'
+          '{"organization_id":"org_123","range_start":"2022-06-22T15:04:19.704Z","range_end":"2022-08-22T15:04:19.704Z","actions":["user.signed_in"],"actors":["Jon Smith"],"actor_names":["Jon Smith"],"actor_ids":["user_123"],"targets":["user","team"]}'
       headers:
         Content-Type:
           - application/json

data/spec/support/fixtures/vcr_cassettes/events/list_events_with_after.yml

@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/events/list_events_with_event.yml

@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/events/list_events_with_no_options.yml

@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/events/list_events_with_range.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.workos.com/events?rangeEnd=2023-01-03T00:00:00Z&rangeStart=2023-01-01T00:00:00Z
+    uri: https://api.workos.com/events?range_end=2023-01-03T00:00:00Z&range_start=2023-01-01T00:00:00Z
     body:
       encoding: US-ASCII
       string: ''
@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.16.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2023-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -181,6 +181,8 @@ files:
 - bin/publish
 - bin/tapioca
 - codecov.yml
+- devbox.json
+- devbox.lock
 - docs/WorkOS.html
 - docs/WorkOS/APIError.html
 - docs/WorkOS/AuditLog.html
@@ -421,7 +423,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.16
 signing_key:
 specification_version: 4
 summary: API client for WorkOS