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
@@ -0,0 +1,11 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::OAuthApplicationSettingsObject
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::OAuthApplicationSettingsObject
11
+ end
@@ -53,7 +53,7 @@ module Clerk
53
53
  # Information about the next payment.
54
54
  field :next_payment, Crystalline::Nilable.new(Models::Components::SchemasCommerceSubscriptionItemNextPayment), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('next_payment') } }
55
55
  # The payer associated with this subscription.
56
- field :payer, Crystalline::Nilable.new(Models::Components::Payer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('payer') } }
56
+ field :payer, Crystalline::Nilable.new(Models::Components::SchemasCommerceSubscriptionItemPayer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('payer') } }
57
57
  # Unix timestamp (in milliseconds) when the current period started.
58
58
  field :period_start, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('period_start') } }
59
59
  # Unix timestamp (in milliseconds) when the current period ends.
@@ -8,7 +8,7 @@ module Clerk
8
8
  module Models
9
9
  module Components
10
10
  # The payer associated with this subscription.
11
- class Payer
11
+ class SchemasCommerceSubscriptionItemPayer
12
12
 
13
13
  include Crystalline::MetadataFields
14
14
 
@@ -2,12 +2,12 @@
2
2
  # frozen_string_literal: true
3
3
 
4
4
 
5
- class Clerk::Models::Components::Payer
5
+ class Clerk::Models::Components::SchemasCommerceSubscriptionItemPayer
6
6
  extend ::Crystalline::MetadataFields::ClassMethods
7
7
  end
8
8
 
9
9
 
10
- class Clerk::Models::Components::Payer
10
+ class Clerk::Models::Components::SchemasCommerceSubscriptionItemPayer
11
11
  def object(); end
12
12
  def object=(str_); end
13
13
  def id(); end
@@ -0,0 +1,32 @@
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
+ # Seat quantity for seat-based billing.
11
+ class Seats
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # Seat quantity being billed; null means unlimited
16
+ field :quantity, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('quantity'), required: true } }
17
+
18
+
19
+ def initialize(quantity: nil)
20
+ @quantity = quantity
21
+ end
22
+
23
+
24
+ def ==(other)
25
+ return false unless other.is_a? self.class
26
+ return false unless @quantity == other.quantity
27
+ true
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,13 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Components::Seats
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Components::Seats
11
+ def quantity(); end
12
+ def quantity=(str_); end
13
+ end
@@ -10,16 +10,24 @@ module Clerk
10
10
  autoload :ActorTokenActor, 'clerk/models/components/actortoken_actor.rb'
11
11
  autoload :ActorTokenObject, 'clerk/models/components/actortoken_object.rb'
12
12
  autoload :ActorTokenStatus, 'clerk/models/components/actortoken_status.rb'
13
+ autoload :AdjustCreditBalanceRequest, 'clerk/models/components/adjustcreditbalancerequest.rb'
14
+ autoload :AgentTask, 'clerk/models/components/agenttask.rb'
15
+ autoload :AgentTaskObject, 'clerk/models/components/agenttask_object.rb'
13
16
  autoload :AllowlistIdentifier, 'clerk/models/components/allowlistidentifier.rb'
14
17
  autoload :AllowlistIdentifierIdentifierType, 'clerk/models/components/allowlistidentifier_identifier_type.rb'
15
18
  autoload :AllowlistIdentifierObject, 'clerk/models/components/allowlistidentifier_object.rb'
16
19
  autoload :BillingPaymentAttempt, 'clerk/models/components/billingpaymentattempt.rb'
20
+ autoload :BillingPaymentAttemptCredits, 'clerk/models/components/billingpaymentattempt_credits.rb'
17
21
  autoload :BillingPaymentAttemptObject, 'clerk/models/components/billingpaymentattempt_object.rb'
22
+ autoload :BillingPaymentAttemptPayer, 'clerk/models/components/billingpaymentattempt_payer.rb'
23
+ autoload :BillingPaymentAttemptProration, 'clerk/models/components/billingpaymentattempt_proration.rb'
18
24
  autoload :BillingPaymentAttemptStatus, 'clerk/models/components/billingpaymentattempt_status.rb'
25
+ autoload :BillingPaymentAttemptTotals, 'clerk/models/components/billingpaymentattempt_totals.rb'
19
26
  autoload :BillingPriceResponse, 'clerk/models/components/billingpriceresponse.rb'
20
27
  autoload :BillingPriceResponseObject, 'clerk/models/components/billingpriceresponse_object.rb'
21
28
  autoload :BillingStatement, 'clerk/models/components/billingstatement.rb'
22
29
  autoload :BillingStatementStatus, 'clerk/models/components/billingstatement_status.rb'
30
+ autoload :BillingStatementTotals, 'clerk/models/components/billingstatement_totals.rb'
23
31
  autoload :BlocklistIdentifier, 'clerk/models/components/blocklistidentifier.rb'
24
32
  autoload :BlocklistIdentifierIdentifierType, 'clerk/models/components/blocklistidentifier_identifier_type.rb'
25
33
  autoload :BlocklistIdentifierObject, 'clerk/models/components/blocklistidentifier_object.rb'
@@ -30,13 +38,19 @@ module Clerk
30
38
  autoload :ClerkErrorsMeta, 'clerk/models/components/clerkerrors_meta.rb'
31
39
  autoload :Client, 'clerk/models/components/client.rb'
32
40
  autoload :ClientObject, 'clerk/models/components/client_object.rb'
41
+ autoload :CommerceCreditBalanceResponse, 'clerk/models/components/commercecreditbalanceresponse.rb'
42
+ autoload :CommerceCreditLedgerResponse, 'clerk/models/components/commercecreditledgerresponse.rb'
33
43
  autoload :CommerceMoneyResponse, 'clerk/models/components/commercemoneyresponse.rb'
34
44
  autoload :CommercePayerResponse, 'clerk/models/components/commercepayerresponse.rb'
35
45
  autoload :CommercePayerResponseObject, 'clerk/models/components/commercepayerresponse_object.rb'
36
46
  autoload :CommercePaymentMethodResponse, 'clerk/models/components/commercepaymentmethodresponse.rb'
37
47
  autoload :CommercePaymentMethodResponseObject, 'clerk/models/components/commercepaymentmethodresponse_object.rb'
38
48
  autoload :CommercePaymentMethodResponseStatus, 'clerk/models/components/commercepaymentmethodresponse_status.rb'
49
+ autoload :CommercePerUnitTotal, 'clerk/models/components/commerceperunittotal.rb'
50
+ autoload :CommercePerUnitTotalTier, 'clerk/models/components/commerceperunittotaltier.rb'
39
51
  autoload :CommercePlan, 'clerk/models/components/commerceplan.rb'
52
+ autoload :CommercePlanUnitPrice, 'clerk/models/components/commerceplanunitprice.rb'
53
+ autoload :CommercePlanUnitPriceTier, 'clerk/models/components/commerceplanunitpricetier.rb'
40
54
  autoload :CommercePlanObject, 'clerk/models/components/commerceplan_object.rb'
41
55
  autoload :CommercePriceTransitionDetails, 'clerk/models/components/commercepricetransitiondetails.rb'
42
56
  autoload :CommercePriceTransitionResponse, 'clerk/models/components/commercepricetransitionresponse.rb'
@@ -48,12 +62,19 @@ module Clerk
48
62
  autoload :CommerceSubscriptionItemAmount, 'clerk/models/components/commercesubscriptionitem_amount.rb'
49
63
  autoload :CommerceSubscriptionItemAnnualFee, 'clerk/models/components/commercesubscriptionitem_annual_fee.rb'
50
64
  autoload :CommerceSubscriptionItemAnnualMonthlyFee, 'clerk/models/components/commercesubscriptionitem_annual_monthly_fee.rb'
65
+ autoload :CommerceSubscriptionItemCredits, 'clerk/models/components/commercesubscriptionitem_credits.rb'
51
66
  autoload :CommerceSubscriptionItemNextPayment, 'clerk/models/components/commercesubscriptionitem_next_payment.rb'
52
67
  autoload :CommerceSubscriptionItemObject, 'clerk/models/components/commercesubscriptionitem_object.rb'
53
68
  autoload :CommerceSubscriptionItemObjectCommercePlan, 'clerk/models/components/commercesubscriptionitem_object_commerceplan.rb'
69
+ autoload :CommerceSubscriptionItemPayer, 'clerk/models/components/commercesubscriptionitem_payer.rb'
54
70
  autoload :CommerceSubscriptionItemPlan, 'clerk/models/components/commercesubscriptionitem_plan.rb'
55
71
  autoload :CommerceSubscriptionItemPlanPeriod, 'clerk/models/components/commercesubscriptionitem_plan_period.rb'
72
+ autoload :CommerceSubscriptionItemProration, 'clerk/models/components/commercesubscriptionitem_proration.rb'
56
73
  autoload :CommerceSubscriptionItemStatus, 'clerk/models/components/commercesubscriptionitem_status.rb'
74
+ autoload :CommerceSubscriptionItemTotals, 'clerk/models/components/commercesubscriptionitem_totals.rb'
75
+ autoload :CommerceSubscriptionItemTotalsCredits, 'clerk/models/components/commercesubscriptionitem_totals_credits.rb'
76
+ autoload :CommerceSubscriptionItemTotalsPayer, 'clerk/models/components/commercesubscriptionitem_totals_payer.rb'
77
+ autoload :CommerceSubscriptionItemTotalsProration, 'clerk/models/components/commercesubscriptionitem_totals_proration.rb'
57
78
  autoload :CommerceSubscriptionNextPayment, 'clerk/models/components/commercesubscriptionnextpayment.rb'
58
79
  autoload :CommerceSubscriptionObject, 'clerk/models/components/commercesubscription_object.rb'
59
80
  autoload :CommerceSubscriptionStatus, 'clerk/models/components/commercesubscription_status.rb'
@@ -159,6 +180,8 @@ module Clerk
159
180
  autoload :OAuthAccessToken, 'clerk/models/components/oauthaccesstoken.rb'
160
181
  autoload :OAuthAccessTokenObject, 'clerk/models/components/oauthaccesstoken_object.rb'
161
182
  autoload :OAuthApplication, 'clerk/models/components/oauthapplication.rb'
183
+ autoload :OAuthApplicationSettings, 'clerk/models/components/oauthapplicationsettings.rb'
184
+ autoload :OAuthApplicationSettingsObject, 'clerk/models/components/oauthapplicationsettings_object.rb'
162
185
  autoload :OAuthApplicationWithSecret, 'clerk/models/components/oauthapplicationwithsecret.rb'
163
186
  autoload :OAuthApplicationWithSecretObject, 'clerk/models/components/oauthapplicationwithsecret_object.rb'
164
187
  autoload :OAuthApplicationObject, 'clerk/models/components/oauthapplication_object.rb'
@@ -288,8 +311,10 @@ module Clerk
288
311
  autoload :Web3WalletVerificationAdminObject, 'clerk/models/components/web3wallet_verification_admin_object.rb'
289
312
  autoload :Web3WalletVerificationAdminStatus, 'clerk/models/components/web3wallet_verification_admin_status.rb'
290
313
  autoload :Web3WalletVerificationAdminStrategy, 'clerk/models/components/web3wallet_verification_admin_strategy.rb'
314
+ autoload :Action, 'clerk/models/components/action.rb'
291
315
  autoload :AnnualFee, 'clerk/models/components/annual_fee.rb'
292
316
  autoload :AnnualMonthlyFee, 'clerk/models/components/annual_monthly_fee.rb'
317
+ autoload :Balance, 'clerk/models/components/balance.rb'
293
318
  autoload :Claims, 'clerk/models/components/claims.rb'
294
319
  autoload :CreatorRole, 'clerk/models/components/creator_role.rb'
295
320
  autoload :Credit, 'clerk/models/components/credit.rb'
@@ -312,7 +337,6 @@ module Clerk
312
337
  autoload :ObjectCommerceStatementGroup, 'clerk/models/components/object_commercestatementgroup.rb'
313
338
  autoload :ObjectRoleSetMigration, 'clerk/models/components/object_rolesetmigration.rb'
314
339
  autoload :Payee, 'clerk/models/components/payee.rb'
315
- autoload :Payer, 'clerk/models/components/payer.rb'
316
340
  autoload :PaymentMethod, 'clerk/models/components/payment_method.rb'
317
341
  autoload :PaymentSource, 'clerk/models/components/payment_source.rb'
318
342
  autoload :PaymentType, 'clerk/models/components/payment_type.rb'
@@ -330,6 +354,7 @@ module Clerk
330
354
  autoload :SchemasCommerceSubscriptionItemObjectCommercePayer, 'clerk/models/components/schemas_commercesubscriptionitem_object_commercepayer.rb'
331
355
  autoload :SchemasCommerceSubscriptionItemObjectCommercePlan, 'clerk/models/components/schemas_commercesubscriptionitem_object_commerceplan.rb'
332
356
  autoload :SchemasCommerceSubscriptionItemObjectCommerceSubscriptionItem, 'clerk/models/components/schemas_commercesubscriptionitem_object_commercesubscriptionitem.rb'
357
+ autoload :SchemasCommerceSubscriptionItemPayer, 'clerk/models/components/schemas_commercesubscriptionitem_payer.rb'
333
358
  autoload :SchemasCommerceSubscriptionItemPlan, 'clerk/models/components/schemas_commercesubscriptionitem_plan.rb'
334
359
  autoload :SchemasCommerceSubscriptionItemPlanPeriod, 'clerk/models/components/schemas_commercesubscriptionitem_plan_period.rb'
335
360
  autoload :SchemasCommerceSubscriptionItemStatus, 'clerk/models/components/schemas_commercesubscriptionitem_status.rb'
@@ -340,10 +365,10 @@ module Clerk
340
365
  autoload :SchemasSAMLConnectionSAMLConnection2, 'clerk/models/components/schemas_samlconnection_samlconnection_2.rb'
341
366
  autoload :SchemasSAMLConnectionObject1, 'clerk/models/components/schemas_samlconnection_object_1.rb'
342
367
  autoload :SchemasSAMLConnectionObject2, 'clerk/models/components/schemas_samlconnection_object_2.rb'
368
+ autoload :Seats, 'clerk/models/components/seats.rb'
343
369
  autoload :StatusCommerceSource, 'clerk/models/components/status_commercesource.rb'
344
370
  autoload :StatusResponse, 'clerk/models/components/status_response.rb'
345
371
  autoload :SubscriptionItem, 'clerk/models/components/subscription_item.rb'
346
- autoload :Totals, 'clerk/models/components/totals.rb'
347
372
  autoload :Type, 'clerk/models/components/type.rb'
348
373
  autoload :VerificationEmailLinkObject, 'clerk/models/components/verification_email_link_object.rb'
349
374
  autoload :VerificationEmailLinkStatus, 'clerk/models/components/verification_email_link_status.rb'
@@ -0,0 +1,36 @@
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 Operations
10
+
11
+ class AdjustOrganizationBillingCreditBalanceRequest
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # The ID of the organization whose credit balance to adjust
16
+ field :organization_id, ::String, { 'path_param': { 'field_name': 'organization_id', 'style': 'simple', 'explode': false } }
17
+ # Parameters for the credit balance adjustment
18
+ field :body, Models::Components::AdjustCreditBalanceRequest, { 'request': { 'media_type': 'application/json' } }
19
+
20
+
21
+ def initialize(organization_id:, body:)
22
+ @organization_id = organization_id
23
+ @body = body
24
+ end
25
+
26
+
27
+ def ==(other)
28
+ return false unless other.is_a? self.class
29
+ return false unless @organization_id == other.organization_id
30
+ return false unless @body == other.body
31
+ true
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,15 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Operations::AdjustOrganizationBillingCreditBalanceRequest
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::AdjustOrganizationBillingCreditBalanceRequest
11
+ def organization_id(); end
12
+ def organization_id=(str_); end
13
+ def body(); end
14
+ def body=(str_); end
15
+ 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 Operations
10
+
11
+ class AdjustOrganizationBillingCreditBalanceResponse
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # HTTP response content type for this operation
16
+ field :content_type, ::String
17
+ # HTTP response status code for this operation
18
+ field :status_code, ::Integer
19
+ # Raw HTTP response; suitable for custom response parsing
20
+ field :raw_response, ::Faraday::Response
21
+ # A credit ledger entry.
22
+ field :commerce_credit_ledger_response, Crystalline::Nilable.new(Models::Components::CommerceCreditLedgerResponse)
23
+
24
+
25
+ def initialize(content_type:, status_code:, raw_response:, commerce_credit_ledger_response: nil)
26
+ @content_type = content_type
27
+ @status_code = status_code
28
+ @raw_response = raw_response
29
+ @commerce_credit_ledger_response = commerce_credit_ledger_response
30
+ end
31
+
32
+
33
+ def ==(other)
34
+ return false unless other.is_a? self.class
35
+ return false unless @content_type == other.content_type
36
+ return false unless @status_code == other.status_code
37
+ return false unless @raw_response == other.raw_response
38
+ return false unless @commerce_credit_ledger_response == other.commerce_credit_ledger_response
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::Operations::AdjustOrganizationBillingCreditBalanceResponse
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::AdjustOrganizationBillingCreditBalanceResponse
11
+ def content_type(); end
12
+ def content_type=(str_); end
13
+ def status_code(); end
14
+ def status_code=(str_); end
15
+ def raw_response(); end
16
+ def raw_response=(str_); end
17
+ def commerce_credit_ledger_response(); end
18
+ def commerce_credit_ledger_response=(str_); end
19
+ end
@@ -0,0 +1,36 @@
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 Operations
10
+
11
+ class AdjustUserBillingCreditBalanceRequest
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # The ID of the user whose credit balance to adjust
16
+ field :user_id, ::String, { 'path_param': { 'field_name': 'user_id', 'style': 'simple', 'explode': false } }
17
+ # Parameters for the credit balance adjustment
18
+ field :body, Models::Components::AdjustCreditBalanceRequest, { 'request': { 'media_type': 'application/json' } }
19
+
20
+
21
+ def initialize(user_id:, body:)
22
+ @user_id = user_id
23
+ @body = body
24
+ end
25
+
26
+
27
+ def ==(other)
28
+ return false unless other.is_a? self.class
29
+ return false unless @user_id == other.user_id
30
+ return false unless @body == other.body
31
+ true
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,15 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Operations::AdjustUserBillingCreditBalanceRequest
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::AdjustUserBillingCreditBalanceRequest
11
+ def user_id(); end
12
+ def user_id=(str_); end
13
+ def body(); end
14
+ def body=(str_); end
15
+ 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 Operations
10
+
11
+ class AdjustUserBillingCreditBalanceResponse
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # HTTP response content type for this operation
16
+ field :content_type, ::String
17
+ # HTTP response status code for this operation
18
+ field :status_code, ::Integer
19
+ # Raw HTTP response; suitable for custom response parsing
20
+ field :raw_response, ::Faraday::Response
21
+ # A credit ledger entry.
22
+ field :commerce_credit_ledger_response, Crystalline::Nilable.new(Models::Components::CommerceCreditLedgerResponse)
23
+
24
+
25
+ def initialize(content_type:, status_code:, raw_response:, commerce_credit_ledger_response: nil)
26
+ @content_type = content_type
27
+ @status_code = status_code
28
+ @raw_response = raw_response
29
+ @commerce_credit_ledger_response = commerce_credit_ledger_response
30
+ end
31
+
32
+
33
+ def ==(other)
34
+ return false unless other.is_a? self.class
35
+ return false unless @content_type == other.content_type
36
+ return false unless @status_code == other.status_code
37
+ return false unless @raw_response == other.raw_response
38
+ return false unless @commerce_credit_ledger_response == other.commerce_credit_ledger_response
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::Operations::AdjustUserBillingCreditBalanceResponse
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::AdjustUserBillingCreditBalanceResponse
11
+ def content_type(); end
12
+ def content_type=(str_); end
13
+ def status_code(); end
14
+ def status_code=(str_); end
15
+ def raw_response(); end
16
+ def raw_response=(str_); end
17
+ def commerce_credit_ledger_response(); end
18
+ def commerce_credit_ledger_response=(str_); end
19
+ end
@@ -0,0 +1,60 @@
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 Operations
10
+
11
+ class CreateAgentTaskRequest
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # Identifies the user on whose behalf the agent task is created.
16
+ # Exactly one of user_id or identifier must be provided.
17
+ field :on_behalf_of, Models::Operations::OnBehalfOf, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('on_behalf_of'), required: true } }
18
+ # The permissions granted to the agent task. Must be "*" (all permissions).
19
+ field :permissions, Models::Operations::Permissions, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('permissions'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Operations::Permissions, false) } }
20
+ # A name identifying the agent. Used to derive a stable agent_id per instance.
21
+ # Logged for audit purposes.
22
+ field :agent_name, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('agent_name'), required: true } }
23
+ # A description of the task being performed. Logged for audit purposes.
24
+ field :task_description, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('task_description'), required: true } }
25
+ # The URL the user is redirected to after the agent task is accepted.
26
+ # Must be a valid absolute URL with an `https` scheme in production instances.
27
+ # In development instances, `http` is also permitted.
28
+ # The URL's domain must belong to one of the instance's associated domains
29
+ # (primary or satellite); otherwise the redirect will be rejected when the
30
+ # task ticket is consumed.
31
+ field :redirect_url, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redirect_url'), required: true } }
32
+ # The maximum duration that the session which will be created by the generated agent task should last.
33
+ # By default, the duration of a session created via an agent task lasts 30 minutes.
34
+ field :session_max_duration_in_seconds, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('session_max_duration_in_seconds') } }
35
+
36
+
37
+ def initialize(on_behalf_of:, permissions:, agent_name:, task_description:, redirect_url:, session_max_duration_in_seconds: 1800)
38
+ @on_behalf_of = on_behalf_of
39
+ @permissions = permissions
40
+ @agent_name = agent_name
41
+ @task_description = task_description
42
+ @redirect_url = redirect_url
43
+ @session_max_duration_in_seconds = session_max_duration_in_seconds
44
+ end
45
+
46
+
47
+ def ==(other)
48
+ return false unless other.is_a? self.class
49
+ return false unless @on_behalf_of == other.on_behalf_of
50
+ return false unless @permissions == other.permissions
51
+ return false unless @agent_name == other.agent_name
52
+ return false unless @task_description == other.task_description
53
+ return false unless @redirect_url == other.redirect_url
54
+ return false unless @session_max_duration_in_seconds == other.session_max_duration_in_seconds
55
+ true
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
@@ -0,0 +1,23 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Operations::CreateAgentTaskRequest
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::CreateAgentTaskRequest
11
+ def on_behalf_of(); end
12
+ def on_behalf_of=(str_); end
13
+ def permissions(); end
14
+ def permissions=(str_); end
15
+ def agent_name(); end
16
+ def agent_name=(str_); end
17
+ def task_description(); end
18
+ def task_description=(str_); end
19
+ def redirect_url(); end
20
+ def redirect_url=(str_); end
21
+ def session_max_duration_in_seconds(); end
22
+ def session_max_duration_in_seconds=(str_); end
23
+ 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 Operations
10
+
11
+ class CreateAgentTaskResponse
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # HTTP response content type for this operation
16
+ field :content_type, ::String
17
+ # HTTP response status code for this operation
18
+ field :status_code, ::Integer
19
+ # Raw HTTP response; suitable for custom response parsing
20
+ field :raw_response, ::Faraday::Response
21
+ # Success
22
+ field :agent_task, Crystalline::Nilable.new(Models::Components::AgentTask)
23
+
24
+
25
+ def initialize(content_type:, status_code:, raw_response:, agent_task: nil)
26
+ @content_type = content_type
27
+ @status_code = status_code
28
+ @raw_response = raw_response
29
+ @agent_task = agent_task
30
+ end
31
+
32
+
33
+ def ==(other)
34
+ return false unless other.is_a? self.class
35
+ return false unless @content_type == other.content_type
36
+ return false unless @status_code == other.status_code
37
+ return false unless @raw_response == other.raw_response
38
+ return false unless @agent_task == other.agent_task
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::Operations::CreateAgentTaskResponse
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::CreateAgentTaskResponse
11
+ def content_type(); end
12
+ def content_type=(str_); end
13
+ def status_code(); end
14
+ def status_code=(str_); end
15
+ def raw_response(); end
16
+ def raw_response=(str_); end
17
+ def agent_task(); end
18
+ def agent_task=(str_); end
19
+ end
@@ -13,12 +13,15 @@ module Clerk
13
13
  include Crystalline::MetadataFields
14
14
 
15
15
 
16
+ field :token_format, Crystalline::Nilable.new(Models::Operations::TokenFormat), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('token_format'), 'decoder': ::Clerk::Utils.enum_from_string(Models::Operations::TokenFormat, true) } }
17
+
16
18
  field :seconds_until_expiration, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('seconds_until_expiration') } }
17
19
 
18
20
  field :claims, Crystalline::Nilable.new(::Object), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('claims') } }
19
21
 
20
22
 
21
- def initialize(seconds_until_expiration: nil, claims: nil)
23
+ def initialize(token_format: Models::Operations::TokenFormat::OPAQUE, seconds_until_expiration: nil, claims: nil)
24
+ @token_format = token_format
22
25
  @seconds_until_expiration = seconds_until_expiration
23
26
  @claims = claims
24
27
  end
@@ -26,6 +29,7 @@ module Clerk
26
29
 
27
30
  def ==(other)
28
31
  return false unless other.is_a? self.class
32
+ return false unless @token_format == other.token_format
29
33
  return false unless @seconds_until_expiration == other.seconds_until_expiration
30
34
  return false unless @claims == other.claims
31
35
  true
@@ -8,6 +8,8 @@ end
8
8
 
9
9
 
10
10
  class Clerk::Models::Operations::CreateM2MTokenRequest
11
+ def token_format(); end
12
+ def token_format=(str_); end
11
13
  def seconds_until_expiration(); end
12
14
  def seconds_until_expiration=(str_); end
13
15
  def claims(); end