clerk-http-client 0.0.1

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 (518) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +87 -0
  4. data/README.md +360 -0
  5. data/Rakefile +10 -0
  6. data/bin/fmt +5 -0
  7. data/bin/generate +8 -0
  8. data/bin/setup +7 -0
  9. data/clerk-http-client.gemspec +41 -0
  10. data/docs/ActorToken.md +34 -0
  11. data/docs/ActorTokensApi.md +147 -0
  12. data/docs/AddDomainRequest.md +22 -0
  13. data/docs/Admin.md +24 -0
  14. data/docs/AllowListBlockListApi.md +421 -0
  15. data/docs/AllowlistIdentifier.md +32 -0
  16. data/docs/BetaFeaturesApi.md +217 -0
  17. data/docs/BlocklistIdentifier.md +30 -0
  18. data/docs/BlocklistIdentifiers.md +20 -0
  19. data/docs/CNameTarget.md +22 -0
  20. data/docs/ChangeProductionInstanceDomainRequest.md +20 -0
  21. data/docs/ClerkError.md +26 -0
  22. data/docs/ClerkErrors.md +20 -0
  23. data/docs/Client.md +34 -0
  24. data/docs/ClientsApi.md +221 -0
  25. data/docs/CreateActorTokenRequest.md +24 -0
  26. data/docs/CreateAllowlistIdentifierRequest.md +20 -0
  27. data/docs/CreateBlocklistIdentifierRequest.md +18 -0
  28. data/docs/CreateEmailAddressRequest.md +24 -0
  29. data/docs/CreateInvitationRequest.md +28 -0
  30. data/docs/CreateJWTTemplateRequest.md +30 -0
  31. data/docs/CreateOAuthApplicationRequest.md +24 -0
  32. data/docs/CreateOrganizationDomainRequest.md +22 -0
  33. data/docs/CreateOrganizationInvitationBulkRequestInner.md +28 -0
  34. data/docs/CreateOrganizationInvitationRequest.md +28 -0
  35. data/docs/CreateOrganizationMembershipRequest.md +20 -0
  36. data/docs/CreateOrganizationRequest.md +30 -0
  37. data/docs/CreatePhoneNumberRequest.md +26 -0
  38. data/docs/CreateRedirectURLRequest.md +18 -0
  39. data/docs/CreateSAMLConnectionRequest.md +34 -0
  40. data/docs/CreateSAMLConnectionRequestAttributeMapping.md +24 -0
  41. data/docs/CreateSessionTokenFromTemplate200Response.md +20 -0
  42. data/docs/CreateSignInTokenRequest.md +20 -0
  43. data/docs/CreateUserRequest.md +62 -0
  44. data/docs/DeletedObject.md +24 -0
  45. data/docs/DisableMFA200Response.md +18 -0
  46. data/docs/Domain.md +34 -0
  47. data/docs/Domains.md +20 -0
  48. data/docs/DomainsApi.md +286 -0
  49. data/docs/EmailAddress.md +32 -0
  50. data/docs/EmailAddressVerification.md +51 -0
  51. data/docs/EmailAddressesApi.md +289 -0
  52. data/docs/EmailSMSTemplatesApi.md +449 -0
  53. data/docs/GetOAuthAccessToken200ResponseInner.md +34 -0
  54. data/docs/IdentificationLink.md +20 -0
  55. data/docs/InstanceRestrictions.md +26 -0
  56. data/docs/InstanceSettingsApi.md +216 -0
  57. data/docs/Invitation.md +36 -0
  58. data/docs/InvitationsApi.md +223 -0
  59. data/docs/JWKSApi.md +74 -0
  60. data/docs/JWTTemplate.md +36 -0
  61. data/docs/JWTTemplatesApi.md +354 -0
  62. data/docs/MergeOrganizationMetadataRequest.md +20 -0
  63. data/docs/MiscellaneousApi.md +75 -0
  64. data/docs/OAuthApplication.md +42 -0
  65. data/docs/OAuthApplicationWithSecret.md +44 -0
  66. data/docs/OAuthApplications.md +20 -0
  67. data/docs/OAuthApplicationsApi.md +433 -0
  68. data/docs/OTP.md +24 -0
  69. data/docs/Oauth.md +28 -0
  70. data/docs/OauthError.md +47 -0
  71. data/docs/Organization.md +40 -0
  72. data/docs/OrganizationDomain.md +38 -0
  73. data/docs/OrganizationDomainApi.md +81 -0
  74. data/docs/OrganizationDomainVerification.md +24 -0
  75. data/docs/OrganizationDomains.md +20 -0
  76. data/docs/OrganizationDomainsApi.md +231 -0
  77. data/docs/OrganizationInvitation.md +38 -0
  78. data/docs/OrganizationInvitationWithPublicOrganizationData.md +40 -0
  79. data/docs/OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData.md +26 -0
  80. data/docs/OrganizationInvitations.md +20 -0
  81. data/docs/OrganizationInvitationsApi.md +533 -0
  82. data/docs/OrganizationInvitationsWithPublicOrganizationData.md +20 -0
  83. data/docs/OrganizationMembership.md +38 -0
  84. data/docs/OrganizationMembershipPublicUserData.md +30 -0
  85. data/docs/OrganizationMemberships.md +20 -0
  86. data/docs/OrganizationMembershipsApi.md +453 -0
  87. data/docs/OrganizationSettings.md +36 -0
  88. data/docs/OrganizationWithLogo.md +46 -0
  89. data/docs/Organizations.md +20 -0
  90. data/docs/OrganizationsApi.md +591 -0
  91. data/docs/Passkey.md +26 -0
  92. data/docs/PhoneNumber.md +38 -0
  93. data/docs/PhoneNumberVerification.md +49 -0
  94. data/docs/PhoneNumbersApi.md +289 -0
  95. data/docs/PreviewTemplateRequest.md +24 -0
  96. data/docs/ProxyCheck.md +32 -0
  97. data/docs/ProxyChecksApi.md +77 -0
  98. data/docs/RedirectURL.md +26 -0
  99. data/docs/RedirectURLsApi.md +284 -0
  100. data/docs/RevokeInvitation200Response.md +36 -0
  101. data/docs/RevokeOrganizationInvitationRequest.md +18 -0
  102. data/docs/SAML.md +28 -0
  103. data/docs/SAMLAccount.md +38 -0
  104. data/docs/SAMLAccountSamlConnection.md +47 -0
  105. data/docs/SAMLAccountVerification.md +49 -0
  106. data/docs/SAMLConnection.md +38 -0
  107. data/docs/SAMLConnections.md +20 -0
  108. data/docs/SAMLConnectionsApi.md +363 -0
  109. data/docs/SchemasPasskey.md +26 -0
  110. data/docs/SchemasPasskeyVerification.md +47 -0
  111. data/docs/SchemasSAMLConnection.md +60 -0
  112. data/docs/SchemasSAMLConnectionAttributeMapping.md +24 -0
  113. data/docs/Session.md +42 -0
  114. data/docs/SessionLatestActivity.md +34 -0
  115. data/docs/SessionsApi.md +373 -0
  116. data/docs/SignInToken.md +32 -0
  117. data/docs/SignInTokensApi.md +147 -0
  118. data/docs/SignUp.md +62 -0
  119. data/docs/SignUpsApi.md +79 -0
  120. data/docs/SvixURL.md +18 -0
  121. data/docs/TOTP.md +28 -0
  122. data/docs/Template.md +60 -0
  123. data/docs/TestingToken.md +22 -0
  124. data/docs/TestingTokensApi.md +74 -0
  125. data/docs/Ticket.md +24 -0
  126. data/docs/ToggleTemplateDeliveryRequest.md +18 -0
  127. data/docs/TotalCount.md +20 -0
  128. data/docs/UpdateDomainRequest.md +22 -0
  129. data/docs/UpdateEmailAddressRequest.md +20 -0
  130. data/docs/UpdateInstanceAuthConfig200Response.md +28 -0
  131. data/docs/UpdateInstanceAuthConfigRequest.md +28 -0
  132. data/docs/UpdateInstanceOrganizationSettingsRequest.md +30 -0
  133. data/docs/UpdateInstanceRequest.md +34 -0
  134. data/docs/UpdateInstanceRestrictionsRequest.md +26 -0
  135. data/docs/UpdateOAuthApplicationRequest.md +22 -0
  136. data/docs/UpdateOrganizationDomainRequest.md +20 -0
  137. data/docs/UpdateOrganizationMembershipMetadataRequest.md +20 -0
  138. data/docs/UpdateOrganizationMembershipRequest.md +18 -0
  139. data/docs/UpdateOrganizationRequest.md +30 -0
  140. data/docs/UpdatePhoneNumberRequest.md +22 -0
  141. data/docs/UpdateProductionInstanceDomainRequest.md +18 -0
  142. data/docs/UpdateSAMLConnectionRequest.md +42 -0
  143. data/docs/UpdateSAMLConnectionRequestAttributeMapping.md +24 -0
  144. data/docs/UpdateSignUpRequest.md +18 -0
  145. data/docs/UpdateUserMetadataRequest.md +22 -0
  146. data/docs/UpdateUserRequest.md +66 -0
  147. data/docs/UpsertTemplateRequest.md +30 -0
  148. data/docs/User.md +94 -0
  149. data/docs/UsersApi.md +1829 -0
  150. data/docs/VerifyClientRequest.md +18 -0
  151. data/docs/VerifyDomainProxyRequest.md +20 -0
  152. data/docs/VerifyPassword200Response.md +18 -0
  153. data/docs/VerifyPasswordRequest.md +18 -0
  154. data/docs/VerifySessionRequest.md +18 -0
  155. data/docs/VerifyTOTP200Response.md +20 -0
  156. data/docs/VerifyTOTPRequest.md +18 -0
  157. data/docs/Web3Signature.md +28 -0
  158. data/docs/Web3Wallet.md +28 -0
  159. data/docs/Web3WalletVerification.md +49 -0
  160. data/docs/WebhooksApi.md +207 -0
  161. data/docs/WellKnownJWKS.md +18 -0
  162. data/docs/WellKnownJWKSKeysInner.md +28 -0
  163. data/git_push.sh +57 -0
  164. data/lib/clerk-http-client/api/actor_tokens_api.rb +157 -0
  165. data/lib/clerk-http-client/api/allow_list_block_list_api.rb +410 -0
  166. data/lib/clerk-http-client/api/beta_features_api.rb +228 -0
  167. data/lib/clerk-http-client/api/clients_api.rb +234 -0
  168. data/lib/clerk-http-client/api/domains_api.rb +292 -0
  169. data/lib/clerk-http-client/api/email_addresses_api.rb +298 -0
  170. data/lib/clerk-http-client/api/email_sms_templates_api.rb +488 -0
  171. data/lib/clerk-http-client/api/instance_settings_api.rb +232 -0
  172. data/lib/clerk-http-client/api/invitations_api.rb +241 -0
  173. data/lib/clerk-http-client/api/jwks_api.rb +81 -0
  174. data/lib/clerk-http-client/api/jwt_templates_api.rb +355 -0
  175. data/lib/clerk-http-client/api/miscellaneous_api.rb +85 -0
  176. data/lib/clerk-http-client/api/o_auth_applications_api.rb +440 -0
  177. data/lib/clerk-http-client/api/organization_domain_api.rb +104 -0
  178. data/lib/clerk-http-client/api/organization_domains_api.rb +258 -0
  179. data/lib/clerk-http-client/api/organization_invitations_api.rb +586 -0
  180. data/lib/clerk-http-client/api/organization_memberships_api.rb +499 -0
  181. data/lib/clerk-http-client/api/organizations_api.rb +606 -0
  182. data/lib/clerk-http-client/api/phone_numbers_api.rb +298 -0
  183. data/lib/clerk-http-client/api/proxy_checks_api.rb +92 -0
  184. data/lib/clerk-http-client/api/redirect_urls_api.rb +281 -0
  185. data/lib/clerk-http-client/api/saml_connections_api.rb +375 -0
  186. data/lib/clerk-http-client/api/sessions_api.rb +385 -0
  187. data/lib/clerk-http-client/api/sign_in_tokens_api.rb +157 -0
  188. data/lib/clerk-http-client/api/sign_ups_api.rb +98 -0
  189. data/lib/clerk-http-client/api/testing_tokens_api.rb +81 -0
  190. data/lib/clerk-http-client/api/users_api.rb +1828 -0
  191. data/lib/clerk-http-client/api/webhooks_api.rb +199 -0
  192. data/lib/clerk-http-client/api_client.rb +437 -0
  193. data/lib/clerk-http-client/api_error.rb +58 -0
  194. data/lib/clerk-http-client/configuration.rb +393 -0
  195. data/lib/clerk-http-client/models/actor_token.rb +385 -0
  196. data/lib/clerk-http-client/models/add_domain_request.rb +249 -0
  197. data/lib/clerk-http-client/models/admin.rb +303 -0
  198. data/lib/clerk-http-client/models/allowlist_identifier.rb +327 -0
  199. data/lib/clerk-http-client/models/blocklist_identifier.rb +318 -0
  200. data/lib/clerk-http-client/models/blocklist_identifiers.rb +240 -0
  201. data/lib/clerk-http-client/models/c_name_target.rb +254 -0
  202. data/lib/clerk-http-client/models/change_production_instance_domain_request.rb +225 -0
  203. data/lib/clerk-http-client/models/clerk_error.rb +271 -0
  204. data/lib/clerk-http-client/models/clerk_errors.rb +232 -0
  205. data/lib/clerk-http-client/models/client.rb +380 -0
  206. data/lib/clerk-http-client/models/create_actor_token_request.rb +263 -0
  207. data/lib/clerk-http-client/models/create_allowlist_identifier_request.rb +234 -0
  208. data/lib/clerk-http-client/models/create_blocklist_identifier_request.rb +222 -0
  209. data/lib/clerk-http-client/models/create_email_address_request.rb +247 -0
  210. data/lib/clerk-http-client/models/create_invitation_request.rb +303 -0
  211. data/lib/clerk-http-client/models/create_jwt_template_request.rb +327 -0
  212. data/lib/clerk-http-client/models/create_o_auth_application_request.rb +261 -0
  213. data/lib/clerk-http-client/models/create_organization_domain_request.rb +236 -0
  214. data/lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb +280 -0
  215. data/lib/clerk-http-client/models/create_organization_invitation_request.rb +280 -0
  216. data/lib/clerk-http-client/models/create_organization_membership_request.rb +239 -0
  217. data/lib/clerk-http-client/models/create_organization_request.rb +289 -0
  218. data/lib/clerk-http-client/models/create_phone_number_request.rb +258 -0
  219. data/lib/clerk-http-client/models/create_redirect_url_request.rb +215 -0
  220. data/lib/clerk-http-client/models/create_saml_connection_request.rb +355 -0
  221. data/lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb +242 -0
  222. data/lib/clerk-http-client/models/create_session_token_from_template200_response.rb +257 -0
  223. data/lib/clerk-http-client/models/create_sign_in_token_request.rb +227 -0
  224. data/lib/clerk-http-client/models/create_user_request.rb +453 -0
  225. data/lib/clerk-http-client/models/deleted_object.rb +255 -0
  226. data/lib/clerk-http-client/models/disable_mfa200_response.rb +214 -0
  227. data/lib/clerk-http-client/models/domain.rb +368 -0
  228. data/lib/clerk-http-client/models/domains.rb +240 -0
  229. data/lib/clerk-http-client/models/email_address.rb +361 -0
  230. data/lib/clerk-http-client/models/email_address_verification.rb +106 -0
  231. data/lib/clerk-http-client/models/get_o_auth_access_token200_response_inner.rb +295 -0
  232. data/lib/clerk-http-client/models/identification_link.rb +271 -0
  233. data/lib/clerk-http-client/models/instance_restrictions.rb +285 -0
  234. data/lib/clerk-http-client/models/invitation.rb +388 -0
  235. data/lib/clerk-http-client/models/jwt_template.rb +387 -0
  236. data/lib/clerk-http-client/models/merge_organization_metadata_request.rb +225 -0
  237. data/lib/clerk-http-client/models/o_auth_application.rb +449 -0
  238. data/lib/clerk-http-client/models/o_auth_application_with_secret.rb +466 -0
  239. data/lib/clerk-http-client/models/o_auth_applications.rb +240 -0
  240. data/lib/clerk-http-client/models/oauth.rb +328 -0
  241. data/lib/clerk-http-client/models/oauth_error.rb +104 -0
  242. data/lib/clerk-http-client/models/organization.rb +413 -0
  243. data/lib/clerk-http-client/models/organization_domain.rb +364 -0
  244. data/lib/clerk-http-client/models/organization_domain_verification.rb +281 -0
  245. data/lib/clerk-http-client/models/organization_domains.rb +240 -0
  246. data/lib/clerk-http-client/models/organization_invitation.rb +342 -0
  247. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb +351 -0
  248. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb +250 -0
  249. data/lib/clerk-http-client/models/organization_invitations.rb +240 -0
  250. data/lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb +240 -0
  251. data/lib/clerk-http-client/models/organization_membership.rb +346 -0
  252. data/lib/clerk-http-client/models/organization_membership_public_user_data.rb +272 -0
  253. data/lib/clerk-http-client/models/organization_memberships.rb +240 -0
  254. data/lib/clerk-http-client/models/organization_settings.rb +391 -0
  255. data/lib/clerk-http-client/models/organization_with_logo.rb +454 -0
  256. data/lib/clerk-http-client/models/organizations.rb +240 -0
  257. data/lib/clerk-http-client/models/otp.rb +315 -0
  258. data/lib/clerk-http-client/models/passkey.rb +324 -0
  259. data/lib/clerk-http-client/models/phone_number.rb +391 -0
  260. data/lib/clerk-http-client/models/phone_number_verification.rb +105 -0
  261. data/lib/clerk-http-client/models/preview_template_request.rb +246 -0
  262. data/lib/clerk-http-client/models/proxy_check.rb +367 -0
  263. data/lib/clerk-http-client/models/redirect_url.rb +321 -0
  264. data/lib/clerk-http-client/models/revoke_invitation200_response.rb +395 -0
  265. data/lib/clerk-http-client/models/revoke_organization_invitation_request.rb +216 -0
  266. data/lib/clerk-http-client/models/saml.rb +331 -0
  267. data/lib/clerk-http-client/models/saml_account.rb +381 -0
  268. data/lib/clerk-http-client/models/saml_account_saml_connection.rb +104 -0
  269. data/lib/clerk-http-client/models/saml_account_verification.rb +105 -0
  270. data/lib/clerk-http-client/models/saml_connection.rb +362 -0
  271. data/lib/clerk-http-client/models/saml_connections.rb +240 -0
  272. data/lib/clerk-http-client/models/schemas_passkey.rb +310 -0
  273. data/lib/clerk-http-client/models/schemas_passkey_verification.rb +104 -0
  274. data/lib/clerk-http-client/models/schemas_saml_connection.rb +541 -0
  275. data/lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb +241 -0
  276. data/lib/clerk-http-client/models/session.rb +444 -0
  277. data/lib/clerk-http-client/models/session_latest_activity.rb +300 -0
  278. data/lib/clerk-http-client/models/sign_in_token.rb +368 -0
  279. data/lib/clerk-http-client/models/sign_up.rb +517 -0
  280. data/lib/clerk-http-client/models/svix_url.rb +221 -0
  281. data/lib/clerk-http-client/models/template.rb +460 -0
  282. data/lib/clerk-http-client/models/testing_token.rb +289 -0
  283. data/lib/clerk-http-client/models/ticket.rb +303 -0
  284. data/lib/clerk-http-client/models/toggle_template_delivery_request.rb +216 -0
  285. data/lib/clerk-http-client/models/total_count.rb +272 -0
  286. data/lib/clerk-http-client/models/totp.rb +289 -0
  287. data/lib/clerk-http-client/models/update_domain_request.rb +238 -0
  288. data/lib/clerk-http-client/models/update_email_address_request.rb +227 -0
  289. data/lib/clerk-http-client/models/update_instance_auth_config200_response.rb +294 -0
  290. data/lib/clerk-http-client/models/update_instance_auth_config_request.rb +273 -0
  291. data/lib/clerk-http-client/models/update_instance_organization_settings_request.rb +277 -0
  292. data/lib/clerk-http-client/models/update_instance_request.rb +300 -0
  293. data/lib/clerk-http-client/models/update_instance_restrictions_request.rb +255 -0
  294. data/lib/clerk-http-client/models/update_o_auth_application_request.rb +237 -0
  295. data/lib/clerk-http-client/models/update_organization_domain_request.rb +227 -0
  296. data/lib/clerk-http-client/models/update_organization_membership_metadata_request.rb +225 -0
  297. data/lib/clerk-http-client/models/update_organization_membership_request.rb +222 -0
  298. data/lib/clerk-http-client/models/update_organization_request.rb +279 -0
  299. data/lib/clerk-http-client/models/update_phone_number_request.rb +238 -0
  300. data/lib/clerk-http-client/models/update_production_instance_domain_request.rb +215 -0
  301. data/lib/clerk-http-client/models/update_saml_connection_request.rb +347 -0
  302. data/lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb +242 -0
  303. data/lib/clerk-http-client/models/update_sign_up_request.rb +216 -0
  304. data/lib/clerk-http-client/models/update_user_metadata_request.rb +241 -0
  305. data/lib/clerk-http-client/models/update_user_request.rb +472 -0
  306. data/lib/clerk-http-client/models/upsert_template_request.rb +278 -0
  307. data/lib/clerk-http-client/models/user.rb +633 -0
  308. data/lib/clerk-http-client/models/verify_client_request.rb +215 -0
  309. data/lib/clerk-http-client/models/verify_domain_proxy_request.rb +225 -0
  310. data/lib/clerk-http-client/models/verify_password200_response.rb +214 -0
  311. data/lib/clerk-http-client/models/verify_password_request.rb +222 -0
  312. data/lib/clerk-http-client/models/verify_session_request.rb +215 -0
  313. data/lib/clerk-http-client/models/verify_totp200_response.rb +257 -0
  314. data/lib/clerk-http-client/models/verify_totp_request.rb +222 -0
  315. data/lib/clerk-http-client/models/web3_signature.rb +323 -0
  316. data/lib/clerk-http-client/models/web3_wallet.rb +327 -0
  317. data/lib/clerk-http-client/models/web3_wallet_verification.rb +105 -0
  318. data/lib/clerk-http-client/models/well_known_jwks.rb +216 -0
  319. data/lib/clerk-http-client/models/well_known_jwks_keys_inner.rb +259 -0
  320. data/lib/clerk-http-client/version.rb +15 -0
  321. data/lib/clerk-http-client.rb +321 -0
  322. data/openapitools.json +7 -0
  323. data/pkg/clerk-http-client-1.0.0.gem +0 -0
  324. data/resources/.DS_Store +0 -0
  325. data/resources/oas/bapi-2024-10-01.yml +7238 -0
  326. data/resources/templates/Gemfile.mustache +9 -0
  327. data/resources/templates/README.mustache +163 -0
  328. data/resources/templates/Rakefile.mustache +10 -0
  329. data/resources/templates/api.mustache +257 -0
  330. data/resources/templates/api_client.mustache +246 -0
  331. data/resources/templates/api_client_faraday_partial.mustache +200 -0
  332. data/resources/templates/api_client_httpx_partial.mustache +134 -0
  333. data/resources/templates/api_client_typhoeus_partial.mustache +161 -0
  334. data/resources/templates/api_doc.mustache +132 -0
  335. data/resources/templates/api_error.mustache +50 -0
  336. data/resources/templates/api_info.mustache +12 -0
  337. data/resources/templates/api_test.mustache +47 -0
  338. data/resources/templates/base_object.mustache +114 -0
  339. data/resources/templates/configuration.mustache +491 -0
  340. data/resources/templates/configuration_faraday_partial.mustache +40 -0
  341. data/resources/templates/configuration_httpx_partial.mustache +11 -0
  342. data/resources/templates/configuration_typhoeus_partial.mustache +41 -0
  343. data/resources/templates/gem.mustache +89 -0
  344. data/resources/templates/gemspec.mustache +41 -0
  345. data/resources/templates/git_push.sh.mustache +57 -0
  346. data/resources/templates/gitignore.mustache +39 -0
  347. data/resources/templates/gitlab-ci.mustache +26 -0
  348. data/resources/templates/model.mustache +33 -0
  349. data/resources/templates/model_doc.mustache +12 -0
  350. data/resources/templates/model_test.mustache +82 -0
  351. data/resources/templates/partial_anyof_module.mustache +94 -0
  352. data/resources/templates/partial_model_enum_class.mustache +23 -0
  353. data/resources/templates/partial_model_generic.mustache +377 -0
  354. data/resources/templates/partial_model_generic_doc.mustache +28 -0
  355. data/resources/templates/partial_oneof_module.mustache +137 -0
  356. data/resources/templates/partial_oneof_module_doc.mustache +93 -0
  357. data/resources/templates/rspec.mustache +2 -0
  358. data/resources/templates/rubocop.mustache +148 -0
  359. data/resources/templates/spec_helper.mustache +103 -0
  360. data/resources/templates/travis.mustache +11 -0
  361. data/resources/templates/version.mustache +7 -0
  362. data/sdk-generator-config.json +20 -0
  363. data/spec/api/actor_tokens_api_spec.rb +59 -0
  364. data/spec/api/allow_list_block_list_api_spec.rb +105 -0
  365. data/spec/api/beta_features_api_spec.rb +71 -0
  366. data/spec/api/clients_api_spec.rb +72 -0
  367. data/spec/api/domains_api_spec.rb +83 -0
  368. data/spec/api/email_addresses_api_spec.rb +84 -0
  369. data/spec/api/email_sms_templates_api_spec.rb +115 -0
  370. data/spec/api/instance_settings_api_spec.rb +71 -0
  371. data/spec/api/invitations_api_spec.rb +73 -0
  372. data/spec/api/jwks_api_spec.rb +46 -0
  373. data/spec/api/jwt_templates_api_spec.rb +94 -0
  374. data/spec/api/miscellaneous_api_spec.rb +48 -0
  375. data/spec/api/o_auth_applications_api_spec.rb +109 -0
  376. data/spec/api/organization_domain_api_spec.rb +49 -0
  377. data/spec/api/organization_domains_api_spec.rb +77 -0
  378. data/spec/api/organization_invitations_api_spec.rb +133 -0
  379. data/spec/api/organization_memberships_api_spec.rb +118 -0
  380. data/spec/api/organizations_api_spec.rb +139 -0
  381. data/spec/api/phone_numbers_api_spec.rb +84 -0
  382. data/spec/api/proxy_checks_api_spec.rb +47 -0
  383. data/spec/api/redirect_urls_api_spec.rb +82 -0
  384. data/spec/api/saml_connections_api_spec.rb +97 -0
  385. data/spec/api/sessions_api_spec.rb +101 -0
  386. data/spec/api/sign_in_tokens_api_spec.rb +59 -0
  387. data/spec/api/sign_ups_api_spec.rb +48 -0
  388. data/spec/api/testing_tokens_api_spec.rb +46 -0
  389. data/spec/api/users_api_spec.rb +366 -0
  390. data/spec/api/webhooks_api_spec.rb +68 -0
  391. data/spec/models/actor_token_spec.rb +92 -0
  392. data/spec/models/add_domain_request_spec.rb +48 -0
  393. data/spec/models/admin_spec.rb +62 -0
  394. data/spec/models/allowlist_identifier_spec.rb +86 -0
  395. data/spec/models/blocklist_identifier_spec.rb +80 -0
  396. data/spec/models/blocklist_identifiers_spec.rb +42 -0
  397. data/spec/models/c_name_target_spec.rb +48 -0
  398. data/spec/models/change_production_instance_domain_request_spec.rb +42 -0
  399. data/spec/models/clerk_error_spec.rb +60 -0
  400. data/spec/models/clerk_errors_spec.rb +42 -0
  401. data/spec/models/client_spec.rb +88 -0
  402. data/spec/models/create_actor_token_request_spec.rb +54 -0
  403. data/spec/models/create_allowlist_identifier_request_spec.rb +42 -0
  404. data/spec/models/create_blocklist_identifier_request_spec.rb +36 -0
  405. data/spec/models/create_email_address_request_spec.rb +54 -0
  406. data/spec/models/create_invitation_request_spec.rb +66 -0
  407. data/spec/models/create_jwt_template_request_spec.rb +72 -0
  408. data/spec/models/create_o_auth_application_request_spec.rb +54 -0
  409. data/spec/models/create_organization_domain_request_spec.rb +48 -0
  410. data/spec/models/create_organization_invitation_bulk_request_inner_spec.rb +66 -0
  411. data/spec/models/create_organization_invitation_request_spec.rb +66 -0
  412. data/spec/models/create_organization_membership_request_spec.rb +42 -0
  413. data/spec/models/create_organization_request_spec.rb +72 -0
  414. data/spec/models/create_phone_number_request_spec.rb +60 -0
  415. data/spec/models/create_redirect_url_request_spec.rb +36 -0
  416. data/spec/models/create_saml_connection_request_attribute_mapping_spec.rb +54 -0
  417. data/spec/models/create_saml_connection_request_spec.rb +88 -0
  418. data/spec/models/create_session_token_from_template200_response_spec.rb +46 -0
  419. data/spec/models/create_sign_in_token_request_spec.rb +42 -0
  420. data/spec/models/create_user_request_spec.rb +168 -0
  421. data/spec/models/deleted_object_spec.rb +54 -0
  422. data/spec/models/disable_mfa200_response_spec.rb +36 -0
  423. data/spec/models/domain_spec.rb +88 -0
  424. data/spec/models/domains_spec.rb +42 -0
  425. data/spec/models/email_address_spec.rb +82 -0
  426. data/spec/models/email_address_verification_spec.rb +32 -0
  427. data/spec/models/get_o_auth_access_token200_response_inner_spec.rb +84 -0
  428. data/spec/models/identification_link_spec.rb +46 -0
  429. data/spec/models/instance_restrictions_spec.rb +64 -0
  430. data/spec/models/invitation_spec.rb +98 -0
  431. data/spec/models/jwt_template_spec.rb +94 -0
  432. data/spec/models/merge_organization_metadata_request_spec.rb +42 -0
  433. data/spec/models/o_auth_application_spec.rb +112 -0
  434. data/spec/models/o_auth_application_with_secret_spec.rb +118 -0
  435. data/spec/models/o_auth_applications_spec.rb +42 -0
  436. data/spec/models/oauth_error_spec.rb +32 -0
  437. data/spec/models/oauth_spec.rb +74 -0
  438. data/spec/models/organization_domain_spec.rb +104 -0
  439. data/spec/models/organization_domain_verification_spec.rb +58 -0
  440. data/spec/models/organization_domains_spec.rb +42 -0
  441. data/spec/models/organization_invitation_spec.rb +100 -0
  442. data/spec/models/organization_invitation_with_public_organization_data_public_organization_data_spec.rb +60 -0
  443. data/spec/models/organization_invitation_with_public_organization_data_spec.rb +106 -0
  444. data/spec/models/organization_invitations_spec.rb +42 -0
  445. data/spec/models/organization_invitations_with_public_organization_data_spec.rb +42 -0
  446. data/spec/models/organization_membership_public_user_data_spec.rb +72 -0
  447. data/spec/models/organization_membership_spec.rb +100 -0
  448. data/spec/models/organization_memberships_spec.rb +42 -0
  449. data/spec/models/organization_settings_spec.rb +98 -0
  450. data/spec/models/organization_spec.rb +106 -0
  451. data/spec/models/organization_with_logo_spec.rb +124 -0
  452. data/spec/models/organizations_spec.rb +42 -0
  453. data/spec/models/otp_spec.rb +62 -0
  454. data/spec/models/passkey_spec.rb +72 -0
  455. data/spec/models/phone_number_spec.rb +100 -0
  456. data/spec/models/phone_number_verification_spec.rb +32 -0
  457. data/spec/models/preview_template_request_spec.rb +54 -0
  458. data/spec/models/proxy_check_spec.rb +82 -0
  459. data/spec/models/redirect_url_spec.rb +64 -0
  460. data/spec/models/revoke_invitation200_response_spec.rb +98 -0
  461. data/spec/models/revoke_organization_invitation_request_spec.rb +36 -0
  462. data/spec/models/saml_account_saml_connection_spec.rb +32 -0
  463. data/spec/models/saml_account_spec.rb +100 -0
  464. data/spec/models/saml_account_verification_spec.rb +32 -0
  465. data/spec/models/saml_connection_spec.rb +96 -0
  466. data/spec/models/saml_connections_spec.rb +42 -0
  467. data/spec/models/saml_spec.rb +74 -0
  468. data/spec/models/schemas_passkey_spec.rb +64 -0
  469. data/spec/models/schemas_passkey_verification_spec.rb +32 -0
  470. data/spec/models/schemas_saml_connection_attribute_mapping_spec.rb +54 -0
  471. data/spec/models/schemas_saml_connection_spec.rb +166 -0
  472. data/spec/models/session_latest_activity_spec.rb +84 -0
  473. data/spec/models/session_spec.rb +116 -0
  474. data/spec/models/sign_in_token_spec.rb +86 -0
  475. data/spec/models/sign_up_spec.rb +176 -0
  476. data/spec/models/svix_url_spec.rb +36 -0
  477. data/spec/models/template_spec.rb +166 -0
  478. data/spec/models/testing_token_spec.rb +52 -0
  479. data/spec/models/ticket_spec.rb +62 -0
  480. data/spec/models/toggle_template_delivery_request_spec.rb +36 -0
  481. data/spec/models/total_count_spec.rb +46 -0
  482. data/spec/models/totp_spec.rb +66 -0
  483. data/spec/models/update_domain_request_spec.rb +48 -0
  484. data/spec/models/update_email_address_request_spec.rb +42 -0
  485. data/spec/models/update_instance_auth_config200_response_spec.rb +70 -0
  486. data/spec/models/update_instance_auth_config_request_spec.rb +66 -0
  487. data/spec/models/update_instance_organization_settings_request_spec.rb +72 -0
  488. data/spec/models/update_instance_request_spec.rb +84 -0
  489. data/spec/models/update_instance_restrictions_request_spec.rb +60 -0
  490. data/spec/models/update_o_auth_application_request_spec.rb +48 -0
  491. data/spec/models/update_organization_domain_request_spec.rb +42 -0
  492. data/spec/models/update_organization_membership_metadata_request_spec.rb +42 -0
  493. data/spec/models/update_organization_membership_request_spec.rb +36 -0
  494. data/spec/models/update_organization_request_spec.rb +72 -0
  495. data/spec/models/update_phone_number_request_spec.rb +48 -0
  496. data/spec/models/update_production_instance_domain_request_spec.rb +36 -0
  497. data/spec/models/update_saml_connection_request_attribute_mapping_spec.rb +54 -0
  498. data/spec/models/update_saml_connection_request_spec.rb +108 -0
  499. data/spec/models/update_sign_up_request_spec.rb +36 -0
  500. data/spec/models/update_user_metadata_request_spec.rb +48 -0
  501. data/spec/models/update_user_request_spec.rb +180 -0
  502. data/spec/models/upsert_template_request_spec.rb +72 -0
  503. data/spec/models/user_spec.rb +268 -0
  504. data/spec/models/verify_client_request_spec.rb +36 -0
  505. data/spec/models/verify_domain_proxy_request_spec.rb +42 -0
  506. data/spec/models/verify_password200_response_spec.rb +36 -0
  507. data/spec/models/verify_password_request_spec.rb +36 -0
  508. data/spec/models/verify_session_request_spec.rb +36 -0
  509. data/spec/models/verify_totp200_response_spec.rb +46 -0
  510. data/spec/models/verify_totp_request_spec.rb +36 -0
  511. data/spec/models/web3_signature_spec.rb +74 -0
  512. data/spec/models/web3_wallet_spec.rb +70 -0
  513. data/spec/models/web3_wallet_verification_spec.rb +32 -0
  514. data/spec/models/well_known_jwks_keys_inner_spec.rb +66 -0
  515. data/spec/models/well_known_jwks_spec.rb +36 -0
  516. data/spec/spec_helper.rb +111 -0
  517. data/test.rb +2 -0
  518. metadata +782 -0
data/docs/TOTP.md ADDED
@@ -0,0 +1,28 @@
1
+ # ClerkHttpClient::TOTP
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | | |
8
+ | **id** | **String** | | |
9
+ | **secret** | **String** | | |
10
+ | **uri** | **String** | | |
11
+ | **verified** | **Boolean** | | |
12
+ | **backup_codes** | **Array<String>** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'clerk-http-client'
18
+
19
+ instance = ClerkHttpClient::TOTP.new(
20
+ object: null,
21
+ id: null,
22
+ secret: null,
23
+ uri: null,
24
+ verified: null,
25
+ backup_codes: null
26
+ )
27
+ ```
28
+
data/docs/Template.md ADDED
@@ -0,0 +1,60 @@
1
+ # ClerkHttpClient::Template
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **object** | **String** | String representing the object's type. Objects of the same type share the same value. | [optional] |
9
+ | **instance_id** | **String** | the id of the instance the template belongs to | [optional] |
10
+ | **resource_type** | **String** | whether this is a system (default) or user overridden) template | [optional] |
11
+ | **template_type** | **String** | whether this is an email or SMS template | [optional] |
12
+ | **name** | **String** | user-friendly name of the template | [optional] |
13
+ | **slug** | **String** | machine-friendly name of the template | [optional] |
14
+ | **position** | **Integer** | position with the listing of templates | [optional] |
15
+ | **can_revert** | **Boolean** | whether this template can be reverted to the corresponding system default | [optional] |
16
+ | **can_delete** | **Boolean** | whether this template can be deleted | [optional] |
17
+ | **can_toggle** | **Boolean** | whether this template can be enabled or disabled, true only for notification SMS templates | [optional] |
18
+ | **subject** | **String** | email subject | [optional] |
19
+ | **markup** | **String** | the editor markup used to generate the body of the template | [optional] |
20
+ | **body** | **String** | the template body before variable interpolation | [optional] |
21
+ | **available_variables** | **Array<String>** | list of variables that are available for use in the template body | [optional] |
22
+ | **required_variables** | **Array<String>** | list of variables that must be contained in the template body | [optional] |
23
+ | **from_email_name** | **String** | | [optional] |
24
+ | **reply_to_email_name** | **String** | | [optional] |
25
+ | **delivered_by_clerk** | **Boolean** | | [optional] |
26
+ | **enabled** | **Boolean** | | [optional] |
27
+ | **updated_at** | **Integer** | Unix timestamp of last update. | [optional] |
28
+ | **created_at** | **Integer** | Unix timestamp of creation. | [optional] |
29
+
30
+ ## Example
31
+
32
+ ```ruby
33
+ require 'clerk-http-client'
34
+
35
+ instance = ClerkHttpClient::Template.new(
36
+ id: null,
37
+ object: null,
38
+ instance_id: null,
39
+ resource_type: null,
40
+ template_type: null,
41
+ name: null,
42
+ slug: null,
43
+ position: null,
44
+ can_revert: null,
45
+ can_delete: null,
46
+ can_toggle: null,
47
+ subject: null,
48
+ markup: null,
49
+ body: null,
50
+ available_variables: null,
51
+ required_variables: null,
52
+ from_email_name: null,
53
+ reply_to_email_name: null,
54
+ delivered_by_clerk: null,
55
+ enabled: null,
56
+ updated_at: null,
57
+ created_at: null
58
+ )
59
+ ```
60
+
@@ -0,0 +1,22 @@
1
+ # ClerkHttpClient::TestingToken
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | | |
8
+ | **token** | **String** | The actual token. This value is meant to be passed in the `__clerk_testing_token` query parameter with requests to the Frontend API. | |
9
+ | **expires_at** | **Integer** | Unix timestamp of the token's expiration time. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'clerk-http-client'
15
+
16
+ instance = ClerkHttpClient::TestingToken.new(
17
+ object: null,
18
+ token: 1713877200-c_2J2MvPu9PnXcuhbPZNao0LOXqK9A7YrnBn0HmIWxy,
19
+ expires_at: 1713880800
20
+ )
21
+ ```
22
+
@@ -0,0 +1,74 @@
1
+ # ClerkHttpClient::TestingTokensApi
2
+
3
+ All URIs are relative to *https://api.clerk.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_testing_token**](TestingTokensApi.md#create_testing_token) | **POST** /testing_tokens | Retrieve a new testing token |
8
+
9
+
10
+ ## create_testing_token
11
+
12
+ > <TestingToken> create_testing_token
13
+
14
+ Retrieve a new testing token
15
+
16
+ Retrieve a new testing token. Only available for development instances.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'clerk-http-client'
23
+ # setup authorization
24
+ ClerkHttpClient.configure do |config|
25
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
27
+ end
28
+
29
+ api_instance = ClerkHttpClient::TestingTokensApi.new
30
+
31
+ begin
32
+ # Retrieve a new testing token
33
+ result = api_instance.create_testing_token
34
+ p result
35
+ rescue ClerkHttpClient::ApiError => e
36
+ puts "Error when calling TestingTokensApi->create_testing_token: #{e}"
37
+ end
38
+ ```
39
+
40
+ #### Using the create_testing_token_with_http_info variant
41
+
42
+ This returns an Array which contains the response data, status code and headers.
43
+
44
+ > <Array(<TestingToken>, Integer, Hash)> create_testing_token_with_http_info
45
+
46
+ ```ruby
47
+ begin
48
+ # Retrieve a new testing token
49
+ data, status_code, headers = api_instance.create_testing_token_with_http_info
50
+ p status_code # => 2xx
51
+ p headers # => { ... }
52
+ p data # => <TestingToken>
53
+ rescue ClerkHttpClient::ApiError => e
54
+ puts "Error when calling TestingTokensApi->create_testing_token_with_http_info: #{e}"
55
+ end
56
+ ```
57
+
58
+ ### Parameters
59
+
60
+ This endpoint does not need any parameter.
61
+
62
+ ### Return type
63
+
64
+ [**TestingToken**](TestingToken.md)
65
+
66
+ ### Authorization
67
+
68
+ [bearerAuth](../README.md#bearerAuth)
69
+
70
+ ### HTTP request headers
71
+
72
+ - **Content-Type**: Not defined
73
+ - **Accept**: application/json
74
+
data/docs/Ticket.md ADDED
@@ -0,0 +1,24 @@
1
+ # ClerkHttpClient::Ticket
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **strategy** | **String** | | |
9
+ | **attempts** | **Integer** | | [optional] |
10
+ | **expire_at** | **Integer** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'clerk-http-client'
16
+
17
+ instance = ClerkHttpClient::Ticket.new(
18
+ status: null,
19
+ strategy: null,
20
+ attempts: null,
21
+ expire_at: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # ClerkHttpClient::ToggleTemplateDeliveryRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **delivered_by_clerk** | **Boolean** | Whether Clerk should deliver emails or SMS messages based on the current template | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'clerk-http-client'
13
+
14
+ instance = ClerkHttpClient::ToggleTemplateDeliveryRequest.new(
15
+ delivered_by_clerk: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # ClerkHttpClient::TotalCount
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | String representing the object&#39;s type. Objects of the same type share the same value. | |
8
+ | **total_count** | **Integer** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'clerk-http-client'
14
+
15
+ instance = ClerkHttpClient::TotalCount.new(
16
+ object: null,
17
+ total_count: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # ClerkHttpClient::UpdateDomainRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The new domain name. For development instances, can contain the port, i.e &#x60;myhostname:3000&#x60;. For production instances, must be a valid FQDN, i.e &#x60;mysite.com&#x60;. Cannot contain protocol scheme. | [optional] |
8
+ | **proxy_url** | **String** | The full URL of the proxy that will forward requests to Clerk&#39;s Frontend API. Can only be updated for production instances. | [optional] |
9
+ | **is_secondary** | **Boolean** | Whether this is a domain for a secondary app, meaning that any subdomain provided is significant and will be stored as part of the domain. This is useful for supporting multiple apps (one primary and multiple secondaries) on the same root domain (eTLD+1). | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'clerk-http-client'
15
+
16
+ instance = ClerkHttpClient::UpdateDomainRequest.new(
17
+ name: null,
18
+ proxy_url: null,
19
+ is_secondary: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # ClerkHttpClient::UpdateEmailAddressRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **verified** | **Boolean** | The email address will be marked as verified. | [optional] |
8
+ | **primary** | **Boolean** | Set this email address as the primary email address for the user. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'clerk-http-client'
14
+
15
+ instance = ClerkHttpClient::UpdateEmailAddressRequest.new(
16
+ verified: null,
17
+ primary: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,28 @@
1
+ # ClerkHttpClient::UpdateInstanceAuthConfig200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | String representing the object&#39;s type. Objects of the same type share the same value. | [optional] |
8
+ | **id** | **String** | | [optional] |
9
+ | **restricted_to_allowlist** | **Boolean** | | [optional] |
10
+ | **from_email_address** | **String** | | [optional] |
11
+ | **progressive_sign_up** | **Boolean** | | [optional] |
12
+ | **enhanced_email_deliverability** | **Boolean** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'clerk-http-client'
18
+
19
+ instance = ClerkHttpClient::UpdateInstanceAuthConfig200Response.new(
20
+ object: null,
21
+ id: null,
22
+ restricted_to_allowlist: null,
23
+ from_email_address: null,
24
+ progressive_sign_up: null,
25
+ enhanced_email_deliverability: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # ClerkHttpClient::UpdateInstanceAuthConfigRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **restricted_to_allowlist** | **Boolean** | Whether sign up is restricted to email addresses, phone numbers and usernames that are on the allowlist. | [optional][default to false] |
8
+ | **from_email_address** | **String** | The local part of the email address from which authentication-related emails (e.g. OTP code, magic links) will be sent. Only alphanumeric values are allowed. Note that this value should contain only the local part of the address (e.g. &#x60;foo&#x60; for &#x60;foo@example.com&#x60;). | [optional] |
9
+ | **progressive_sign_up** | **Boolean** | Enable the Progressive Sign Up algorithm. Refer to the [docs](https://clerk.com/docs/upgrade-guides/progressive-sign-up) for more info. | [optional] |
10
+ | **session_token_template** | **String** | The name of the JWT Template used to augment your session tokens. To disable this, pass an empty string. | [optional] |
11
+ | **enhanced_email_deliverability** | **Boolean** | The \&quot;enhanced_email_deliverability\&quot; feature will send emails from \&quot;verifications@clerk.dev\&quot; instead of your domain. This can be helpful if you do not have a high domain reputation. | [optional] |
12
+ | **test_mode** | **Boolean** | Toggles test mode for this instance, allowing the use of test email addresses and phone numbers. Defaults to true for development instances. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'clerk-http-client'
18
+
19
+ instance = ClerkHttpClient::UpdateInstanceAuthConfigRequest.new(
20
+ restricted_to_allowlist: null,
21
+ from_email_address: null,
22
+ progressive_sign_up: null,
23
+ session_token_template: null,
24
+ enhanced_email_deliverability: null,
25
+ test_mode: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,30 @@
1
+ # ClerkHttpClient::UpdateInstanceOrganizationSettingsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | | [optional] |
8
+ | **max_allowed_memberships** | **Integer** | | [optional] |
9
+ | **admin_delete_enabled** | **Boolean** | | [optional] |
10
+ | **domains_enabled** | **Boolean** | | [optional] |
11
+ | **domains_enrollment_modes** | **Array&lt;String&gt;** | Specify which enrollment modes to enable for your Organization Domains. Supported modes are &#39;automatic_invitation&#39; &amp; &#39;automatic_suggestion&#39;. | [optional] |
12
+ | **creator_role_id** | **String** | Specify what the default organization role is for an organization creator. | [optional] |
13
+ | **domains_default_role_id** | **String** | Specify what the default organization role is for the organization domains. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'clerk-http-client'
19
+
20
+ instance = ClerkHttpClient::UpdateInstanceOrganizationSettingsRequest.new(
21
+ enabled: null,
22
+ max_allowed_memberships: null,
23
+ admin_delete_enabled: null,
24
+ domains_enabled: null,
25
+ domains_enrollment_modes: null,
26
+ creator_role_id: null,
27
+ domains_default_role_id: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,34 @@
1
+ # ClerkHttpClient::UpdateInstanceRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **test_mode** | **Boolean** | Toggles test mode for this instance, allowing the use of test email addresses and phone numbers. Defaults to true for development instances. | [optional] |
8
+ | **hibp** | **Boolean** | Whether the instance should be using the HIBP service to check passwords for breaches | [optional] |
9
+ | **enhanced_email_deliverability** | **Boolean** | The \&quot;enhanced_email_deliverability\&quot; feature will send emails from \&quot;verifications@clerk.dev\&quot; instead of your domain. This can be helpful if you do not have a high domain reputation. | [optional] |
10
+ | **support_email** | **String** | | [optional] |
11
+ | **clerk_js_version** | **String** | | [optional] |
12
+ | **development_origin** | **String** | | [optional] |
13
+ | **allowed_origins** | **Array&lt;String&gt;** | For browser-like stacks such as browser extensions, Electron, or Capacitor.js the instance allowed origins need to be updated with the request origin value. For Chrome extensions popup, background, or service worker pages the origin is chrome-extension://extension_uiid. For Electron apps the default origin is http://localhost:3000. For Capacitor, the origin is capacitor://localhost. | [optional] |
14
+ | **cookieless_dev** | **Boolean** | Whether the instance should operate in cookieless development mode (i.e. without third-party cookies). Deprecated: Please use &#x60;url_based_session_syncing&#x60; instead. | [optional] |
15
+ | **url_based_session_syncing** | **Boolean** | Whether the instance should use URL-based session syncing in development mode (i.e. without third-party cookies). | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'clerk-http-client'
21
+
22
+ instance = ClerkHttpClient::UpdateInstanceRequest.new(
23
+ test_mode: null,
24
+ hibp: null,
25
+ enhanced_email_deliverability: null,
26
+ support_email: null,
27
+ clerk_js_version: null,
28
+ development_origin: null,
29
+ allowed_origins: null,
30
+ cookieless_dev: null,
31
+ url_based_session_syncing: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,26 @@
1
+ # ClerkHttpClient::UpdateInstanceRestrictionsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allowlist** | **Boolean** | | [optional] |
8
+ | **blocklist** | **Boolean** | | [optional] |
9
+ | **block_email_subaddresses** | **Boolean** | | [optional] |
10
+ | **block_disposable_email_domains** | **Boolean** | | [optional] |
11
+ | **ignore_dots_for_gmail_addresses** | **Boolean** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'clerk-http-client'
17
+
18
+ instance = ClerkHttpClient::UpdateInstanceRestrictionsRequest.new(
19
+ allowlist: null,
20
+ blocklist: null,
21
+ block_email_subaddresses: null,
22
+ block_disposable_email_domains: null,
23
+ ignore_dots_for_gmail_addresses: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # ClerkHttpClient::UpdateOAuthApplicationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The new name of the OAuth application | [optional] |
8
+ | **callback_url** | **String** | The new callback URL of the OAuth application | [optional] |
9
+ | **scopes** | **String** | Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are &#x60;profile&#x60;, &#x60;email&#x60;, &#x60;public_metadata&#x60;, &#x60;private_metadata&#x60;. Provide the requested scopes as a string, separated by spaces. | [optional][default to &#39;profile email&#39;] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'clerk-http-client'
15
+
16
+ instance = ClerkHttpClient::UpdateOAuthApplicationRequest.new(
17
+ name: null,
18
+ callback_url: null,
19
+ scopes: profile email public_metadata private_metadata
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # ClerkHttpClient::UpdateOrganizationDomainRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enrollment_mode** | **String** | The enrollment_mode for the new domain. This can be &#x60;automatic_invitation&#x60;, &#x60;automatic_suggestion&#x60; or &#x60;manual_invitation&#x60; | [optional] |
8
+ | **verified** | **Boolean** | The status of the domain&#39;s verification | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'clerk-http-client'
14
+
15
+ instance = ClerkHttpClient::UpdateOrganizationDomainRequest.new(
16
+ enrollment_mode: null,
17
+ verified: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # ClerkHttpClient::UpdateOrganizationMembershipMetadataRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **public_metadata** | **Object** | Metadata saved on the organization membership, that is visible to both your frontend and backend. The new object will be merged with the existing value. | [optional] |
8
+ | **private_metadata** | **Object** | Metadata saved on the organization membership that is only visible to your backend. The new object will be merged with the existing value. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'clerk-http-client'
14
+
15
+ instance = ClerkHttpClient::UpdateOrganizationMembershipMetadataRequest.new(
16
+ public_metadata: null,
17
+ private_metadata: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # ClerkHttpClient::UpdateOrganizationMembershipRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **role** | **String** | The new role of the given membership. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'clerk-http-client'
13
+
14
+ instance = ClerkHttpClient::UpdateOrganizationMembershipRequest.new(
15
+ role: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,30 @@
1
+ # ClerkHttpClient::UpdateOrganizationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **public_metadata** | **Object** | Metadata saved on the organization, that is visible to both your frontend and backend. | [optional] |
8
+ | **private_metadata** | **Object** | Metadata saved on the organization that is only visible to your backend. | [optional] |
9
+ | **name** | **String** | The new name of the organization. May not contain URLs or HTML. | [optional] |
10
+ | **slug** | **String** | The new slug of the organization, which needs to be unique in the instance | [optional] |
11
+ | **max_allowed_memberships** | **Integer** | The maximum number of memberships allowed for this organization | [optional] |
12
+ | **admin_delete_enabled** | **Boolean** | If true, an admin can delete this organization with the Frontend API. | [optional] |
13
+ | **created_at** | **String** | A custom date/time denoting _when_ the organization was created, specified in RFC3339 format (e.g. &#x60;2012-10-20T07:15:20.902Z&#x60;). | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'clerk-http-client'
19
+
20
+ instance = ClerkHttpClient::UpdateOrganizationRequest.new(
21
+ public_metadata: null,
22
+ private_metadata: null,
23
+ name: null,
24
+ slug: null,
25
+ max_allowed_memberships: null,
26
+ admin_delete_enabled: null,
27
+ created_at: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,22 @@
1
+ # ClerkHttpClient::UpdatePhoneNumberRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **verified** | **Boolean** | The phone number will be marked as verified. | [optional] |
8
+ | **primary** | **Boolean** | Set this phone number as the primary phone number for the user. | [optional] |
9
+ | **reserved_for_second_factor** | **Boolean** | Set this phone number as reserved for multi-factor authentication. The phone number must also be verified. If there are no other reserved second factors, the phone number will be set as the default second factor. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'clerk-http-client'
15
+
16
+ instance = ClerkHttpClient::UpdatePhoneNumberRequest.new(
17
+ verified: null,
18
+ primary: null,
19
+ reserved_for_second_factor: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # ClerkHttpClient::UpdateProductionInstanceDomainRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **home_url** | **String** | The new home URL of the production instance e.g. https://www.example.com | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'clerk-http-client'
13
+
14
+ instance = ClerkHttpClient::UpdateProductionInstanceDomainRequest.new(
15
+ home_url: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,42 @@
1
+ # ClerkHttpClient::UpdateSAMLConnectionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the new SAML Connection | [optional] |
8
+ | **domain** | **String** | The domain to use for the new SAML Connection | [optional] |
9
+ | **idp_entity_id** | **String** | The entity id as provided by the IdP | [optional] |
10
+ | **idp_sso_url** | **String** | The SSO url as provided by the IdP | [optional] |
11
+ | **idp_certificate** | **String** | The x509 certificated as provided by the IdP | [optional] |
12
+ | **idp_metadata_url** | **String** | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties and replaces them | [optional] |
13
+ | **idp_metadata** | **String** | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties | [optional] |
14
+ | **attribute_mapping** | [**UpdateSAMLConnectionRequestAttributeMapping**](UpdateSAMLConnectionRequestAttributeMapping.md) | | [optional] |
15
+ | **active** | **Boolean** | Activate or de-activate the SAML Connection | [optional] |
16
+ | **sync_user_attributes** | **Boolean** | Controls whether to update the user&#39;s attributes in each sign-in | [optional] |
17
+ | **allow_subdomains** | **Boolean** | Allow users with an email address subdomain to use this connection in order to authenticate | [optional] |
18
+ | **allow_idp_initiated** | **Boolean** | Enable or deactivate IdP-initiated flows | [optional] |
19
+ | **disable_additional_identifications** | **Boolean** | Enable or deactivate additional identifications | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'clerk-http-client'
25
+
26
+ instance = ClerkHttpClient::UpdateSAMLConnectionRequest.new(
27
+ name: null,
28
+ domain: null,
29
+ idp_entity_id: null,
30
+ idp_sso_url: null,
31
+ idp_certificate: null,
32
+ idp_metadata_url: null,
33
+ idp_metadata: null,
34
+ attribute_mapping: null,
35
+ active: null,
36
+ sync_user_attributes: null,
37
+ allow_subdomains: null,
38
+ allow_idp_initiated: null,
39
+ disable_additional_identifications: null
40
+ )
41
+ ```
42
+