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(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 all organization permissions
44
46
  # Retrieves all organization permissions for the given instance.
45
47
  request = Models::Operations::ListOrganizationPermissionsRequest.new(
@@ -97,6 +99,9 @@ module Clerk
97
99
  req.options.timeout = timeout unless timeout.nil?
98
100
  req.params = query_params
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 create(request:, retries: nil, timeout_ms: nil)
188
+ def create(request:, retries: nil, timeout_ms: nil, http_headers: nil)
184
189
  # create - Create a new organization permission
185
190
  # Creates a new organization permission for the given instance.
186
191
  url, params = @sdk_configuration.get_server_details
@@ -242,6 +247,9 @@ module Clerk
242
247
  req.headers.merge!(headers)
243
248
  req.options.timeout = timeout unless timeout.nil?
244
249
  Utils.configure_request_security(req, security)
250
+ http_headers&.each do |key, value|
251
+ req.headers[key.to_s] = value
252
+ end
245
253
 
246
254
  @sdk_configuration.hooks.before_request(
247
255
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -325,7 +333,7 @@ module Clerk
325
333
 
326
334
 
327
335
 
328
- def get(permission_id:, retries: nil, timeout_ms: nil)
336
+ def get(permission_id:, retries: nil, timeout_ms: nil, http_headers: nil)
329
337
  # get - Get an organization permission
330
338
  # Retrieves the details of an organization permission.
331
339
  request = Models::Operations::GetOrganizationPermissionRequest.new(
@@ -383,6 +391,9 @@ module Clerk
383
391
  req.headers.merge!(headers)
384
392
  req.options.timeout = timeout unless timeout.nil?
385
393
  Utils.configure_request_security(req, security)
394
+ http_headers&.each do |key, value|
395
+ req.headers[key.to_s] = value
396
+ end
386
397
 
387
398
  @sdk_configuration.hooks.before_request(
388
399
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -466,7 +477,7 @@ module Clerk
466
477
 
467
478
 
468
479
 
469
- def update(body:, permission_id:, retries: nil, timeout_ms: nil)
480
+ def update(body:, permission_id:, retries: nil, timeout_ms: nil, http_headers: nil)
470
481
  # update - Update an organization permission
471
482
  # Updates the properties of an existing organization permission.
472
483
  # System permissions cannot 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(permission_id:, retries: nil, timeout_ms: nil)
638
+ def delete(permission_id:, retries: nil, timeout_ms: nil, http_headers: nil)
625
639
  # delete - Delete an organization permission
626
640
  # Deletes an organization permission.
627
641
  # System permissions cannot be deleted.
@@ -680,6 +694,9 @@ module Clerk
680
694
  req.headers.merge!(headers)
681
695
  req.options.timeout = timeout unless timeout.nil?
682
696
  Utils.configure_request_security(req, security)
697
+ http_headers&.each do |key, value|
698
+ req.headers[key.to_s] = value
699
+ end
683
700
 
684
701
  @sdk_configuration.hooks.before_request(
685
702
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -760,5 +777,5 @@ module Clerk
760
777
 
761
778
  end
762
779
  end
763
- end
780
+ end
764
781
  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 organization roles
44
46
  # This request returns the list of organization roles for the instance.
45
47
  # Results can be paginated using the optional `limit` and `offset` query parameters.
@@ -100,6 +102,9 @@ module Clerk
100
102
  req.options.timeout = timeout unless timeout.nil?
101
103
  req.params = query_params
102
104
  Utils.configure_request_security(req, security)
105
+ http_headers&.each do |key, value|
106
+ req.headers[key.to_s] = value
107
+ end
103
108
 
104
109
  @sdk_configuration.hooks.before_request(
105
110
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -183,7 +188,7 @@ module Clerk
183
188
 
184
189
 
185
190
 
186
- def create(request:, retries: nil, timeout_ms: nil)
191
+ def create(request:, retries: nil, timeout_ms: nil, http_headers: nil)
187
192
  # create - Create an organization role
188
193
  # Creates a new organization role with the given name and permissions for an instance.
189
194
  # The key must be unique for the instance and start with the 'org:' prefix, followed by lowercase alphanumeric characters and underscores only.
@@ -248,6 +253,9 @@ module Clerk
248
253
  req.headers.merge!(headers)
249
254
  req.options.timeout = timeout unless timeout.nil?
250
255
  Utils.configure_request_security(req, security)
256
+ http_headers&.each do |key, value|
257
+ req.headers[key.to_s] = value
258
+ end
251
259
 
252
260
  @sdk_configuration.hooks.before_request(
253
261
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -331,7 +339,7 @@ module Clerk
331
339
 
332
340
 
333
341
 
334
- def get(organization_role_id:, retries: nil, timeout_ms: nil)
342
+ def get(organization_role_id:, retries: nil, timeout_ms: nil, http_headers: nil)
335
343
  # get - Retrieve an organization role
336
344
  # Use this request to retrieve an existing organization role by its ID.
337
345
  request = Models::Operations::GetOrganizationRoleRequest.new(
@@ -389,6 +397,9 @@ module Clerk
389
397
  req.headers.merge!(headers)
390
398
  req.options.timeout = timeout unless timeout.nil?
391
399
  Utils.configure_request_security(req, security)
400
+ http_headers&.each do |key, value|
401
+ req.headers[key.to_s] = value
402
+ end
392
403
 
393
404
  @sdk_configuration.hooks.before_request(
394
405
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -472,7 +483,7 @@ module Clerk
472
483
 
473
484
 
474
485
 
475
- def update(body:, organization_role_id:, retries: nil, timeout_ms: nil)
486
+ def update(body:, organization_role_id:, retries: nil, timeout_ms: nil, http_headers: nil)
476
487
  # update - Update an organization role
477
488
  # Updates an existing organization role.
478
489
  # You can update the name, key, description, and permissions of the role.
@@ -546,6 +557,9 @@ module Clerk
546
557
  req.headers.merge!(headers)
547
558
  req.options.timeout = timeout unless timeout.nil?
548
559
  Utils.configure_request_security(req, security)
560
+ http_headers&.each do |key, value|
561
+ req.headers[key.to_s] = value
562
+ end
549
563
 
550
564
  @sdk_configuration.hooks.before_request(
551
565
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -629,7 +643,7 @@ module Clerk
629
643
 
630
644
 
631
645
 
632
- def delete(organization_role_id:, retries: nil, timeout_ms: nil)
646
+ def delete(organization_role_id:, retries: nil, timeout_ms: nil, http_headers: nil)
633
647
  # delete - Delete an organization role
634
648
  # Deletes the organization role.
635
649
  # The role cannot be deleted if it is currently used as the default creator role, domain default role, assigned to any members, or exists in any invitations.
@@ -688,6 +702,9 @@ module Clerk
688
702
  req.headers.merge!(headers)
689
703
  req.options.timeout = timeout unless timeout.nil?
690
704
  Utils.configure_request_security(req, security)
705
+ http_headers&.each do |key, value|
706
+ req.headers[key.to_s] = value
707
+ end
691
708
 
692
709
  @sdk_configuration.hooks.before_request(
693
710
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -771,7 +788,7 @@ module Clerk
771
788
 
772
789
 
773
790
 
774
- def assign_permission(organization_role_id:, permission_id:, retries: nil, timeout_ms: nil)
791
+ def assign_permission(organization_role_id:, permission_id:, retries: nil, timeout_ms: nil, http_headers: nil)
775
792
  # assign_permission - Assign a permission to an organization role
776
793
  # Assigns a permission to an organization role
777
794
  request = Models::Operations::AssignPermissionToOrganizationRoleRequest.new(
@@ -830,6 +847,9 @@ module Clerk
830
847
  req.headers.merge!(headers)
831
848
  req.options.timeout = timeout unless timeout.nil?
832
849
  Utils.configure_request_security(req, security)
850
+ http_headers&.each do |key, value|
851
+ req.headers[key.to_s] = value
852
+ end
833
853
 
834
854
  @sdk_configuration.hooks.before_request(
835
855
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -913,7 +933,7 @@ module Clerk
913
933
 
914
934
 
915
935
 
916
- def remove_permission(organization_role_id:, permission_id:, retries: nil, timeout_ms: nil)
936
+ def remove_permission(organization_role_id:, permission_id:, retries: nil, timeout_ms: nil, http_headers: nil)
917
937
  # remove_permission - Remove a permission from an organization role
918
938
  # Removes a permission from an organization role
919
939
  request = Models::Operations::RemovePermissionFromOrganizationRoleRequest.new(
@@ -972,6 +992,9 @@ module Clerk
972
992
  req.headers.merge!(headers)
973
993
  req.options.timeout = timeout unless timeout.nil?
974
994
  Utils.configure_request_security(req, security)
995
+ http_headers&.each do |key, value|
996
+ req.headers[key.to_s] = value
997
+ end
975
998
 
976
999
  @sdk_configuration.hooks.before_request(
977
1000
  hook_ctx: SDKHooks::BeforeRequestHookContext.new(
@@ -1052,5 +1075,5 @@ module Clerk
1052
1075
 
1053
1076
  end
1054
1077
  end
1055
- end
1078
+ end
1056
1079
  end