workos 2.13.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e44f2efdf7c26581302bb194d95e2230f64b74f2b0eb30da284f08ceeb15c7e6
-  data.tar.gz: f759fcbd20ba0faedb50cefd158df2d7f26b8c2ec666692941d70cbb6d7ffbe4
+  metadata.gz: 2b01746fa31764bb3e0a381ca2e3dd0bef08a39a9e80db8d5079997e2e392d36
+  data.tar.gz: 79ec855c5da2d642a911b7896d353628e837c020a471d70824b39bb510e60d71
 SHA512:
-  metadata.gz: f105326800e2c4021c6eca851b550e319cca1a798e78b77dc81e94d23984d34e30ff36421dfd055eb0f1546c0050a46797671d25ab06b952c122813141fe5b18
-  data.tar.gz: 996ddb5dfc85ab85cfc919ac43a5abcf3a95016a98748fc881802e537723a00e7746fb4c8d1f57fc6bd1f38e56a0eb14e688c9422de591e2e6e5dc17b2daad7a
+  metadata.gz: 6aaee86d818a23e40de43f9f5eececdb109fe1fdbba6c4c7a50916e814976ec7a140628415c40aca4d170eb4fd3105125eb8bc4c68ea8ff695f6bb8f91baeea9
+  data.tar.gz: c805ad7bf051ebaeb1b5ac485f710d951d5890cd9219adbf32daa3edf653d2baa8e0fb740c550d4e0be9433d7fe6fb355d4130148a66ef9e80f7f73d76bebc66

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.13.0)
+    workos (2.15.0)
       sorbet-runtime (~> 0.5)
 
 GEM

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/event.rb

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

data/lib/workos/events.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'net/http'
+
+module WorkOS
+  # The Events module provides convenience methods for working with the
+  # WorkOS Events platform. You'll need a valid API key and be in the
+  # Events beta to be able to access the API
+  #
+  module Events
+    class << self
+      extend T::Sig
+      include Client
+
+      # Retrieve events.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] event The type of event
+      #  retrieved.
+      # @option options [String] limit Maximum number of records to return.
+      # @option options [String] after Pagination cursor to receive records
+      #  after a provided Event ID.
+      #
+      # @return [Hash]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(WorkOS::Types::ListStruct)
+      end
+      def list_events(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/events',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+        events = parsed_response['data'].map do |event|
+          ::WorkOS::Event.new(event.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: events,
+          list_metadata: parsed_response['listMetadata'],
+        )
+      end
+    end
+  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/types/event_struct.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # The EventStruct acts as a typed interface
+    # for the Event class
+    class EventStruct < T::Struct
+      const :id, String
+      const :event, String
+      const :data, T::Hash[Symbol, Object]
+      const :created_at, String
+    end
+  end
+end

data/lib/workos/types.rb

@@ -9,6 +9,7 @@ module WorkOS
     require_relative 'types/connection_struct'
     require_relative 'types/directory_struct'
     require_relative 'types/directory_group_struct'
+    require_relative 'types/event_struct'
     require_relative 'types/intent_enum'
     require_relative 'types/list_struct'
     require_relative 'types/organization_struct'

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '2.13.0'
+  VERSION = '2.15.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/lib/workos.rb

@@ -46,6 +46,8 @@ module WorkOS
   autoload :DirectorySync, 'workos/directory_sync'
   autoload :Directory, 'workos/directory'
   autoload :DirectoryGroup, 'workos/directory_group'
+  autoload :Event, 'workos/event'
+  autoload :Events, 'workos/events'
   autoload :Organization, 'workos/organization'
   autoload :Organizations, 'workos/organizations'
   autoload :Passwordless, 'workos/passwordless'

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::Events do
+  it_behaves_like 'client'
+
+  describe '.list_events' do
+    context 'with no options' do
+      it 'returns events and metadata' do
+        expected_metadata = {
+          'after' => nil,
+        }
+
+        VCR.use_cassette 'events/list_events_with_no_options' do
+          events = described_class.list_events
+
+          expect(events.data.size).to eq(1)
+          expect(events.list_metadata).to eq(expected_metadata)
+        end
+      end
+    end
+
+    context 'with event option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/events?events=connection.activated',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'events/list_events_with_event' do
+          events = described_class.list_events(
+            events: ['connection.activated'],
+          )
+
+          expect(events.data.size).to eq(1)
+        end
+      end
+    end
+
+    context 'with the after option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/events?after=event_01FGCPNV312FHFRCX0BYWHVSE1',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'events/list_events_with_after' do
+          events = described_class.list_events(after: 'event_01FGCPNV312FHFRCX0BYWHVSE1')
+
+          expect(events.data.size).to eq(1)
+        end
+      end
+    end
+
+    context 'with the range_start and range_end options' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/events?range_start=2023-01-01T00%3A00%3A00Z&range_end=2023-01-03T00%3A00%3A00Z',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'events/list_events_with_range' do
+          events = described_class.list_events(
+            range_start: '2023-01-01T00:00:00Z',
+            range_end: '2023-01-03T00:00:00Z',
+          )
+
+          expect(events.data.size).to eq(1)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/events?after=event_01FGCPNV312FHFRCX0BYWHVSE1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.2; arm64-darwin21; v2.3.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 Jul 2022 16:46:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '616'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      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/"680-NPvBik348v8xg6EE7iZMYwD5UXw"
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Via:
+      - 1.1 spaces-router (b642bf20b975)
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 51a82273-b413-cead-b968-c07ba4d6fd08
+      X-Xss-Protection:
+      - '0'
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=OS7ELJ3A8tkzMafvaIThD%2B5JlYmul1puZlAXTxEKYBLlq%2B6DCtqDqAi4dtr4yRP3khNmg6MwPiuLqtdOXRmPOtag9Ti%2FGK8ra%2BJOlpwkFjD965CNBfzao4EJtExDkbS3"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 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}}'
+    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

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/events?events=connection.activated
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.2; arm64-darwin21; v2.3.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 Jul 2022 16:46:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '616'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      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/"680-NPvBik348v8xg6EE7iZMYwD5UXw"
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Via:
+      - 1.1 spaces-router (b642bf20b975)
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 51a82273-b413-cead-b968-c07ba4d6fd08
+      X-Xss-Protection:
+      - '0'
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=OS7ELJ3A8tkzMafvaIThD%2B5JlYmul1puZlAXTxEKYBLlq%2B6DCtqDqAi4dtr4yRP3khNmg6MwPiuLqtdOXRmPOtag9Ti%2FGK8ra%2BJOlpwkFjD965CNBfzao4EJtExDkbS3"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 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}}'
+    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

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/events
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.2; arm64-darwin21; v2.3.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 Jul 2022 16:46:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '616'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      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/"680-NPvBik348v8xg6EE7iZMYwD5UXw"
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Via:
+      - 1.1 spaces-router (b642bf20b975)
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 51a82273-b413-cead-b968-c07ba4d6fd08
+      X-Xss-Protection:
+      - '0'
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=OS7ELJ3A8tkzMafvaIThD%2B5JlYmul1puZlAXTxEKYBLlq%2B6DCtqDqAi4dtr4yRP3khNmg6MwPiuLqtdOXRmPOtag9Ti%2FGK8ra%2BJOlpwkFjD965CNBfzao4EJtExDkbS3"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 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}}'
+    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

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    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: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.2; arm64-darwin21; v2.3.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 Jul 2022 16:46:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '616'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      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/"680-NPvBik348v8xg6EE7iZMYwD5UXw"
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Via:
+      - 1.1 spaces-router (b642bf20b975)
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 51a82273-b413-cead-b968-c07ba4d6fd08
+      X-Xss-Protection:
+      - '0'
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=OS7ELJ3A8tkzMafvaIThD%2B5JlYmul1puZlAXTxEKYBLlq%2B6DCtqDqAi4dtr4yRP3khNmg6MwPiuLqtdOXRmPOtag9Ti%2FGK8ra%2BJOlpwkFjD965CNBfzao4EJtExDkbS3"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 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}}'
+    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.13.0
+  version: 2.15.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -223,6 +223,8 @@ files:
 - lib/workos/directory_sync.rb
 - lib/workos/directory_user.rb
 - lib/workos/errors.rb
+- lib/workos/event.rb
+- lib/workos/events.rb
 - lib/workos/factor.rb
 - lib/workos/hash_provider.rb
 - lib/workos/mfa.rb
@@ -240,6 +242,7 @@ files:
 - lib/workos/types/directory_group_struct.rb
 - lib/workos/types/directory_struct.rb
 - lib/workos/types/directory_user_struct.rb
+- lib/workos/types/event_struct.rb
 - lib/workos/types/factor_struct.rb
 - lib/workos/types/intent_enum.rb
 - lib/workos/types/list_struct.rb
@@ -300,6 +303,7 @@ files:
 - spec/lib/workos/configuration_spec.rb
 - spec/lib/workos/directory_sync_spec.rb
 - spec/lib/workos/directory_user_spec.rb
+- spec/lib/workos/event_spec.rb
 - spec/lib/workos/mfa_spec.rb
 - spec/lib/workos/organizations_spec.rb
 - spec/lib/workos/passwordless_spec.rb
@@ -345,6 +349,10 @@ files:
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_group.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_limit.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_after.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_event.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_range.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_generic_valid.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_sms_valid.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_totp_valid.yml
@@ -413,7 +421,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: API client for WorkOS
@@ -423,6 +431,7 @@ test_files:
 - spec/lib/workos/configuration_spec.rb
 - spec/lib/workos/directory_sync_spec.rb
 - spec/lib/workos/directory_user_spec.rb
+- spec/lib/workos/event_spec.rb
 - spec/lib/workos/mfa_spec.rb
 - spec/lib/workos/organizations_spec.rb
 - spec/lib/workos/passwordless_spec.rb
@@ -468,6 +477,10 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_group.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_limit.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_after.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_event.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_range.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_generic_valid.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_sms_valid.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_totp_valid.yml