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
data/lib/clerk/m2m.rb CHANGED
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def create_token(request:, retries: nil, timeout_ms: nil)
44
+ def create_token(request:, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # create_token - Create a M2M Token
44
46
  # Creates a new M2M Token. Must be authenticated via a Machine Secret Key.
45
47
  url, params = @sdk_configuration.get_server_details
@@ -101,6 +103,9 @@ module Clerk
101
103
  req.headers.merge!(headers)
102
104
  req.options.timeout = timeout unless timeout.nil?
103
105
  Utils.configure_request_security(req, security)
106
+ http_headers&.each do |key, value|
107
+ req.headers[key.to_s] = value
108
+ end
104
109
 
105
110
  @sdk_configuration.hooks.before_request(
106
111
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -199,10 +204,12 @@ module Clerk
199
204
 
200
205
 
201
206
 
202
- def list_tokens(request:, retries: nil, timeout_ms: nil)
207
+ def list_tokens(request:, retries: nil, timeout_ms: nil, http_headers: nil)
203
208
  # list_tokens - Get M2M Tokens
204
209
  # Fetches M2M tokens for a specific machine.
205
210
  #
211
+ # Only tokens created with the opaque token format are returned by this endpoint. JWT-format M2M tokens are stateless and are not stored.
212
+ #
206
213
  # This endpoint can be authenticated by either a Machine Secret Key or by a Clerk Secret Key.
207
214
  #
208
215
  # - When fetching M2M tokens with a Machine Secret Key, only tokens associated with the authenticated machine can be retrieved.
@@ -256,6 +263,9 @@ module Clerk
256
263
  req.options.timeout = timeout unless timeout.nil?
257
264
  req.params = query_params
258
265
  Utils.configure_request_security(req, security)
266
+ http_headers&.each do |key, value|
267
+ req.headers[key.to_s] = value
268
+ end
259
269
 
260
270
  @sdk_configuration.hooks.before_request(
261
271
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -369,10 +379,12 @@ module Clerk
369
379
 
370
380
 
371
381
 
372
- def revoke_token(body:, m2m_token_id:, retries: nil, timeout_ms: nil)
382
+ def revoke_token(body:, m2m_token_id:, retries: nil, timeout_ms: nil, http_headers: nil)
373
383
  # revoke_token - Revoke a M2M Token
374
384
  # Revokes a M2M Token.
375
385
  #
386
+ # This endpoint only revokes stored opaque-format M2M tokens. JWT-format M2M tokens are stateless and cannot be revoked.
387
+ #
376
388
  # This endpoint can be authenticated by either a Machine Secret Key or by a Clerk Secret Key.
377
389
  #
378
390
  # - When revoking a M2M Token with a Machine Secret Key, the token must managed by the Machine associated with the Machine Secret Key.
@@ -445,6 +457,9 @@ module Clerk
445
457
  req.headers.merge!(headers)
446
458
  req.options.timeout = timeout unless timeout.nil?
447
459
  Utils.configure_request_security(req, security)
460
+ http_headers&.each do |key, value|
461
+ req.headers[key.to_s] = value
462
+ end
448
463
 
449
464
  @sdk_configuration.hooks.before_request(
450
465
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -543,7 +558,7 @@ module Clerk
543
558
 
544
559
 
545
560
 
546
- def verify_token(request:, retries: nil, timeout_ms: nil)
561
+ def verify_token(request:, retries: nil, timeout_ms: nil, http_headers: nil)
547
562
  # verify_token - Verify a M2M Token
548
563
  # Verifies a M2M Token.
549
564
  #
@@ -610,6 +625,9 @@ module Clerk
610
625
  req.headers.merge!(headers)
611
626
  req.options.timeout = timeout unless timeout.nil?
612
627
  Utils.configure_request_security(req, security)
628
+ http_headers&.each do |key, value|
629
+ req.headers[key.to_s] = value
630
+ end
613
631
 
614
632
  @sdk_configuration.hooks.before_request(
615
633
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -705,5 +723,5 @@ module Clerk
705
723
 
706
724
  end
707
725
  end
708
- end
726
+ end
709
727
  end
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def list(limit: nil, offset: nil, query: nil, order_by: nil, retries: nil, timeout_ms: nil)
44
+ def list(limit: nil, offset: nil, query: nil, order_by: nil, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # list - Get a list of machines for an instance
44
46
  # This request returns the list of machines for an instance. The machines are
45
47
  # ordered by descending creation date (i.e. most recent machines will be
@@ -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: nil, retries: nil, timeout_ms: nil)
190
+ def create(request: nil, retries: nil, timeout_ms: nil, http_headers: nil)
186
191
  # create - Create a machine
187
192
  # Creates a new machine.
188
193
  url, params = @sdk_configuration.get_server_details
@@ -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(
@@ -326,7 +334,7 @@ module Clerk
326
334
 
327
335
 
328
336
 
329
- def get(machine_id:, retries: nil, timeout_ms: nil)
337
+ def get(machine_id:, retries: nil, timeout_ms: nil, http_headers: nil)
330
338
  # get - Retrieve a machine
331
339
  # Returns the details of a machine.
332
340
  request = Models::Operations::GetMachineRequest.new(
@@ -384,6 +392,9 @@ module Clerk
384
392
  req.headers.merge!(headers)
385
393
  req.options.timeout = timeout unless timeout.nil?
386
394
  Utils.configure_request_security(req, security)
395
+ http_headers&.each do |key, value|
396
+ req.headers[key.to_s] = value
397
+ end
387
398
 
388
399
  @sdk_configuration.hooks.before_request(
389
400
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -467,7 +478,7 @@ module Clerk
467
478
 
468
479
 
469
480
 
470
- def update(machine_id:, body: nil, retries: nil, timeout_ms: nil)
481
+ def update(machine_id:, body: nil, retries: nil, timeout_ms: nil, http_headers: nil)
471
482
  # update - Update a machine
472
483
  # Updates an existing machine.
473
484
  # Only the provided fields will be updated.
@@ -538,6 +549,9 @@ module Clerk
538
549
  req.headers.merge!(headers)
539
550
  req.options.timeout = timeout unless timeout.nil?
540
551
  Utils.configure_request_security(req, security)
552
+ http_headers&.each do |key, value|
553
+ req.headers[key.to_s] = value
554
+ end
541
555
 
542
556
  @sdk_configuration.hooks.before_request(
543
557
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -621,7 +635,7 @@ module Clerk
621
635
 
622
636
 
623
637
 
624
- def delete(machine_id:, retries: nil, timeout_ms: nil)
638
+ def delete(machine_id:, retries: nil, timeout_ms: nil, http_headers: nil)
625
639
  # delete - Delete a machine
626
640
  # Deletes a machine.
627
641
  request = Models::Operations::DeleteMachineRequest.new(
@@ -679,6 +693,9 @@ module Clerk
679
693
  req.headers.merge!(headers)
680
694
  req.options.timeout = timeout unless timeout.nil?
681
695
  Utils.configure_request_security(req, security)
696
+ http_headers&.each do |key, value|
697
+ req.headers[key.to_s] = value
698
+ end
682
699
 
683
700
  @sdk_configuration.hooks.before_request(
684
701
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -762,7 +779,7 @@ module Clerk
762
779
 
763
780
 
764
781
 
765
- def get_secret_key(machine_id:, retries: nil, timeout_ms: nil)
782
+ def get_secret_key(machine_id:, retries: nil, timeout_ms: nil, http_headers: nil)
766
783
  # get_secret_key - Retrieve a machine secret key
767
784
  # Returns the secret key for a machine.
768
785
  request = Models::Operations::GetMachineSecretKeyRequest.new(
@@ -820,6 +837,9 @@ module Clerk
820
837
  req.headers.merge!(headers)
821
838
  req.options.timeout = timeout unless timeout.nil?
822
839
  Utils.configure_request_security(req, security)
840
+ http_headers&.each do |key, value|
841
+ req.headers[key.to_s] = value
842
+ end
823
843
 
824
844
  @sdk_configuration.hooks.before_request(
825
845
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -903,7 +923,7 @@ module Clerk
903
923
 
904
924
 
905
925
 
906
- def rotate_secret_key(body:, machine_id:, retries: nil, timeout_ms: nil)
926
+ def rotate_secret_key(body:, machine_id:, retries: nil, timeout_ms: nil, http_headers: nil)
907
927
  # rotate_secret_key - Rotate a machine's secret key
908
928
  # Rotates the machine's secret key.
909
929
  # When the secret key is rotated, make sure to update it in your machine/application.
@@ -976,6 +996,9 @@ module Clerk
976
996
  req.headers.merge!(headers)
977
997
  req.options.timeout = timeout unless timeout.nil?
978
998
  Utils.configure_request_security(req, security)
999
+ http_headers&.each do |key, value|
1000
+ req.headers[key.to_s] = value
1001
+ end
979
1002
 
980
1003
  @sdk_configuration.hooks.before_request(
981
1004
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -1059,7 +1082,7 @@ module Clerk
1059
1082
 
1060
1083
 
1061
1084
 
1062
- def create_scope(machine_id:, body: nil, retries: nil, timeout_ms: nil)
1085
+ def create_scope(machine_id:, body: nil, retries: nil, timeout_ms: nil, http_headers: nil)
1063
1086
  # create_scope - Create a machine scope
1064
1087
  # Creates a new machine scope, allowing the specified machine to access another machine.
1065
1088
  # Maximum of 150 scopes per machine.
@@ -1130,6 +1153,9 @@ module Clerk
1130
1153
  req.headers.merge!(headers)
1131
1154
  req.options.timeout = timeout unless timeout.nil?
1132
1155
  Utils.configure_request_security(req, security)
1156
+ http_headers&.each do |key, value|
1157
+ req.headers[key.to_s] = value
1158
+ end
1133
1159
 
1134
1160
  @sdk_configuration.hooks.before_request(
1135
1161
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -1213,7 +1239,7 @@ module Clerk
1213
1239
 
1214
1240
 
1215
1241
 
1216
- def delete_scope(machine_id:, other_machine_id:, retries: nil, timeout_ms: nil)
1242
+ def delete_scope(machine_id:, other_machine_id:, retries: nil, timeout_ms: nil, http_headers: nil)
1217
1243
  # delete_scope - Delete a machine scope
1218
1244
  # Deletes a machine scope, removing access from one machine to another.
1219
1245
  request = Models::Operations::DeleteMachineScopeRequest.new(
@@ -1272,6 +1298,9 @@ module Clerk
1272
1298
  req.headers.merge!(headers)
1273
1299
  req.options.timeout = timeout unless timeout.nil?
1274
1300
  Utils.configure_request_security(req, security)
1301
+ http_headers&.each do |key, value|
1302
+ req.headers[key.to_s] = value
1303
+ end
1275
1304
 
1276
1305
  @sdk_configuration.hooks.before_request(
1277
1306
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -1352,5 +1381,5 @@ module Clerk
1352
1381
 
1353
1382
  end
1354
1383
  end
1355
- end
1384
+ end
1356
1385
  end
@@ -38,8 +38,10 @@ module Clerk
38
38
  end
39
39
 
40
40
 
41
+
42
+
41
43
 
42
- def get_public_interstitial(request:, retries: nil, timeout_ms: nil)
44
+ def get_public_interstitial(request:, retries: nil, timeout_ms: nil, http_headers: nil)
43
45
  # get_public_interstitial - Returns the markup for the interstitial page
44
46
  # The Clerk interstitial endpoint serves an html page that loads clerk.js in order to check the user's authentication state.
45
47
  # It is used by Clerk SDKs when the user's authentication state cannot be immediately determined.
@@ -89,6 +91,9 @@ module Clerk
89
91
  req.headers.merge!(headers)
90
92
  req.options.timeout = timeout unless timeout.nil?
91
93
  req.params = query_params
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(
@@ -145,5 +150,5 @@ module Clerk
145
150
 
146
151
  end
147
152
  end
148
- end
153
+ end
149
154
  end
@@ -0,0 +1,20 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Components
10
+ # Action - Whether to increase or decrease the credit balance.
11
+ class Action
12
+ include ::Crystalline::Enum
13
+ enums do
14
+ INCREASE = new('increase')
15
+ DECREASE = new('decrease')
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,11 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::Action
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::Action
11
+ end
@@ -0,0 +1,48 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Components
10
+
11
+ class AdjustCreditBalanceRequest
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # The credit amount in cents. Must be greater than zero.
16
+ field :amount, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount'), required: true } }
17
+ # Whether to increase or decrease the credit balance.
18
+ field :action, Models::Components::Action, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('action'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::Action, false) } }
19
+ # A unique key to ensure the adjustment is applied only once. Repeated requests with the same key return the original ledger entry.
20
+ field :idempotency_key, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idempotency_key'), required: true } }
21
+ # The currency code (e.g. "USD"). Defaults to USD if not provided.
22
+ field :currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('currency') } }
23
+ # An optional note to attach to the ledger entry.
24
+ field :note, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('note') } }
25
+
26
+
27
+ def initialize(amount:, action:, idempotency_key:, currency: nil, note: nil)
28
+ @amount = amount
29
+ @action = action
30
+ @idempotency_key = idempotency_key
31
+ @currency = currency
32
+ @note = note
33
+ end
34
+
35
+
36
+ def ==(other)
37
+ return false unless other.is_a? self.class
38
+ return false unless @amount == other.amount
39
+ return false unless @action == other.action
40
+ return false unless @idempotency_key == other.idempotency_key
41
+ return false unless @currency == other.currency
42
+ return false unless @note == other.note
43
+ true
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,21 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::AdjustCreditBalanceRequest
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::AdjustCreditBalanceRequest
11
+ def amount(); end
12
+ def amount=(str_); end
13
+ def action(); end
14
+ def action=(str_); end
15
+ def idempotency_key(); end
16
+ def idempotency_key=(str_); end
17
+ def currency(); end
18
+ def currency=(str_); end
19
+ def note(); end
20
+ def note=(str_); end
21
+ end
@@ -0,0 +1,47 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Components
10
+ # Success
11
+ class AgentTask
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+
16
+ field :object, Models::Components::AgentTaskObject, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('object'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Components::AgentTaskObject, false) } }
17
+ # A stable identifier for the agent, unique per agent_name within an instance.
18
+ #
19
+ field :agent_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('agent_id'), required: true } }
20
+ # A unique identifier for this agent task.
21
+ #
22
+ field :task_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('task_id'), required: true } }
23
+ # The URL that, when visited, creates a session for the user. Only present in the response to a create request.
24
+ #
25
+ field :url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('url') } }
26
+
27
+
28
+ def initialize(object:, agent_id:, task_id:, url: nil)
29
+ @object = object
30
+ @agent_id = agent_id
31
+ @task_id = task_id
32
+ @url = url
33
+ end
34
+
35
+
36
+ def ==(other)
37
+ return false unless other.is_a? self.class
38
+ return false unless @object == other.object
39
+ return false unless @agent_id == other.agent_id
40
+ return false unless @task_id == other.task_id
41
+ return false unless @url == other.url
42
+ true
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,19 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::AgentTask
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::AgentTask
11
+ def object(); end
12
+ def object=(str_); end
13
+ def agent_id(); end
14
+ def agent_id=(str_); end
15
+ def task_id(); end
16
+ def task_id=(str_); end
17
+ def url(); end
18
+ def url=(str_); end
19
+ end
@@ -0,0 +1,19 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Components
10
+
11
+ class AgentTaskObject
12
+ include ::Crystalline::Enum
13
+ enums do
14
+ AGENT_TASK = new('agent_task')
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,11 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::AgentTaskObject
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::AgentTaskObject
11
+ end
@@ -0,0 +1,44 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Components
10
+ # The current credit balance. Null when the payer has never had credits.
11
+ class Balance
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # The amount in cents.
16
+ field :amount, ::Integer, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount'), required: true } }
17
+ # The formatted amount as a string (e.g., "$49.99").
18
+ field :amount_formatted, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('amount_formatted'), required: true } }
19
+ # The currency code (e.g., "USD").
20
+ field :currency, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('currency'), required: true } }
21
+ # The currency symbol (e.g., "$").
22
+ field :currency_symbol, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('currency_symbol'), required: true } }
23
+
24
+
25
+ def initialize(amount:, amount_formatted:, currency:, currency_symbol:)
26
+ @amount = amount
27
+ @amount_formatted = amount_formatted
28
+ @currency = currency
29
+ @currency_symbol = currency_symbol
30
+ end
31
+
32
+
33
+ def ==(other)
34
+ return false unless other.is_a? self.class
35
+ return false unless @amount == other.amount
36
+ return false unless @amount_formatted == other.amount_formatted
37
+ return false unless @currency == other.currency
38
+ return false unless @currency_symbol == other.currency_symbol
39
+ true
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,19 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::Balance
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::Balance
11
+ def amount(); end
12
+ def amount=(str_); end
13
+ def amount_formatted(); end
14
+ def amount_formatted=(str_); end
15
+ def currency(); end
16
+ def currency=(str_); end
17
+ def currency_symbol(); end
18
+ def currency_symbol=(str_); end
19
+ end
@@ -56,9 +56,11 @@ module Clerk
56
56
  field :paid_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('paid_at'), required: true } }
57
57
  # Unix timestamp (in milliseconds) when the payment failed to be processed.
58
58
  field :failed_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('failed_at'), required: true } }
59
+ # Totals breakdown for this payment attempt.
60
+ field :totals, Crystalline::Nilable.new(Models::Components::BillingPaymentAttemptTotals), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('totals') } }
59
61
 
60
62
 
61
- def initialize(object:, id:, payment_id:, instance_id:, charge_type:, payee_id:, payee:, payer_id:, payer:, amount:, payment_method_id:, payment_method:, statement_id:, status:, created_at:, updated_at:, subscription_item_id: nil, subscription_item: nil, gateway_external_id: nil, gateway_external_url: nil, paid_at: nil, failed_at: nil)
63
+ def initialize(object:, id:, payment_id:, instance_id:, charge_type:, payee_id:, payee:, payer_id:, payer:, amount:, payment_method_id:, payment_method:, statement_id:, status:, created_at:, updated_at:, subscription_item_id: nil, subscription_item: nil, gateway_external_id: nil, gateway_external_url: nil, paid_at: nil, failed_at: nil, totals: nil)
62
64
  @object = object
63
65
  @id = id
64
66
  @payment_id = payment_id
@@ -81,6 +83,7 @@ module Clerk
81
83
  @gateway_external_url = gateway_external_url
82
84
  @paid_at = paid_at
83
85
  @failed_at = failed_at
86
+ @totals = totals
84
87
  end
85
88
 
86
89
 
@@ -108,6 +111,7 @@ module Clerk
108
111
  return false unless @gateway_external_url == other.gateway_external_url
109
112
  return false unless @paid_at == other.paid_at
110
113
  return false unless @failed_at == other.failed_at
114
+ return false unless @totals == other.totals
111
115
  true
112
116
  end
113
117
  end
@@ -52,4 +52,6 @@ class Clerk::Models::Components::BillingPaymentAttempt
52
52
  def paid_at=(str_); end
53
53
  def failed_at(); end
54
54
  def failed_at=(str_); end
55
+ def totals(); end
56
+ def totals=(str_); end
55
57
  end
@@ -0,0 +1,40 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Components
10
+
11
+ class BillingPaymentAttemptCredits
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+
16
+ field :total, Models::Components::CommerceMoneyResponse, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('total'), required: true } }
17
+
18
+ field :proration, Crystalline::Nilable.new(Models::Components::BillingPaymentAttemptProration), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('proration'), required: true } }
19
+
20
+ field :payer, Crystalline::Nilable.new(Models::Components::BillingPaymentAttemptPayer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('payer'), required: true } }
21
+
22
+
23
+ def initialize(total:, proration: nil, payer: nil)
24
+ @total = total
25
+ @proration = proration
26
+ @payer = payer
27
+ end
28
+
29
+
30
+ def ==(other)
31
+ return false unless other.is_a? self.class
32
+ return false unless @total == other.total
33
+ return false unless @proration == other.proration
34
+ return false unless @payer == other.payer
35
+ true
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,17 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::BillingPaymentAttemptCredits
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::BillingPaymentAttemptCredits
11
+ def total(); end
12
+ def total=(str_); end
13
+ def proration(); end
14
+ def proration=(str_); end
15
+ def payer(); end
16
+ def payer=(str_); end
17
+ end