clerk-http-client 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (518) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +87 -0
  4. data/README.md +360 -0
  5. data/Rakefile +10 -0
  6. data/bin/fmt +5 -0
  7. data/bin/generate +8 -0
  8. data/bin/setup +7 -0
  9. data/clerk-http-client.gemspec +41 -0
  10. data/docs/ActorToken.md +34 -0
  11. data/docs/ActorTokensApi.md +147 -0
  12. data/docs/AddDomainRequest.md +22 -0
  13. data/docs/Admin.md +24 -0
  14. data/docs/AllowListBlockListApi.md +421 -0
  15. data/docs/AllowlistIdentifier.md +32 -0
  16. data/docs/BetaFeaturesApi.md +217 -0
  17. data/docs/BlocklistIdentifier.md +30 -0
  18. data/docs/BlocklistIdentifiers.md +20 -0
  19. data/docs/CNameTarget.md +22 -0
  20. data/docs/ChangeProductionInstanceDomainRequest.md +20 -0
  21. data/docs/ClerkError.md +26 -0
  22. data/docs/ClerkErrors.md +20 -0
  23. data/docs/Client.md +34 -0
  24. data/docs/ClientsApi.md +221 -0
  25. data/docs/CreateActorTokenRequest.md +24 -0
  26. data/docs/CreateAllowlistIdentifierRequest.md +20 -0
  27. data/docs/CreateBlocklistIdentifierRequest.md +18 -0
  28. data/docs/CreateEmailAddressRequest.md +24 -0
  29. data/docs/CreateInvitationRequest.md +28 -0
  30. data/docs/CreateJWTTemplateRequest.md +30 -0
  31. data/docs/CreateOAuthApplicationRequest.md +24 -0
  32. data/docs/CreateOrganizationDomainRequest.md +22 -0
  33. data/docs/CreateOrganizationInvitationBulkRequestInner.md +28 -0
  34. data/docs/CreateOrganizationInvitationRequest.md +28 -0
  35. data/docs/CreateOrganizationMembershipRequest.md +20 -0
  36. data/docs/CreateOrganizationRequest.md +30 -0
  37. data/docs/CreatePhoneNumberRequest.md +26 -0
  38. data/docs/CreateRedirectURLRequest.md +18 -0
  39. data/docs/CreateSAMLConnectionRequest.md +34 -0
  40. data/docs/CreateSAMLConnectionRequestAttributeMapping.md +24 -0
  41. data/docs/CreateSessionTokenFromTemplate200Response.md +20 -0
  42. data/docs/CreateSignInTokenRequest.md +20 -0
  43. data/docs/CreateUserRequest.md +62 -0
  44. data/docs/DeletedObject.md +24 -0
  45. data/docs/DisableMFA200Response.md +18 -0
  46. data/docs/Domain.md +34 -0
  47. data/docs/Domains.md +20 -0
  48. data/docs/DomainsApi.md +286 -0
  49. data/docs/EmailAddress.md +32 -0
  50. data/docs/EmailAddressVerification.md +51 -0
  51. data/docs/EmailAddressesApi.md +289 -0
  52. data/docs/EmailSMSTemplatesApi.md +449 -0
  53. data/docs/GetOAuthAccessToken200ResponseInner.md +34 -0
  54. data/docs/IdentificationLink.md +20 -0
  55. data/docs/InstanceRestrictions.md +26 -0
  56. data/docs/InstanceSettingsApi.md +216 -0
  57. data/docs/Invitation.md +36 -0
  58. data/docs/InvitationsApi.md +223 -0
  59. data/docs/JWKSApi.md +74 -0
  60. data/docs/JWTTemplate.md +36 -0
  61. data/docs/JWTTemplatesApi.md +354 -0
  62. data/docs/MergeOrganizationMetadataRequest.md +20 -0
  63. data/docs/MiscellaneousApi.md +75 -0
  64. data/docs/OAuthApplication.md +42 -0
  65. data/docs/OAuthApplicationWithSecret.md +44 -0
  66. data/docs/OAuthApplications.md +20 -0
  67. data/docs/OAuthApplicationsApi.md +433 -0
  68. data/docs/OTP.md +24 -0
  69. data/docs/Oauth.md +28 -0
  70. data/docs/OauthError.md +47 -0
  71. data/docs/Organization.md +40 -0
  72. data/docs/OrganizationDomain.md +38 -0
  73. data/docs/OrganizationDomainApi.md +81 -0
  74. data/docs/OrganizationDomainVerification.md +24 -0
  75. data/docs/OrganizationDomains.md +20 -0
  76. data/docs/OrganizationDomainsApi.md +231 -0
  77. data/docs/OrganizationInvitation.md +38 -0
  78. data/docs/OrganizationInvitationWithPublicOrganizationData.md +40 -0
  79. data/docs/OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData.md +26 -0
  80. data/docs/OrganizationInvitations.md +20 -0
  81. data/docs/OrganizationInvitationsApi.md +533 -0
  82. data/docs/OrganizationInvitationsWithPublicOrganizationData.md +20 -0
  83. data/docs/OrganizationMembership.md +38 -0
  84. data/docs/OrganizationMembershipPublicUserData.md +30 -0
  85. data/docs/OrganizationMemberships.md +20 -0
  86. data/docs/OrganizationMembershipsApi.md +453 -0
  87. data/docs/OrganizationSettings.md +36 -0
  88. data/docs/OrganizationWithLogo.md +46 -0
  89. data/docs/Organizations.md +20 -0
  90. data/docs/OrganizationsApi.md +591 -0
  91. data/docs/Passkey.md +26 -0
  92. data/docs/PhoneNumber.md +38 -0
  93. data/docs/PhoneNumberVerification.md +49 -0
  94. data/docs/PhoneNumbersApi.md +289 -0
  95. data/docs/PreviewTemplateRequest.md +24 -0
  96. data/docs/ProxyCheck.md +32 -0
  97. data/docs/ProxyChecksApi.md +77 -0
  98. data/docs/RedirectURL.md +26 -0
  99. data/docs/RedirectURLsApi.md +284 -0
  100. data/docs/RevokeInvitation200Response.md +36 -0
  101. data/docs/RevokeOrganizationInvitationRequest.md +18 -0
  102. data/docs/SAML.md +28 -0
  103. data/docs/SAMLAccount.md +38 -0
  104. data/docs/SAMLAccountSamlConnection.md +47 -0
  105. data/docs/SAMLAccountVerification.md +49 -0
  106. data/docs/SAMLConnection.md +38 -0
  107. data/docs/SAMLConnections.md +20 -0
  108. data/docs/SAMLConnectionsApi.md +363 -0
  109. data/docs/SchemasPasskey.md +26 -0
  110. data/docs/SchemasPasskeyVerification.md +47 -0
  111. data/docs/SchemasSAMLConnection.md +60 -0
  112. data/docs/SchemasSAMLConnectionAttributeMapping.md +24 -0
  113. data/docs/Session.md +42 -0
  114. data/docs/SessionLatestActivity.md +34 -0
  115. data/docs/SessionsApi.md +373 -0
  116. data/docs/SignInToken.md +32 -0
  117. data/docs/SignInTokensApi.md +147 -0
  118. data/docs/SignUp.md +62 -0
  119. data/docs/SignUpsApi.md +79 -0
  120. data/docs/SvixURL.md +18 -0
  121. data/docs/TOTP.md +28 -0
  122. data/docs/Template.md +60 -0
  123. data/docs/TestingToken.md +22 -0
  124. data/docs/TestingTokensApi.md +74 -0
  125. data/docs/Ticket.md +24 -0
  126. data/docs/ToggleTemplateDeliveryRequest.md +18 -0
  127. data/docs/TotalCount.md +20 -0
  128. data/docs/UpdateDomainRequest.md +22 -0
  129. data/docs/UpdateEmailAddressRequest.md +20 -0
  130. data/docs/UpdateInstanceAuthConfig200Response.md +28 -0
  131. data/docs/UpdateInstanceAuthConfigRequest.md +28 -0
  132. data/docs/UpdateInstanceOrganizationSettingsRequest.md +30 -0
  133. data/docs/UpdateInstanceRequest.md +34 -0
  134. data/docs/UpdateInstanceRestrictionsRequest.md +26 -0
  135. data/docs/UpdateOAuthApplicationRequest.md +22 -0
  136. data/docs/UpdateOrganizationDomainRequest.md +20 -0
  137. data/docs/UpdateOrganizationMembershipMetadataRequest.md +20 -0
  138. data/docs/UpdateOrganizationMembershipRequest.md +18 -0
  139. data/docs/UpdateOrganizationRequest.md +30 -0
  140. data/docs/UpdatePhoneNumberRequest.md +22 -0
  141. data/docs/UpdateProductionInstanceDomainRequest.md +18 -0
  142. data/docs/UpdateSAMLConnectionRequest.md +42 -0
  143. data/docs/UpdateSAMLConnectionRequestAttributeMapping.md +24 -0
  144. data/docs/UpdateSignUpRequest.md +18 -0
  145. data/docs/UpdateUserMetadataRequest.md +22 -0
  146. data/docs/UpdateUserRequest.md +66 -0
  147. data/docs/UpsertTemplateRequest.md +30 -0
  148. data/docs/User.md +94 -0
  149. data/docs/UsersApi.md +1829 -0
  150. data/docs/VerifyClientRequest.md +18 -0
  151. data/docs/VerifyDomainProxyRequest.md +20 -0
  152. data/docs/VerifyPassword200Response.md +18 -0
  153. data/docs/VerifyPasswordRequest.md +18 -0
  154. data/docs/VerifySessionRequest.md +18 -0
  155. data/docs/VerifyTOTP200Response.md +20 -0
  156. data/docs/VerifyTOTPRequest.md +18 -0
  157. data/docs/Web3Signature.md +28 -0
  158. data/docs/Web3Wallet.md +28 -0
  159. data/docs/Web3WalletVerification.md +49 -0
  160. data/docs/WebhooksApi.md +207 -0
  161. data/docs/WellKnownJWKS.md +18 -0
  162. data/docs/WellKnownJWKSKeysInner.md +28 -0
  163. data/git_push.sh +57 -0
  164. data/lib/clerk-http-client/api/actor_tokens_api.rb +157 -0
  165. data/lib/clerk-http-client/api/allow_list_block_list_api.rb +410 -0
  166. data/lib/clerk-http-client/api/beta_features_api.rb +228 -0
  167. data/lib/clerk-http-client/api/clients_api.rb +234 -0
  168. data/lib/clerk-http-client/api/domains_api.rb +292 -0
  169. data/lib/clerk-http-client/api/email_addresses_api.rb +298 -0
  170. data/lib/clerk-http-client/api/email_sms_templates_api.rb +488 -0
  171. data/lib/clerk-http-client/api/instance_settings_api.rb +232 -0
  172. data/lib/clerk-http-client/api/invitations_api.rb +241 -0
  173. data/lib/clerk-http-client/api/jwks_api.rb +81 -0
  174. data/lib/clerk-http-client/api/jwt_templates_api.rb +355 -0
  175. data/lib/clerk-http-client/api/miscellaneous_api.rb +85 -0
  176. data/lib/clerk-http-client/api/o_auth_applications_api.rb +440 -0
  177. data/lib/clerk-http-client/api/organization_domain_api.rb +104 -0
  178. data/lib/clerk-http-client/api/organization_domains_api.rb +258 -0
  179. data/lib/clerk-http-client/api/organization_invitations_api.rb +586 -0
  180. data/lib/clerk-http-client/api/organization_memberships_api.rb +499 -0
  181. data/lib/clerk-http-client/api/organizations_api.rb +606 -0
  182. data/lib/clerk-http-client/api/phone_numbers_api.rb +298 -0
  183. data/lib/clerk-http-client/api/proxy_checks_api.rb +92 -0
  184. data/lib/clerk-http-client/api/redirect_urls_api.rb +281 -0
  185. data/lib/clerk-http-client/api/saml_connections_api.rb +375 -0
  186. data/lib/clerk-http-client/api/sessions_api.rb +385 -0
  187. data/lib/clerk-http-client/api/sign_in_tokens_api.rb +157 -0
  188. data/lib/clerk-http-client/api/sign_ups_api.rb +98 -0
  189. data/lib/clerk-http-client/api/testing_tokens_api.rb +81 -0
  190. data/lib/clerk-http-client/api/users_api.rb +1828 -0
  191. data/lib/clerk-http-client/api/webhooks_api.rb +199 -0
  192. data/lib/clerk-http-client/api_client.rb +437 -0
  193. data/lib/clerk-http-client/api_error.rb +58 -0
  194. data/lib/clerk-http-client/configuration.rb +393 -0
  195. data/lib/clerk-http-client/models/actor_token.rb +385 -0
  196. data/lib/clerk-http-client/models/add_domain_request.rb +249 -0
  197. data/lib/clerk-http-client/models/admin.rb +303 -0
  198. data/lib/clerk-http-client/models/allowlist_identifier.rb +327 -0
  199. data/lib/clerk-http-client/models/blocklist_identifier.rb +318 -0
  200. data/lib/clerk-http-client/models/blocklist_identifiers.rb +240 -0
  201. data/lib/clerk-http-client/models/c_name_target.rb +254 -0
  202. data/lib/clerk-http-client/models/change_production_instance_domain_request.rb +225 -0
  203. data/lib/clerk-http-client/models/clerk_error.rb +271 -0
  204. data/lib/clerk-http-client/models/clerk_errors.rb +232 -0
  205. data/lib/clerk-http-client/models/client.rb +380 -0
  206. data/lib/clerk-http-client/models/create_actor_token_request.rb +263 -0
  207. data/lib/clerk-http-client/models/create_allowlist_identifier_request.rb +234 -0
  208. data/lib/clerk-http-client/models/create_blocklist_identifier_request.rb +222 -0
  209. data/lib/clerk-http-client/models/create_email_address_request.rb +247 -0
  210. data/lib/clerk-http-client/models/create_invitation_request.rb +303 -0
  211. data/lib/clerk-http-client/models/create_jwt_template_request.rb +327 -0
  212. data/lib/clerk-http-client/models/create_o_auth_application_request.rb +261 -0
  213. data/lib/clerk-http-client/models/create_organization_domain_request.rb +236 -0
  214. data/lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb +280 -0
  215. data/lib/clerk-http-client/models/create_organization_invitation_request.rb +280 -0
  216. data/lib/clerk-http-client/models/create_organization_membership_request.rb +239 -0
  217. data/lib/clerk-http-client/models/create_organization_request.rb +289 -0
  218. data/lib/clerk-http-client/models/create_phone_number_request.rb +258 -0
  219. data/lib/clerk-http-client/models/create_redirect_url_request.rb +215 -0
  220. data/lib/clerk-http-client/models/create_saml_connection_request.rb +355 -0
  221. data/lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb +242 -0
  222. data/lib/clerk-http-client/models/create_session_token_from_template200_response.rb +257 -0
  223. data/lib/clerk-http-client/models/create_sign_in_token_request.rb +227 -0
  224. data/lib/clerk-http-client/models/create_user_request.rb +453 -0
  225. data/lib/clerk-http-client/models/deleted_object.rb +255 -0
  226. data/lib/clerk-http-client/models/disable_mfa200_response.rb +214 -0
  227. data/lib/clerk-http-client/models/domain.rb +368 -0
  228. data/lib/clerk-http-client/models/domains.rb +240 -0
  229. data/lib/clerk-http-client/models/email_address.rb +361 -0
  230. data/lib/clerk-http-client/models/email_address_verification.rb +106 -0
  231. data/lib/clerk-http-client/models/get_o_auth_access_token200_response_inner.rb +295 -0
  232. data/lib/clerk-http-client/models/identification_link.rb +271 -0
  233. data/lib/clerk-http-client/models/instance_restrictions.rb +285 -0
  234. data/lib/clerk-http-client/models/invitation.rb +388 -0
  235. data/lib/clerk-http-client/models/jwt_template.rb +387 -0
  236. data/lib/clerk-http-client/models/merge_organization_metadata_request.rb +225 -0
  237. data/lib/clerk-http-client/models/o_auth_application.rb +449 -0
  238. data/lib/clerk-http-client/models/o_auth_application_with_secret.rb +466 -0
  239. data/lib/clerk-http-client/models/o_auth_applications.rb +240 -0
  240. data/lib/clerk-http-client/models/oauth.rb +328 -0
  241. data/lib/clerk-http-client/models/oauth_error.rb +104 -0
  242. data/lib/clerk-http-client/models/organization.rb +413 -0
  243. data/lib/clerk-http-client/models/organization_domain.rb +364 -0
  244. data/lib/clerk-http-client/models/organization_domain_verification.rb +281 -0
  245. data/lib/clerk-http-client/models/organization_domains.rb +240 -0
  246. data/lib/clerk-http-client/models/organization_invitation.rb +342 -0
  247. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb +351 -0
  248. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb +250 -0
  249. data/lib/clerk-http-client/models/organization_invitations.rb +240 -0
  250. data/lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb +240 -0
  251. data/lib/clerk-http-client/models/organization_membership.rb +346 -0
  252. data/lib/clerk-http-client/models/organization_membership_public_user_data.rb +272 -0
  253. data/lib/clerk-http-client/models/organization_memberships.rb +240 -0
  254. data/lib/clerk-http-client/models/organization_settings.rb +391 -0
  255. data/lib/clerk-http-client/models/organization_with_logo.rb +454 -0
  256. data/lib/clerk-http-client/models/organizations.rb +240 -0
  257. data/lib/clerk-http-client/models/otp.rb +315 -0
  258. data/lib/clerk-http-client/models/passkey.rb +324 -0
  259. data/lib/clerk-http-client/models/phone_number.rb +391 -0
  260. data/lib/clerk-http-client/models/phone_number_verification.rb +105 -0
  261. data/lib/clerk-http-client/models/preview_template_request.rb +246 -0
  262. data/lib/clerk-http-client/models/proxy_check.rb +367 -0
  263. data/lib/clerk-http-client/models/redirect_url.rb +321 -0
  264. data/lib/clerk-http-client/models/revoke_invitation200_response.rb +395 -0
  265. data/lib/clerk-http-client/models/revoke_organization_invitation_request.rb +216 -0
  266. data/lib/clerk-http-client/models/saml.rb +331 -0
  267. data/lib/clerk-http-client/models/saml_account.rb +381 -0
  268. data/lib/clerk-http-client/models/saml_account_saml_connection.rb +104 -0
  269. data/lib/clerk-http-client/models/saml_account_verification.rb +105 -0
  270. data/lib/clerk-http-client/models/saml_connection.rb +362 -0
  271. data/lib/clerk-http-client/models/saml_connections.rb +240 -0
  272. data/lib/clerk-http-client/models/schemas_passkey.rb +310 -0
  273. data/lib/clerk-http-client/models/schemas_passkey_verification.rb +104 -0
  274. data/lib/clerk-http-client/models/schemas_saml_connection.rb +541 -0
  275. data/lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb +241 -0
  276. data/lib/clerk-http-client/models/session.rb +444 -0
  277. data/lib/clerk-http-client/models/session_latest_activity.rb +300 -0
  278. data/lib/clerk-http-client/models/sign_in_token.rb +368 -0
  279. data/lib/clerk-http-client/models/sign_up.rb +517 -0
  280. data/lib/clerk-http-client/models/svix_url.rb +221 -0
  281. data/lib/clerk-http-client/models/template.rb +460 -0
  282. data/lib/clerk-http-client/models/testing_token.rb +289 -0
  283. data/lib/clerk-http-client/models/ticket.rb +303 -0
  284. data/lib/clerk-http-client/models/toggle_template_delivery_request.rb +216 -0
  285. data/lib/clerk-http-client/models/total_count.rb +272 -0
  286. data/lib/clerk-http-client/models/totp.rb +289 -0
  287. data/lib/clerk-http-client/models/update_domain_request.rb +238 -0
  288. data/lib/clerk-http-client/models/update_email_address_request.rb +227 -0
  289. data/lib/clerk-http-client/models/update_instance_auth_config200_response.rb +294 -0
  290. data/lib/clerk-http-client/models/update_instance_auth_config_request.rb +273 -0
  291. data/lib/clerk-http-client/models/update_instance_organization_settings_request.rb +277 -0
  292. data/lib/clerk-http-client/models/update_instance_request.rb +300 -0
  293. data/lib/clerk-http-client/models/update_instance_restrictions_request.rb +255 -0
  294. data/lib/clerk-http-client/models/update_o_auth_application_request.rb +237 -0
  295. data/lib/clerk-http-client/models/update_organization_domain_request.rb +227 -0
  296. data/lib/clerk-http-client/models/update_organization_membership_metadata_request.rb +225 -0
  297. data/lib/clerk-http-client/models/update_organization_membership_request.rb +222 -0
  298. data/lib/clerk-http-client/models/update_organization_request.rb +279 -0
  299. data/lib/clerk-http-client/models/update_phone_number_request.rb +238 -0
  300. data/lib/clerk-http-client/models/update_production_instance_domain_request.rb +215 -0
  301. data/lib/clerk-http-client/models/update_saml_connection_request.rb +347 -0
  302. data/lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb +242 -0
  303. data/lib/clerk-http-client/models/update_sign_up_request.rb +216 -0
  304. data/lib/clerk-http-client/models/update_user_metadata_request.rb +241 -0
  305. data/lib/clerk-http-client/models/update_user_request.rb +472 -0
  306. data/lib/clerk-http-client/models/upsert_template_request.rb +278 -0
  307. data/lib/clerk-http-client/models/user.rb +633 -0
  308. data/lib/clerk-http-client/models/verify_client_request.rb +215 -0
  309. data/lib/clerk-http-client/models/verify_domain_proxy_request.rb +225 -0
  310. data/lib/clerk-http-client/models/verify_password200_response.rb +214 -0
  311. data/lib/clerk-http-client/models/verify_password_request.rb +222 -0
  312. data/lib/clerk-http-client/models/verify_session_request.rb +215 -0
  313. data/lib/clerk-http-client/models/verify_totp200_response.rb +257 -0
  314. data/lib/clerk-http-client/models/verify_totp_request.rb +222 -0
  315. data/lib/clerk-http-client/models/web3_signature.rb +323 -0
  316. data/lib/clerk-http-client/models/web3_wallet.rb +327 -0
  317. data/lib/clerk-http-client/models/web3_wallet_verification.rb +105 -0
  318. data/lib/clerk-http-client/models/well_known_jwks.rb +216 -0
  319. data/lib/clerk-http-client/models/well_known_jwks_keys_inner.rb +259 -0
  320. data/lib/clerk-http-client/version.rb +15 -0
  321. data/lib/clerk-http-client.rb +321 -0
  322. data/openapitools.json +7 -0
  323. data/pkg/clerk-http-client-1.0.0.gem +0 -0
  324. data/resources/.DS_Store +0 -0
  325. data/resources/oas/bapi-2024-10-01.yml +7238 -0
  326. data/resources/templates/Gemfile.mustache +9 -0
  327. data/resources/templates/README.mustache +163 -0
  328. data/resources/templates/Rakefile.mustache +10 -0
  329. data/resources/templates/api.mustache +257 -0
  330. data/resources/templates/api_client.mustache +246 -0
  331. data/resources/templates/api_client_faraday_partial.mustache +200 -0
  332. data/resources/templates/api_client_httpx_partial.mustache +134 -0
  333. data/resources/templates/api_client_typhoeus_partial.mustache +161 -0
  334. data/resources/templates/api_doc.mustache +132 -0
  335. data/resources/templates/api_error.mustache +50 -0
  336. data/resources/templates/api_info.mustache +12 -0
  337. data/resources/templates/api_test.mustache +47 -0
  338. data/resources/templates/base_object.mustache +114 -0
  339. data/resources/templates/configuration.mustache +491 -0
  340. data/resources/templates/configuration_faraday_partial.mustache +40 -0
  341. data/resources/templates/configuration_httpx_partial.mustache +11 -0
  342. data/resources/templates/configuration_typhoeus_partial.mustache +41 -0
  343. data/resources/templates/gem.mustache +89 -0
  344. data/resources/templates/gemspec.mustache +41 -0
  345. data/resources/templates/git_push.sh.mustache +57 -0
  346. data/resources/templates/gitignore.mustache +39 -0
  347. data/resources/templates/gitlab-ci.mustache +26 -0
  348. data/resources/templates/model.mustache +33 -0
  349. data/resources/templates/model_doc.mustache +12 -0
  350. data/resources/templates/model_test.mustache +82 -0
  351. data/resources/templates/partial_anyof_module.mustache +94 -0
  352. data/resources/templates/partial_model_enum_class.mustache +23 -0
  353. data/resources/templates/partial_model_generic.mustache +377 -0
  354. data/resources/templates/partial_model_generic_doc.mustache +28 -0
  355. data/resources/templates/partial_oneof_module.mustache +137 -0
  356. data/resources/templates/partial_oneof_module_doc.mustache +93 -0
  357. data/resources/templates/rspec.mustache +2 -0
  358. data/resources/templates/rubocop.mustache +148 -0
  359. data/resources/templates/spec_helper.mustache +103 -0
  360. data/resources/templates/travis.mustache +11 -0
  361. data/resources/templates/version.mustache +7 -0
  362. data/sdk-generator-config.json +20 -0
  363. data/spec/api/actor_tokens_api_spec.rb +59 -0
  364. data/spec/api/allow_list_block_list_api_spec.rb +105 -0
  365. data/spec/api/beta_features_api_spec.rb +71 -0
  366. data/spec/api/clients_api_spec.rb +72 -0
  367. data/spec/api/domains_api_spec.rb +83 -0
  368. data/spec/api/email_addresses_api_spec.rb +84 -0
  369. data/spec/api/email_sms_templates_api_spec.rb +115 -0
  370. data/spec/api/instance_settings_api_spec.rb +71 -0
  371. data/spec/api/invitations_api_spec.rb +73 -0
  372. data/spec/api/jwks_api_spec.rb +46 -0
  373. data/spec/api/jwt_templates_api_spec.rb +94 -0
  374. data/spec/api/miscellaneous_api_spec.rb +48 -0
  375. data/spec/api/o_auth_applications_api_spec.rb +109 -0
  376. data/spec/api/organization_domain_api_spec.rb +49 -0
  377. data/spec/api/organization_domains_api_spec.rb +77 -0
  378. data/spec/api/organization_invitations_api_spec.rb +133 -0
  379. data/spec/api/organization_memberships_api_spec.rb +118 -0
  380. data/spec/api/organizations_api_spec.rb +139 -0
  381. data/spec/api/phone_numbers_api_spec.rb +84 -0
  382. data/spec/api/proxy_checks_api_spec.rb +47 -0
  383. data/spec/api/redirect_urls_api_spec.rb +82 -0
  384. data/spec/api/saml_connections_api_spec.rb +97 -0
  385. data/spec/api/sessions_api_spec.rb +101 -0
  386. data/spec/api/sign_in_tokens_api_spec.rb +59 -0
  387. data/spec/api/sign_ups_api_spec.rb +48 -0
  388. data/spec/api/testing_tokens_api_spec.rb +46 -0
  389. data/spec/api/users_api_spec.rb +366 -0
  390. data/spec/api/webhooks_api_spec.rb +68 -0
  391. data/spec/models/actor_token_spec.rb +92 -0
  392. data/spec/models/add_domain_request_spec.rb +48 -0
  393. data/spec/models/admin_spec.rb +62 -0
  394. data/spec/models/allowlist_identifier_spec.rb +86 -0
  395. data/spec/models/blocklist_identifier_spec.rb +80 -0
  396. data/spec/models/blocklist_identifiers_spec.rb +42 -0
  397. data/spec/models/c_name_target_spec.rb +48 -0
  398. data/spec/models/change_production_instance_domain_request_spec.rb +42 -0
  399. data/spec/models/clerk_error_spec.rb +60 -0
  400. data/spec/models/clerk_errors_spec.rb +42 -0
  401. data/spec/models/client_spec.rb +88 -0
  402. data/spec/models/create_actor_token_request_spec.rb +54 -0
  403. data/spec/models/create_allowlist_identifier_request_spec.rb +42 -0
  404. data/spec/models/create_blocklist_identifier_request_spec.rb +36 -0
  405. data/spec/models/create_email_address_request_spec.rb +54 -0
  406. data/spec/models/create_invitation_request_spec.rb +66 -0
  407. data/spec/models/create_jwt_template_request_spec.rb +72 -0
  408. data/spec/models/create_o_auth_application_request_spec.rb +54 -0
  409. data/spec/models/create_organization_domain_request_spec.rb +48 -0
  410. data/spec/models/create_organization_invitation_bulk_request_inner_spec.rb +66 -0
  411. data/spec/models/create_organization_invitation_request_spec.rb +66 -0
  412. data/spec/models/create_organization_membership_request_spec.rb +42 -0
  413. data/spec/models/create_organization_request_spec.rb +72 -0
  414. data/spec/models/create_phone_number_request_spec.rb +60 -0
  415. data/spec/models/create_redirect_url_request_spec.rb +36 -0
  416. data/spec/models/create_saml_connection_request_attribute_mapping_spec.rb +54 -0
  417. data/spec/models/create_saml_connection_request_spec.rb +88 -0
  418. data/spec/models/create_session_token_from_template200_response_spec.rb +46 -0
  419. data/spec/models/create_sign_in_token_request_spec.rb +42 -0
  420. data/spec/models/create_user_request_spec.rb +168 -0
  421. data/spec/models/deleted_object_spec.rb +54 -0
  422. data/spec/models/disable_mfa200_response_spec.rb +36 -0
  423. data/spec/models/domain_spec.rb +88 -0
  424. data/spec/models/domains_spec.rb +42 -0
  425. data/spec/models/email_address_spec.rb +82 -0
  426. data/spec/models/email_address_verification_spec.rb +32 -0
  427. data/spec/models/get_o_auth_access_token200_response_inner_spec.rb +84 -0
  428. data/spec/models/identification_link_spec.rb +46 -0
  429. data/spec/models/instance_restrictions_spec.rb +64 -0
  430. data/spec/models/invitation_spec.rb +98 -0
  431. data/spec/models/jwt_template_spec.rb +94 -0
  432. data/spec/models/merge_organization_metadata_request_spec.rb +42 -0
  433. data/spec/models/o_auth_application_spec.rb +112 -0
  434. data/spec/models/o_auth_application_with_secret_spec.rb +118 -0
  435. data/spec/models/o_auth_applications_spec.rb +42 -0
  436. data/spec/models/oauth_error_spec.rb +32 -0
  437. data/spec/models/oauth_spec.rb +74 -0
  438. data/spec/models/organization_domain_spec.rb +104 -0
  439. data/spec/models/organization_domain_verification_spec.rb +58 -0
  440. data/spec/models/organization_domains_spec.rb +42 -0
  441. data/spec/models/organization_invitation_spec.rb +100 -0
  442. data/spec/models/organization_invitation_with_public_organization_data_public_organization_data_spec.rb +60 -0
  443. data/spec/models/organization_invitation_with_public_organization_data_spec.rb +106 -0
  444. data/spec/models/organization_invitations_spec.rb +42 -0
  445. data/spec/models/organization_invitations_with_public_organization_data_spec.rb +42 -0
  446. data/spec/models/organization_membership_public_user_data_spec.rb +72 -0
  447. data/spec/models/organization_membership_spec.rb +100 -0
  448. data/spec/models/organization_memberships_spec.rb +42 -0
  449. data/spec/models/organization_settings_spec.rb +98 -0
  450. data/spec/models/organization_spec.rb +106 -0
  451. data/spec/models/organization_with_logo_spec.rb +124 -0
  452. data/spec/models/organizations_spec.rb +42 -0
  453. data/spec/models/otp_spec.rb +62 -0
  454. data/spec/models/passkey_spec.rb +72 -0
  455. data/spec/models/phone_number_spec.rb +100 -0
  456. data/spec/models/phone_number_verification_spec.rb +32 -0
  457. data/spec/models/preview_template_request_spec.rb +54 -0
  458. data/spec/models/proxy_check_spec.rb +82 -0
  459. data/spec/models/redirect_url_spec.rb +64 -0
  460. data/spec/models/revoke_invitation200_response_spec.rb +98 -0
  461. data/spec/models/revoke_organization_invitation_request_spec.rb +36 -0
  462. data/spec/models/saml_account_saml_connection_spec.rb +32 -0
  463. data/spec/models/saml_account_spec.rb +100 -0
  464. data/spec/models/saml_account_verification_spec.rb +32 -0
  465. data/spec/models/saml_connection_spec.rb +96 -0
  466. data/spec/models/saml_connections_spec.rb +42 -0
  467. data/spec/models/saml_spec.rb +74 -0
  468. data/spec/models/schemas_passkey_spec.rb +64 -0
  469. data/spec/models/schemas_passkey_verification_spec.rb +32 -0
  470. data/spec/models/schemas_saml_connection_attribute_mapping_spec.rb +54 -0
  471. data/spec/models/schemas_saml_connection_spec.rb +166 -0
  472. data/spec/models/session_latest_activity_spec.rb +84 -0
  473. data/spec/models/session_spec.rb +116 -0
  474. data/spec/models/sign_in_token_spec.rb +86 -0
  475. data/spec/models/sign_up_spec.rb +176 -0
  476. data/spec/models/svix_url_spec.rb +36 -0
  477. data/spec/models/template_spec.rb +166 -0
  478. data/spec/models/testing_token_spec.rb +52 -0
  479. data/spec/models/ticket_spec.rb +62 -0
  480. data/spec/models/toggle_template_delivery_request_spec.rb +36 -0
  481. data/spec/models/total_count_spec.rb +46 -0
  482. data/spec/models/totp_spec.rb +66 -0
  483. data/spec/models/update_domain_request_spec.rb +48 -0
  484. data/spec/models/update_email_address_request_spec.rb +42 -0
  485. data/spec/models/update_instance_auth_config200_response_spec.rb +70 -0
  486. data/spec/models/update_instance_auth_config_request_spec.rb +66 -0
  487. data/spec/models/update_instance_organization_settings_request_spec.rb +72 -0
  488. data/spec/models/update_instance_request_spec.rb +84 -0
  489. data/spec/models/update_instance_restrictions_request_spec.rb +60 -0
  490. data/spec/models/update_o_auth_application_request_spec.rb +48 -0
  491. data/spec/models/update_organization_domain_request_spec.rb +42 -0
  492. data/spec/models/update_organization_membership_metadata_request_spec.rb +42 -0
  493. data/spec/models/update_organization_membership_request_spec.rb +36 -0
  494. data/spec/models/update_organization_request_spec.rb +72 -0
  495. data/spec/models/update_phone_number_request_spec.rb +48 -0
  496. data/spec/models/update_production_instance_domain_request_spec.rb +36 -0
  497. data/spec/models/update_saml_connection_request_attribute_mapping_spec.rb +54 -0
  498. data/spec/models/update_saml_connection_request_spec.rb +108 -0
  499. data/spec/models/update_sign_up_request_spec.rb +36 -0
  500. data/spec/models/update_user_metadata_request_spec.rb +48 -0
  501. data/spec/models/update_user_request_spec.rb +180 -0
  502. data/spec/models/upsert_template_request_spec.rb +72 -0
  503. data/spec/models/user_spec.rb +268 -0
  504. data/spec/models/verify_client_request_spec.rb +36 -0
  505. data/spec/models/verify_domain_proxy_request_spec.rb +42 -0
  506. data/spec/models/verify_password200_response_spec.rb +36 -0
  507. data/spec/models/verify_password_request_spec.rb +36 -0
  508. data/spec/models/verify_session_request_spec.rb +36 -0
  509. data/spec/models/verify_totp200_response_spec.rb +46 -0
  510. data/spec/models/verify_totp_request_spec.rb +36 -0
  511. data/spec/models/web3_signature_spec.rb +74 -0
  512. data/spec/models/web3_wallet_spec.rb +70 -0
  513. data/spec/models/web3_wallet_verification_spec.rb +32 -0
  514. data/spec/models/well_known_jwks_keys_inner_spec.rb +66 -0
  515. data/spec/models/well_known_jwks_spec.rb +36 -0
  516. data/spec/spec_helper.rb +111 -0
  517. data/test.rb +2 -0
  518. metadata +782 -0
@@ -0,0 +1,433 @@
1
+ # ClerkHttpClient::OAuthApplicationsApi
2
+
3
+ All URIs are relative to *https://api.clerk.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_o_auth_application**](OAuthApplicationsApi.md#create_o_auth_application) | **POST** /oauth_applications | Create an OAuth application |
8
+ | [**delete_o_auth_application**](OAuthApplicationsApi.md#delete_o_auth_application) | **DELETE** /oauth_applications/{oauth_application_id} | Delete an OAuth application |
9
+ | [**get_o_auth_application**](OAuthApplicationsApi.md#get_o_auth_application) | **GET** /oauth_applications/{oauth_application_id} | Retrieve an OAuth application by ID |
10
+ | [**list_o_auth_applications**](OAuthApplicationsApi.md#list_o_auth_applications) | **GET** /oauth_applications | Get a list of OAuth applications for an instance |
11
+ | [**rotate_o_auth_application_secret**](OAuthApplicationsApi.md#rotate_o_auth_application_secret) | **POST** /oauth_applications/{oauth_application_id}/rotate_secret | Rotate the client secret of the given OAuth application |
12
+ | [**update_o_auth_application**](OAuthApplicationsApi.md#update_o_auth_application) | **PATCH** /oauth_applications/{oauth_application_id} | Update an OAuth application |
13
+
14
+
15
+ ## create_o_auth_application
16
+
17
+ > <OAuthApplicationWithSecret> create_o_auth_application(create_o_auth_application_request)
18
+
19
+ Create an OAuth application
20
+
21
+ Creates a new OAuth application with the given name and callback URL for an instance. The callback URL must be a valid url. All URL schemes are allowed such as `http://`, `https://`, `myapp://`, etc...
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'clerk-http-client'
28
+ # setup authorization
29
+ ClerkHttpClient.configure do |config|
30
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
31
+ config.access_token = 'YOUR_BEARER_TOKEN'
32
+ end
33
+
34
+ api_instance = ClerkHttpClient::OAuthApplicationsApi.new
35
+ create_o_auth_application_request = ClerkHttpClient::CreateOAuthApplicationRequest.new({name: 'name_example', callback_url: 'callback_url_example'}) # CreateOAuthApplicationRequest |
36
+
37
+ begin
38
+ # Create an OAuth application
39
+ result = api_instance.create_o_auth_application(create_o_auth_application_request)
40
+ p result
41
+ rescue ClerkHttpClient::ApiError => e
42
+ puts "Error when calling OAuthApplicationsApi->create_o_auth_application: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_o_auth_application_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<OAuthApplicationWithSecret>, Integer, Hash)> create_o_auth_application_with_http_info(create_o_auth_application_request)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create an OAuth application
55
+ data, status_code, headers = api_instance.create_o_auth_application_with_http_info(create_o_auth_application_request)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <OAuthApplicationWithSecret>
59
+ rescue ClerkHttpClient::ApiError => e
60
+ puts "Error when calling OAuthApplicationsApi->create_o_auth_application_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **create_o_auth_application_request** | [**CreateOAuthApplicationRequest**](CreateOAuthApplicationRequest.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**OAuthApplicationWithSecret**](OAuthApplicationWithSecret.md)
73
+
74
+ ### Authorization
75
+
76
+ [bearerAuth](../README.md#bearerAuth)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## delete_o_auth_application
85
+
86
+ > <DeletedObject> delete_o_auth_application(oauth_application_id)
87
+
88
+ Delete an OAuth application
89
+
90
+ Deletes the given OAuth application. This is not reversible.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'clerk-http-client'
97
+ # setup authorization
98
+ ClerkHttpClient.configure do |config|
99
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+ end
102
+
103
+ api_instance = ClerkHttpClient::OAuthApplicationsApi.new
104
+ oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application to delete
105
+
106
+ begin
107
+ # Delete an OAuth application
108
+ result = api_instance.delete_o_auth_application(oauth_application_id)
109
+ p result
110
+ rescue ClerkHttpClient::ApiError => e
111
+ puts "Error when calling OAuthApplicationsApi->delete_o_auth_application: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the delete_o_auth_application_with_http_info variant
116
+
117
+ This returns an Array which contains the response data, status code and headers.
118
+
119
+ > <Array(<DeletedObject>, Integer, Hash)> delete_o_auth_application_with_http_info(oauth_application_id)
120
+
121
+ ```ruby
122
+ begin
123
+ # Delete an OAuth application
124
+ data, status_code, headers = api_instance.delete_o_auth_application_with_http_info(oauth_application_id)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => <DeletedObject>
128
+ rescue ClerkHttpClient::ApiError => e
129
+ puts "Error when calling OAuthApplicationsApi->delete_o_auth_application_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **oauth_application_id** | **String** | The ID of the OAuth application to delete | |
138
+
139
+ ### Return type
140
+
141
+ [**DeletedObject**](DeletedObject.md)
142
+
143
+ ### Authorization
144
+
145
+ [bearerAuth](../README.md#bearerAuth)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: Not defined
150
+ - **Accept**: application/json
151
+
152
+
153
+ ## get_o_auth_application
154
+
155
+ > <OAuthApplication> get_o_auth_application(oauth_application_id)
156
+
157
+ Retrieve an OAuth application by ID
158
+
159
+ Fetches the OAuth application whose ID matches the provided `id` in the path.
160
+
161
+ ### Examples
162
+
163
+ ```ruby
164
+ require 'time'
165
+ require 'clerk-http-client'
166
+ # setup authorization
167
+ ClerkHttpClient.configure do |config|
168
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
169
+ config.access_token = 'YOUR_BEARER_TOKEN'
170
+ end
171
+
172
+ api_instance = ClerkHttpClient::OAuthApplicationsApi.new
173
+ oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application
174
+
175
+ begin
176
+ # Retrieve an OAuth application by ID
177
+ result = api_instance.get_o_auth_application(oauth_application_id)
178
+ p result
179
+ rescue ClerkHttpClient::ApiError => e
180
+ puts "Error when calling OAuthApplicationsApi->get_o_auth_application: #{e}"
181
+ end
182
+ ```
183
+
184
+ #### Using the get_o_auth_application_with_http_info variant
185
+
186
+ This returns an Array which contains the response data, status code and headers.
187
+
188
+ > <Array(<OAuthApplication>, Integer, Hash)> get_o_auth_application_with_http_info(oauth_application_id)
189
+
190
+ ```ruby
191
+ begin
192
+ # Retrieve an OAuth application by ID
193
+ data, status_code, headers = api_instance.get_o_auth_application_with_http_info(oauth_application_id)
194
+ p status_code # => 2xx
195
+ p headers # => { ... }
196
+ p data # => <OAuthApplication>
197
+ rescue ClerkHttpClient::ApiError => e
198
+ puts "Error when calling OAuthApplicationsApi->get_o_auth_application_with_http_info: #{e}"
199
+ end
200
+ ```
201
+
202
+ ### Parameters
203
+
204
+ | Name | Type | Description | Notes |
205
+ | ---- | ---- | ----------- | ----- |
206
+ | **oauth_application_id** | **String** | The ID of the OAuth application | |
207
+
208
+ ### Return type
209
+
210
+ [**OAuthApplication**](OAuthApplication.md)
211
+
212
+ ### Authorization
213
+
214
+ [bearerAuth](../README.md#bearerAuth)
215
+
216
+ ### HTTP request headers
217
+
218
+ - **Content-Type**: Not defined
219
+ - **Accept**: application/json
220
+
221
+
222
+ ## list_o_auth_applications
223
+
224
+ > <OAuthApplications> list_o_auth_applications(opts)
225
+
226
+ Get a list of OAuth applications for an instance
227
+
228
+ This request returns the list of OAuth applications for an instance. Results can be paginated using the optional `limit` and `offset` query parameters. The OAuth applications are ordered by descending creation date. Most recent OAuth applications will be returned first.
229
+
230
+ ### Examples
231
+
232
+ ```ruby
233
+ require 'time'
234
+ require 'clerk-http-client'
235
+ # setup authorization
236
+ ClerkHttpClient.configure do |config|
237
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
238
+ config.access_token = 'YOUR_BEARER_TOKEN'
239
+ end
240
+
241
+ api_instance = ClerkHttpClient::OAuthApplicationsApi.new
242
+ opts = {
243
+ limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
244
+ 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`.
245
+ }
246
+
247
+ begin
248
+ # Get a list of OAuth applications for an instance
249
+ result = api_instance.list_o_auth_applications(opts)
250
+ p result
251
+ rescue ClerkHttpClient::ApiError => e
252
+ puts "Error when calling OAuthApplicationsApi->list_o_auth_applications: #{e}"
253
+ end
254
+ ```
255
+
256
+ #### Using the list_o_auth_applications_with_http_info variant
257
+
258
+ This returns an Array which contains the response data, status code and headers.
259
+
260
+ > <Array(<OAuthApplications>, Integer, Hash)> list_o_auth_applications_with_http_info(opts)
261
+
262
+ ```ruby
263
+ begin
264
+ # Get a list of OAuth applications for an instance
265
+ data, status_code, headers = api_instance.list_o_auth_applications_with_http_info(opts)
266
+ p status_code # => 2xx
267
+ p headers # => { ... }
268
+ p data # => <OAuthApplications>
269
+ rescue ClerkHttpClient::ApiError => e
270
+ puts "Error when calling OAuthApplicationsApi->list_o_auth_applications_with_http_info: #{e}"
271
+ end
272
+ ```
273
+
274
+ ### Parameters
275
+
276
+ | Name | Type | Description | Notes |
277
+ | ---- | ---- | ----------- | ----- |
278
+ | **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] |
279
+ | **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] |
280
+
281
+ ### Return type
282
+
283
+ [**OAuthApplications**](OAuthApplications.md)
284
+
285
+ ### Authorization
286
+
287
+ [bearerAuth](../README.md#bearerAuth)
288
+
289
+ ### HTTP request headers
290
+
291
+ - **Content-Type**: Not defined
292
+ - **Accept**: application/json
293
+
294
+
295
+ ## rotate_o_auth_application_secret
296
+
297
+ > <OAuthApplicationWithSecret> rotate_o_auth_application_secret(oauth_application_id)
298
+
299
+ Rotate the client secret of the given OAuth application
300
+
301
+ Rotates the OAuth application's client secret. When the client secret is rotated, make sure to update it in authorized OAuth clients.
302
+
303
+ ### Examples
304
+
305
+ ```ruby
306
+ require 'time'
307
+ require 'clerk-http-client'
308
+ # setup authorization
309
+ ClerkHttpClient.configure do |config|
310
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
311
+ config.access_token = 'YOUR_BEARER_TOKEN'
312
+ end
313
+
314
+ api_instance = ClerkHttpClient::OAuthApplicationsApi.new
315
+ oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application for which to rotate the client secret
316
+
317
+ begin
318
+ # Rotate the client secret of the given OAuth application
319
+ result = api_instance.rotate_o_auth_application_secret(oauth_application_id)
320
+ p result
321
+ rescue ClerkHttpClient::ApiError => e
322
+ puts "Error when calling OAuthApplicationsApi->rotate_o_auth_application_secret: #{e}"
323
+ end
324
+ ```
325
+
326
+ #### Using the rotate_o_auth_application_secret_with_http_info variant
327
+
328
+ This returns an Array which contains the response data, status code and headers.
329
+
330
+ > <Array(<OAuthApplicationWithSecret>, Integer, Hash)> rotate_o_auth_application_secret_with_http_info(oauth_application_id)
331
+
332
+ ```ruby
333
+ begin
334
+ # Rotate the client secret of the given OAuth application
335
+ data, status_code, headers = api_instance.rotate_o_auth_application_secret_with_http_info(oauth_application_id)
336
+ p status_code # => 2xx
337
+ p headers # => { ... }
338
+ p data # => <OAuthApplicationWithSecret>
339
+ rescue ClerkHttpClient::ApiError => e
340
+ puts "Error when calling OAuthApplicationsApi->rotate_o_auth_application_secret_with_http_info: #{e}"
341
+ end
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+ | Name | Type | Description | Notes |
347
+ | ---- | ---- | ----------- | ----- |
348
+ | **oauth_application_id** | **String** | The ID of the OAuth application for which to rotate the client secret | |
349
+
350
+ ### Return type
351
+
352
+ [**OAuthApplicationWithSecret**](OAuthApplicationWithSecret.md)
353
+
354
+ ### Authorization
355
+
356
+ [bearerAuth](../README.md#bearerAuth)
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: Not defined
361
+ - **Accept**: application/json
362
+
363
+
364
+ ## update_o_auth_application
365
+
366
+ > <OAuthApplication> update_o_auth_application(oauth_application_id, update_o_auth_application_request)
367
+
368
+ Update an OAuth application
369
+
370
+ Updates an existing OAuth application
371
+
372
+ ### Examples
373
+
374
+ ```ruby
375
+ require 'time'
376
+ require 'clerk-http-client'
377
+ # setup authorization
378
+ ClerkHttpClient.configure do |config|
379
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
380
+ config.access_token = 'YOUR_BEARER_TOKEN'
381
+ end
382
+
383
+ api_instance = ClerkHttpClient::OAuthApplicationsApi.new
384
+ oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application to update
385
+ update_o_auth_application_request = ClerkHttpClient::UpdateOAuthApplicationRequest.new # UpdateOAuthApplicationRequest |
386
+
387
+ begin
388
+ # Update an OAuth application
389
+ result = api_instance.update_o_auth_application(oauth_application_id, update_o_auth_application_request)
390
+ p result
391
+ rescue ClerkHttpClient::ApiError => e
392
+ puts "Error when calling OAuthApplicationsApi->update_o_auth_application: #{e}"
393
+ end
394
+ ```
395
+
396
+ #### Using the update_o_auth_application_with_http_info variant
397
+
398
+ This returns an Array which contains the response data, status code and headers.
399
+
400
+ > <Array(<OAuthApplication>, Integer, Hash)> update_o_auth_application_with_http_info(oauth_application_id, update_o_auth_application_request)
401
+
402
+ ```ruby
403
+ begin
404
+ # Update an OAuth application
405
+ data, status_code, headers = api_instance.update_o_auth_application_with_http_info(oauth_application_id, update_o_auth_application_request)
406
+ p status_code # => 2xx
407
+ p headers # => { ... }
408
+ p data # => <OAuthApplication>
409
+ rescue ClerkHttpClient::ApiError => e
410
+ puts "Error when calling OAuthApplicationsApi->update_o_auth_application_with_http_info: #{e}"
411
+ end
412
+ ```
413
+
414
+ ### Parameters
415
+
416
+ | Name | Type | Description | Notes |
417
+ | ---- | ---- | ----------- | ----- |
418
+ | **oauth_application_id** | **String** | The ID of the OAuth application to update | |
419
+ | **update_o_auth_application_request** | [**UpdateOAuthApplicationRequest**](UpdateOAuthApplicationRequest.md) | | |
420
+
421
+ ### Return type
422
+
423
+ [**OAuthApplication**](OAuthApplication.md)
424
+
425
+ ### Authorization
426
+
427
+ [bearerAuth](../README.md#bearerAuth)
428
+
429
+ ### HTTP request headers
430
+
431
+ - **Content-Type**: application/json
432
+ - **Accept**: application/json
433
+
data/docs/OTP.md ADDED
@@ -0,0 +1,24 @@
1
+ # ClerkHttpClient::OTP
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **strategy** | **String** | | |
9
+ | **attempts** | **Integer** | | |
10
+ | **expire_at** | **Integer** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'clerk-http-client'
16
+
17
+ instance = ClerkHttpClient::OTP.new(
18
+ status: null,
19
+ strategy: null,
20
+ attempts: null,
21
+ expire_at: null
22
+ )
23
+ ```
24
+
data/docs/Oauth.md ADDED
@@ -0,0 +1,28 @@
1
+ # ClerkHttpClient::Oauth
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **strategy** | **String** | | |
9
+ | **external_verification_redirect_url** | **String** | | [optional] |
10
+ | **error** | [**OauthError**](OauthError.md) | | [optional] |
11
+ | **expire_at** | **Integer** | | |
12
+ | **attempts** | **Integer** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'clerk-http-client'
18
+
19
+ instance = ClerkHttpClient::Oauth.new(
20
+ status: null,
21
+ strategy: null,
22
+ external_verification_redirect_url: null,
23
+ error: null,
24
+ expire_at: null,
25
+ attempts: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,47 @@
1
+ # ClerkHttpClient::OauthError
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'clerk-http-client'
13
+
14
+ ClerkHttpClient::OauthError.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'ClerkError'
18
+ # ]
19
+ ```
20
+
21
+ ### build
22
+
23
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
24
+
25
+ #### Example
26
+
27
+ ```ruby
28
+ require 'clerk-http-client'
29
+
30
+ ClerkHttpClient::OauthError.build(data)
31
+ # => #<ClerkError:0x00007fdd4aab02a0>
32
+
33
+ ClerkHttpClient::OauthError.build(data_that_doesnt_match)
34
+ # => nil
35
+ ```
36
+
37
+ #### Parameters
38
+
39
+ | Name | Type | Description |
40
+ | ---- | ---- | ----------- |
41
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
42
+
43
+ #### Return type
44
+
45
+ - `ClerkError`
46
+ - `nil` (if no type matches)
47
+
@@ -0,0 +1,40 @@
1
+ # ClerkHttpClient::Organization
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | | |
8
+ | **id** | **String** | | |
9
+ | **name** | **String** | | |
10
+ | **slug** | **String** | | |
11
+ | **members_count** | **Integer** | | [optional] |
12
+ | **max_allowed_memberships** | **Integer** | | |
13
+ | **admin_delete_enabled** | **Boolean** | | [optional] |
14
+ | **public_metadata** | **Object** | | |
15
+ | **private_metadata** | **Object** | | |
16
+ | **created_by** | **String** | | [optional] |
17
+ | **created_at** | **Integer** | Unix timestamp of creation. | |
18
+ | **updated_at** | **Integer** | Unix timestamp of last update. | |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'clerk-http-client'
24
+
25
+ instance = ClerkHttpClient::Organization.new(
26
+ object: null,
27
+ id: null,
28
+ name: null,
29
+ slug: null,
30
+ members_count: null,
31
+ max_allowed_memberships: null,
32
+ admin_delete_enabled: null,
33
+ public_metadata: null,
34
+ private_metadata: null,
35
+ created_by: null,
36
+ created_at: null,
37
+ updated_at: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,38 @@
1
+ # ClerkHttpClient::OrganizationDomain
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier for the organization domain | [optional] |
8
+ | **object** | **String** | String representing the object&#39;s type. Objects of the same type share the same value. Always &#x60;organization_domain&#x60; | [optional] |
9
+ | **organization_id** | **String** | Unique identifier for the organization | [optional] |
10
+ | **name** | **String** | Name of the organization domain | [optional] |
11
+ | **enrollment_mode** | **String** | Mode of enrollment for the domain | [optional] |
12
+ | **affiliation_email_address** | **String** | Affiliation email address for the domain, if available. | [optional] |
13
+ | **verification** | [**OrganizationDomainVerification**](OrganizationDomainVerification.md) | Verification details for the domain | [optional] |
14
+ | **total_pending_invitations** | **Integer** | Total number of pending invitations associated with this domain | [optional] |
15
+ | **total_pending_suggestions** | **Integer** | Total number of pending suggestions associated with this domain | [optional] |
16
+ | **created_at** | **Integer** | Unix timestamp when the domain was created | [optional] |
17
+ | **updated_at** | **Integer** | Unix timestamp of the last update to the domain | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'clerk-http-client'
23
+
24
+ instance = ClerkHttpClient::OrganizationDomain.new(
25
+ id: null,
26
+ object: null,
27
+ organization_id: null,
28
+ name: null,
29
+ enrollment_mode: null,
30
+ affiliation_email_address: null,
31
+ verification: null,
32
+ total_pending_invitations: null,
33
+ total_pending_suggestions: null,
34
+ created_at: null,
35
+ updated_at: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,81 @@
1
+ # ClerkHttpClient::OrganizationDomainApi
2
+
3
+ All URIs are relative to *https://api.clerk.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**update_organization_domain**](OrganizationDomainApi.md#update_organization_domain) | **PATCH** /organizations/{organization_id}/domains/{domain_id} | Update an organization domain. |
8
+
9
+
10
+ ## update_organization_domain
11
+
12
+ > <OrganizationDomain> update_organization_domain(organization_id, domain_id, update_organization_domain_request)
13
+
14
+ Update an organization domain.
15
+
16
+ Updates the properties of an existing organization domain.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'clerk-http-client'
23
+ # setup authorization
24
+ ClerkHttpClient.configure do |config|
25
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
27
+ end
28
+
29
+ api_instance = ClerkHttpClient::OrganizationDomainApi.new
30
+ organization_id = 'organization_id_example' # String | The ID of the organization the domain belongs to
31
+ domain_id = 'domain_id_example' # String | The ID of the domain
32
+ update_organization_domain_request = ClerkHttpClient::UpdateOrganizationDomainRequest.new # UpdateOrganizationDomainRequest |
33
+
34
+ begin
35
+ # Update an organization domain.
36
+ result = api_instance.update_organization_domain(organization_id, domain_id, update_organization_domain_request)
37
+ p result
38
+ rescue ClerkHttpClient::ApiError => e
39
+ puts "Error when calling OrganizationDomainApi->update_organization_domain: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the update_organization_domain_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<OrganizationDomain>, Integer, Hash)> update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)
48
+
49
+ ```ruby
50
+ begin
51
+ # Update an organization domain.
52
+ data, status_code, headers = api_instance.update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <OrganizationDomain>
56
+ rescue ClerkHttpClient::ApiError => e
57
+ puts "Error when calling OrganizationDomainApi->update_organization_domain_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **organization_id** | **String** | The ID of the organization the domain belongs to | |
66
+ | **domain_id** | **String** | The ID of the domain | |
67
+ | **update_organization_domain_request** | [**UpdateOrganizationDomainRequest**](UpdateOrganizationDomainRequest.md) | | |
68
+
69
+ ### Return type
70
+
71
+ [**OrganizationDomain**](OrganizationDomain.md)
72
+
73
+ ### Authorization
74
+
75
+ [bearerAuth](../README.md#bearerAuth)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: application/json
80
+ - **Accept**: application/json
81
+