clerk-http-client 1.0.0 → 2.0.0.beta2

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 (343) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +155 -191
  4. data/clerk-http-client.gemspec +1 -1
  5. data/docs/ActorTokensApi.md +26 -26
  6. data/docs/AllowListBlockListApi.md +72 -74
  7. data/docs/BetaFeaturesApi.md +42 -41
  8. data/docs/ClientsApi.md +36 -37
  9. data/docs/CreateBulkInvitationsRequestInner.md +28 -0
  10. data/docs/CreateInvitationRequest.md +6 -4
  11. data/docs/{CreateOAuthApplicationRequest.md → CreateOauthApplicationRequest.md} +1 -1
  12. data/docs/CreateOrganizationInvitationBulkRequestInner.md +2 -2
  13. data/docs/CreateOrganizationInvitationRequest.md +5 -3
  14. data/docs/CreateOrganizationRequest.md +3 -3
  15. data/docs/CreateSAMLConnectionRequest.md +2 -0
  16. data/docs/CreateSessionRequest.md +18 -0
  17. data/docs/CreateSessionToken200Response.md +20 -0
  18. data/docs/CreateSessionTokenFromTemplateRequest.md +18 -0
  19. data/docs/CreateSessionTokenRequest.md +18 -0
  20. data/docs/CreateUserRequest.md +3 -3
  21. data/docs/CreateWaitlistEntryRequest.md +20 -0
  22. data/docs/DomainsApi.md +46 -48
  23. data/docs/EmailAddress.md +2 -0
  24. data/docs/EmailAddressVerification.md +3 -3
  25. data/docs/EmailAddressesApi.md +52 -52
  26. data/docs/EmailSMSTemplatesApi.md +60 -66
  27. data/docs/FromOauth.md +26 -0
  28. data/docs/FromOauthError.md +47 -0
  29. data/docs/{GetOAuthAccessToken200ResponseInner.md → GetOauthAccessToken200ResponseInner.md} +4 -2
  30. data/docs/Instance.md +24 -0
  31. data/docs/InstanceSettingsApi.md +114 -45
  32. data/docs/Invitation.md +1 -1
  33. data/docs/InvitationsApi.md +110 -38
  34. data/docs/JWKS.md +18 -0
  35. data/docs/JWKSApi.md +14 -15
  36. data/docs/JWKSKeysInner.md +32 -0
  37. data/docs/JWTTemplatesApi.md +62 -63
  38. data/docs/ListWaitlistEntries200Response.md +20 -0
  39. data/docs/MergeOrganizationMetadataRequest.md +2 -2
  40. data/docs/MiscellaneousApi.md +11 -7
  41. data/docs/{OAuthApplication.md → OauthApplication.md} +4 -0
  42. data/docs/{OAuthApplicationWithSecret.md → OauthApplicationWithSecret.md} +4 -0
  43. data/docs/{OAuthApplicationsApi.md → OauthApplicationsApi.md} +90 -94
  44. data/docs/Organization.md +2 -2
  45. data/docs/OrganizationDomainApi.md +15 -13
  46. data/docs/OrganizationDomainsApi.md +103 -33
  47. data/docs/OrganizationInvitation.md +6 -2
  48. data/docs/OrganizationInvitationWithPublicOrganizationData.md +4 -2
  49. data/docs/OrganizationInvitationsApi.md +76 -81
  50. data/docs/OrganizationMembership.md +2 -2
  51. data/docs/OrganizationMembershipsApi.md +66 -70
  52. data/docs/OrganizationWithLogo.md +2 -2
  53. data/docs/OrganizationsApi.md +87 -93
  54. data/docs/PhoneNumbersApi.md +52 -52
  55. data/docs/ProxyChecksApi.md +16 -15
  56. data/docs/{RedirectURLsApi.md → RedirectUrlsApi.md} +46 -48
  57. data/docs/RevokeInvitation200Response.md +1 -1
  58. data/docs/SAML.md +1 -1
  59. data/docs/SAMLAccount.md +1 -1
  60. data/docs/SAMLConnectionsApi.md +59 -60
  61. data/docs/SchemasSAMLConnection.md +2 -0
  62. data/docs/SessionsApi.md +203 -60
  63. data/docs/SignInTokensApi.md +26 -26
  64. data/docs/SignUp.md +4 -2
  65. data/docs/SignUpsApi.md +16 -15
  66. data/docs/TestingTokensApi.md +11 -12
  67. data/docs/UpdateOrganizationMembershipMetadataRequest.md +2 -2
  68. data/docs/UpdateOrganizationRequest.md +2 -2
  69. data/docs/UpdateSAMLConnectionRequest.md +2 -0
  70. data/docs/UpdateUserRequest.md +3 -3
  71. data/docs/User.md +3 -3
  72. data/docs/UsersApi.md +297 -294
  73. data/docs/WaitlistEntriesApi.md +157 -0
  74. data/docs/WaitlistEntry.md +32 -0
  75. data/docs/WaitlistEntryInvitation.md +36 -0
  76. data/docs/WebhooksApi.md +30 -33
  77. data/lib/clerk-http-client/api/actor_tokens_api.rb +10 -14
  78. data/lib/clerk-http-client/api/allow_list_block_list_api.rb +25 -33
  79. data/lib/clerk-http-client/api/beta_features_api.rb +13 -21
  80. data/lib/clerk-http-client/api/clients_api.rb +13 -17
  81. data/lib/clerk-http-client/api/domains_api.rb +16 -20
  82. data/lib/clerk-http-client/api/email_addresses_api.rb +19 -27
  83. data/lib/clerk-http-client/api/email_sms_templates_api.rb +19 -19
  84. data/lib/clerk-http-client/api/instance_settings_api.rb +78 -31
  85. data/lib/clerk-http-client/api/invitations_api.rb +82 -17
  86. data/lib/clerk-http-client/api/jwks_api.rb +7 -7
  87. data/lib/clerk-http-client/api/jwt_templates_api.rb +22 -30
  88. data/lib/clerk-http-client/api/miscellaneous_api.rb +4 -4
  89. data/lib/clerk-http-client/api/{o_auth_applications_api.rb → oauth_applications_api.rb} +53 -57
  90. data/lib/clerk-http-client/api/organization_domains_api.rb +92 -10
  91. data/lib/clerk-http-client/api/organization_invitations_api.rb +25 -29
  92. data/lib/clerk-http-client/api/organization_memberships_api.rb +22 -26
  93. data/lib/clerk-http-client/api/organizations_api.rb +30 -34
  94. data/lib/clerk-http-client/api/phone_numbers_api.rb +19 -27
  95. data/lib/clerk-http-client/api/proxy_checks_api.rb +7 -11
  96. data/lib/clerk-http-client/api/redirect_urls_api.rb +16 -20
  97. data/lib/clerk-http-client/api/saml_connections_api.rb +22 -23
  98. data/lib/clerk-http-client/api/sessions_api.rb +165 -20
  99. data/lib/clerk-http-client/api/sign_in_tokens_api.rb +10 -14
  100. data/lib/clerk-http-client/api/sign_ups_api.rb +7 -11
  101. data/lib/clerk-http-client/api/testing_tokens_api.rb +6 -6
  102. data/lib/clerk-http-client/api/users_api.rb +149 -92
  103. data/lib/clerk-http-client/api/waitlist_entries_api.rb +178 -0
  104. data/lib/clerk-http-client/api/webhooks_api.rb +10 -10
  105. data/lib/clerk-http-client/api_client.rb +1 -1
  106. data/lib/clerk-http-client/api_error.rb +1 -1
  107. data/lib/clerk-http-client/configuration.rb +1 -1
  108. data/lib/clerk-http-client/models/actor_token.rb +2 -1
  109. data/lib/clerk-http-client/models/add_domain_request.rb +2 -1
  110. data/lib/clerk-http-client/models/admin.rb +2 -1
  111. data/lib/clerk-http-client/models/allowlist_identifier.rb +2 -1
  112. data/lib/clerk-http-client/models/blocklist_identifier.rb +2 -1
  113. data/lib/clerk-http-client/models/blocklist_identifiers.rb +2 -1
  114. data/lib/clerk-http-client/models/change_production_instance_domain_request.rb +2 -1
  115. data/lib/clerk-http-client/models/clerk_error.rb +2 -1
  116. data/lib/clerk-http-client/models/clerk_errors.rb +2 -1
  117. data/lib/clerk-http-client/models/client.rb +2 -1
  118. data/lib/clerk-http-client/models/{c_name_target.rb → cname_target.rb} +2 -1
  119. data/lib/clerk-http-client/models/create_actor_token_request.rb +2 -1
  120. data/lib/clerk-http-client/models/create_allowlist_identifier_request.rb +2 -1
  121. data/lib/clerk-http-client/models/create_blocklist_identifier_request.rb +2 -1
  122. data/lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb +306 -0
  123. data/lib/clerk-http-client/models/create_email_address_request.rb +2 -1
  124. data/lib/clerk-http-client/models/create_invitation_request.rb +58 -10
  125. data/lib/clerk-http-client/models/create_jwt_template_request.rb +2 -1
  126. data/lib/clerk-http-client/models/{create_o_auth_application_request.rb → create_oauth_application_request.rb} +2 -8
  127. data/lib/clerk-http-client/models/create_organization_domain_request.rb +2 -1
  128. data/lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb +12 -7
  129. data/lib/clerk-http-client/models/create_organization_invitation_request.rb +51 -11
  130. data/lib/clerk-http-client/models/create_organization_membership_request.rb +2 -1
  131. data/lib/clerk-http-client/models/create_organization_request.rb +10 -12
  132. data/lib/clerk-http-client/models/create_phone_number_request.rb +2 -1
  133. data/lib/clerk-http-client/models/create_redirect_url_request.rb +2 -1
  134. data/lib/clerk-http-client/models/create_saml_connection_request.rb +14 -2
  135. data/lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb +2 -1
  136. data/lib/clerk-http-client/models/create_session_request.rb +216 -0
  137. data/lib/clerk-http-client/models/create_session_token200_response.rb +258 -0
  138. data/lib/clerk-http-client/models/create_session_token_from_template_request.rb +241 -0
  139. data/lib/clerk-http-client/models/create_session_token_request.rb +241 -0
  140. data/lib/clerk-http-client/models/create_sign_in_token_request.rb +2 -1
  141. data/lib/clerk-http-client/models/create_user_request.rb +14 -7
  142. data/lib/clerk-http-client/models/create_waitlist_entry_request.rb +233 -0
  143. data/lib/clerk-http-client/models/deleted_object.rb +2 -1
  144. data/lib/clerk-http-client/models/disable_mfa200_response.rb +2 -1
  145. data/lib/clerk-http-client/models/domain.rb +2 -1
  146. data/lib/clerk-http-client/models/domains.rb +2 -1
  147. data/lib/clerk-http-client/models/email_address.rb +13 -2
  148. data/lib/clerk-http-client/models/email_address_verification.rb +6 -3
  149. data/lib/clerk-http-client/models/from_o_auth.rb +324 -0
  150. data/{resources/templates/partial_anyof_module.mustache → lib/clerk-http-client/models/from_o_auth_error.rb} +29 -19
  151. data/lib/clerk-http-client/models/from_oauth.rb +325 -0
  152. data/{resources/templates/partial_oneof_module.mustache → lib/clerk-http-client/models/from_oauth_error.rb} +24 -54
  153. data/lib/clerk-http-client/models/{get_o_auth_access_token200_response_inner.rb → get_oauth_access_token200_response_inner.rb} +21 -7
  154. data/lib/clerk-http-client/models/identification_link.rb +4 -3
  155. data/lib/clerk-http-client/models/instance.rb +280 -0
  156. data/lib/clerk-http-client/models/instance_restrictions.rb +2 -1
  157. data/lib/clerk-http-client/models/invitation.rb +6 -3
  158. data/lib/clerk-http-client/models/jwks.rb +217 -0
  159. data/lib/clerk-http-client/models/jwks_keys_inner.rb +278 -0
  160. data/lib/clerk-http-client/models/jwt_template.rb +2 -1
  161. data/lib/clerk-http-client/models/list_waitlist_entries200_response.rb +241 -0
  162. data/lib/clerk-http-client/models/merge_organization_metadata_request.rb +10 -5
  163. data/lib/clerk-http-client/models/o_auth_application.rb +34 -2
  164. data/lib/clerk-http-client/models/o_auth_application_with_secret.rb +34 -2
  165. data/lib/clerk-http-client/models/o_auth_applications.rb +1 -1
  166. data/lib/clerk-http-client/models/oauth.rb +2 -2
  167. data/lib/clerk-http-client/models/oauth_application.rb +482 -0
  168. data/lib/clerk-http-client/models/oauth_application_with_secret.rb +499 -0
  169. data/lib/clerk-http-client/models/oauth_applications.rb +241 -0
  170. data/lib/clerk-http-client/models/organization.rb +11 -5
  171. data/lib/clerk-http-client/models/organization_domain.rb +2 -1
  172. data/lib/clerk-http-client/models/organization_domain_verification.rb +2 -1
  173. data/lib/clerk-http-client/models/organization_domains.rb +2 -1
  174. data/lib/clerk-http-client/models/organization_invitation.rb +32 -6
  175. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb +21 -6
  176. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb +2 -1
  177. data/lib/clerk-http-client/models/organization_invitations.rb +2 -1
  178. data/lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb +2 -1
  179. data/lib/clerk-http-client/models/organization_membership.rb +10 -5
  180. data/lib/clerk-http-client/models/organization_membership_public_user_data.rb +2 -1
  181. data/lib/clerk-http-client/models/organization_memberships.rb +2 -1
  182. data/lib/clerk-http-client/models/organization_settings.rb +2 -1
  183. data/lib/clerk-http-client/models/organization_with_logo.rb +11 -5
  184. data/lib/clerk-http-client/models/organizations.rb +2 -1
  185. data/lib/clerk-http-client/models/otp.rb +2 -1
  186. data/lib/clerk-http-client/models/passkey.rb +2 -1
  187. data/lib/clerk-http-client/models/phone_number.rb +2 -1
  188. data/lib/clerk-http-client/models/phone_number_verification.rb +4 -1
  189. data/lib/clerk-http-client/models/preview_template_request.rb +2 -1
  190. data/lib/clerk-http-client/models/proxy_check.rb +2 -1
  191. data/lib/clerk-http-client/models/redirect_url.rb +2 -1
  192. data/lib/clerk-http-client/models/revoke_invitation200_response.rb +6 -3
  193. data/lib/clerk-http-client/models/revoke_organization_invitation_request.rb +2 -1
  194. data/lib/clerk-http-client/models/saml.rb +3 -2
  195. data/lib/clerk-http-client/models/saml_account.rb +6 -3
  196. data/lib/clerk-http-client/models/saml_account_saml_connection.rb +4 -1
  197. data/lib/clerk-http-client/models/saml_account_verification.rb +4 -1
  198. data/lib/clerk-http-client/models/saml_connection.rb +2 -1
  199. data/lib/clerk-http-client/models/saml_connections.rb +2 -1
  200. data/lib/clerk-http-client/models/schemas_passkey.rb +2 -1
  201. data/lib/clerk-http-client/models/schemas_passkey_verification.rb +4 -1
  202. data/lib/clerk-http-client/models/schemas_saml_connection.rb +13 -2
  203. data/lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb +2 -1
  204. data/lib/clerk-http-client/models/session.rb +2 -1
  205. data/lib/clerk-http-client/models/session_latest_activity.rb +2 -1
  206. data/lib/clerk-http-client/models/sign_in_token.rb +2 -1
  207. data/lib/clerk-http-client/models/sign_up.rb +22 -6
  208. data/lib/clerk-http-client/models/svix_url.rb +2 -1
  209. data/lib/clerk-http-client/models/template.rb +2 -1
  210. data/lib/clerk-http-client/models/testing_token.rb +2 -1
  211. data/lib/clerk-http-client/models/ticket.rb +2 -1
  212. data/lib/clerk-http-client/models/toggle_template_delivery_request.rb +2 -1
  213. data/lib/clerk-http-client/models/total_count.rb +2 -1
  214. data/lib/clerk-http-client/models/totp.rb +2 -1
  215. data/lib/clerk-http-client/models/update_domain_request.rb +2 -1
  216. data/lib/clerk-http-client/models/update_email_address_request.rb +2 -1
  217. data/lib/clerk-http-client/models/update_instance_auth_config200_response.rb +2 -1
  218. data/lib/clerk-http-client/models/update_instance_auth_config_request.rb +2 -1
  219. data/lib/clerk-http-client/models/update_instance_organization_settings_request.rb +2 -1
  220. data/lib/clerk-http-client/models/update_instance_request.rb +2 -1
  221. data/lib/clerk-http-client/models/update_instance_restrictions_request.rb +2 -1
  222. data/lib/clerk-http-client/models/{update_o_auth_application_request.rb → update_oauth_application_request.rb} +2 -1
  223. data/lib/clerk-http-client/models/update_organization_domain_request.rb +2 -1
  224. data/lib/clerk-http-client/models/update_organization_membership_metadata_request.rb +10 -5
  225. data/lib/clerk-http-client/models/update_organization_membership_request.rb +2 -1
  226. data/lib/clerk-http-client/models/update_organization_request.rb +10 -5
  227. data/lib/clerk-http-client/models/update_phone_number_request.rb +2 -1
  228. data/lib/clerk-http-client/models/update_production_instance_domain_request.rb +2 -1
  229. data/lib/clerk-http-client/models/update_saml_connection_request.rb +14 -2
  230. data/lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb +2 -1
  231. data/lib/clerk-http-client/models/update_sign_up_request.rb +2 -1
  232. data/lib/clerk-http-client/models/update_user_metadata_request.rb +2 -1
  233. data/lib/clerk-http-client/models/update_user_request.rb +14 -7
  234. data/lib/clerk-http-client/models/upsert_template_request.rb +2 -1
  235. data/lib/clerk-http-client/models/user.rb +14 -7
  236. data/lib/clerk-http-client/models/verify_client_request.rb +2 -1
  237. data/lib/clerk-http-client/models/verify_domain_proxy_request.rb +2 -1
  238. data/lib/clerk-http-client/models/verify_password200_response.rb +2 -1
  239. data/lib/clerk-http-client/models/verify_password_request.rb +2 -1
  240. data/lib/clerk-http-client/models/verify_session_request.rb +2 -1
  241. data/lib/clerk-http-client/models/verify_totp200_response.rb +2 -1
  242. data/lib/clerk-http-client/models/verify_totp_request.rb +2 -1
  243. data/lib/clerk-http-client/models/waitlist_entry.rb +370 -0
  244. data/lib/clerk-http-client/models/waitlist_entry_invitation.rb +397 -0
  245. data/lib/clerk-http-client/models/web3_signature.rb +4 -3
  246. data/lib/clerk-http-client/models/web3_wallet.rb +2 -1
  247. data/lib/clerk-http-client/models/web3_wallet_verification.rb +4 -1
  248. data/lib/clerk-http-client/version.rb +1 -1
  249. data/lib/clerk-http-client.rb +56 -59
  250. data/spec/api/actor_tokens_api_spec.rb +1 -1
  251. data/spec/api/allow_list_block_list_api_spec.rb +2 -2
  252. data/spec/api/beta_features_api_spec.rb +2 -2
  253. data/spec/api/clients_api_spec.rb +1 -1
  254. data/spec/api/domains_api_spec.rb +1 -1
  255. data/spec/api/email_addresses_api_spec.rb +2 -2
  256. data/spec/api/instance_settings_api_spec.rb +3 -3
  257. data/spec/api/invitations_api_spec.rb +1 -1
  258. data/spec/api/jwt_templates_api_spec.rb +2 -2
  259. data/spec/api/{o_auth_applications_api_spec.rb → oauth_applications_api_spec.rb} +15 -15
  260. data/spec/api/organizations_api_spec.rb +1 -1
  261. data/spec/api/phone_numbers_api_spec.rb +2 -2
  262. data/spec/api/proxy_checks_api_spec.rb +1 -1
  263. data/spec/api/redirect_urls_api_spec.rb +1 -1
  264. data/spec/api/saml_connections_api_spec.rb +1 -1
  265. data/spec/api/sign_in_tokens_api_spec.rb +1 -1
  266. data/spec/api/sign_ups_api_spec.rb +1 -1
  267. data/spec/api/users_api_spec.rb +3 -3
  268. data/spec/api/waitlist_entries_api_spec.rb +63 -0
  269. data/spec/models/cname_target_spec.rb +48 -0
  270. data/spec/models/create_bulk_invitations_request_inner_spec.rb +66 -0
  271. data/spec/models/create_oauth_application_request_spec.rb +54 -0
  272. data/spec/models/create_session_request_spec.rb +36 -0
  273. data/spec/models/create_session_token200_response_spec.rb +46 -0
  274. data/spec/models/create_session_token_from_template_request_spec.rb +36 -0
  275. data/spec/models/create_session_token_request_spec.rb +36 -0
  276. data/spec/models/create_waitlist_entry_request_spec.rb +42 -0
  277. data/spec/models/from_o_auth_error_spec.rb +32 -0
  278. data/spec/models/from_o_auth_spec.rb +64 -0
  279. data/spec/models/from_oauth_error_spec.rb +32 -0
  280. data/spec/models/from_oauth_spec.rb +64 -0
  281. data/spec/models/get_oauth_access_token200_response_inner_spec.rb +90 -0
  282. data/spec/models/identification_link_spec.rb +1 -1
  283. data/spec/models/instance_spec.rb +58 -0
  284. data/spec/models/jwks_keys_inner_spec.rb +78 -0
  285. data/spec/models/jwks_spec.rb +36 -0
  286. data/spec/models/list_waitlist_entries200_response_spec.rb +42 -0
  287. data/spec/models/oauth_application_spec.rb +124 -0
  288. data/spec/models/oauth_application_with_secret_spec.rb +130 -0
  289. data/spec/models/oauth_applications_spec.rb +42 -0
  290. data/spec/models/oauth_spec.rb +1 -1
  291. data/spec/models/update_oauth_application_request_spec.rb +48 -0
  292. data/spec/models/waitlist_entry_invitation_spec.rb +98 -0
  293. data/spec/models/waitlist_entry_spec.rb +86 -0
  294. data/spec/spec_helper.rb +1 -1
  295. metadata +104 -65
  296. data/bin/fmt +0 -5
  297. data/bin/generate +0 -8
  298. data/bin/setup +0 -7
  299. data/openapitools.json +0 -7
  300. data/pkg/clerk-http-client-1.0.0.gem +0 -0
  301. data/resources/.DS_Store +0 -0
  302. data/resources/oas/bapi-2024-10-01.yml +0 -7238
  303. data/resources/templates/Gemfile.mustache +0 -9
  304. data/resources/templates/README.mustache +0 -163
  305. data/resources/templates/Rakefile.mustache +0 -10
  306. data/resources/templates/api.mustache +0 -257
  307. data/resources/templates/api_client.mustache +0 -246
  308. data/resources/templates/api_client_faraday_partial.mustache +0 -200
  309. data/resources/templates/api_client_httpx_partial.mustache +0 -134
  310. data/resources/templates/api_client_typhoeus_partial.mustache +0 -161
  311. data/resources/templates/api_doc.mustache +0 -132
  312. data/resources/templates/api_error.mustache +0 -50
  313. data/resources/templates/api_info.mustache +0 -12
  314. data/resources/templates/api_test.mustache +0 -47
  315. data/resources/templates/base_object.mustache +0 -114
  316. data/resources/templates/configuration.mustache +0 -491
  317. data/resources/templates/configuration_faraday_partial.mustache +0 -40
  318. data/resources/templates/configuration_httpx_partial.mustache +0 -11
  319. data/resources/templates/configuration_typhoeus_partial.mustache +0 -41
  320. data/resources/templates/gem.mustache +0 -89
  321. data/resources/templates/gemspec.mustache +0 -41
  322. data/resources/templates/git_push.sh.mustache +0 -57
  323. data/resources/templates/gitignore.mustache +0 -39
  324. data/resources/templates/gitlab-ci.mustache +0 -26
  325. data/resources/templates/model.mustache +0 -33
  326. data/resources/templates/model_doc.mustache +0 -12
  327. data/resources/templates/model_test.mustache +0 -82
  328. data/resources/templates/partial_model_enum_class.mustache +0 -23
  329. data/resources/templates/partial_model_generic.mustache +0 -377
  330. data/resources/templates/partial_model_generic_doc.mustache +0 -28
  331. data/resources/templates/partial_oneof_module_doc.mustache +0 -93
  332. data/resources/templates/rspec.mustache +0 -2
  333. data/resources/templates/rubocop.mustache +0 -148
  334. data/resources/templates/spec_helper.mustache +0 -103
  335. data/resources/templates/travis.mustache +0 -11
  336. data/resources/templates/version.mustache +0 -7
  337. data/sdk-generator-config.json +0 -25
  338. /data/docs/{CNameTarget.md → CnameTarget.md} +0 -0
  339. /data/docs/{CreateRedirectURLRequest.md → CreateRedirectUrlRequest.md} +0 -0
  340. /data/docs/{OAuthApplications.md → OauthApplications.md} +0 -0
  341. /data/docs/{RedirectURL.md → RedirectUrl.md} +0 -0
  342. /data/docs/{SvixURL.md → SvixUrl.md} +0 -0
  343. /data/docs/{UpdateOAuthApplicationRequest.md → UpdateOauthApplicationRequest.md} +0 -0
data/docs/UsersApi.md CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.clerk.com/v1*
13
13
  | [**delete_user**](UsersApi.md#delete_user) | **DELETE** /users/{user_id} | Delete a user |
14
14
  | [**delete_user_profile_image**](UsersApi.md#delete_user_profile_image) | **DELETE** /users/{user_id}/profile_image | Delete user profile image |
15
15
  | [**disable_mfa**](UsersApi.md#disable_mfa) | **DELETE** /users/{user_id}/mfa | Disable a user's MFA methods |
16
- | [**get_o_auth_access_token**](UsersApi.md#get_o_auth_access_token) | **GET** /users/{user_id}/oauth_access_tokens/{provider} | Retrieve the OAuth access token of a user |
16
+ | [**get_oauth_access_token**](UsersApi.md#get_oauth_access_token) | **GET** /users/{user_id}/oauth_access_tokens/{provider} | Retrieve the OAuth access token of a user |
17
17
  | [**get_user**](UsersApi.md#get_user) | **GET** /users/{user_id} | Retrieve a user |
18
18
  | [**get_user_list**](UsersApi.md#get_user_list) | **GET** /users | List all users |
19
19
  | [**get_users_count**](UsersApi.md#get_users_count) | **GET** /users/count | Count users |
@@ -43,26 +43,25 @@ Marks the given user as banned, which means that all their sessions are revoked
43
43
 
44
44
  ```ruby
45
45
  require 'time'
46
- require 'clerk-http-client'
47
- # setup authorization
48
- ClerkHttpClient.configure do |config|
49
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
50
- config.access_token = 'YOUR_BEARER_TOKEN'
46
+ require 'clerk'
47
+
48
+ ## Setup
49
+ Clerk.configure do |config|
50
+ config.secret_key = 'sk_test_xxxxxxxxx'
51
51
  end
52
52
 
53
- api_instance = ClerkHttpClient::UsersApi.new
54
53
  user_id = 'user_id_example' # String | The ID of the user to ban
55
54
 
56
55
  begin
57
56
  # Ban a user
58
- result = api_instance.ban_user(user_id)
57
+ result = Clerk::SDK.users.ban_user(user_id)
59
58
  p result
60
59
  rescue ClerkHttpClient::ApiError => e
61
- puts "Error when calling UsersApi->ban_user: #{e}"
60
+ puts "Error when calling Clerk::SDK.users->ban_user: #{e}"
62
61
  end
63
62
  ```
64
63
 
65
- #### Using the ban_user_with_http_info variant
64
+ #### Using the `ban_user_with_http_info variant
66
65
 
67
66
  This returns an Array which contains the response data, status code and headers.
68
67
 
@@ -71,12 +70,12 @@ This returns an Array which contains the response data, status code and headers.
71
70
  ```ruby
72
71
  begin
73
72
  # Ban a user
74
- data, status_code, headers = api_instance.ban_user_with_http_info(user_id)
73
+ data, status_code, headers = Clerk::SDK.users.ban_user_with_http_info(user_id)
75
74
  p status_code # => 2xx
76
75
  p headers # => { ... }
77
76
  p data # => <User>
78
77
  rescue ClerkHttpClient::ApiError => e
79
- puts "Error when calling UsersApi->ban_user_with_http_info: #{e}"
78
+ puts "Error when calling Clerk::SDK.users->ban_user_with_http_info: #{e}"
80
79
  end
81
80
  ```
82
81
 
@@ -112,26 +111,25 @@ Creates a new user. Your user management settings determine how you should setup
112
111
 
113
112
  ```ruby
114
113
  require 'time'
115
- require 'clerk-http-client'
116
- # setup authorization
117
- ClerkHttpClient.configure do |config|
118
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
119
- config.access_token = 'YOUR_BEARER_TOKEN'
114
+ require 'clerk'
115
+
116
+ ## Setup
117
+ Clerk.configure do |config|
118
+ config.secret_key = 'sk_test_xxxxxxxxx'
120
119
  end
121
120
 
122
- api_instance = ClerkHttpClient::UsersApi.new
123
121
  create_user_request = ClerkHttpClient::CreateUserRequest.new # CreateUserRequest |
124
122
 
125
123
  begin
126
124
  # Create a new user
127
- result = api_instance.create_user(create_user_request)
125
+ result = Clerk::SDK.users.create_user(create_user_request)
128
126
  p result
129
127
  rescue ClerkHttpClient::ApiError => e
130
- puts "Error when calling UsersApi->create_user: #{e}"
128
+ puts "Error when calling Clerk::SDK.users->create_user: #{e}"
131
129
  end
132
130
  ```
133
131
 
134
- #### Using the create_user_with_http_info variant
132
+ #### Using the `create_user_with_http_info variant
135
133
 
136
134
  This returns an Array which contains the response data, status code and headers.
137
135
 
@@ -140,12 +138,12 @@ This returns an Array which contains the response data, status code and headers.
140
138
  ```ruby
141
139
  begin
142
140
  # Create a new user
143
- data, status_code, headers = api_instance.create_user_with_http_info(create_user_request)
141
+ data, status_code, headers = Clerk::SDK.users.create_user_with_http_info(create_user_request)
144
142
  p status_code # => 2xx
145
143
  p headers # => { ... }
146
144
  p data # => <User>
147
145
  rescue ClerkHttpClient::ApiError => e
148
- puts "Error when calling UsersApi->create_user_with_http_info: #{e}"
146
+ puts "Error when calling Clerk::SDK.users->create_user_with_http_info: #{e}"
149
147
  end
150
148
  ```
151
149
 
@@ -181,26 +179,25 @@ Creates a TOTP (Time-based One-Time Password) for a given user, returning both t
181
179
 
182
180
  ```ruby
183
181
  require 'time'
184
- require 'clerk-http-client'
185
- # setup authorization
186
- ClerkHttpClient.configure do |config|
187
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
188
- config.access_token = 'YOUR_BEARER_TOKEN'
182
+ require 'clerk'
183
+
184
+ ## Setup
185
+ Clerk.configure do |config|
186
+ config.secret_key = 'sk_test_xxxxxxxxx'
189
187
  end
190
188
 
191
- api_instance = ClerkHttpClient::UsersApi.new
192
189
  user_id = 'user_id_example' # String | The ID of the user for whom the TOTP is being created.
193
190
 
194
191
  begin
195
192
  # Create a TOTP for a user
196
- result = api_instance.create_user_totp(user_id)
193
+ result = Clerk::SDK.users.create_user_totp(user_id)
197
194
  p result
198
195
  rescue ClerkHttpClient::ApiError => e
199
- puts "Error when calling UsersApi->create_user_totp: #{e}"
196
+ puts "Error when calling Clerk::SDK.users->create_user_totp: #{e}"
200
197
  end
201
198
  ```
202
199
 
203
- #### Using the create_user_totp_with_http_info variant
200
+ #### Using the `create_user_totp_with_http_info variant
204
201
 
205
202
  This returns an Array which contains the response data, status code and headers.
206
203
 
@@ -209,12 +206,12 @@ This returns an Array which contains the response data, status code and headers.
209
206
  ```ruby
210
207
  begin
211
208
  # Create a TOTP for a user
212
- data, status_code, headers = api_instance.create_user_totp_with_http_info(user_id)
209
+ data, status_code, headers = Clerk::SDK.users.create_user_totp_with_http_info(user_id)
213
210
  p status_code # => 2xx
214
211
  p headers # => { ... }
215
212
  p data # => <TOTP>
216
213
  rescue ClerkHttpClient::ApiError => e
217
- puts "Error when calling UsersApi->create_user_totp_with_http_info: #{e}"
214
+ puts "Error when calling Clerk::SDK.users->create_user_totp_with_http_info: #{e}"
218
215
  end
219
216
  ```
220
217
 
@@ -250,26 +247,25 @@ Disable all of a user's backup codes.
250
247
 
251
248
  ```ruby
252
249
  require 'time'
253
- require 'clerk-http-client'
254
- # setup authorization
255
- ClerkHttpClient.configure do |config|
256
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
257
- config.access_token = 'YOUR_BEARER_TOKEN'
250
+ require 'clerk'
251
+
252
+ ## Setup
253
+ Clerk.configure do |config|
254
+ config.secret_key = 'sk_test_xxxxxxxxx'
258
255
  end
259
256
 
260
- api_instance = ClerkHttpClient::UsersApi.new
261
257
  user_id = 'user_id_example' # String | The ID of the user whose backup codes are to be deleted.
262
258
 
263
259
  begin
264
260
  # Disable all user's Backup codes
265
- result = api_instance.delete_backup_code(user_id)
261
+ result = Clerk::SDK.users.delete_backup_code(user_id)
266
262
  p result
267
263
  rescue ClerkHttpClient::ApiError => e
268
- puts "Error when calling UsersApi->delete_backup_code: #{e}"
264
+ puts "Error when calling Clerk::SDK.users->delete_backup_code: #{e}"
269
265
  end
270
266
  ```
271
267
 
272
- #### Using the delete_backup_code_with_http_info variant
268
+ #### Using the `delete_backup_code_with_http_info variant
273
269
 
274
270
  This returns an Array which contains the response data, status code and headers.
275
271
 
@@ -278,12 +274,12 @@ This returns an Array which contains the response data, status code and headers.
278
274
  ```ruby
279
275
  begin
280
276
  # Disable all user's Backup codes
281
- data, status_code, headers = api_instance.delete_backup_code_with_http_info(user_id)
277
+ data, status_code, headers = Clerk::SDK.users.delete_backup_code_with_http_info(user_id)
282
278
  p status_code # => 2xx
283
279
  p headers # => { ... }
284
280
  p data # => <DisableMFA200Response>
285
281
  rescue ClerkHttpClient::ApiError => e
286
- puts "Error when calling UsersApi->delete_backup_code_with_http_info: #{e}"
282
+ puts "Error when calling Clerk::SDK.users->delete_backup_code_with_http_info: #{e}"
287
283
  end
288
284
  ```
289
285
 
@@ -319,27 +315,26 @@ Delete an external account by ID.
319
315
 
320
316
  ```ruby
321
317
  require 'time'
322
- require 'clerk-http-client'
323
- # setup authorization
324
- ClerkHttpClient.configure do |config|
325
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
326
- config.access_token = 'YOUR_BEARER_TOKEN'
318
+ require 'clerk'
319
+
320
+ ## Setup
321
+ Clerk.configure do |config|
322
+ config.secret_key = 'sk_test_xxxxxxxxx'
327
323
  end
328
324
 
329
- api_instance = ClerkHttpClient::UsersApi.new
330
325
  user_id = 'user_id_example' # String | The ID of the user's external account
331
326
  external_account_id = 'external_account_id_example' # String | The ID of the external account to delete
332
327
 
333
328
  begin
334
329
  # Delete External Account
335
- result = api_instance.delete_external_account(user_id, external_account_id)
330
+ result = Clerk::SDK.users.delete_external_account(user_id, external_account_id)
336
331
  p result
337
332
  rescue ClerkHttpClient::ApiError => e
338
- puts "Error when calling UsersApi->delete_external_account: #{e}"
333
+ puts "Error when calling Clerk::SDK.users->delete_external_account: #{e}"
339
334
  end
340
335
  ```
341
336
 
342
- #### Using the delete_external_account_with_http_info variant
337
+ #### Using the `delete_external_account_with_http_info variant
343
338
 
344
339
  This returns an Array which contains the response data, status code and headers.
345
340
 
@@ -348,12 +343,12 @@ This returns an Array which contains the response data, status code and headers.
348
343
  ```ruby
349
344
  begin
350
345
  # Delete External Account
351
- data, status_code, headers = api_instance.delete_external_account_with_http_info(user_id, external_account_id)
346
+ data, status_code, headers = Clerk::SDK.users.delete_external_account_with_http_info(user_id, external_account_id)
352
347
  p status_code # => 2xx
353
348
  p headers # => { ... }
354
349
  p data # => <DeletedObject>
355
350
  rescue ClerkHttpClient::ApiError => e
356
- puts "Error when calling UsersApi->delete_external_account_with_http_info: #{e}"
351
+ puts "Error when calling Clerk::SDK.users->delete_external_account_with_http_info: #{e}"
357
352
  end
358
353
  ```
359
354
 
@@ -390,26 +385,25 @@ Deletes all of the user's TOTPs.
390
385
 
391
386
  ```ruby
392
387
  require 'time'
393
- require 'clerk-http-client'
394
- # setup authorization
395
- ClerkHttpClient.configure do |config|
396
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
397
- config.access_token = 'YOUR_BEARER_TOKEN'
388
+ require 'clerk'
389
+
390
+ ## Setup
391
+ Clerk.configure do |config|
392
+ config.secret_key = 'sk_test_xxxxxxxxx'
398
393
  end
399
394
 
400
- api_instance = ClerkHttpClient::UsersApi.new
401
395
  user_id = 'user_id_example' # String | The ID of the user whose TOTPs are to be deleted
402
396
 
403
397
  begin
404
398
  # Delete all the user's TOTPs
405
- result = api_instance.delete_totp(user_id)
399
+ result = Clerk::SDK.users.delete_totp(user_id)
406
400
  p result
407
401
  rescue ClerkHttpClient::ApiError => e
408
- puts "Error when calling UsersApi->delete_totp: #{e}"
402
+ puts "Error when calling Clerk::SDK.users->delete_totp: #{e}"
409
403
  end
410
404
  ```
411
405
 
412
- #### Using the delete_totp_with_http_info variant
406
+ #### Using the `delete_totp_with_http_info variant
413
407
 
414
408
  This returns an Array which contains the response data, status code and headers.
415
409
 
@@ -418,12 +412,12 @@ This returns an Array which contains the response data, status code and headers.
418
412
  ```ruby
419
413
  begin
420
414
  # Delete all the user's TOTPs
421
- data, status_code, headers = api_instance.delete_totp_with_http_info(user_id)
415
+ data, status_code, headers = Clerk::SDK.users.delete_totp_with_http_info(user_id)
422
416
  p status_code # => 2xx
423
417
  p headers # => { ... }
424
418
  p data # => <DisableMFA200Response>
425
419
  rescue ClerkHttpClient::ApiError => e
426
- puts "Error when calling UsersApi->delete_totp_with_http_info: #{e}"
420
+ puts "Error when calling Clerk::SDK.users->delete_totp_with_http_info: #{e}"
427
421
  end
428
422
  ```
429
423
 
@@ -459,26 +453,25 @@ Delete the specified user
459
453
 
460
454
  ```ruby
461
455
  require 'time'
462
- require 'clerk-http-client'
463
- # setup authorization
464
- ClerkHttpClient.configure do |config|
465
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
466
- config.access_token = 'YOUR_BEARER_TOKEN'
456
+ require 'clerk'
457
+
458
+ ## Setup
459
+ Clerk.configure do |config|
460
+ config.secret_key = 'sk_test_xxxxxxxxx'
467
461
  end
468
462
 
469
- api_instance = ClerkHttpClient::UsersApi.new
470
463
  user_id = 'user_id_example' # String | The ID of the user to delete
471
464
 
472
465
  begin
473
466
  # Delete a user
474
- result = api_instance.delete_user(user_id)
467
+ result = Clerk::SDK.users.delete_user(user_id)
475
468
  p result
476
469
  rescue ClerkHttpClient::ApiError => e
477
- puts "Error when calling UsersApi->delete_user: #{e}"
470
+ puts "Error when calling Clerk::SDK.users->delete_user: #{e}"
478
471
  end
479
472
  ```
480
473
 
481
- #### Using the delete_user_with_http_info variant
474
+ #### Using the `delete_user_with_http_info variant
482
475
 
483
476
  This returns an Array which contains the response data, status code and headers.
484
477
 
@@ -487,12 +480,12 @@ This returns an Array which contains the response data, status code and headers.
487
480
  ```ruby
488
481
  begin
489
482
  # Delete a user
490
- data, status_code, headers = api_instance.delete_user_with_http_info(user_id)
483
+ data, status_code, headers = Clerk::SDK.users.delete_user_with_http_info(user_id)
491
484
  p status_code # => 2xx
492
485
  p headers # => { ... }
493
486
  p data # => <DeletedObject>
494
487
  rescue ClerkHttpClient::ApiError => e
495
- puts "Error when calling UsersApi->delete_user_with_http_info: #{e}"
488
+ puts "Error when calling Clerk::SDK.users->delete_user_with_http_info: #{e}"
496
489
  end
497
490
  ```
498
491
 
@@ -528,26 +521,25 @@ Delete a user's profile image
528
521
 
529
522
  ```ruby
530
523
  require 'time'
531
- require 'clerk-http-client'
532
- # setup authorization
533
- ClerkHttpClient.configure do |config|
534
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
535
- config.access_token = 'YOUR_BEARER_TOKEN'
524
+ require 'clerk'
525
+
526
+ ## Setup
527
+ Clerk.configure do |config|
528
+ config.secret_key = 'sk_test_xxxxxxxxx'
536
529
  end
537
530
 
538
- api_instance = ClerkHttpClient::UsersApi.new
539
531
  user_id = 'user_id_example' # String | The ID of the user to delete the profile image for
540
532
 
541
533
  begin
542
534
  # Delete user profile image
543
- result = api_instance.delete_user_profile_image(user_id)
535
+ result = Clerk::SDK.users.delete_user_profile_image(user_id)
544
536
  p result
545
537
  rescue ClerkHttpClient::ApiError => e
546
- puts "Error when calling UsersApi->delete_user_profile_image: #{e}"
538
+ puts "Error when calling Clerk::SDK.users->delete_user_profile_image: #{e}"
547
539
  end
548
540
  ```
549
541
 
550
- #### Using the delete_user_profile_image_with_http_info variant
542
+ #### Using the `delete_user_profile_image_with_http_info variant
551
543
 
552
544
  This returns an Array which contains the response data, status code and headers.
553
545
 
@@ -556,12 +548,12 @@ This returns an Array which contains the response data, status code and headers.
556
548
  ```ruby
557
549
  begin
558
550
  # Delete user profile image
559
- data, status_code, headers = api_instance.delete_user_profile_image_with_http_info(user_id)
551
+ data, status_code, headers = Clerk::SDK.users.delete_user_profile_image_with_http_info(user_id)
560
552
  p status_code # => 2xx
561
553
  p headers # => { ... }
562
554
  p data # => <User>
563
555
  rescue ClerkHttpClient::ApiError => e
564
- puts "Error when calling UsersApi->delete_user_profile_image_with_http_info: #{e}"
556
+ puts "Error when calling Clerk::SDK.users->delete_user_profile_image_with_http_info: #{e}"
565
557
  end
566
558
  ```
567
559
 
@@ -597,26 +589,25 @@ Disable all of a user's MFA methods (e.g. OTP sent via SMS, TOTP on their authen
597
589
 
598
590
  ```ruby
599
591
  require 'time'
600
- require 'clerk-http-client'
601
- # setup authorization
602
- ClerkHttpClient.configure do |config|
603
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
604
- config.access_token = 'YOUR_BEARER_TOKEN'
592
+ require 'clerk'
593
+
594
+ ## Setup
595
+ Clerk.configure do |config|
596
+ config.secret_key = 'sk_test_xxxxxxxxx'
605
597
  end
606
598
 
607
- api_instance = ClerkHttpClient::UsersApi.new
608
599
  user_id = 'user_id_example' # String | The ID of the user whose MFA methods are to be disabled
609
600
 
610
601
  begin
611
602
  # Disable a user's MFA methods
612
- result = api_instance.disable_mfa(user_id)
603
+ result = Clerk::SDK.users.disable_mfa(user_id)
613
604
  p result
614
605
  rescue ClerkHttpClient::ApiError => e
615
- puts "Error when calling UsersApi->disable_mfa: #{e}"
606
+ puts "Error when calling Clerk::SDK.users->disable_mfa: #{e}"
616
607
  end
617
608
  ```
618
609
 
619
- #### Using the disable_mfa_with_http_info variant
610
+ #### Using the `disable_mfa_with_http_info variant
620
611
 
621
612
  This returns an Array which contains the response data, status code and headers.
622
613
 
@@ -625,12 +616,12 @@ This returns an Array which contains the response data, status code and headers.
625
616
  ```ruby
626
617
  begin
627
618
  # Disable a user's MFA methods
628
- data, status_code, headers = api_instance.disable_mfa_with_http_info(user_id)
619
+ data, status_code, headers = Clerk::SDK.users.disable_mfa_with_http_info(user_id)
629
620
  p status_code # => 2xx
630
621
  p headers # => { ... }
631
622
  p data # => <DisableMFA200Response>
632
623
  rescue ClerkHttpClient::ApiError => e
633
- puts "Error when calling UsersApi->disable_mfa_with_http_info: #{e}"
624
+ puts "Error when calling Clerk::SDK.users->disable_mfa_with_http_info: #{e}"
634
625
  end
635
626
  ```
636
627
 
@@ -654,9 +645,9 @@ end
654
645
  - **Accept**: application/json
655
646
 
656
647
 
657
- ## get_o_auth_access_token
648
+ ## get_oauth_access_token
658
649
 
659
- > <Array<GetOAuthAccessToken200ResponseInner>> get_o_auth_access_token(user_id, provider)
650
+ > <Array<GetOAuthAccessToken200ResponseInner>> get_oauth_access_token(user_id, provider)
660
651
 
661
652
  Retrieve the OAuth access token of a user
662
653
 
@@ -666,41 +657,40 @@ Fetch the corresponding OAuth access token for a user that has previously authen
666
657
 
667
658
  ```ruby
668
659
  require 'time'
669
- require 'clerk-http-client'
670
- # setup authorization
671
- ClerkHttpClient.configure do |config|
672
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
673
- config.access_token = 'YOUR_BEARER_TOKEN'
660
+ require 'clerk'
661
+
662
+ ## Setup
663
+ Clerk.configure do |config|
664
+ config.secret_key = 'sk_test_xxxxxxxxx'
674
665
  end
675
666
 
676
- api_instance = ClerkHttpClient::UsersApi.new
677
667
  user_id = 'user_id_example' # String | The ID of the user for which to retrieve the OAuth access token
678
668
  provider = 'provider_example' # String | The ID of the OAuth provider (e.g. `oauth_google`)
679
669
 
680
670
  begin
681
671
  # Retrieve the OAuth access token of a user
682
- result = api_instance.get_o_auth_access_token(user_id, provider)
672
+ result = Clerk::SDK.users.get_oauth_access_token(user_id, provider)
683
673
  p result
684
674
  rescue ClerkHttpClient::ApiError => e
685
- puts "Error when calling UsersApi->get_o_auth_access_token: #{e}"
675
+ puts "Error when calling Clerk::SDK.users->get_oauth_access_token: #{e}"
686
676
  end
687
677
  ```
688
678
 
689
- #### Using the get_o_auth_access_token_with_http_info variant
679
+ #### Using the `get_oauth_access_token_with_http_info variant
690
680
 
691
681
  This returns an Array which contains the response data, status code and headers.
692
682
 
693
- > <Array(<Array<GetOAuthAccessToken200ResponseInner>>, Integer, Hash)> get_o_auth_access_token_with_http_info(user_id, provider)
683
+ > <Array(<Array<GetOAuthAccessToken200ResponseInner>>, Integer, Hash)> get_oauth_access_token_with_http_info(user_id, provider)
694
684
 
695
685
  ```ruby
696
686
  begin
697
687
  # Retrieve the OAuth access token of a user
698
- data, status_code, headers = api_instance.get_o_auth_access_token_with_http_info(user_id, provider)
688
+ data, status_code, headers = Clerk::SDK.users.get_oauth_access_token_with_http_info(user_id, provider)
699
689
  p status_code # => 2xx
700
690
  p headers # => { ... }
701
691
  p data # => <Array<GetOAuthAccessToken200ResponseInner>>
702
692
  rescue ClerkHttpClient::ApiError => e
703
- puts "Error when calling UsersApi->get_o_auth_access_token_with_http_info: #{e}"
693
+ puts "Error when calling Clerk::SDK.users->get_oauth_access_token_with_http_info: #{e}"
704
694
  end
705
695
  ```
706
696
 
@@ -737,26 +727,25 @@ Retrieve the details of a user
737
727
 
738
728
  ```ruby
739
729
  require 'time'
740
- require 'clerk-http-client'
741
- # setup authorization
742
- ClerkHttpClient.configure do |config|
743
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
744
- config.access_token = 'YOUR_BEARER_TOKEN'
730
+ require 'clerk'
731
+
732
+ ## Setup
733
+ Clerk.configure do |config|
734
+ config.secret_key = 'sk_test_xxxxxxxxx'
745
735
  end
746
736
 
747
- api_instance = ClerkHttpClient::UsersApi.new
748
737
  user_id = 'user_id_example' # String | The ID of the user to retrieve
749
738
 
750
739
  begin
751
740
  # Retrieve a user
752
- result = api_instance.get_user(user_id)
741
+ result = Clerk::SDK.users.get_user(user_id)
753
742
  p result
754
743
  rescue ClerkHttpClient::ApiError => e
755
- puts "Error when calling UsersApi->get_user: #{e}"
744
+ puts "Error when calling Clerk::SDK.users->get_user: #{e}"
756
745
  end
757
746
  ```
758
747
 
759
- #### Using the get_user_with_http_info variant
748
+ #### Using the `get_user_with_http_info variant
760
749
 
761
750
  This returns an Array which contains the response data, status code and headers.
762
751
 
@@ -765,12 +754,12 @@ This returns an Array which contains the response data, status code and headers.
765
754
  ```ruby
766
755
  begin
767
756
  # Retrieve a user
768
- data, status_code, headers = api_instance.get_user_with_http_info(user_id)
757
+ data, status_code, headers = Clerk::SDK.users.get_user_with_http_info(user_id)
769
758
  p status_code # => 2xx
770
759
  p headers # => { ... }
771
760
  p data # => <User>
772
761
  rescue ClerkHttpClient::ApiError => e
773
- puts "Error when calling UsersApi->get_user_with_http_info: #{e}"
762
+ puts "Error when calling Clerk::SDK.users->get_user_with_http_info: #{e}"
774
763
  end
775
764
  ```
776
765
 
@@ -806,14 +795,13 @@ Returns a list of all users. The users are returned sorted by creation date, wit
806
795
 
807
796
  ```ruby
808
797
  require 'time'
809
- require 'clerk-http-client'
810
- # setup authorization
811
- ClerkHttpClient.configure do |config|
812
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
813
- config.access_token = 'YOUR_BEARER_TOKEN'
798
+ require 'clerk'
799
+
800
+ ## Setup
801
+ Clerk.configure do |config|
802
+ config.secret_key = 'sk_test_xxxxxxxxx'
814
803
  end
815
804
 
816
- api_instance = ClerkHttpClient::UsersApi.new
817
805
  opts = {
818
806
  email_address: ['inner_example'], # Array<String> | Returns users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored.
819
807
  phone_number: ['inner_example'], # Array<String> | Returns users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored.
@@ -823,7 +811,15 @@ opts = {
823
811
  user_id: ['inner_example'], # Array<String> | Returns users with the user ids specified. For each user id, the `+` and `-` can be prepended to the id, which denote whether the respective user id should be included or excluded from the result set. Accepts up to 100 user ids. Any user ids not found are ignored.
824
812
  organization_id: ['inner_example'], # Array<String> | Returns users that have memberships to the given organizations. For each organization id, the `+` and `-` can be prepended to the id, which denote whether the respective organization should be included or excluded from the result set. Accepts up to 100 organization ids.
825
813
  query: 'query_example', # String | Returns users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user ids, first and last names. The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well.
826
- last_active_at_since: 1700690400000, # Integer | Returns users that had session activity since the given date, with day precision. Providing a value with higher precision than day will result in an error. Example: use 1700690400000 to retrieve users that had session activity from 2023-11-23 until the current day.
814
+ email_address_query: 'email_address_query_example', # String | Returns users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will match a user with the email `HELLO@example.com`.
815
+ phone_number_query: 'phone_number_query_example', # String | Returns users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555` will match a user with the phone number `+1555xxxxxxx`.
816
+ username_query: 'username_query_example', # String | Returns users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will match a user with the username `SomeCoolUser`.
817
+ name_query: 'name_query_example', # String | Returns users with names that match the given query, via case-insensitive partial match.
818
+ last_active_at_before: 1700690400000, # Integer | Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose last session activity was before 2023-11-23.
819
+ last_active_at_after: 1700690400000, # Integer | Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose last session activity was after 2023-11-23.
820
+ last_active_at_since: 1700690400000, # Integer | Returns users that had session activity since the given date. Example: use 1700690400000 to retrieve users that had session activity from 2023-11-23 until the current day. Deprecated in favor of `last_active_at_after`.
821
+ created_at_before: 1730160000000, # Integer | Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who have been created before 2024-10-29.
822
+ created_at_after: 1730160000000, # Integer | Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who have been created after 2024-10-29.
827
823
  limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
828
824
  offset: 8.14, # Float | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
829
825
  order_by: 'order_by_example' # String | Allows to return users in a particular order. At the moment, you can order the returned users by their `created_at`,`updated_at`,`email_address`,`web3wallet`,`first_name`,`last_name`,`phone_number`,`username`,`last_active_at`,`last_sign_in_at`. In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by. For example, if you want users to be returned in descending order according to their `created_at` property, you can use `-created_at`. If you don't use `+` or `-`, then `+` is implied. We only support one `order_by` parameter, and if multiple `order_by` parameters are provided, we will only keep the first one. For example, if you pass `order_by=username&order_by=created_at`, we will consider only the first `order_by` parameter, which is `username`. The `created_at` parameter will be ignored in this case.
@@ -831,14 +827,14 @@ opts = {
831
827
 
832
828
  begin
833
829
  # List all users
834
- result = api_instance.get_user_list(opts)
830
+ result = Clerk::SDK.users.get_user_list(opts)
835
831
  p result
836
832
  rescue ClerkHttpClient::ApiError => e
837
- puts "Error when calling UsersApi->get_user_list: #{e}"
833
+ puts "Error when calling Clerk::SDK.users->get_user_list: #{e}"
838
834
  end
839
835
  ```
840
836
 
841
- #### Using the get_user_list_with_http_info variant
837
+ #### Using the `get_user_list_with_http_info variant
842
838
 
843
839
  This returns an Array which contains the response data, status code and headers.
844
840
 
@@ -847,12 +843,12 @@ This returns an Array which contains the response data, status code and headers.
847
843
  ```ruby
848
844
  begin
849
845
  # List all users
850
- data, status_code, headers = api_instance.get_user_list_with_http_info(opts)
846
+ data, status_code, headers = Clerk::SDK.users.get_user_list_with_http_info(opts)
851
847
  p status_code # => 2xx
852
848
  p headers # => { ... }
853
849
  p data # => <Array<User>>
854
850
  rescue ClerkHttpClient::ApiError => e
855
- puts "Error when calling UsersApi->get_user_list_with_http_info: #{e}"
851
+ puts "Error when calling Clerk::SDK.users->get_user_list_with_http_info: #{e}"
856
852
  end
857
853
  ```
858
854
 
@@ -868,7 +864,15 @@ end
868
864
  | **user_id** | [**Array&lt;String&gt;**](String.md) | Returns users with the user ids specified. For each user id, the &#x60;+&#x60; and &#x60;-&#x60; can be prepended to the id, which denote whether the respective user id should be included or excluded from the result set. Accepts up to 100 user ids. Any user ids not found are ignored. | [optional] |
869
865
  | **organization_id** | [**Array&lt;String&gt;**](String.md) | Returns users that have memberships to the given organizations. For each organization id, the &#x60;+&#x60; and &#x60;-&#x60; can be prepended to the id, which denote whether the respective organization should be included or excluded from the result set. Accepts up to 100 organization ids. | [optional] |
870
866
  | **query** | **String** | Returns users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user ids, first and last names. The query value doesn&#39;t need to match the exact value you are looking for, it is capable of partial matches as well. | [optional] |
871
- | **last_active_at_since** | **Integer** | Returns users that had session activity since the given date, with day precision. Providing a value with higher precision than day will result in an error. Example: use 1700690400000 to retrieve users that had session activity from 2023-11-23 until the current day. | [optional] |
867
+ | **email_address_query** | **String** | Returns users with emails that match the given query, via case-insensitive partial match. For example, &#x60;email_address_query&#x3D;ello&#x60; will match a user with the email &#x60;HELLO@example.com&#x60;. | [optional] |
868
+ | **phone_number_query** | **String** | Returns users with phone numbers that match the given query, via case-insensitive partial match. For example, &#x60;phone_number_query&#x3D;555&#x60; will match a user with the phone number &#x60;+1555xxxxxxx&#x60;. | [optional] |
869
+ | **username_query** | **String** | Returns users with usernames that match the given query, via case-insensitive partial match. For example, &#x60;username_query&#x3D;CoolUser&#x60; will match a user with the username &#x60;SomeCoolUser&#x60;. | [optional] |
870
+ | **name_query** | **String** | Returns users with names that match the given query, via case-insensitive partial match. | [optional] |
871
+ | **last_active_at_before** | **Integer** | Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose last session activity was before 2023-11-23. | [optional] |
872
+ | **last_active_at_after** | **Integer** | Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose last session activity was after 2023-11-23. | [optional] |
873
+ | **last_active_at_since** | **Integer** | Returns users that had session activity since the given date. Example: use 1700690400000 to retrieve users that had session activity from 2023-11-23 until the current day. Deprecated in favor of &#x60;last_active_at_after&#x60;. | [optional] |
874
+ | **created_at_before** | **Integer** | Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who have been created before 2024-10-29. | [optional] |
875
+ | **created_at_after** | **Integer** | Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who have been created after 2024-10-29. | [optional] |
872
876
  | **limit** | **Float** | Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. | [optional][default to 10] |
873
877
  | **offset** | **Float** | Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. | [optional][default to 0] |
874
878
  | **order_by** | **String** | Allows to return users in a particular order. At the moment, you can order the returned users by their &#x60;created_at&#x60;,&#x60;updated_at&#x60;,&#x60;email_address&#x60;,&#x60;web3wallet&#x60;,&#x60;first_name&#x60;,&#x60;last_name&#x60;,&#x60;phone_number&#x60;,&#x60;username&#x60;,&#x60;last_active_at&#x60;,&#x60;last_sign_in_at&#x60;. In order to specify the direction, you can use the &#x60;+/-&#x60; symbols prepended in the property to order by. For example, if you want users to be returned in descending order according to their &#x60;created_at&#x60; property, you can use &#x60;-created_at&#x60;. If you don&#39;t use &#x60;+&#x60; or &#x60;-&#x60;, then &#x60;+&#x60; is implied. We only support one &#x60;order_by&#x60; parameter, and if multiple &#x60;order_by&#x60; parameters are provided, we will only keep the first one. For example, if you pass &#x60;order_by&#x3D;username&amp;order_by&#x3D;created_at&#x60;, we will consider only the first &#x60;order_by&#x60; parameter, which is &#x60;username&#x60;. The &#x60;created_at&#x60; parameter will be ignored in this case. | [optional][default to &#39;-created_at&#39;] |
@@ -899,14 +903,13 @@ Returns a total count of all users that match the given filtering criteria.
899
903
 
900
904
  ```ruby
901
905
  require 'time'
902
- require 'clerk-http-client'
903
- # setup authorization
904
- ClerkHttpClient.configure do |config|
905
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
906
- config.access_token = 'YOUR_BEARER_TOKEN'
906
+ require 'clerk'
907
+
908
+ ## Setup
909
+ Clerk.configure do |config|
910
+ config.secret_key = 'sk_test_xxxxxxxxx'
907
911
  end
908
912
 
909
- api_instance = ClerkHttpClient::UsersApi.new
910
913
  opts = {
911
914
  email_address: ['inner_example'], # Array<String> | Counts users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored.
912
915
  phone_number: ['inner_example'], # Array<String> | Counts users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored.
@@ -914,19 +917,22 @@ opts = {
914
917
  username: ['inner_example'], # Array<String> | Counts users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored.
915
918
  web3_wallet: ['inner_example'], # Array<String> | Counts users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addressed not found are ignored.
916
919
  user_id: ['inner_example'], # Array<String> | Counts users with the user ids specified. Accepts up to 100 user ids. Any user ids not found are ignored.
917
- query: 'query_example' # String | Counts users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user ids, first and last names. The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well.
920
+ query: 'query_example', # String | Counts users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user ids, first and last names. The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well.
921
+ email_address_query: 'email_address_query_example', # String | Counts users with emails that match the given query, via case-insensitive partial match. For example, `email_address_query=ello` will match a user with the email `HELLO@example.com`, and will be included in the resulting count.
922
+ phone_number_query: 'phone_number_query_example', # String | Counts users with phone numbers that match the given query, via case-insensitive partial match. For example, `phone_number_query=555` will match a user with the phone number `+1555xxxxxxx`, and will be included in the resulting count.
923
+ username_query: 'username_query_example' # String | Counts users with usernames that match the given query, via case-insensitive partial match. For example, `username_query=CoolUser` will match a user with the username `SomeCoolUser`, and will be included in the resulting count.
918
924
  }
919
925
 
920
926
  begin
921
927
  # Count users
922
- result = api_instance.get_users_count(opts)
928
+ result = Clerk::SDK.users.get_users_count(opts)
923
929
  p result
924
930
  rescue ClerkHttpClient::ApiError => e
925
- puts "Error when calling UsersApi->get_users_count: #{e}"
931
+ puts "Error when calling Clerk::SDK.users->get_users_count: #{e}"
926
932
  end
927
933
  ```
928
934
 
929
- #### Using the get_users_count_with_http_info variant
935
+ #### Using the `get_users_count_with_http_info variant
930
936
 
931
937
  This returns an Array which contains the response data, status code and headers.
932
938
 
@@ -935,12 +941,12 @@ This returns an Array which contains the response data, status code and headers.
935
941
  ```ruby
936
942
  begin
937
943
  # Count users
938
- data, status_code, headers = api_instance.get_users_count_with_http_info(opts)
944
+ data, status_code, headers = Clerk::SDK.users.get_users_count_with_http_info(opts)
939
945
  p status_code # => 2xx
940
946
  p headers # => { ... }
941
947
  p data # => <TotalCount>
942
948
  rescue ClerkHttpClient::ApiError => e
943
- puts "Error when calling UsersApi->get_users_count_with_http_info: #{e}"
949
+ puts "Error when calling Clerk::SDK.users->get_users_count_with_http_info: #{e}"
944
950
  end
945
951
  ```
946
952
 
@@ -955,6 +961,9 @@ end
955
961
  | **web3_wallet** | [**Array&lt;String&gt;**](String.md) | Counts users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addressed not found are ignored. | [optional] |
956
962
  | **user_id** | [**Array&lt;String&gt;**](String.md) | Counts users with the user ids specified. Accepts up to 100 user ids. Any user ids not found are ignored. | [optional] |
957
963
  | **query** | **String** | Counts users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user ids, first and last names. The query value doesn&#39;t need to match the exact value you are looking for, it is capable of partial matches as well. | [optional] |
964
+ | **email_address_query** | **String** | Counts users with emails that match the given query, via case-insensitive partial match. For example, &#x60;email_address_query&#x3D;ello&#x60; will match a user with the email &#x60;HELLO@example.com&#x60;, and will be included in the resulting count. | [optional] |
965
+ | **phone_number_query** | **String** | Counts users with phone numbers that match the given query, via case-insensitive partial match. For example, &#x60;phone_number_query&#x3D;555&#x60; will match a user with the phone number &#x60;+1555xxxxxxx&#x60;, and will be included in the resulting count. | [optional] |
966
+ | **username_query** | **String** | Counts users with usernames that match the given query, via case-insensitive partial match. For example, &#x60;username_query&#x3D;CoolUser&#x60; will match a user with the username &#x60;SomeCoolUser&#x60;, and will be included in the resulting count. | [optional] |
958
967
 
959
968
  ### Return type
960
969
 
@@ -982,26 +991,25 @@ Marks the given user as locked, which means they are not allowed to sign in agai
982
991
 
983
992
  ```ruby
984
993
  require 'time'
985
- require 'clerk-http-client'
986
- # setup authorization
987
- ClerkHttpClient.configure do |config|
988
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
989
- config.access_token = 'YOUR_BEARER_TOKEN'
994
+ require 'clerk'
995
+
996
+ ## Setup
997
+ Clerk.configure do |config|
998
+ config.secret_key = 'sk_test_xxxxxxxxx'
990
999
  end
991
1000
 
992
- api_instance = ClerkHttpClient::UsersApi.new
993
1001
  user_id = 'user_id_example' # String | The ID of the user to lock
994
1002
 
995
1003
  begin
996
1004
  # Lock a user
997
- result = api_instance.lock_user(user_id)
1005
+ result = Clerk::SDK.users.lock_user(user_id)
998
1006
  p result
999
1007
  rescue ClerkHttpClient::ApiError => e
1000
- puts "Error when calling UsersApi->lock_user: #{e}"
1008
+ puts "Error when calling Clerk::SDK.users->lock_user: #{e}"
1001
1009
  end
1002
1010
  ```
1003
1011
 
1004
- #### Using the lock_user_with_http_info variant
1012
+ #### Using the `lock_user_with_http_info variant
1005
1013
 
1006
1014
  This returns an Array which contains the response data, status code and headers.
1007
1015
 
@@ -1010,12 +1018,12 @@ This returns an Array which contains the response data, status code and headers.
1010
1018
  ```ruby
1011
1019
  begin
1012
1020
  # Lock a user
1013
- data, status_code, headers = api_instance.lock_user_with_http_info(user_id)
1021
+ data, status_code, headers = Clerk::SDK.users.lock_user_with_http_info(user_id)
1014
1022
  p status_code # => 2xx
1015
1023
  p headers # => { ... }
1016
1024
  p data # => <User>
1017
1025
  rescue ClerkHttpClient::ApiError => e
1018
- puts "Error when calling UsersApi->lock_user_with_http_info: #{e}"
1026
+ puts "Error when calling Clerk::SDK.users->lock_user_with_http_info: #{e}"
1019
1027
  end
1020
1028
  ```
1021
1029
 
@@ -1051,14 +1059,13 @@ Update a user's profile image
1051
1059
 
1052
1060
  ```ruby
1053
1061
  require 'time'
1054
- require 'clerk-http-client'
1055
- # setup authorization
1056
- ClerkHttpClient.configure do |config|
1057
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1058
- config.access_token = 'YOUR_BEARER_TOKEN'
1062
+ require 'clerk'
1063
+
1064
+ ## Setup
1065
+ Clerk.configure do |config|
1066
+ config.secret_key = 'sk_test_xxxxxxxxx'
1059
1067
  end
1060
1068
 
1061
- api_instance = ClerkHttpClient::UsersApi.new
1062
1069
  user_id = 'user_id_example' # String | The ID of the user to update the profile image for
1063
1070
  opts = {
1064
1071
  file: File.new('/path/to/some/file') # File |
@@ -1066,14 +1073,14 @@ opts = {
1066
1073
 
1067
1074
  begin
1068
1075
  # Set user profile image
1069
- result = api_instance.set_user_profile_image(user_id, opts)
1076
+ result = Clerk::SDK.users.set_user_profile_image(user_id, opts)
1070
1077
  p result
1071
1078
  rescue ClerkHttpClient::ApiError => e
1072
- puts "Error when calling UsersApi->set_user_profile_image: #{e}"
1079
+ puts "Error when calling Clerk::SDK.users->set_user_profile_image: #{e}"
1073
1080
  end
1074
1081
  ```
1075
1082
 
1076
- #### Using the set_user_profile_image_with_http_info variant
1083
+ #### Using the `set_user_profile_image_with_http_info variant
1077
1084
 
1078
1085
  This returns an Array which contains the response data, status code and headers.
1079
1086
 
@@ -1082,12 +1089,12 @@ This returns an Array which contains the response data, status code and headers.
1082
1089
  ```ruby
1083
1090
  begin
1084
1091
  # Set user profile image
1085
- data, status_code, headers = api_instance.set_user_profile_image_with_http_info(user_id, opts)
1092
+ data, status_code, headers = Clerk::SDK.users.set_user_profile_image_with_http_info(user_id, opts)
1086
1093
  p status_code # => 2xx
1087
1094
  p headers # => { ... }
1088
1095
  p data # => <User>
1089
1096
  rescue ClerkHttpClient::ApiError => e
1090
- puts "Error when calling UsersApi->set_user_profile_image_with_http_info: #{e}"
1097
+ puts "Error when calling Clerk::SDK.users->set_user_profile_image_with_http_info: #{e}"
1091
1098
  end
1092
1099
  ```
1093
1100
 
@@ -1124,26 +1131,25 @@ Removes the ban mark from the given user.
1124
1131
 
1125
1132
  ```ruby
1126
1133
  require 'time'
1127
- require 'clerk-http-client'
1128
- # setup authorization
1129
- ClerkHttpClient.configure do |config|
1130
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1131
- config.access_token = 'YOUR_BEARER_TOKEN'
1134
+ require 'clerk'
1135
+
1136
+ ## Setup
1137
+ Clerk.configure do |config|
1138
+ config.secret_key = 'sk_test_xxxxxxxxx'
1132
1139
  end
1133
1140
 
1134
- api_instance = ClerkHttpClient::UsersApi.new
1135
1141
  user_id = 'user_id_example' # String | The ID of the user to unban
1136
1142
 
1137
1143
  begin
1138
1144
  # Unban a user
1139
- result = api_instance.unban_user(user_id)
1145
+ result = Clerk::SDK.users.unban_user(user_id)
1140
1146
  p result
1141
1147
  rescue ClerkHttpClient::ApiError => e
1142
- puts "Error when calling UsersApi->unban_user: #{e}"
1148
+ puts "Error when calling Clerk::SDK.users->unban_user: #{e}"
1143
1149
  end
1144
1150
  ```
1145
1151
 
1146
- #### Using the unban_user_with_http_info variant
1152
+ #### Using the `unban_user_with_http_info variant
1147
1153
 
1148
1154
  This returns an Array which contains the response data, status code and headers.
1149
1155
 
@@ -1152,12 +1158,12 @@ This returns an Array which contains the response data, status code and headers.
1152
1158
  ```ruby
1153
1159
  begin
1154
1160
  # Unban a user
1155
- data, status_code, headers = api_instance.unban_user_with_http_info(user_id)
1161
+ data, status_code, headers = Clerk::SDK.users.unban_user_with_http_info(user_id)
1156
1162
  p status_code # => 2xx
1157
1163
  p headers # => { ... }
1158
1164
  p data # => <User>
1159
1165
  rescue ClerkHttpClient::ApiError => e
1160
- puts "Error when calling UsersApi->unban_user_with_http_info: #{e}"
1166
+ puts "Error when calling Clerk::SDK.users->unban_user_with_http_info: #{e}"
1161
1167
  end
1162
1168
  ```
1163
1169
 
@@ -1193,26 +1199,25 @@ Removes the lock from the given user.
1193
1199
 
1194
1200
  ```ruby
1195
1201
  require 'time'
1196
- require 'clerk-http-client'
1197
- # setup authorization
1198
- ClerkHttpClient.configure do |config|
1199
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1200
- config.access_token = 'YOUR_BEARER_TOKEN'
1202
+ require 'clerk'
1203
+
1204
+ ## Setup
1205
+ Clerk.configure do |config|
1206
+ config.secret_key = 'sk_test_xxxxxxxxx'
1201
1207
  end
1202
1208
 
1203
- api_instance = ClerkHttpClient::UsersApi.new
1204
1209
  user_id = 'user_id_example' # String | The ID of the user to unlock
1205
1210
 
1206
1211
  begin
1207
1212
  # Unlock a user
1208
- result = api_instance.unlock_user(user_id)
1213
+ result = Clerk::SDK.users.unlock_user(user_id)
1209
1214
  p result
1210
1215
  rescue ClerkHttpClient::ApiError => e
1211
- puts "Error when calling UsersApi->unlock_user: #{e}"
1216
+ puts "Error when calling Clerk::SDK.users->unlock_user: #{e}"
1212
1217
  end
1213
1218
  ```
1214
1219
 
1215
- #### Using the unlock_user_with_http_info variant
1220
+ #### Using the `unlock_user_with_http_info variant
1216
1221
 
1217
1222
  This returns an Array which contains the response data, status code and headers.
1218
1223
 
@@ -1221,12 +1226,12 @@ This returns an Array which contains the response data, status code and headers.
1221
1226
  ```ruby
1222
1227
  begin
1223
1228
  # Unlock a user
1224
- data, status_code, headers = api_instance.unlock_user_with_http_info(user_id)
1229
+ data, status_code, headers = Clerk::SDK.users.unlock_user_with_http_info(user_id)
1225
1230
  p status_code # => 2xx
1226
1231
  p headers # => { ... }
1227
1232
  p data # => <User>
1228
1233
  rescue ClerkHttpClient::ApiError => e
1229
- puts "Error when calling UsersApi->unlock_user_with_http_info: #{e}"
1234
+ puts "Error when calling Clerk::SDK.users->unlock_user_with_http_info: #{e}"
1230
1235
  end
1231
1236
  ```
1232
1237
 
@@ -1262,27 +1267,26 @@ Update a user's attributes. You can set the user's primary contact identifiers
1262
1267
 
1263
1268
  ```ruby
1264
1269
  require 'time'
1265
- require 'clerk-http-client'
1266
- # setup authorization
1267
- ClerkHttpClient.configure do |config|
1268
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1269
- config.access_token = 'YOUR_BEARER_TOKEN'
1270
+ require 'clerk'
1271
+
1272
+ ## Setup
1273
+ Clerk.configure do |config|
1274
+ config.secret_key = 'sk_test_xxxxxxxxx'
1270
1275
  end
1271
1276
 
1272
- api_instance = ClerkHttpClient::UsersApi.new
1273
1277
  user_id = 'user_id_example' # String | The ID of the user to update
1274
1278
  update_user_request = ClerkHttpClient::UpdateUserRequest.new # UpdateUserRequest |
1275
1279
 
1276
1280
  begin
1277
1281
  # Update a user
1278
- result = api_instance.update_user(user_id, update_user_request)
1282
+ result = Clerk::SDK.users.update_user(user_id, update_user_request)
1279
1283
  p result
1280
1284
  rescue ClerkHttpClient::ApiError => e
1281
- puts "Error when calling UsersApi->update_user: #{e}"
1285
+ puts "Error when calling Clerk::SDK.users->update_user: #{e}"
1282
1286
  end
1283
1287
  ```
1284
1288
 
1285
- #### Using the update_user_with_http_info variant
1289
+ #### Using the `update_user_with_http_info variant
1286
1290
 
1287
1291
  This returns an Array which contains the response data, status code and headers.
1288
1292
 
@@ -1291,12 +1295,12 @@ This returns an Array which contains the response data, status code and headers.
1291
1295
  ```ruby
1292
1296
  begin
1293
1297
  # Update a user
1294
- data, status_code, headers = api_instance.update_user_with_http_info(user_id, update_user_request)
1298
+ data, status_code, headers = Clerk::SDK.users.update_user_with_http_info(user_id, update_user_request)
1295
1299
  p status_code # => 2xx
1296
1300
  p headers # => { ... }
1297
1301
  p data # => <User>
1298
1302
  rescue ClerkHttpClient::ApiError => e
1299
- puts "Error when calling UsersApi->update_user_with_http_info: #{e}"
1303
+ puts "Error when calling Clerk::SDK.users->update_user_with_http_info: #{e}"
1300
1304
  end
1301
1305
  ```
1302
1306
 
@@ -1323,7 +1327,7 @@ end
1323
1327
 
1324
1328
  ## update_user_metadata
1325
1329
 
1326
- > <User> update_user_metadata(user_id, update_user_metadata_request)
1330
+ > <User> update_user_metadata(user_id, opts)
1327
1331
 
1328
1332
  Merge and update a user's metadata
1329
1333
 
@@ -1333,41 +1337,42 @@ Update a user's metadata attributes by merging existing values with the provided
1333
1337
 
1334
1338
  ```ruby
1335
1339
  require 'time'
1336
- require 'clerk-http-client'
1337
- # setup authorization
1338
- ClerkHttpClient.configure do |config|
1339
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1340
- config.access_token = 'YOUR_BEARER_TOKEN'
1340
+ require 'clerk'
1341
+
1342
+ ## Setup
1343
+ Clerk.configure do |config|
1344
+ config.secret_key = 'sk_test_xxxxxxxxx'
1341
1345
  end
1342
1346
 
1343
- api_instance = ClerkHttpClient::UsersApi.new
1344
1347
  user_id = 'user_id_example' # String | The ID of the user whose metadata will be updated and merged
1345
- update_user_metadata_request = ClerkHttpClient::UpdateUserMetadataRequest.new # UpdateUserMetadataRequest |
1348
+ opts = {
1349
+ update_user_metadata_request: ClerkHttpClient::UpdateUserMetadataRequest.new # UpdateUserMetadataRequest |
1350
+ }
1346
1351
 
1347
1352
  begin
1348
1353
  # Merge and update a user's metadata
1349
- result = api_instance.update_user_metadata(user_id, update_user_metadata_request)
1354
+ result = Clerk::SDK.users.update_user_metadata(user_id, opts)
1350
1355
  p result
1351
1356
  rescue ClerkHttpClient::ApiError => e
1352
- puts "Error when calling UsersApi->update_user_metadata: #{e}"
1357
+ puts "Error when calling Clerk::SDK.users->update_user_metadata: #{e}"
1353
1358
  end
1354
1359
  ```
1355
1360
 
1356
- #### Using the update_user_metadata_with_http_info variant
1361
+ #### Using the `update_user_metadata_with_http_info variant
1357
1362
 
1358
1363
  This returns an Array which contains the response data, status code and headers.
1359
1364
 
1360
- > <Array(<User>, Integer, Hash)> update_user_metadata_with_http_info(user_id, update_user_metadata_request)
1365
+ > <Array(<User>, Integer, Hash)> update_user_metadata_with_http_info(user_id, opts)
1361
1366
 
1362
1367
  ```ruby
1363
1368
  begin
1364
1369
  # Merge and update a user's metadata
1365
- data, status_code, headers = api_instance.update_user_metadata_with_http_info(user_id, update_user_metadata_request)
1370
+ data, status_code, headers = Clerk::SDK.users.update_user_metadata_with_http_info(user_id, opts)
1366
1371
  p status_code # => 2xx
1367
1372
  p headers # => { ... }
1368
1373
  p data # => <User>
1369
1374
  rescue ClerkHttpClient::ApiError => e
1370
- puts "Error when calling UsersApi->update_user_metadata_with_http_info: #{e}"
1375
+ puts "Error when calling Clerk::SDK.users->update_user_metadata_with_http_info: #{e}"
1371
1376
  end
1372
1377
  ```
1373
1378
 
@@ -1376,7 +1381,7 @@ end
1376
1381
  | Name | Type | Description | Notes |
1377
1382
  | ---- | ---- | ----------- | ----- |
1378
1383
  | **user_id** | **String** | The ID of the user whose metadata will be updated and merged | |
1379
- | **update_user_metadata_request** | [**UpdateUserMetadataRequest**](UpdateUserMetadataRequest.md) | | |
1384
+ | **update_user_metadata_request** | [**UpdateUserMetadataRequest**](UpdateUserMetadataRequest.md) | | [optional] |
1380
1385
 
1381
1386
  ### Return type
1382
1387
 
@@ -1404,27 +1409,26 @@ Delete the passkey identification for a given user and notify them through email
1404
1409
 
1405
1410
  ```ruby
1406
1411
  require 'time'
1407
- require 'clerk-http-client'
1408
- # setup authorization
1409
- ClerkHttpClient.configure do |config|
1410
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1411
- config.access_token = 'YOUR_BEARER_TOKEN'
1412
+ require 'clerk'
1413
+
1414
+ ## Setup
1415
+ Clerk.configure do |config|
1416
+ config.secret_key = 'sk_test_xxxxxxxxx'
1412
1417
  end
1413
1418
 
1414
- api_instance = ClerkHttpClient::UsersApi.new
1415
1419
  user_id = 'user_id_example' # String | The ID of the user that owns the passkey identity
1416
1420
  passkey_identification_id = 'passkey_identification_id_example' # String | The ID of the passkey identity to be deleted
1417
1421
 
1418
1422
  begin
1419
1423
  # Delete a user passkey
1420
- result = api_instance.user_passkey_delete(user_id, passkey_identification_id)
1424
+ result = Clerk::SDK.users.user_passkey_delete(user_id, passkey_identification_id)
1421
1425
  p result
1422
1426
  rescue ClerkHttpClient::ApiError => e
1423
- puts "Error when calling UsersApi->user_passkey_delete: #{e}"
1427
+ puts "Error when calling Clerk::SDK.users->user_passkey_delete: #{e}"
1424
1428
  end
1425
1429
  ```
1426
1430
 
1427
- #### Using the user_passkey_delete_with_http_info variant
1431
+ #### Using the `user_passkey_delete_with_http_info variant
1428
1432
 
1429
1433
  This returns an Array which contains the response data, status code and headers.
1430
1434
 
@@ -1433,12 +1437,12 @@ This returns an Array which contains the response data, status code and headers.
1433
1437
  ```ruby
1434
1438
  begin
1435
1439
  # Delete a user passkey
1436
- data, status_code, headers = api_instance.user_passkey_delete_with_http_info(user_id, passkey_identification_id)
1440
+ data, status_code, headers = Clerk::SDK.users.user_passkey_delete_with_http_info(user_id, passkey_identification_id)
1437
1441
  p status_code # => 2xx
1438
1442
  p headers # => { ... }
1439
1443
  p data # => <DeletedObject>
1440
1444
  rescue ClerkHttpClient::ApiError => e
1441
- puts "Error when calling UsersApi->user_passkey_delete_with_http_info: #{e}"
1445
+ puts "Error when calling Clerk::SDK.users->user_passkey_delete_with_http_info: #{e}"
1442
1446
  end
1443
1447
  ```
1444
1448
 
@@ -1475,27 +1479,26 @@ Delete the web3 wallet identification for a given user.
1475
1479
 
1476
1480
  ```ruby
1477
1481
  require 'time'
1478
- require 'clerk-http-client'
1479
- # setup authorization
1480
- ClerkHttpClient.configure do |config|
1481
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1482
- config.access_token = 'YOUR_BEARER_TOKEN'
1482
+ require 'clerk'
1483
+
1484
+ ## Setup
1485
+ Clerk.configure do |config|
1486
+ config.secret_key = 'sk_test_xxxxxxxxx'
1483
1487
  end
1484
1488
 
1485
- api_instance = ClerkHttpClient::UsersApi.new
1486
1489
  user_id = 'user_id_example' # String | The ID of the user that owns the web3 wallet
1487
1490
  web3_wallet_identification_id = 'web3_wallet_identification_id_example' # String | The ID of the web3 wallet identity to be deleted
1488
1491
 
1489
1492
  begin
1490
1493
  # Delete a user web3 wallet
1491
- result = api_instance.user_web3_wallet_delete(user_id, web3_wallet_identification_id)
1494
+ result = Clerk::SDK.users.user_web3_wallet_delete(user_id, web3_wallet_identification_id)
1492
1495
  p result
1493
1496
  rescue ClerkHttpClient::ApiError => e
1494
- puts "Error when calling UsersApi->user_web3_wallet_delete: #{e}"
1497
+ puts "Error when calling Clerk::SDK.users->user_web3_wallet_delete: #{e}"
1495
1498
  end
1496
1499
  ```
1497
1500
 
1498
- #### Using the user_web3_wallet_delete_with_http_info variant
1501
+ #### Using the `user_web3_wallet_delete_with_http_info variant
1499
1502
 
1500
1503
  This returns an Array which contains the response data, status code and headers.
1501
1504
 
@@ -1504,12 +1507,12 @@ This returns an Array which contains the response data, status code and headers.
1504
1507
  ```ruby
1505
1508
  begin
1506
1509
  # Delete a user web3 wallet
1507
- data, status_code, headers = api_instance.user_web3_wallet_delete_with_http_info(user_id, web3_wallet_identification_id)
1510
+ data, status_code, headers = Clerk::SDK.users.user_web3_wallet_delete_with_http_info(user_id, web3_wallet_identification_id)
1508
1511
  p status_code # => 2xx
1509
1512
  p headers # => { ... }
1510
1513
  p data # => <DeletedObject>
1511
1514
  rescue ClerkHttpClient::ApiError => e
1512
- puts "Error when calling UsersApi->user_web3_wallet_delete_with_http_info: #{e}"
1515
+ puts "Error when calling Clerk::SDK.users->user_web3_wallet_delete_with_http_info: #{e}"
1513
1516
  end
1514
1517
  ```
1515
1518
 
@@ -1546,14 +1549,13 @@ Retrieve a paginated list of the user's organization invitations
1546
1549
 
1547
1550
  ```ruby
1548
1551
  require 'time'
1549
- require 'clerk-http-client'
1550
- # setup authorization
1551
- ClerkHttpClient.configure do |config|
1552
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1553
- config.access_token = 'YOUR_BEARER_TOKEN'
1552
+ require 'clerk'
1553
+
1554
+ ## Setup
1555
+ Clerk.configure do |config|
1556
+ config.secret_key = 'sk_test_xxxxxxxxx'
1554
1557
  end
1555
1558
 
1556
- api_instance = ClerkHttpClient::UsersApi.new
1557
1559
  user_id = 'user_id_example' # String | The ID of the user whose organization invitations we want to retrieve
1558
1560
  opts = {
1559
1561
  limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
@@ -1563,14 +1565,14 @@ opts = {
1563
1565
 
1564
1566
  begin
1565
1567
  # Retrieve all invitations for a user
1566
- result = api_instance.users_get_organization_invitations(user_id, opts)
1568
+ result = Clerk::SDK.users.users_get_organization_invitations(user_id, opts)
1567
1569
  p result
1568
1570
  rescue ClerkHttpClient::ApiError => e
1569
- puts "Error when calling UsersApi->users_get_organization_invitations: #{e}"
1571
+ puts "Error when calling Clerk::SDK.users->users_get_organization_invitations: #{e}"
1570
1572
  end
1571
1573
  ```
1572
1574
 
1573
- #### Using the users_get_organization_invitations_with_http_info variant
1575
+ #### Using the `users_get_organization_invitations_with_http_info variant
1574
1576
 
1575
1577
  This returns an Array which contains the response data, status code and headers.
1576
1578
 
@@ -1579,12 +1581,12 @@ This returns an Array which contains the response data, status code and headers.
1579
1581
  ```ruby
1580
1582
  begin
1581
1583
  # Retrieve all invitations for a user
1582
- data, status_code, headers = api_instance.users_get_organization_invitations_with_http_info(user_id, opts)
1584
+ data, status_code, headers = Clerk::SDK.users.users_get_organization_invitations_with_http_info(user_id, opts)
1583
1585
  p status_code # => 2xx
1584
1586
  p headers # => { ... }
1585
1587
  p data # => <OrganizationInvitationsWithPublicOrganizationData>
1586
1588
  rescue ClerkHttpClient::ApiError => e
1587
- puts "Error when calling UsersApi->users_get_organization_invitations_with_http_info: #{e}"
1589
+ puts "Error when calling Clerk::SDK.users->users_get_organization_invitations_with_http_info: #{e}"
1588
1590
  end
1589
1591
  ```
1590
1592
 
@@ -1623,14 +1625,13 @@ Retrieve a paginated list of the user's organization memberships
1623
1625
 
1624
1626
  ```ruby
1625
1627
  require 'time'
1626
- require 'clerk-http-client'
1627
- # setup authorization
1628
- ClerkHttpClient.configure do |config|
1629
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1630
- config.access_token = 'YOUR_BEARER_TOKEN'
1628
+ require 'clerk'
1629
+
1630
+ ## Setup
1631
+ Clerk.configure do |config|
1632
+ config.secret_key = 'sk_test_xxxxxxxxx'
1631
1633
  end
1632
1634
 
1633
- api_instance = ClerkHttpClient::UsersApi.new
1634
1635
  user_id = 'user_id_example' # String | The ID of the user whose organization memberships we want to retrieve
1635
1636
  opts = {
1636
1637
  limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
@@ -1639,14 +1640,14 @@ opts = {
1639
1640
 
1640
1641
  begin
1641
1642
  # Retrieve all memberships for a user
1642
- result = api_instance.users_get_organization_memberships(user_id, opts)
1643
+ result = Clerk::SDK.users.users_get_organization_memberships(user_id, opts)
1643
1644
  p result
1644
1645
  rescue ClerkHttpClient::ApiError => e
1645
- puts "Error when calling UsersApi->users_get_organization_memberships: #{e}"
1646
+ puts "Error when calling Clerk::SDK.users->users_get_organization_memberships: #{e}"
1646
1647
  end
1647
1648
  ```
1648
1649
 
1649
- #### Using the users_get_organization_memberships_with_http_info variant
1650
+ #### Using the `users_get_organization_memberships_with_http_info variant
1650
1651
 
1651
1652
  This returns an Array which contains the response data, status code and headers.
1652
1653
 
@@ -1655,12 +1656,12 @@ This returns an Array which contains the response data, status code and headers.
1655
1656
  ```ruby
1656
1657
  begin
1657
1658
  # Retrieve all memberships for a user
1658
- data, status_code, headers = api_instance.users_get_organization_memberships_with_http_info(user_id, opts)
1659
+ data, status_code, headers = Clerk::SDK.users.users_get_organization_memberships_with_http_info(user_id, opts)
1659
1660
  p status_code # => 2xx
1660
1661
  p headers # => { ... }
1661
1662
  p data # => <OrganizationMemberships>
1662
1663
  rescue ClerkHttpClient::ApiError => e
1663
- puts "Error when calling UsersApi->users_get_organization_memberships_with_http_info: #{e}"
1664
+ puts "Error when calling Clerk::SDK.users->users_get_organization_memberships_with_http_info: #{e}"
1664
1665
  end
1665
1666
  ```
1666
1667
 
@@ -1688,7 +1689,7 @@ end
1688
1689
 
1689
1690
  ## verify_password
1690
1691
 
1691
- > <VerifyPassword200Response> verify_password(user_id, verify_password_request)
1692
+ > <VerifyPassword200Response> verify_password(user_id, opts)
1692
1693
 
1693
1694
  Verify the password of a user
1694
1695
 
@@ -1698,41 +1699,42 @@ Check that the user's password matches the supplied input. Useful for custom aut
1698
1699
 
1699
1700
  ```ruby
1700
1701
  require 'time'
1701
- require 'clerk-http-client'
1702
- # setup authorization
1703
- ClerkHttpClient.configure do |config|
1704
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1705
- config.access_token = 'YOUR_BEARER_TOKEN'
1702
+ require 'clerk'
1703
+
1704
+ ## Setup
1705
+ Clerk.configure do |config|
1706
+ config.secret_key = 'sk_test_xxxxxxxxx'
1706
1707
  end
1707
1708
 
1708
- api_instance = ClerkHttpClient::UsersApi.new
1709
1709
  user_id = 'user_id_example' # String | The ID of the user for whom to verify the password
1710
- verify_password_request = ClerkHttpClient::VerifyPasswordRequest.new({password: 'password_example'}) # VerifyPasswordRequest |
1710
+ opts = {
1711
+ verify_password_request: ClerkHttpClient::VerifyPasswordRequest.new({password: 'password_example'}) # VerifyPasswordRequest |
1712
+ }
1711
1713
 
1712
1714
  begin
1713
1715
  # Verify the password of a user
1714
- result = api_instance.verify_password(user_id, verify_password_request)
1716
+ result = Clerk::SDK.users.verify_password(user_id, opts)
1715
1717
  p result
1716
1718
  rescue ClerkHttpClient::ApiError => e
1717
- puts "Error when calling UsersApi->verify_password: #{e}"
1719
+ puts "Error when calling Clerk::SDK.users->verify_password: #{e}"
1718
1720
  end
1719
1721
  ```
1720
1722
 
1721
- #### Using the verify_password_with_http_info variant
1723
+ #### Using the `verify_password_with_http_info variant
1722
1724
 
1723
1725
  This returns an Array which contains the response data, status code and headers.
1724
1726
 
1725
- > <Array(<VerifyPassword200Response>, Integer, Hash)> verify_password_with_http_info(user_id, verify_password_request)
1727
+ > <Array(<VerifyPassword200Response>, Integer, Hash)> verify_password_with_http_info(user_id, opts)
1726
1728
 
1727
1729
  ```ruby
1728
1730
  begin
1729
1731
  # Verify the password of a user
1730
- data, status_code, headers = api_instance.verify_password_with_http_info(user_id, verify_password_request)
1732
+ data, status_code, headers = Clerk::SDK.users.verify_password_with_http_info(user_id, opts)
1731
1733
  p status_code # => 2xx
1732
1734
  p headers # => { ... }
1733
1735
  p data # => <VerifyPassword200Response>
1734
1736
  rescue ClerkHttpClient::ApiError => e
1735
- puts "Error when calling UsersApi->verify_password_with_http_info: #{e}"
1737
+ puts "Error when calling Clerk::SDK.users->verify_password_with_http_info: #{e}"
1736
1738
  end
1737
1739
  ```
1738
1740
 
@@ -1741,7 +1743,7 @@ end
1741
1743
  | Name | Type | Description | Notes |
1742
1744
  | ---- | ---- | ----------- | ----- |
1743
1745
  | **user_id** | **String** | The ID of the user for whom to verify the password | |
1744
- | **verify_password_request** | [**VerifyPasswordRequest**](VerifyPasswordRequest.md) | | |
1746
+ | **verify_password_request** | [**VerifyPasswordRequest**](VerifyPasswordRequest.md) | | [optional] |
1745
1747
 
1746
1748
  ### Return type
1747
1749
 
@@ -1759,7 +1761,7 @@ end
1759
1761
 
1760
1762
  ## verify_totp
1761
1763
 
1762
- > <VerifyTOTP200Response> verify_totp(user_id, verify_totp_request)
1764
+ > <VerifyTOTP200Response> verify_totp(user_id, opts)
1763
1765
 
1764
1766
  Verify a TOTP or backup code for a user
1765
1767
 
@@ -1769,41 +1771,42 @@ Verify that the provided TOTP or backup code is valid for the user. Verifying a
1769
1771
 
1770
1772
  ```ruby
1771
1773
  require 'time'
1772
- require 'clerk-http-client'
1773
- # setup authorization
1774
- ClerkHttpClient.configure do |config|
1775
- # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
1776
- config.access_token = 'YOUR_BEARER_TOKEN'
1774
+ require 'clerk'
1775
+
1776
+ ## Setup
1777
+ Clerk.configure do |config|
1778
+ config.secret_key = 'sk_test_xxxxxxxxx'
1777
1779
  end
1778
1780
 
1779
- api_instance = ClerkHttpClient::UsersApi.new
1780
1781
  user_id = 'user_id_example' # String | The ID of the user for whom to verify the TOTP
1781
- verify_totp_request = ClerkHttpClient::VerifyTOTPRequest.new({code: 'code_example'}) # VerifyTOTPRequest |
1782
+ opts = {
1783
+ verify_totp_request: ClerkHttpClient::VerifyTOTPRequest.new({code: 'code_example'}) # VerifyTOTPRequest |
1784
+ }
1782
1785
 
1783
1786
  begin
1784
1787
  # Verify a TOTP or backup code for a user
1785
- result = api_instance.verify_totp(user_id, verify_totp_request)
1788
+ result = Clerk::SDK.users.verify_totp(user_id, opts)
1786
1789
  p result
1787
1790
  rescue ClerkHttpClient::ApiError => e
1788
- puts "Error when calling UsersApi->verify_totp: #{e}"
1791
+ puts "Error when calling Clerk::SDK.users->verify_totp: #{e}"
1789
1792
  end
1790
1793
  ```
1791
1794
 
1792
- #### Using the verify_totp_with_http_info variant
1795
+ #### Using the `verify_totp_with_http_info variant
1793
1796
 
1794
1797
  This returns an Array which contains the response data, status code and headers.
1795
1798
 
1796
- > <Array(<VerifyTOTP200Response>, Integer, Hash)> verify_totp_with_http_info(user_id, verify_totp_request)
1799
+ > <Array(<VerifyTOTP200Response>, Integer, Hash)> verify_totp_with_http_info(user_id, opts)
1797
1800
 
1798
1801
  ```ruby
1799
1802
  begin
1800
1803
  # Verify a TOTP or backup code for a user
1801
- data, status_code, headers = api_instance.verify_totp_with_http_info(user_id, verify_totp_request)
1804
+ data, status_code, headers = Clerk::SDK.users.verify_totp_with_http_info(user_id, opts)
1802
1805
  p status_code # => 2xx
1803
1806
  p headers # => { ... }
1804
1807
  p data # => <VerifyTOTP200Response>
1805
1808
  rescue ClerkHttpClient::ApiError => e
1806
- puts "Error when calling UsersApi->verify_totp_with_http_info: #{e}"
1809
+ puts "Error when calling Clerk::SDK.users->verify_totp_with_http_info: #{e}"
1807
1810
  end
1808
1811
  ```
1809
1812
 
@@ -1812,7 +1815,7 @@ end
1812
1815
  | Name | Type | Description | Notes |
1813
1816
  | ---- | ---- | ----------- | ----- |
1814
1817
  | **user_id** | **String** | The ID of the user for whom to verify the TOTP | |
1815
- | **verify_totp_request** | [**VerifyTOTPRequest**](VerifyTOTPRequest.md) | | |
1818
+ | **verify_totp_request** | [**VerifyTOTPRequest**](VerifyTOTPRequest.md) | | [optional] |
1816
1819
 
1817
1820
  ### Return type
1818
1821