workos 7.1.1 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/docs.yml +46 -0
  3. data/.gitignore +2 -0
  4. data/.last-synced-sha +1 -1
  5. data/.oagen-manifest.json +61 -40
  6. data/.release-please-manifest.json +1 -1
  7. data/.yardopts +6 -0
  8. data/CHANGELOG.md +38 -0
  9. data/Gemfile +6 -0
  10. data/Gemfile.lock +33 -2
  11. data/lib/workos/api_keys/api_key.rb +1 -1
  12. data/lib/workos/api_keys/api_key_created_data.rb +1 -1
  13. data/lib/workos/api_keys/organization_api_key.rb +43 -0
  14. data/lib/workos/{types/events_order.rb → api_keys/organization_api_key_owner.rb} +1 -3
  15. data/lib/workos/api_keys/organization_api_key_with_value.rb +46 -0
  16. data/lib/workos/{types/audit_logs_order.rb → api_keys/organization_api_key_with_value_owner.rb} +1 -3
  17. data/lib/workos/api_keys.rb +46 -46
  18. data/lib/workos/audit_logs.rb +6 -6
  19. data/lib/workos/authorization/user_organization_membership_base_list_data.rb +5 -2
  20. data/lib/workos/authorization/{role_assignment.rb → user_role_assignment.rb} +5 -2
  21. data/lib/workos/authorization/{role_assignment_resource.rb → user_role_assignment_resource.rb} +1 -1
  22. data/lib/workos/authorization.rb +250 -138
  23. data/lib/workos/base_client.rb +6 -1
  24. data/lib/workos/client.rb +4 -4
  25. data/lib/workos/connect.rb +2 -2
  26. data/lib/workos/directory_sync/directory_user.rb +3 -0
  27. data/lib/workos/directory_sync/directory_user_with_groups.rb +4 -1
  28. data/lib/workos/directory_sync/dsync_user_updated_data.rb +3 -0
  29. data/lib/workos/directory_sync.rb +6 -6
  30. data/lib/workos/encryptors/aes_gcm.rb +35 -3
  31. data/lib/workos/events.rb +2 -2
  32. data/lib/workos/feature_flags.rb +6 -6
  33. data/lib/workos/groups.rb +5 -5
  34. data/lib/workos/multi_factor_auth.rb +3 -3
  35. data/lib/workos/organization_domains.rb +1 -1
  36. data/lib/workos/organizations.rb +2 -2
  37. data/lib/workos/radar.rb +2 -2
  38. data/lib/workos/sso/profile.rb +3 -0
  39. data/lib/workos/sso.rb +4 -4
  40. data/lib/workos/types/event_context_actor_source.rb +2 -1
  41. data/lib/workos/types/{applications_order.rb → pagination_order.rb} +1 -1
  42. data/lib/workos/types/{vault_byok_key_verification_completed_data_key_provider.rb → vault_byok_key_provider.rb} +1 -1
  43. data/lib/workos/user_management/create_user_api_key.rb +25 -0
  44. data/lib/workos/user_management/organization_membership.rb +5 -2
  45. data/lib/workos/user_management/user_api_key.rb +43 -0
  46. data/lib/workos/user_management/user_api_key_created_data_owner.rb +25 -0
  47. data/lib/workos/{api_keys/api_key_with_value_owner.rb → user_management/user_api_key_owner.rb} +1 -1
  48. data/lib/workos/{types/webhooks_order.rb → user_management/user_api_key_revoked_data_owner.rb} +1 -3
  49. data/lib/workos/{api_keys/api_key_with_value.rb → user_management/user_api_key_with_value.rb} +2 -2
  50. data/lib/workos/{types/groups_order.rb → user_management/user_api_key_with_value_owner.rb} +1 -3
  51. data/lib/workos/user_management/user_organization_membership.rb +5 -2
  52. data/lib/workos/user_management.rb +181 -75
  53. data/lib/workos/user_management_organization_membership_groups.rb +2 -2
  54. data/lib/workos/vault/vault_byok_key_deleted.rb +34 -0
  55. data/lib/workos/vault/vault_byok_key_deleted_data.rb +22 -0
  56. data/lib/workos/version.rb +1 -1
  57. data/lib/workos/webhooks.rb +3 -3
  58. data/rbi/workos/api_key.rbi +2 -2
  59. data/rbi/workos/api_key_created_data.rbi +2 -2
  60. data/rbi/workos/api_key_revoked_data.rbi +2 -2
  61. data/rbi/workos/api_keys.rbi +17 -17
  62. data/rbi/workos/authorization.rbi +127 -27
  63. data/rbi/workos/client.rbi +3 -3
  64. data/rbi/workos/create_user_api_key.rbi +36 -0
  65. data/rbi/workos/directory_user.rbi +6 -0
  66. data/rbi/workos/directory_user_with_groups.rbi +6 -0
  67. data/rbi/workos/dsync_user_updated_data.rbi +6 -0
  68. data/rbi/workos/organization_api_key.rbi +72 -0
  69. data/rbi/workos/{api_key_with_value_owner.rbi → organization_api_key_owner.rbi} +1 -1
  70. data/rbi/workos/organization_api_key_with_value.rbi +78 -0
  71. data/rbi/workos/organization_api_key_with_value_owner.rbi +30 -0
  72. data/rbi/workos/organization_membership.rbi +6 -0
  73. data/rbi/workos/profile.rbi +6 -0
  74. data/rbi/workos/user_api_key.rbi +72 -0
  75. data/rbi/workos/user_api_key_created_data_owner.rbi +36 -0
  76. data/rbi/workos/user_api_key_owner.rbi +36 -0
  77. data/rbi/workos/user_api_key_revoked_data_owner.rbi +36 -0
  78. data/rbi/workos/{api_key_with_value.rbi → user_api_key_with_value.rbi} +3 -3
  79. data/rbi/workos/user_api_key_with_value_owner.rbi +36 -0
  80. data/rbi/workos/user_management.rbi +91 -14
  81. data/rbi/workos/user_organization_membership.rbi +6 -0
  82. data/rbi/workos/user_organization_membership_base_list_data.rbi +6 -0
  83. data/rbi/workos/{role_assignment.rbi → user_role_assignment.rbi} +9 -3
  84. data/rbi/workos/{role_assignment_resource.rbi → user_role_assignment_resource.rbi} +1 -1
  85. data/rbi/workos/vault_byok_key_deleted.rbi +54 -0
  86. data/rbi/workos/vault_byok_key_deleted_data.rbi +30 -0
  87. data/script/docs +16 -0
  88. data/script/docs-serve +12 -0
  89. data/script/llms-txt +37 -0
  90. data/test/workos/test_api_keys.rb +17 -17
  91. data/test/workos/test_audit_logs.rb +2 -2
  92. data/test/workos/test_authorization.rb +102 -20
  93. data/test/workos/test_encryptors_aes_gcm.rb +21 -0
  94. data/test/workos/test_model_round_trip.rb +278 -83
  95. data/test/workos/test_session.rb +68 -0
  96. data/test/workos/test_user_management.rb +69 -9
  97. data/test/workos/test_webhooks.rb +2 -2
  98. metadata +39 -33
  99. data/lib/workos/types/authorization_order.rb +0 -9
  100. data/lib/workos/types/connections_order.rb +0 -9
  101. data/lib/workos/types/directories_order.rb +0 -9
  102. data/lib/workos/types/directory_groups_order.rb +0 -9
  103. data/lib/workos/types/directory_users_order.rb +0 -9
  104. data/lib/workos/types/feature_flags_order.rb +0 -9
  105. data/lib/workos/types/organizations_api_keys_order.rb +0 -9
  106. data/lib/workos/types/organizations_feature_flags_order.rb +0 -9
  107. data/lib/workos/types/organizations_order.rb +0 -9
  108. data/lib/workos/types/permissions_order.rb +0 -9
  109. data/lib/workos/types/user_management_invitations_order.rb +0 -9
  110. data/lib/workos/types/user_management_multi_factor_authentication_order.rb +0 -9
  111. data/lib/workos/types/user_management_organization_membership_groups_order.rb +0 -9
  112. data/lib/workos/types/user_management_organization_membership_order.rb +0 -9
  113. data/lib/workos/types/user_management_users_authorized_applications_order.rb +0 -9
  114. data/lib/workos/types/user_management_users_feature_flags_order.rb +0 -9
  115. data/lib/workos/types/user_management_users_order.rb +0 -9
@@ -203,8 +203,17 @@ class UserManagementTest < Minitest::Test
203
203
 
204
204
  def test_create_user_returns_expected_result
205
205
  stub_request(:post, %r{\Ahttps://api\.workos\.com/user_management/users(\?|\z)})
206
+ .with(body: hash_including("email" => "stub", "password" => "stub"))
206
207
  .to_return(body: "{}", status: 200)
207
- result = @client.user_management.create_user(email: "stub")
208
+ result = @client.user_management.create_user(email: "stub", password: WorkOS::UserManagement::PasswordPlaintext.new(password: "stub"))
209
+ refute_nil result
210
+ end
211
+
212
+ def test_create_user_with_password_hashed_returns_expected_result
213
+ stub_request(:post, %r{\Ahttps://api\.workos\.com/user_management/users(\?|\z)})
214
+ .with(body: hash_including("email" => "stub", "password_hash" => "stub", "password_hash_type" => "stub"))
215
+ .to_return(body: "{}", status: 200)
216
+ result = @client.user_management.create_user(email: "stub", password: WorkOS::UserManagement::PasswordHashed.new(password_hash: "stub", password_hash_type: "stub"))
208
217
  refute_nil result
209
218
  end
210
219
 
@@ -224,8 +233,17 @@ class UserManagementTest < Minitest::Test
224
233
 
225
234
  def test_update_user_returns_expected_result
226
235
  stub_request(:put, %r{\Ahttps://api\.workos\.com/user_management/users/stub(\?|\z)})
236
+ .with(body: hash_including("password" => "stub"))
237
+ .to_return(body: "{}", status: 200)
238
+ result = @client.user_management.update_user(id: "stub", password: WorkOS::UserManagement::PasswordPlaintext.new(password: "stub"))
239
+ refute_nil result
240
+ end
241
+
242
+ def test_update_user_with_password_hashed_returns_expected_result
243
+ stub_request(:put, %r{\Ahttps://api\.workos\.com/user_management/users/stub(\?|\z)})
244
+ .with(body: hash_including("password_hash" => "stub", "password_hash_type" => "stub"))
227
245
  .to_return(body: "{}", status: 200)
228
- result = @client.user_management.update_user(id: "stub")
246
+ result = @client.user_management.update_user(id: "stub", password: WorkOS::UserManagement::PasswordHashed.new(password_hash: "stub", password_hash_type: "stub"))
229
247
  refute_nil result
230
248
  end
231
249
 
@@ -327,6 +345,13 @@ class UserManagementTest < Minitest::Test
327
345
  refute_nil result
328
346
  end
329
347
 
348
+ def test_list_jwt_template_returns_expected_result
349
+ stub_request(:get, %r{\Ahttps://api\.workos\.com/user_management/jwt_template(\?|\z)})
350
+ .to_return(body: "{}", status: 200)
351
+ result = @client.user_management.list_jwt_template
352
+ refute_nil result
353
+ end
354
+
330
355
  def test_update_jwt_template_returns_expected_result
331
356
  stub_request(:put, %r{\Ahttps://api\.workos\.com/user_management/jwt_template(\?|\z)})
332
357
  .to_return(body: "{}", status: 200)
@@ -357,8 +382,17 @@ class UserManagementTest < Minitest::Test
357
382
 
358
383
  def test_create_organization_membership_returns_expected_result
359
384
  stub_request(:post, %r{\Ahttps://api\.workos\.com/user_management/organization_memberships(\?|\z)})
385
+ .with(body: hash_including("user_id" => "stub", "organization_id" => "stub", "role_slug" => "stub"))
386
+ .to_return(body: "{}", status: 200)
387
+ result = @client.user_management.create_organization_membership(user_id: "stub", organization_id: "stub", role: WorkOS::UserManagement::RoleSingle.new(role_slug: "stub"))
388
+ refute_nil result
389
+ end
390
+
391
+ def test_create_organization_membership_with_role_multiple_returns_expected_result
392
+ stub_request(:post, %r{\Ahttps://api\.workos\.com/user_management/organization_memberships(\?|\z)})
393
+ .with(body: hash_including("user_id" => "stub", "organization_id" => "stub", "role_slugs" => ["stub"]))
360
394
  .to_return(body: "{}", status: 200)
361
- result = @client.user_management.create_organization_membership(user_id: "stub", organization_id: "stub")
395
+ result = @client.user_management.create_organization_membership(user_id: "stub", organization_id: "stub", role: WorkOS::UserManagement::RoleMultiple.new(role_slugs: ["stub"]))
362
396
  refute_nil result
363
397
  end
364
398
 
@@ -371,8 +405,17 @@ class UserManagementTest < Minitest::Test
371
405
 
372
406
  def test_update_organization_membership_returns_expected_result
373
407
  stub_request(:put, %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub(\?|\z)})
408
+ .with(body: hash_including("role_slug" => "stub"))
409
+ .to_return(body: "{}", status: 200)
410
+ result = @client.user_management.update_organization_membership(id: "stub", role: WorkOS::UserManagement::RoleSingle.new(role_slug: "stub"))
411
+ refute_nil result
412
+ end
413
+
414
+ def test_update_organization_membership_with_role_multiple_returns_expected_result
415
+ stub_request(:put, %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub(\?|\z)})
416
+ .with(body: hash_including("role_slugs" => ["stub"]))
374
417
  .to_return(body: "{}", status: 200)
375
- result = @client.user_management.update_organization_membership(id: "stub")
418
+ result = @client.user_management.update_organization_membership(id: "stub", role: WorkOS::UserManagement::RoleMultiple.new(role_slugs: ["stub"]))
376
419
  refute_nil result
377
420
  end
378
421
 
@@ -418,6 +461,20 @@ class UserManagementTest < Minitest::Test
418
461
  assert_nil result
419
462
  end
420
463
 
464
+ def test_list_user_api_keys_returns_expected_result
465
+ stub_request(:get, %r{\Ahttps://api\.workos\.com/user_management/users/stub/api_keys(\?|\z)})
466
+ .to_return(body: '{"data": [], "list_metadata": {}}', status: 200)
467
+ result = @client.user_management.list_user_api_keys(user_id: "stub")
468
+ assert_kind_of WorkOS::Types::ListStruct, result
469
+ end
470
+
471
+ def test_create_user_api_key_returns_expected_result
472
+ stub_request(:post, %r{\Ahttps://api\.workos\.com/user_management/users/stub/api_keys(\?|\z)})
473
+ .to_return(body: "{}", status: 200)
474
+ result = @client.user_management.create_user_api_key(user_id: "stub", name: "stub", organization_id: "stub")
475
+ refute_nil result
476
+ end
477
+
421
478
  # Parameterized authentication error tests (one per endpoint).
422
479
  [
423
480
  {name: :get_jwks, verb: :get, url: %r{\Ahttps://api\.workos\.com/sso/jwks/stub(\?|\z)}, args: {client_id: "stub"}},
@@ -430,10 +487,10 @@ class UserManagementTest < Minitest::Test
430
487
  {name: :confirm_password_reset, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/password_reset/confirm(\?|\z)}, args: {token: "stub", new_password: "stub"}},
431
488
  {name: :get_password_reset, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/password_reset/stub(\?|\z)}, args: {id: "stub"}},
432
489
  {name: :list_users, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/users(\?|\z)}},
433
- {name: :create_user, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/users(\?|\z)}, args: {email: "stub"}},
490
+ {name: :create_user, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/users(\?|\z)}, args: {email: "stub", password: WorkOS::UserManagement::PasswordPlaintext.new(password: "stub")}},
434
491
  {name: :get_user_by_external_id, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/users/external_id/stub(\?|\z)}, args: {external_id: "stub"}},
435
492
  {name: :get_user, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub(\?|\z)}, args: {id: "stub"}},
436
- {name: :update_user, verb: :put, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub(\?|\z)}, args: {id: "stub"}},
493
+ {name: :update_user, verb: :put, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub(\?|\z)}, args: {id: "stub", password: WorkOS::UserManagement::PasswordPlaintext.new(password: "stub")}},
437
494
  {name: :delete_user, verb: :delete, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub(\?|\z)}, args: {id: "stub"}},
438
495
  {name: :confirm_email_change, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub/email_change/confirm(\?|\z)}, args: {id: "stub", code: "stub"}},
439
496
  {name: :send_email_change, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub/email_change/send(\?|\z)}, args: {id: "stub", new_email: "stub"}},
@@ -448,19 +505,22 @@ class UserManagementTest < Minitest::Test
448
505
  {name: :accept_invitation, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/invitations/stub/accept(\?|\z)}, args: {id: "stub"}},
449
506
  {name: :resend_invitation, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/invitations/stub/resend(\?|\z)}, args: {id: "stub"}},
450
507
  {name: :revoke_invitation, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/invitations/stub/revoke(\?|\z)}, args: {id: "stub"}},
508
+ {name: :list_jwt_template, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/jwt_template(\?|\z)}},
451
509
  {name: :update_jwt_template, verb: :put, url: %r{\Ahttps://api\.workos\.com/user_management/jwt_template(\?|\z)}, args: {content: "stub"}},
452
510
  {name: :create_magic_auth, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/magic_auth(\?|\z)}, args: {email: "stub"}},
453
511
  {name: :get_magic_auth, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/magic_auth/stub(\?|\z)}, args: {id: "stub"}},
454
512
  {name: :list_organization_memberships, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships(\?|\z)}},
455
- {name: :create_organization_membership, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships(\?|\z)}, args: {user_id: "stub", organization_id: "stub"}},
513
+ {name: :create_organization_membership, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships(\?|\z)}, args: {user_id: "stub", organization_id: "stub", role: WorkOS::UserManagement::RoleSingle.new(role_slug: "stub")}},
456
514
  {name: :get_organization_membership, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub(\?|\z)}, args: {id: "stub"}},
457
- {name: :update_organization_membership, verb: :put, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub(\?|\z)}, args: {id: "stub"}},
515
+ {name: :update_organization_membership, verb: :put, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub(\?|\z)}, args: {id: "stub", role: WorkOS::UserManagement::RoleSingle.new(role_slug: "stub")}},
458
516
  {name: :delete_organization_membership, verb: :delete, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub(\?|\z)}, args: {id: "stub"}},
459
517
  {name: :deactivate_organization_membership, verb: :put, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub/deactivate(\?|\z)}, args: {id: "stub"}},
460
518
  {name: :reactivate_organization_membership, verb: :put, url: %r{\Ahttps://api\.workos\.com/user_management/organization_memberships/stub/reactivate(\?|\z)}, args: {id: "stub"}},
461
519
  {name: :create_redirect_uri, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/redirect_uris(\?|\z)}, args: {uri: "stub"}},
462
520
  {name: :list_user_authorized_applications, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub/authorized_applications(\?|\z)}, args: {user_id: "stub"}},
463
- {name: :delete_user_authorized_application, verb: :delete, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub/authorized_applications/stub(\?|\z)}, args: {application_id: "stub", user_id: "stub"}}
521
+ {name: :delete_user_authorized_application, verb: :delete, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub/authorized_applications/stub(\?|\z)}, args: {application_id: "stub", user_id: "stub"}},
522
+ {name: :list_user_api_keys, verb: :get, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub/api_keys(\?|\z)}, args: {user_id: "stub"}},
523
+ {name: :create_user_api_key, verb: :post, url: %r{\Ahttps://api\.workos\.com/user_management/users/stub/api_keys(\?|\z)}, args: {user_id: "stub", name: "stub", organization_id: "stub"}}
464
524
  ].each do |spec|
465
525
  define_method("test_#{spec[:name]}_raises_authentication_error_on_401") do
466
526
  stub_request(spec[:verb], spec[:url])
@@ -21,7 +21,7 @@ class WebhooksTest < Minitest::Test
21
21
  def test_create_webhook_endpoint_returns_expected_result
22
22
  stub_request(:post, %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)})
23
23
  .to_return(body: "{}", status: 200)
24
- result = @client.webhooks.create_webhook_endpoint(endpoint_url: "stub", events: [])
24
+ result = @client.webhooks.create_webhook_endpoint(endpoint_url: "stub", events: ["stub"])
25
25
  refute_nil result
26
26
  end
27
27
 
@@ -42,7 +42,7 @@ class WebhooksTest < Minitest::Test
42
42
  # Parameterized authentication error tests (one per endpoint).
43
43
  [
44
44
  {name: :list_webhook_endpoints, verb: :get, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)}},
45
- {name: :create_webhook_endpoint, verb: :post, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)}, args: {endpoint_url: "stub", events: []}},
45
+ {name: :create_webhook_endpoint, verb: :post, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)}, args: {endpoint_url: "stub", events: ["stub"]}},
46
46
  {name: :update_webhook_endpoint, verb: :patch, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints/stub(\?|\z)}, args: {id: "stub"}},
47
47
  {name: :delete_webhook_endpoint, verb: :delete, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints/stub(\?|\z)}, args: {id: "stub"}}
48
48
  ].each do |spec|
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: workos
3
3
  version: !ruby/object:Gem::Version
4
- version: 7.1.1
4
+ version: 8.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - WorkOS
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-04-29 00:00:00.000000000 Z
11
+ date: 2026-05-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jwt
@@ -132,6 +132,7 @@ files:
132
132
  - ".github/CODEOWNERS"
133
133
  - ".github/pull_request_template.md"
134
134
  - ".github/workflows/ci.yml"
135
+ - ".github/workflows/docs.yml"
135
136
  - ".github/workflows/lint-pr-title.yml"
136
137
  - ".github/workflows/lint.yml"
137
138
  - ".github/workflows/release-please.yml"
@@ -142,6 +143,7 @@ files:
142
143
  - ".release-please-manifest.json"
143
144
  - ".ruby-version"
144
145
  - ".standard.yml"
146
+ - ".yardopts"
145
147
  - CHANGELOG.md
146
148
  - Gemfile
147
149
  - Gemfile.lock
@@ -171,9 +173,11 @@ files:
171
173
  - lib/workos/api_keys/api_key_revoked_data.rb
172
174
  - lib/workos/api_keys/api_key_revoked_data_owner.rb
173
175
  - lib/workos/api_keys/api_key_validation_response.rb
174
- - lib/workos/api_keys/api_key_with_value.rb
175
- - lib/workos/api_keys/api_key_with_value_owner.rb
176
176
  - lib/workos/api_keys/create_organization_api_key.rb
177
+ - lib/workos/api_keys/organization_api_key.rb
178
+ - lib/workos/api_keys/organization_api_key_owner.rb
179
+ - lib/workos/api_keys/organization_api_key_with_value.rb
180
+ - lib/workos/api_keys/organization_api_key_with_value_owner.rb
177
181
  - lib/workos/api_keys/validate_api_key.rb
178
182
  - lib/workos/audit_logs.rb
179
183
  - lib/workos/audit_logs/audit_log_action.rb
@@ -213,8 +217,6 @@ files:
213
217
  - lib/workos/authorization/permission_updated_data.rb
214
218
  - lib/workos/authorization/remove_role.rb
215
219
  - lib/workos/authorization/role.rb
216
- - lib/workos/authorization/role_assignment.rb
217
- - lib/workos/authorization/role_assignment_resource.rb
218
220
  - lib/workos/authorization/role_created.rb
219
221
  - lib/workos/authorization/role_created_data.rb
220
222
  - lib/workos/authorization/role_deleted.rb
@@ -229,6 +231,8 @@ files:
229
231
  - lib/workos/authorization/update_organization_role.rb
230
232
  - lib/workos/authorization/update_role.rb
231
233
  - lib/workos/authorization/user_organization_membership_base_list_data.rb
234
+ - lib/workos/authorization/user_role_assignment.rb
235
+ - lib/workos/authorization/user_role_assignment_resource.rb
232
236
  - lib/workos/base_client.rb
233
237
  - lib/workos/client.rb
234
238
  - lib/workos/configuration.rb
@@ -449,20 +453,17 @@ files:
449
453
  - lib/workos/sso/sso_token_response_oauth_token.rb
450
454
  - lib/workos/sso/token_query.rb
451
455
  - lib/workos/types/api_response.rb
452
- - lib/workos/types/applications_order.rb
453
456
  - lib/workos/types/audit_log_configuration_log_stream_state.rb
454
457
  - lib/workos/types/audit_log_configuration_log_stream_type.rb
455
458
  - lib/workos/types/audit_log_configuration_state.rb
456
459
  - lib/workos/types/audit_log_export_json_state.rb
457
460
  - lib/workos/types/audit_log_export_state.rb
458
- - lib/workos/types/audit_logs_order.rb
459
461
  - lib/workos/types/authenticate_response_authentication_method.rb
460
462
  - lib/workos/types/authentication_factor_enrolled_type.rb
461
463
  - lib/workos/types/authentication_factor_type.rb
462
464
  - lib/workos/types/authentication_factors_create_request_type.rb
463
465
  - lib/workos/types/authentication_radar_risk_detected_data_action.rb
464
466
  - lib/workos/types/authorization_assignment.rb
465
- - lib/workos/types/authorization_order.rb
466
467
  - lib/workos/types/base_model.rb
467
468
  - lib/workos/types/connected_account_state.rb
468
469
  - lib/workos/types/connection_activated_data_connection_type.rb
@@ -479,20 +480,16 @@ files:
479
480
  - lib/workos/types/connection_status.rb
480
481
  - lib/workos/types/connection_type.rb
481
482
  - lib/workos/types/connections_connection_type.rb
482
- - lib/workos/types/connections_order.rb
483
483
  - lib/workos/types/create_user_invite_options_locale.rb
484
484
  - lib/workos/types/create_user_password_hash_type.rb
485
485
  - lib/workos/types/create_webhook_endpoint_events.rb
486
486
  - lib/workos/types/data_integration_access_token_response_error.rb
487
487
  - lib/workos/types/data_integrations_list_response_data_connected_account_state.rb
488
488
  - lib/workos/types/data_integrations_list_response_data_ownership.rb
489
- - lib/workos/types/directories_order.rb
490
- - lib/workos/types/directory_groups_order.rb
491
489
  - lib/workos/types/directory_state.rb
492
490
  - lib/workos/types/directory_type.rb
493
491
  - lib/workos/types/directory_user_state.rb
494
492
  - lib/workos/types/directory_user_with_groups_state.rb
495
- - lib/workos/types/directory_users_order.rb
496
493
  - lib/workos/types/dsync_activated_data_state.rb
497
494
  - lib/workos/types/dsync_activated_data_type.rb
498
495
  - lib/workos/types/dsync_deactivated_data_state.rb
@@ -501,8 +498,6 @@ files:
501
498
  - lib/workos/types/dsync_deleted_data_type.rb
502
499
  - lib/workos/types/dsync_user_updated_data_state.rb
503
500
  - lib/workos/types/event_context_actor_source.rb
504
- - lib/workos/types/events_order.rb
505
- - lib/workos/types/feature_flags_order.rb
506
501
  - lib/workos/types/flag_created_context_actor_source.rb
507
502
  - lib/workos/types/flag_deleted_context_actor_source.rb
508
503
  - lib/workos/types/flag_rule_updated_context_access_type.rb
@@ -510,7 +505,6 @@ files:
510
505
  - lib/workos/types/flag_rule_updated_context_previous_attribute_context_access_type.rb
511
506
  - lib/workos/types/flag_updated_context_actor_source.rb
512
507
  - lib/workos/types/generate_link_intent.rb
513
- - lib/workos/types/groups_order.rb
514
508
  - lib/workos/types/invitation_accepted_data_state.rb
515
509
  - lib/workos/types/invitation_created_data_state.rb
516
510
  - lib/workos/types/invitation_resent_data_state.rb
@@ -543,10 +537,7 @@ files:
543
537
  - lib/workos/types/organization_membership_updated_data_status.rb
544
538
  - lib/workos/types/organization_updated_data_domain_state.rb
545
539
  - lib/workos/types/organization_updated_data_domain_verification_strategy.rb
546
- - lib/workos/types/organizations_api_keys_order.rb
547
- - lib/workos/types/organizations_feature_flags_order.rb
548
- - lib/workos/types/organizations_order.rb
549
- - lib/workos/types/permissions_order.rb
540
+ - lib/workos/types/pagination_order.rb
550
541
  - lib/workos/types/profile_connection_type.rb
551
542
  - lib/workos/types/radar_action.rb
552
543
  - lib/workos/types/radar_standalone_assess_request_action.rb
@@ -570,19 +561,12 @@ files:
570
561
  - lib/workos/types/user_invite_state.rb
571
562
  - lib/workos/types/user_management_authentication_provider.rb
572
563
  - lib/workos/types/user_management_authentication_screen_hint.rb
573
- - lib/workos/types/user_management_invitations_order.rb
574
- - lib/workos/types/user_management_multi_factor_authentication_order.rb
575
- - lib/workos/types/user_management_organization_membership_groups_order.rb
576
- - lib/workos/types/user_management_organization_membership_order.rb
577
564
  - lib/workos/types/user_management_organization_membership_statuses.rb
578
- - lib/workos/types/user_management_users_authorized_applications_order.rb
579
- - lib/workos/types/user_management_users_feature_flags_order.rb
580
- - lib/workos/types/user_management_users_order.rb
581
565
  - lib/workos/types/user_organization_membership_base_list_data_status.rb
582
566
  - lib/workos/types/user_organization_membership_status.rb
583
567
  - lib/workos/types/user_sessions_auth_method.rb
584
568
  - lib/workos/types/user_sessions_status.rb
585
- - lib/workos/types/vault_byok_key_verification_completed_data_key_provider.rb
569
+ - lib/workos/types/vault_byok_key_provider.rb
586
570
  - lib/workos/types/vault_data_created_data_actor_source.rb
587
571
  - lib/workos/types/vault_data_deleted_data_actor_source.rb
588
572
  - lib/workos/types/vault_data_read_data_actor_source.rb
@@ -595,7 +579,6 @@ files:
595
579
  - lib/workos/types/waitlist_user_state.rb
596
580
  - lib/workos/types/webhook_endpoint_json_status.rb
597
581
  - lib/workos/types/webhook_endpoint_status.rb
598
- - lib/workos/types/webhooks_order.rb
599
582
  - lib/workos/types/widget_session_token_scopes.rb
600
583
  - lib/workos/user_management.rb
601
584
  - lib/workos/user_management/action_authentication_denied.rb
@@ -661,6 +644,7 @@ files:
661
644
  - lib/workos/user_management/create_password_reset_token.rb
662
645
  - lib/workos/user_management/create_redirect_uri.rb
663
646
  - lib/workos/user_management/create_user.rb
647
+ - lib/workos/user_management/create_user_api_key.rb
664
648
  - lib/workos/user_management/create_user_invite_options.rb
665
649
  - lib/workos/user_management/create_user_organization_membership.rb
666
650
  - lib/workos/user_management/device_authorization_response.rb
@@ -715,6 +699,12 @@ files:
715
699
  - lib/workos/user_management/update_user.rb
716
700
  - lib/workos/user_management/update_user_organization_membership.rb
717
701
  - lib/workos/user_management/user.rb
702
+ - lib/workos/user_management/user_api_key.rb
703
+ - lib/workos/user_management/user_api_key_created_data_owner.rb
704
+ - lib/workos/user_management/user_api_key_owner.rb
705
+ - lib/workos/user_management/user_api_key_revoked_data_owner.rb
706
+ - lib/workos/user_management/user_api_key_with_value.rb
707
+ - lib/workos/user_management/user_api_key_with_value_owner.rb
718
708
  - lib/workos/user_management/user_created.rb
719
709
  - lib/workos/user_management/user_deleted.rb
720
710
  - lib/workos/user_management/user_identities_get_item.rb
@@ -729,6 +719,8 @@ files:
729
719
  - lib/workos/util.rb
730
720
  - lib/workos/util/signature.rb
731
721
  - lib/workos/vault.rb
722
+ - lib/workos/vault/vault_byok_key_deleted.rb
723
+ - lib/workos/vault/vault_byok_key_deleted_data.rb
732
724
  - lib/workos/vault/vault_byok_key_verification_completed.rb
733
725
  - lib/workos/vault/vault_byok_key_verification_completed_data.rb
734
726
  - lib/workos/vault/vault_data_created.rb
@@ -775,8 +767,6 @@ files:
775
767
  - rbi/workos/api_key_revoked_data.rbi
776
768
  - rbi/workos/api_key_revoked_data_owner.rbi
777
769
  - rbi/workos/api_key_validation_response.rbi
778
- - rbi/workos/api_key_with_value.rbi
779
- - rbi/workos/api_key_with_value_owner.rbi
780
770
  - rbi/workos/api_keys.rbi
781
771
  - rbi/workos/application_credentials_list_item.rbi
782
772
  - rbi/workos/assign_role.rbi
@@ -913,6 +903,7 @@ files:
913
903
  - rbi/workos/create_redirect_uri.rbi
914
904
  - rbi/workos/create_role.rbi
915
905
  - rbi/workos/create_user.rbi
906
+ - rbi/workos/create_user_api_key.rbi
916
907
  - rbi/workos/create_user_invite_options.rbi
917
908
  - rbi/workos/create_user_organization_membership.rbi
918
909
  - rbi/workos/create_webhook_endpoint.rbi
@@ -1042,6 +1033,10 @@ files:
1042
1033
  - rbi/workos/multi_factor_auth.rbi
1043
1034
  - rbi/workos/new_connect_application_secret.rbi
1044
1035
  - rbi/workos/organization.rbi
1036
+ - rbi/workos/organization_api_key.rbi
1037
+ - rbi/workos/organization_api_key_owner.rbi
1038
+ - rbi/workos/organization_api_key_with_value.rbi
1039
+ - rbi/workos/organization_api_key_with_value_owner.rbi
1045
1040
  - rbi/workos/organization_created.rbi
1046
1041
  - rbi/workos/organization_created_data.rbi
1047
1042
  - rbi/workos/organization_created_data_domain.rbi
@@ -1115,8 +1110,6 @@ files:
1115
1110
  - rbi/workos/reset_password_response.rbi
1116
1111
  - rbi/workos/revoke_session.rbi
1117
1112
  - rbi/workos/role.rbi
1118
- - rbi/workos/role_assignment.rbi
1119
- - rbi/workos/role_assignment_resource.rbi
1120
1113
  - rbi/workos/role_created.rbi
1121
1114
  - rbi/workos/role_created_data.rbi
1122
1115
  - rbi/workos/role_deleted.rbi
@@ -1162,6 +1155,12 @@ files:
1162
1155
  - rbi/workos/update_user_organization_membership.rbi
1163
1156
  - rbi/workos/update_webhook_endpoint.rbi
1164
1157
  - rbi/workos/user.rbi
1158
+ - rbi/workos/user_api_key.rbi
1159
+ - rbi/workos/user_api_key_created_data_owner.rbi
1160
+ - rbi/workos/user_api_key_owner.rbi
1161
+ - rbi/workos/user_api_key_revoked_data_owner.rbi
1162
+ - rbi/workos/user_api_key_with_value.rbi
1163
+ - rbi/workos/user_api_key_with_value_owner.rbi
1165
1164
  - rbi/workos/user_authentication_factor_enroll_response.rbi
1166
1165
  - rbi/workos/user_consent_option.rbi
1167
1166
  - rbi/workos/user_consent_option_choice.rbi
@@ -1175,12 +1174,16 @@ files:
1175
1174
  - rbi/workos/user_object.rbi
1176
1175
  - rbi/workos/user_organization_membership.rbi
1177
1176
  - rbi/workos/user_organization_membership_base_list_data.rbi
1177
+ - rbi/workos/user_role_assignment.rbi
1178
+ - rbi/workos/user_role_assignment_resource.rbi
1178
1179
  - rbi/workos/user_sessions_impersonator.rbi
1179
1180
  - rbi/workos/user_sessions_list_item.rbi
1180
1181
  - rbi/workos/user_updated.rbi
1181
1182
  - rbi/workos/util.rbi
1182
1183
  - rbi/workos/validate_api_key.rbi
1183
1184
  - rbi/workos/vault.rbi
1185
+ - rbi/workos/vault_byok_key_deleted.rbi
1186
+ - rbi/workos/vault_byok_key_deleted_data.rbi
1184
1187
  - rbi/workos/vault_byok_key_verification_completed.rbi
1185
1188
  - rbi/workos/vault_byok_key_verification_completed_data.rbi
1186
1189
  - rbi/workos/vault_data_created.rbi
@@ -1216,6 +1219,9 @@ files:
1216
1219
  - release-please-config.json
1217
1220
  - renovate.json
1218
1221
  - script/ci
1222
+ - script/docs
1223
+ - script/docs-serve
1224
+ - script/llms-txt
1219
1225
  - test/test_helper.rb
1220
1226
  - test/workos/test_actions.rb
1221
1227
  - test/workos/test_admin_portal.rb
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- AuthorizationOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- ConnectionsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- DirectoriesOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- DirectoryGroupsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- DirectoryUsersOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- FeatureFlagsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- OrganizationsApiKeysOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- OrganizationsFeatureFlagsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- OrganizationsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- PermissionsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- UserManagementInvitationsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- UserManagementMultiFactorAuthenticationOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- UserManagementOrganizationMembershipGroupsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- UserManagementOrganizationMembershipOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- UserManagementUsersAuthorizedApplicationsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- UserManagementUsersFeatureFlagsOrder = ApplicationsOrder
8
- end
9
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # This file is auto-generated by oagen. Do not edit.
4
-
5
- module WorkOS
6
- module Types
7
- UserManagementUsersOrder = ApplicationsOrder
8
- end
9
- end