clerk-sdk-ruby 5.1.2 → 5.1.3

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 (155) hide show
  1. checksums.yaml +4 -4
  2. data/lib/clerk/actortokens.rb +11 -3
  3. data/lib/clerk/agenttasks.rb +335 -0
  4. data/lib/clerk/allowlistidentifiers.rb +15 -4
  5. data/lib/clerk/api_keys.rb +35 -9
  6. data/lib/clerk/betafeatures.rb +11 -3
  7. data/lib/clerk/billing.rb +43 -11
  8. data/lib/clerk/blocklistidentifiers.rb +15 -4
  9. data/lib/clerk/clients.rb +15 -4
  10. data/lib/clerk/domains.rb +19 -5
  11. data/lib/clerk/emailaddresses.rb +21 -7
  12. data/lib/clerk/emailandsmstemplates.rb +7 -2
  13. data/lib/clerk/emailsmstemplates.rb +19 -5
  14. data/lib/clerk/instancesettings.rb +299 -8
  15. data/lib/clerk/invitations.rb +19 -5
  16. data/lib/clerk/jwks.rb +7 -2
  17. data/lib/clerk/jwttemplates.rb +23 -6
  18. data/lib/clerk/m2m.rb +23 -5
  19. data/lib/clerk/machines.rb +39 -10
  20. data/lib/clerk/miscellaneous.rb +7 -2
  21. data/lib/clerk/models/components/action.rb +20 -0
  22. data/lib/clerk/models/components/action.rbi +11 -0
  23. data/lib/clerk/models/components/adjustcreditbalancerequest.rb +48 -0
  24. data/lib/clerk/models/components/adjustcreditbalancerequest.rbi +21 -0
  25. data/lib/clerk/models/components/agenttask.rb +47 -0
  26. data/lib/clerk/models/components/agenttask.rbi +19 -0
  27. data/lib/clerk/models/components/agenttask_object.rb +19 -0
  28. data/lib/clerk/models/components/agenttask_object.rbi +11 -0
  29. data/lib/clerk/models/components/balance.rb +44 -0
  30. data/lib/clerk/models/components/balance.rbi +19 -0
  31. data/lib/clerk/models/components/billingpaymentattempt.rb +5 -1
  32. data/lib/clerk/models/components/billingpaymentattempt.rbi +2 -0
  33. data/lib/clerk/models/components/billingpaymentattempt_credits.rb +40 -0
  34. data/lib/clerk/models/components/billingpaymentattempt_credits.rbi +17 -0
  35. data/lib/clerk/models/components/billingpaymentattempt_payer.rb +36 -0
  36. data/lib/clerk/models/components/billingpaymentattempt_payer.rbi +15 -0
  37. data/lib/clerk/models/components/billingpaymentattempt_proration.rb +44 -0
  38. data/lib/clerk/models/components/billingpaymentattempt_proration.rbi +19 -0
  39. data/lib/clerk/models/components/billingpaymentattempt_totals.rb +52 -0
  40. data/lib/clerk/models/components/billingpaymentattempt_totals.rbi +23 -0
  41. data/lib/clerk/models/components/billingpriceresponse.rb +5 -1
  42. data/lib/clerk/models/components/billingpriceresponse.rbi +2 -0
  43. data/lib/clerk/models/components/billingstatement.rb +1 -1
  44. data/lib/clerk/models/components/{totals.rb → billingstatement_totals.rb} +6 -2
  45. data/lib/clerk/models/components/{totals.rbi → billingstatement_totals.rbi} +4 -2
  46. data/lib/clerk/models/components/commercecreditbalanceresponse.rb +36 -0
  47. data/lib/clerk/models/components/commercecreditbalanceresponse.rbi +15 -0
  48. data/lib/clerk/models/components/commercecreditledgerresponse.rb +64 -0
  49. data/lib/clerk/models/components/commercecreditledgerresponse.rbi +29 -0
  50. data/lib/clerk/models/components/commerceperunittotal.rb +40 -0
  51. data/lib/clerk/models/components/commerceperunittotal.rbi +17 -0
  52. data/lib/clerk/models/components/commerceperunittotaltier.rb +40 -0
  53. data/lib/clerk/models/components/commerceperunittotaltier.rbi +17 -0
  54. data/lib/clerk/models/components/commerceplan.rb +5 -1
  55. data/lib/clerk/models/components/commerceplan.rbi +2 -0
  56. data/lib/clerk/models/components/commerceplanunitprice.rb +40 -0
  57. data/lib/clerk/models/components/commerceplanunitprice.rbi +17 -0
  58. data/lib/clerk/models/components/commerceplanunitpricetier.rb +40 -0
  59. data/lib/clerk/models/components/commerceplanunitpricetier.rbi +17 -0
  60. data/lib/clerk/models/components/commercesubscriptionitem.rb +13 -1
  61. data/lib/clerk/models/components/commercesubscriptionitem.rbi +6 -0
  62. data/lib/clerk/models/components/commercesubscriptionitem_credits.rb +40 -0
  63. data/lib/clerk/models/components/commercesubscriptionitem_credits.rbi +17 -0
  64. data/lib/clerk/models/components/commercesubscriptionitem_payer.rb +36 -0
  65. data/lib/clerk/models/components/commercesubscriptionitem_payer.rbi +15 -0
  66. data/lib/clerk/models/components/commercesubscriptionitem_plan.rb +5 -1
  67. data/lib/clerk/models/components/commercesubscriptionitem_plan.rbi +2 -0
  68. data/lib/clerk/models/components/commercesubscriptionitem_proration.rb +44 -0
  69. data/lib/clerk/models/components/commercesubscriptionitem_proration.rbi +19 -0
  70. data/lib/clerk/models/components/commercesubscriptionitem_totals.rb +52 -0
  71. data/lib/clerk/models/components/commercesubscriptionitem_totals.rbi +23 -0
  72. data/lib/clerk/models/components/commercesubscriptionitem_totals_credits.rb +40 -0
  73. data/lib/clerk/models/components/commercesubscriptionitem_totals_credits.rbi +17 -0
  74. data/lib/clerk/models/components/commercesubscriptionitem_totals_payer.rb +36 -0
  75. data/lib/clerk/models/components/commercesubscriptionitem_totals_payer.rbi +15 -0
  76. data/lib/clerk/models/components/commercesubscriptionitem_totals_proration.rb +44 -0
  77. data/lib/clerk/models/components/commercesubscriptionitem_totals_proration.rbi +19 -0
  78. data/lib/clerk/models/components/oauthapplicationsettings.rb +40 -0
  79. data/lib/clerk/models/components/oauthapplicationsettings.rbi +17 -0
  80. data/lib/clerk/models/components/oauthapplicationsettings_object.rb +19 -0
  81. data/lib/clerk/models/components/oauthapplicationsettings_object.rbi +11 -0
  82. data/lib/clerk/models/components/schemas_commercesubscriptionitem.rb +1 -1
  83. data/lib/clerk/models/components/{payer.rb → schemas_commercesubscriptionitem_payer.rb} +1 -1
  84. data/lib/clerk/models/components/{payer.rbi → schemas_commercesubscriptionitem_payer.rbi} +2 -2
  85. data/lib/clerk/models/components/seats.rb +32 -0
  86. data/lib/clerk/models/components/seats.rbi +13 -0
  87. data/lib/clerk/models/components.rb +27 -2
  88. data/lib/clerk/models/operations/adjustorganizationbillingcreditbalance_request.rb +36 -0
  89. data/lib/clerk/models/operations/adjustorganizationbillingcreditbalance_request.rbi +15 -0
  90. data/lib/clerk/models/operations/adjustorganizationbillingcreditbalance_response.rb +44 -0
  91. data/lib/clerk/models/operations/adjustorganizationbillingcreditbalance_response.rbi +19 -0
  92. data/lib/clerk/models/operations/adjustuserbillingcreditbalance_request.rb +36 -0
  93. data/lib/clerk/models/operations/adjustuserbillingcreditbalance_request.rbi +15 -0
  94. data/lib/clerk/models/operations/adjustuserbillingcreditbalance_response.rb +44 -0
  95. data/lib/clerk/models/operations/adjustuserbillingcreditbalance_response.rbi +19 -0
  96. data/lib/clerk/models/operations/createagenttask_request.rb +60 -0
  97. data/lib/clerk/models/operations/createagenttask_request.rbi +23 -0
  98. data/lib/clerk/models/operations/createagenttask_response.rb +44 -0
  99. data/lib/clerk/models/operations/createagenttask_response.rbi +19 -0
  100. data/lib/clerk/models/operations/createm2mtoken_request.rb +5 -1
  101. data/lib/clerk/models/operations/createm2mtoken_request.rbi +2 -0
  102. data/lib/clerk/models/operations/getinstanceoauthapplicationsettings_response.rb +44 -0
  103. data/lib/clerk/models/operations/getinstanceoauthapplicationsettings_response.rbi +19 -0
  104. data/lib/clerk/models/operations/getorganizationbillingcreditbalance_request.rb +32 -0
  105. data/lib/clerk/models/operations/getorganizationbillingcreditbalance_request.rbi +13 -0
  106. data/lib/clerk/models/operations/getorganizationbillingcreditbalance_response.rb +44 -0
  107. data/lib/clerk/models/operations/getorganizationbillingcreditbalance_response.rbi +19 -0
  108. data/lib/clerk/models/operations/getuserbillingcreditbalance_request.rb +32 -0
  109. data/lib/clerk/models/operations/getuserbillingcreditbalance_request.rbi +13 -0
  110. data/lib/clerk/models/operations/getuserbillingcreditbalance_response.rb +44 -0
  111. data/lib/clerk/models/operations/getuserbillingcreditbalance_response.rbi +19 -0
  112. data/lib/clerk/models/operations/listinstanceorganizationinvitations_status.rb +1 -0
  113. data/lib/clerk/models/operations/listorganizationinvitations_status.rb +1 -0
  114. data/lib/clerk/models/operations/on_behalf_of.rb +37 -0
  115. data/lib/clerk/models/operations/on_behalf_of.rbi +15 -0
  116. data/lib/clerk/models/operations/permissions.rb +19 -0
  117. data/lib/clerk/models/operations/permissions.rbi +11 -0
  118. data/lib/clerk/models/operations/revokeagenttask_request.rb +32 -0
  119. data/lib/clerk/models/operations/revokeagenttask_request.rbi +13 -0
  120. data/lib/clerk/models/operations/revokeagenttask_response.rb +44 -0
  121. data/lib/clerk/models/operations/revokeagenttask_response.rbi +19 -0
  122. data/lib/clerk/models/operations/token_format.rb +20 -0
  123. data/lib/clerk/models/operations/token_format.rbi +11 -0
  124. data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_request.rb +36 -0
  125. data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_request.rbi +15 -0
  126. data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_response.rb +44 -0
  127. data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_response.rbi +19 -0
  128. data/lib/clerk/models/operations/usersgetorganizationinvitations_status.rb +1 -0
  129. data/lib/clerk/models/operations.rb +18 -0
  130. data/lib/clerk/oauthaccesstokens.rb +7 -2
  131. data/lib/clerk/oauthapplications.rb +27 -7
  132. data/lib/clerk/openapiclient.rb +4 -2
  133. data/lib/clerk/organizationdomains.rb +23 -6
  134. data/lib/clerk/organizationinvitations.rb +32 -9
  135. data/lib/clerk/organizationmemberships.rb +23 -6
  136. data/lib/clerk/organizationpermissions.rb +23 -6
  137. data/lib/clerk/organizationroles.rb +31 -8
  138. data/lib/clerk/organizations.rb +374 -11
  139. data/lib/clerk/phonenumbers.rb +19 -5
  140. data/lib/clerk/proxychecks.rb +7 -2
  141. data/lib/clerk/redirecturls.rb +19 -5
  142. data/lib/clerk/rolesets.rb +31 -8
  143. data/lib/clerk/samlconnections.rb +23 -6
  144. data/lib/clerk/sdkconfiguration.rb +3 -3
  145. data/lib/clerk/sessions.rb +35 -9
  146. data/lib/clerk/signintokens.rb +11 -3
  147. data/lib/clerk/signups.rb +11 -3
  148. data/lib/clerk/templates.rb +7 -2
  149. data/lib/clerk/testingtokens.rb +7 -2
  150. data/lib/clerk/users.rb +458 -32
  151. data/lib/clerk/waitlistentries.rb +27 -7
  152. data/lib/clerk/webhooks.rb +15 -4
  153. data/lib/clerk_sdk_ruby.rb +1 -0
  154. data/lib/crystalline/types.rb +11 -3
  155. metadata +107 -6
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def list(paginated: nil, limit: nil, offset: nil, retries: nil, timeout_ms: nil)
44
+ def list(paginated: nil, limit: nil, offset: nil, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # list - List all redirect URLs
44
46
  # Lists all whitelisted redirect_urls for the instance
45
47
  request = Models::Operations::ListRedirectURLsRequest.new(
@@ -96,6 +98,9 @@ module Clerk
96
98
  req.options.timeout = timeout unless timeout.nil?
97
99
  req.params = query_params
98
100
  Utils.configure_request_security(req, security)
101
+ http_headers&.each do |key, value|
102
+ req.headers[key.to_s] = value
103
+ end
99
104
 
100
105
  @sdk_configuration.hooks.before_request(
101
106
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -164,7 +169,7 @@ module Clerk
164
169
 
165
170
 
166
171
 
167
- def create(request: nil, retries: nil, timeout_ms: nil)
172
+ def create(request: nil, retries: nil, timeout_ms: nil, http_headers: nil)
168
173
  # create - Create a redirect URL
169
174
  # Create a redirect URL
170
175
  url, params = @sdk_configuration.get_server_details
@@ -225,6 +230,9 @@ module Clerk
225
230
  req.headers.merge!(headers)
226
231
  req.options.timeout = timeout unless timeout.nil?
227
232
  Utils.configure_request_security(req, security)
233
+ http_headers&.each do |key, value|
234
+ req.headers[key.to_s] = value
235
+ end
228
236
 
229
237
  @sdk_configuration.hooks.before_request(
230
238
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -308,7 +316,7 @@ module Clerk
308
316
 
309
317
 
310
318
 
311
- def get(id:, retries: nil, timeout_ms: nil)
319
+ def get(id:, retries: nil, timeout_ms: nil, http_headers: nil)
312
320
  # get - Retrieve a redirect URL
313
321
  # Retrieve the details of the redirect URL with the given ID
314
322
  request = Models::Operations::GetRedirectURLRequest.new(
@@ -366,6 +374,9 @@ module Clerk
366
374
  req.headers.merge!(headers)
367
375
  req.options.timeout = timeout unless timeout.nil?
368
376
  Utils.configure_request_security(req, security)
377
+ http_headers&.each do |key, value|
378
+ req.headers[key.to_s] = value
379
+ end
369
380
 
370
381
  @sdk_configuration.hooks.before_request(
371
382
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -449,7 +460,7 @@ module Clerk
449
460
 
450
461
 
451
462
 
452
- def delete(id:, retries: nil, timeout_ms: nil)
463
+ def delete(id:, retries: nil, timeout_ms: nil, http_headers: nil)
453
464
  # delete - Delete a redirect URL
454
465
  # Remove the selected redirect URL from the whitelist of the instance
455
466
  request = Models::Operations::DeleteRedirectURLRequest.new(
@@ -507,6 +518,9 @@ module Clerk
507
518
  req.headers.merge!(headers)
508
519
  req.options.timeout = timeout unless timeout.nil?
509
520
  Utils.configure_request_security(req, security)
521
+ http_headers&.each do |key, value|
522
+ req.headers[key.to_s] = value
523
+ end
510
524
 
511
525
  @sdk_configuration.hooks.before_request(
512
526
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -587,5 +601,5 @@ module Clerk
587
601
 
588
602
  end
589
603
  end
590
- end
604
+ end
591
605
  end
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def list(query: nil, order_by: nil, limit: nil, offset: nil, retries: nil, timeout_ms: nil)
44
+ def list(query: nil, order_by: nil, limit: nil, offset: nil, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # list - Get a list of role sets
44
46
  # Returns a list of role sets for the instance.
45
47
  # Results can be paginated using the optional `limit` and `offset` query parameters.
@@ -99,6 +101,9 @@ module Clerk
99
101
  req.options.timeout = timeout unless timeout.nil?
100
102
  req.params = query_params
101
103
  Utils.configure_request_security(req, security)
104
+ http_headers&.each do |key, value|
105
+ req.headers[key.to_s] = value
106
+ end
102
107
 
103
108
  @sdk_configuration.hooks.before_request(
104
109
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -182,7 +187,7 @@ module Clerk
182
187
 
183
188
 
184
189
 
185
- def create(request:, retries: nil, timeout_ms: nil)
190
+ def create(request:, retries: nil, timeout_ms: nil, http_headers: nil)
186
191
  # create - Create a role set
187
192
  # Creates a new role set with the given name and roles.
188
193
  # The key must be unique for the instance and start with the 'role_set:' prefix, followed by lowercase alphanumeric characters and underscores only.
@@ -246,6 +251,9 @@ module Clerk
246
251
  req.headers.merge!(headers)
247
252
  req.options.timeout = timeout unless timeout.nil?
248
253
  Utils.configure_request_security(req, security)
254
+ http_headers&.each do |key, value|
255
+ req.headers[key.to_s] = value
256
+ end
249
257
 
250
258
  @sdk_configuration.hooks.before_request(
251
259
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -329,7 +337,7 @@ module Clerk
329
337
 
330
338
 
331
339
 
332
- def get(role_set_key_or_id:, retries: nil, timeout_ms: nil)
340
+ def get(role_set_key_or_id:, retries: nil, timeout_ms: nil, http_headers: nil)
333
341
  # get - Retrieve a role set
334
342
  # Retrieves an existing role set by its key or ID.
335
343
  request = Models::Operations::GetRoleSetRequest.new(
@@ -387,6 +395,9 @@ module Clerk
387
395
  req.headers.merge!(headers)
388
396
  req.options.timeout = timeout unless timeout.nil?
389
397
  Utils.configure_request_security(req, security)
398
+ http_headers&.each do |key, value|
399
+ req.headers[key.to_s] = value
400
+ end
390
401
 
391
402
  @sdk_configuration.hooks.before_request(
392
403
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -470,7 +481,7 @@ module Clerk
470
481
 
471
482
 
472
483
 
473
- def update(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil)
484
+ def update(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil, http_headers: nil)
474
485
  # update - Update a role set
475
486
  # Updates an existing role set.
476
487
  # You can update the name, key, description, type, default role, or creator role.
@@ -543,6 +554,9 @@ module Clerk
543
554
  req.headers.merge!(headers)
544
555
  req.options.timeout = timeout unless timeout.nil?
545
556
  Utils.configure_request_security(req, security)
557
+ http_headers&.each do |key, value|
558
+ req.headers[key.to_s] = value
559
+ end
546
560
 
547
561
  @sdk_configuration.hooks.before_request(
548
562
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -626,7 +640,7 @@ module Clerk
626
640
 
627
641
 
628
642
 
629
- def replace(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil)
643
+ def replace(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil, http_headers: nil)
630
644
  # replace - Replace a role set
631
645
  # Replaces a role set with another role set. This is functionally equivalent to deleting
632
646
  # the role set but allows for atomic replacement with migration support.
@@ -699,6 +713,9 @@ module Clerk
699
713
  req.headers.merge!(headers)
700
714
  req.options.timeout = timeout unless timeout.nil?
701
715
  Utils.configure_request_security(req, security)
716
+ http_headers&.each do |key, value|
717
+ req.headers[key.to_s] = value
718
+ end
702
719
 
703
720
  @sdk_configuration.hooks.before_request(
704
721
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -782,7 +799,7 @@ module Clerk
782
799
 
783
800
 
784
801
 
785
- def add_roles(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil)
802
+ def add_roles(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil, http_headers: nil)
786
803
  # add_roles - Add roles to a role set
787
804
  # Adds one or more roles to an existing role set.
788
805
  # You can optionally update the default role or creator role when adding new roles.
@@ -854,6 +871,9 @@ module Clerk
854
871
  req.headers.merge!(headers)
855
872
  req.options.timeout = timeout unless timeout.nil?
856
873
  Utils.configure_request_security(req, security)
874
+ http_headers&.each do |key, value|
875
+ req.headers[key.to_s] = value
876
+ end
857
877
 
858
878
  @sdk_configuration.hooks.before_request(
859
879
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -937,7 +957,7 @@ module Clerk
937
957
 
938
958
 
939
959
 
940
- def replace_role(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil)
960
+ def replace_role(body:, role_set_key_or_id:, retries: nil, timeout_ms: nil, http_headers: nil)
941
961
  # replace_role - Replace a role in a role set
942
962
  # Replaces a role in a role set with another role. This atomically removes
943
963
  # the source role and reassigns any members to the destination role.
@@ -1009,6 +1029,9 @@ module Clerk
1009
1029
  req.headers.merge!(headers)
1010
1030
  req.options.timeout = timeout unless timeout.nil?
1011
1031
  Utils.configure_request_security(req, security)
1032
+ http_headers&.each do |key, value|
1033
+ req.headers[key.to_s] = value
1034
+ end
1012
1035
 
1013
1036
  @sdk_configuration.hooks.before_request(
1014
1037
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -1089,5 +1112,5 @@ module Clerk
1089
1112
 
1090
1113
  end
1091
1114
  end
1092
- end
1115
+ end
1093
1116
  end
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def list(request:, retries: nil, timeout_ms: nil)
44
+ def list(request:, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # list - Get a list of SAML Connections for an instance
44
46
  # Returns the list of SAML Connections for an instance.
45
47
  # Results can be paginated using the optional `limit` and `offset` query parameters.
@@ -93,6 +95,9 @@ module Clerk
93
95
  req.options.timeout = timeout unless timeout.nil?
94
96
  req.params = query_params
95
97
  Utils.configure_request_security(req, security)
98
+ http_headers&.each do |key, value|
99
+ req.headers[key.to_s] = value
100
+ end
96
101
 
97
102
  @sdk_configuration.hooks.before_request(
98
103
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -176,7 +181,7 @@ module Clerk
176
181
 
177
182
 
178
183
 
179
- def create(request: nil, retries: nil, timeout_ms: nil)
184
+ def create(request: nil, retries: nil, timeout_ms: nil, http_headers: nil)
180
185
  # create - Create a SAML Connection
181
186
  # Create a new SAML Connection.
182
187
  url, params = @sdk_configuration.get_server_details
@@ -237,6 +242,9 @@ module Clerk
237
242
  req.headers.merge!(headers)
238
243
  req.options.timeout = timeout unless timeout.nil?
239
244
  Utils.configure_request_security(req, security)
245
+ http_headers&.each do |key, value|
246
+ req.headers[key.to_s] = value
247
+ end
240
248
 
241
249
  @sdk_configuration.hooks.before_request(
242
250
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -320,7 +328,7 @@ module Clerk
320
328
 
321
329
 
322
330
 
323
- def get(saml_connection_id:, retries: nil, timeout_ms: nil)
331
+ def get(saml_connection_id:, retries: nil, timeout_ms: nil, http_headers: nil)
324
332
  # get - Retrieve a SAML Connection by ID
325
333
  # Fetches the SAML Connection whose ID matches the provided `saml_connection_id` in the path.
326
334
  request = Models::Operations::GetSAMLConnectionRequest.new(
@@ -378,6 +386,9 @@ module Clerk
378
386
  req.headers.merge!(headers)
379
387
  req.options.timeout = timeout unless timeout.nil?
380
388
  Utils.configure_request_security(req, security)
389
+ http_headers&.each do |key, value|
390
+ req.headers[key.to_s] = value
391
+ end
381
392
 
382
393
  @sdk_configuration.hooks.before_request(
383
394
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -461,7 +472,7 @@ module Clerk
461
472
 
462
473
 
463
474
 
464
- def update(body:, saml_connection_id:, retries: nil, timeout_ms: nil)
475
+ def update(body:, saml_connection_id:, retries: nil, timeout_ms: nil, http_headers: nil)
465
476
  # update - Update a SAML Connection
466
477
  # Updates the SAML Connection whose ID matches the provided `id` in the path.
467
478
  request = Models::Operations::UpdateSAMLConnectionRequest.new(
@@ -532,6 +543,9 @@ module Clerk
532
543
  req.headers.merge!(headers)
533
544
  req.options.timeout = timeout unless timeout.nil?
534
545
  Utils.configure_request_security(req, security)
546
+ http_headers&.each do |key, value|
547
+ req.headers[key.to_s] = value
548
+ end
535
549
 
536
550
  @sdk_configuration.hooks.before_request(
537
551
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -615,7 +629,7 @@ module Clerk
615
629
 
616
630
 
617
631
 
618
- def delete(saml_connection_id:, retries: nil, timeout_ms: nil)
632
+ def delete(saml_connection_id:, retries: nil, timeout_ms: nil, http_headers: nil)
619
633
  # delete - Delete a SAML Connection
620
634
  # Deletes the SAML Connection whose ID matches the provided `id` in the path.
621
635
  request = Models::Operations::DeleteSAMLConnectionRequest.new(
@@ -673,6 +687,9 @@ module Clerk
673
687
  req.headers.merge!(headers)
674
688
  req.options.timeout = timeout unless timeout.nil?
675
689
  Utils.configure_request_security(req, security)
690
+ http_headers&.each do |key, value|
691
+ req.headers[key.to_s] = value
692
+ end
676
693
 
677
694
  @sdk_configuration.hooks.before_request(
678
695
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -753,5 +770,5 @@ module Clerk
753
770
 
754
771
  end
755
772
  end
756
- end
773
+ end
757
774
  end
@@ -77,9 +77,9 @@ module Clerk
77
77
  end
78
78
  @language = 'ruby'
79
79
  @openapi_doc_version = '2025-11-10'
80
- @sdk_version = '5.1.2'
81
- @gen_version = '2.832.2'
82
- @user_agent = 'speakeasy-sdk/ruby 5.1.2 2.832.2 2025-11-10 clerk-sdk-ruby'
80
+ @sdk_version = '5.1.3'
81
+ @gen_version = '2.855.2'
82
+ @user_agent = 'speakeasy-sdk/ruby 5.1.3 2.855.2 2025-11-10 clerk-sdk-ruby'
83
83
  end
84
84
 
85
85
 
@@ -38,11 +38,16 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def list(request:, retries: nil, timeout_ms: nil)
44
+ def list(request:, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # list - List all sessions
44
- # Returns a list of all sessions.
46
+ # Returns a list of sessions matching the provided criteria.
45
47
  # The sessions are returned sorted by creation date, with the newest sessions appearing first.
48
+ #
49
+ # Note: This endpoint does not return all sessions that have ever existed. Old and inactive sessions are periodically cleaned up and will not be included in the results.
50
+ #
46
51
  # **Deprecation Notice (2024-01-01):** All parameters were initially considered optional, however
47
52
  # moving forward at least one of `client_id` or `user_id` parameters should be provided.
48
53
  url, params = @sdk_configuration.get_server_details
@@ -94,6 +99,9 @@ module Clerk
94
99
  req.options.timeout = timeout unless timeout.nil?
95
100
  req.params = query_params
96
101
  Utils.configure_request_security(req, security)
102
+ http_headers&.each do |key, value|
103
+ req.headers[key.to_s] = value
104
+ end
97
105
 
98
106
  @sdk_configuration.hooks.before_request(
99
107
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -177,7 +185,7 @@ module Clerk
177
185
 
178
186
 
179
187
 
180
- def create(request: nil, retries: nil, timeout_ms: nil)
188
+ def create(request: nil, retries: nil, timeout_ms: nil, http_headers: nil)
181
189
  # create - Create a new active session
182
190
  # Create a new active session for the provided user ID.
183
191
  #
@@ -241,6 +249,9 @@ module Clerk
241
249
  req.headers.merge!(headers)
242
250
  req.options.timeout = timeout unless timeout.nil?
243
251
  Utils.configure_request_security(req, security)
252
+ http_headers&.each do |key, value|
253
+ req.headers[key.to_s] = value
254
+ end
244
255
 
245
256
  @sdk_configuration.hooks.before_request(
246
257
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -324,7 +335,7 @@ module Clerk
324
335
 
325
336
 
326
337
 
327
- def get(session_id:, retries: nil, timeout_ms: nil)
338
+ def get(session_id:, retries: nil, timeout_ms: nil, http_headers: nil)
328
339
  # get - Retrieve a session
329
340
  # Retrieve the details of a session
330
341
  request = Models::Operations::GetSessionRequest.new(
@@ -382,6 +393,9 @@ module Clerk
382
393
  req.headers.merge!(headers)
383
394
  req.options.timeout = timeout unless timeout.nil?
384
395
  Utils.configure_request_security(req, security)
396
+ http_headers&.each do |key, value|
397
+ req.headers[key.to_s] = value
398
+ end
385
399
 
386
400
  @sdk_configuration.hooks.before_request(
387
401
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -465,7 +479,7 @@ module Clerk
465
479
 
466
480
 
467
481
 
468
- def refresh(session_id:, body: nil, retries: nil, timeout_ms: nil)
482
+ def refresh(session_id:, body: nil, retries: nil, timeout_ms: nil, http_headers: nil)
469
483
  # refresh - Refresh a session
470
484
  # Refreshes a session by creating a new session token. A 401 is returned when there
471
485
  # are validation errors, which signals the SDKs to fall back to the handshake flow.
@@ -536,6 +550,9 @@ module Clerk
536
550
  req.headers.merge!(headers)
537
551
  req.options.timeout = timeout unless timeout.nil?
538
552
  Utils.configure_request_security(req, security)
553
+ http_headers&.each do |key, value|
554
+ req.headers[key.to_s] = value
555
+ end
539
556
 
540
557
  @sdk_configuration.hooks.before_request(
541
558
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -619,7 +636,7 @@ module Clerk
619
636
 
620
637
 
621
638
 
622
- def revoke(session_id:, retries: nil, timeout_ms: nil)
639
+ def revoke(session_id:, retries: nil, timeout_ms: nil, http_headers: nil)
623
640
  # revoke - Revoke a session
624
641
  # Sets the status of a session as "revoked", which is an unauthenticated state.
625
642
  # In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.
@@ -678,6 +695,9 @@ module Clerk
678
695
  req.headers.merge!(headers)
679
696
  req.options.timeout = timeout unless timeout.nil?
680
697
  Utils.configure_request_security(req, security)
698
+ http_headers&.each do |key, value|
699
+ req.headers[key.to_s] = value
700
+ end
681
701
 
682
702
  @sdk_configuration.hooks.before_request(
683
703
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -761,7 +781,7 @@ module Clerk
761
781
 
762
782
 
763
783
 
764
- def create_token(session_id:, body: nil, retries: nil, timeout_ms: nil)
784
+ def create_token(session_id:, body: nil, retries: nil, timeout_ms: nil, http_headers: nil)
765
785
  # create_token - Create a session token
766
786
  # Creates a session JSON Web Token (JWT) based on a session.
767
787
  request = Models::Operations::CreateSessionTokenRequest.new(
@@ -831,6 +851,9 @@ module Clerk
831
851
  req.headers.merge!(headers)
832
852
  req.options.timeout = timeout unless timeout.nil?
833
853
  Utils.configure_request_security(req, security)
854
+ http_headers&.each do |key, value|
855
+ req.headers[key.to_s] = value
856
+ end
834
857
 
835
858
  @sdk_configuration.hooks.before_request(
836
859
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -914,7 +937,7 @@ module Clerk
914
937
 
915
938
 
916
939
 
917
- def create_token_from_template(session_id:, template_name:, body: nil, retries: nil, timeout_ms: nil)
940
+ def create_token_from_template(session_id:, template_name:, body: nil, retries: nil, timeout_ms: nil, http_headers: nil)
918
941
  # create_token_from_template - Create a session token from a JWT template
919
942
  # Creates a JSON Web Token (JWT) based on a session and a JWT Template name defined for your instance
920
943
  request = Models::Operations::CreateSessionTokenFromTemplateRequest.new(
@@ -985,6 +1008,9 @@ module Clerk
985
1008
  req.headers.merge!(headers)
986
1009
  req.options.timeout = timeout unless timeout.nil?
987
1010
  Utils.configure_request_security(req, security)
1011
+ http_headers&.each do |key, value|
1012
+ req.headers[key.to_s] = value
1013
+ end
988
1014
 
989
1015
  @sdk_configuration.hooks.before_request(
990
1016
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -1065,5 +1091,5 @@ module Clerk
1065
1091
 
1066
1092
  end
1067
1093
  end
1068
- end
1094
+ end
1069
1095
  end
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def create(request: nil, retries: nil, timeout_ms: nil)
44
+ def create(request: nil, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # create - Create sign-in token
44
46
  # Creates a new sign-in token and associates it with the given user.
45
47
  # By default, sign-in tokens expire in 30 days.
@@ -102,6 +104,9 @@ module Clerk
102
104
  req.headers.merge!(headers)
103
105
  req.options.timeout = timeout unless timeout.nil?
104
106
  Utils.configure_request_security(req, security)
107
+ http_headers&.each do |key, value|
108
+ req.headers[key.to_s] = value
109
+ end
105
110
 
106
111
  @sdk_configuration.hooks.before_request(
107
112
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -185,7 +190,7 @@ module Clerk
185
190
 
186
191
 
187
192
 
188
- def revoke(sign_in_token_id:, retries: nil, timeout_ms: nil)
193
+ def revoke(sign_in_token_id:, retries: nil, timeout_ms: nil, http_headers: nil)
189
194
  # revoke - Revoke the given sign-in token
190
195
  # Revokes a pending sign-in token
191
196
  request = Models::Operations::RevokeSignInTokenRequest.new(
@@ -243,6 +248,9 @@ module Clerk
243
248
  req.headers.merge!(headers)
244
249
  req.options.timeout = timeout unless timeout.nil?
245
250
  Utils.configure_request_security(req, security)
251
+ http_headers&.each do |key, value|
252
+ req.headers[key.to_s] = value
253
+ end
246
254
 
247
255
  @sdk_configuration.hooks.before_request(
248
256
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -323,5 +331,5 @@ module Clerk
323
331
 
324
332
  end
325
333
  end
326
- end
334
+ end
327
335
  end
data/lib/clerk/signups.rb CHANGED
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def get(id:, retries: nil, timeout_ms: nil)
44
+ def get(id:, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # get - Retrieve a sign-up by ID
44
46
  # Retrieve the details of the sign-up with the given ID
45
47
  request = Models::Operations::GetSignUpRequest.new(
@@ -97,6 +99,9 @@ module Clerk
97
99
  req.headers.merge!(headers)
98
100
  req.options.timeout = timeout unless timeout.nil?
99
101
  Utils.configure_request_security(req, security)
102
+ http_headers&.each do |key, value|
103
+ req.headers[key.to_s] = value
104
+ end
100
105
 
101
106
  @sdk_configuration.hooks.before_request(
102
107
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -180,7 +185,7 @@ module Clerk
180
185
 
181
186
 
182
187
 
183
- def update(id:, body: nil, retries: nil, timeout_ms: nil)
188
+ def update(id:, body: nil, retries: nil, timeout_ms: nil, http_headers: nil)
184
189
  # update - Update a sign-up
185
190
  # Update the sign-up with the given ID
186
191
  request = Models::Operations::UpdateSignUpRequest.new(
@@ -250,6 +255,9 @@ module Clerk
250
255
  req.headers.merge!(headers)
251
256
  req.options.timeout = timeout unless timeout.nil?
252
257
  Utils.configure_request_security(req, security)
258
+ http_headers&.each do |key, value|
259
+ req.headers[key.to_s] = value
260
+ end
253
261
 
254
262
  @sdk_configuration.hooks.before_request(
255
263
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -330,5 +338,5 @@ module Clerk
330
338
 
331
339
  end
332
340
  end
333
- end
341
+ end
334
342
  end
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def preview(template_type:, slug:, body: nil, retries: nil, timeout_ms: nil)
44
+ def preview(template_type:, slug:, body: nil, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # preview - Preview changes to a template
44
46
  # Returns a preview of a template for a given template_type, slug and body
45
47
  #
@@ -112,6 +114,9 @@ module Clerk
112
114
  req.headers.merge!(headers)
113
115
  req.options.timeout = timeout unless timeout.nil?
114
116
  Utils.configure_request_security(req, security)
117
+ http_headers&.each do |key, value|
118
+ req.headers[key.to_s] = value
119
+ end
115
120
 
116
121
  @sdk_configuration.hooks.before_request(
117
122
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -192,5 +197,5 @@ module Clerk
192
197
 
193
198
  end
194
199
  end
195
- end
200
+ end
196
201
  end
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def create(retries: nil, timeout_ms: nil)
44
+ def create(retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # create - Retrieve a new testing token
44
46
  # Retrieve a new testing token.
45
47
  url, params = @sdk_configuration.get_server_details
@@ -89,6 +91,9 @@ module Clerk
89
91
  req.headers.merge!(headers)
90
92
  req.options.timeout = timeout unless timeout.nil?
91
93
  Utils.configure_request_security(req, security)
94
+ http_headers&.each do |key, value|
95
+ req.headers[key.to_s] = value
96
+ end
92
97
 
93
98
  @sdk_configuration.hooks.before_request(
94
99
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -154,5 +159,5 @@ module Clerk
154
159
 
155
160
  end
156
161
  end
157
- end
162
+ end
158
163
  end