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,591 @@
1
+ # ClerkHttpClient::OrganizationsApi
2
+
3
+ All URIs are relative to *https://api.clerk.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_organization**](OrganizationsApi.md#create_organization) | **POST** /organizations | Create an organization |
8
+ | [**delete_organization**](OrganizationsApi.md#delete_organization) | **DELETE** /organizations/{organization_id} | Delete an organization |
9
+ | [**delete_organization_logo**](OrganizationsApi.md#delete_organization_logo) | **DELETE** /organizations/{organization_id}/logo | |
10
+ | [**get_organization**](OrganizationsApi.md#get_organization) | **GET** /organizations/{organization_id} | Retrieve an organization by ID or slug |
11
+ | [**list_organizations**](OrganizationsApi.md#list_organizations) | **GET** /organizations | Get a list of organizations for an instance |
12
+ | [**merge_organization_metadata**](OrganizationsApi.md#merge_organization_metadata) | **PATCH** /organizations/{organization_id}/metadata | Merge and update metadata for an organization |
13
+ | [**update_organization**](OrganizationsApi.md#update_organization) | **PATCH** /organizations/{organization_id} | Update an organization |
14
+ | [**upload_organization_logo**](OrganizationsApi.md#upload_organization_logo) | **PUT** /organizations/{organization_id}/logo | Upload a logo for the organization |
15
+
16
+
17
+ ## create_organization
18
+
19
+ > <Organization> create_organization(create_organization_request)
20
+
21
+ Create an organization
22
+
23
+ Creates a new organization with the given name for an instance. In order to successfully create an organization you need to provide the ID of the User who will become the organization administrator. You can specify an optional slug for the new organization. If provided, the organization slug can contain only lowercase alphanumeric characters (letters and digits) and the dash \"-\". Organization slugs must be unique for the instance. You can provide additional metadata for the organization and set any custom attribute you want. Organizations support private and public metadata. Private metadata can only be accessed from the Backend API. Public metadata can be accessed from the Backend API, and are read-only from the Frontend API. The `created_by` user will see this as their [active organization] (https://clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don't explicitly set a different organization as active before then.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'clerk-http-client'
30
+ # setup authorization
31
+ ClerkHttpClient.configure do |config|
32
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
33
+ config.access_token = 'YOUR_BEARER_TOKEN'
34
+ end
35
+
36
+ api_instance = ClerkHttpClient::OrganizationsApi.new
37
+ create_organization_request = ClerkHttpClient::CreateOrganizationRequest.new({name: 'name_example', created_by: 'created_by_example'}) # CreateOrganizationRequest |
38
+
39
+ begin
40
+ # Create an organization
41
+ result = api_instance.create_organization(create_organization_request)
42
+ p result
43
+ rescue ClerkHttpClient::ApiError => e
44
+ puts "Error when calling OrganizationsApi->create_organization: #{e}"
45
+ end
46
+ ```
47
+
48
+ #### Using the create_organization_with_http_info variant
49
+
50
+ This returns an Array which contains the response data, status code and headers.
51
+
52
+ > <Array(<Organization>, Integer, Hash)> create_organization_with_http_info(create_organization_request)
53
+
54
+ ```ruby
55
+ begin
56
+ # Create an organization
57
+ data, status_code, headers = api_instance.create_organization_with_http_info(create_organization_request)
58
+ p status_code # => 2xx
59
+ p headers # => { ... }
60
+ p data # => <Organization>
61
+ rescue ClerkHttpClient::ApiError => e
62
+ puts "Error when calling OrganizationsApi->create_organization_with_http_info: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ | Name | Type | Description | Notes |
69
+ | ---- | ---- | ----------- | ----- |
70
+ | **create_organization_request** | [**CreateOrganizationRequest**](CreateOrganizationRequest.md) | | |
71
+
72
+ ### Return type
73
+
74
+ [**Organization**](Organization.md)
75
+
76
+ ### Authorization
77
+
78
+ [bearerAuth](../README.md#bearerAuth)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json
83
+ - **Accept**: application/json
84
+
85
+
86
+ ## delete_organization
87
+
88
+ > <DeletedObject> delete_organization(organization_id)
89
+
90
+ Delete an organization
91
+
92
+ Deletes the given organization. Please note that deleting an organization will also delete all memberships and invitations. This is not reversible.
93
+
94
+ ### Examples
95
+
96
+ ```ruby
97
+ require 'time'
98
+ require 'clerk-http-client'
99
+ # setup authorization
100
+ ClerkHttpClient.configure do |config|
101
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
102
+ config.access_token = 'YOUR_BEARER_TOKEN'
103
+ end
104
+
105
+ api_instance = ClerkHttpClient::OrganizationsApi.new
106
+ organization_id = 'organization_id_example' # String | The ID of the organization to delete
107
+
108
+ begin
109
+ # Delete an organization
110
+ result = api_instance.delete_organization(organization_id)
111
+ p result
112
+ rescue ClerkHttpClient::ApiError => e
113
+ puts "Error when calling OrganizationsApi->delete_organization: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the delete_organization_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(<DeletedObject>, Integer, Hash)> delete_organization_with_http_info(organization_id)
122
+
123
+ ```ruby
124
+ begin
125
+ # Delete an organization
126
+ data, status_code, headers = api_instance.delete_organization_with_http_info(organization_id)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <DeletedObject>
130
+ rescue ClerkHttpClient::ApiError => e
131
+ puts "Error when calling OrganizationsApi->delete_organization_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **organization_id** | **String** | The ID of the organization to delete | |
140
+
141
+ ### Return type
142
+
143
+ [**DeletedObject**](DeletedObject.md)
144
+
145
+ ### Authorization
146
+
147
+ [bearerAuth](../README.md#bearerAuth)
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: Not defined
152
+ - **Accept**: application/json
153
+
154
+
155
+ ## delete_organization_logo
156
+
157
+ > <Organization> delete_organization_logo(organization_id)
158
+
159
+
160
+
161
+ Delete the organization's logo.
162
+
163
+ ### Examples
164
+
165
+ ```ruby
166
+ require 'time'
167
+ require 'clerk-http-client'
168
+ # setup authorization
169
+ ClerkHttpClient.configure do |config|
170
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
171
+ config.access_token = 'YOUR_BEARER_TOKEN'
172
+ end
173
+
174
+ api_instance = ClerkHttpClient::OrganizationsApi.new
175
+ organization_id = 'organization_id_example' # String | The ID of the organization for which the logo will be deleted.
176
+
177
+ begin
178
+
179
+ result = api_instance.delete_organization_logo(organization_id)
180
+ p result
181
+ rescue ClerkHttpClient::ApiError => e
182
+ puts "Error when calling OrganizationsApi->delete_organization_logo: #{e}"
183
+ end
184
+ ```
185
+
186
+ #### Using the delete_organization_logo_with_http_info variant
187
+
188
+ This returns an Array which contains the response data, status code and headers.
189
+
190
+ > <Array(<Organization>, Integer, Hash)> delete_organization_logo_with_http_info(organization_id)
191
+
192
+ ```ruby
193
+ begin
194
+
195
+ data, status_code, headers = api_instance.delete_organization_logo_with_http_info(organization_id)
196
+ p status_code # => 2xx
197
+ p headers # => { ... }
198
+ p data # => <Organization>
199
+ rescue ClerkHttpClient::ApiError => e
200
+ puts "Error when calling OrganizationsApi->delete_organization_logo_with_http_info: #{e}"
201
+ end
202
+ ```
203
+
204
+ ### Parameters
205
+
206
+ | Name | Type | Description | Notes |
207
+ | ---- | ---- | ----------- | ----- |
208
+ | **organization_id** | **String** | The ID of the organization for which the logo will be deleted. | |
209
+
210
+ ### Return type
211
+
212
+ [**Organization**](Organization.md)
213
+
214
+ ### Authorization
215
+
216
+ [bearerAuth](../README.md#bearerAuth)
217
+
218
+ ### HTTP request headers
219
+
220
+ - **Content-Type**: Not defined
221
+ - **Accept**: application/json
222
+
223
+
224
+ ## get_organization
225
+
226
+ > <Organization> get_organization(organization_id, opts)
227
+
228
+ Retrieve an organization by ID or slug
229
+
230
+ Fetches the organization whose ID or slug matches the provided `id_or_slug` URL query parameter.
231
+
232
+ ### Examples
233
+
234
+ ```ruby
235
+ require 'time'
236
+ require 'clerk-http-client'
237
+ # setup authorization
238
+ ClerkHttpClient.configure do |config|
239
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
240
+ config.access_token = 'YOUR_BEARER_TOKEN'
241
+ end
242
+
243
+ api_instance = ClerkHttpClient::OrganizationsApi.new
244
+ organization_id = 'organization_id_example' # String | The ID or slug of the organization
245
+ opts = {
246
+ include_members_count: true # Boolean | Flag to denote whether or not the organization's members count should be included in the response.
247
+ }
248
+
249
+ begin
250
+ # Retrieve an organization by ID or slug
251
+ result = api_instance.get_organization(organization_id, opts)
252
+ p result
253
+ rescue ClerkHttpClient::ApiError => e
254
+ puts "Error when calling OrganizationsApi->get_organization: #{e}"
255
+ end
256
+ ```
257
+
258
+ #### Using the get_organization_with_http_info variant
259
+
260
+ This returns an Array which contains the response data, status code and headers.
261
+
262
+ > <Array(<Organization>, Integer, Hash)> get_organization_with_http_info(organization_id, opts)
263
+
264
+ ```ruby
265
+ begin
266
+ # Retrieve an organization by ID or slug
267
+ data, status_code, headers = api_instance.get_organization_with_http_info(organization_id, opts)
268
+ p status_code # => 2xx
269
+ p headers # => { ... }
270
+ p data # => <Organization>
271
+ rescue ClerkHttpClient::ApiError => e
272
+ puts "Error when calling OrganizationsApi->get_organization_with_http_info: #{e}"
273
+ end
274
+ ```
275
+
276
+ ### Parameters
277
+
278
+ | Name | Type | Description | Notes |
279
+ | ---- | ---- | ----------- | ----- |
280
+ | **organization_id** | **String** | The ID or slug of the organization | |
281
+ | **include_members_count** | **Boolean** | Flag to denote whether or not the organization&#39;s members count should be included in the response. | [optional] |
282
+
283
+ ### Return type
284
+
285
+ [**Organization**](Organization.md)
286
+
287
+ ### Authorization
288
+
289
+ [bearerAuth](../README.md#bearerAuth)
290
+
291
+ ### HTTP request headers
292
+
293
+ - **Content-Type**: Not defined
294
+ - **Accept**: application/json
295
+
296
+
297
+ ## list_organizations
298
+
299
+ > <Organizations> list_organizations(opts)
300
+
301
+ Get a list of organizations for an instance
302
+
303
+ This request returns the list of organizations for an instance. Results can be paginated using the optional `limit` and `offset` query parameters. The organizations are ordered by descending creation date. Most recent organizations will be returned first.
304
+
305
+ ### Examples
306
+
307
+ ```ruby
308
+ require 'time'
309
+ require 'clerk-http-client'
310
+ # setup authorization
311
+ ClerkHttpClient.configure do |config|
312
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
313
+ config.access_token = 'YOUR_BEARER_TOKEN'
314
+ end
315
+
316
+ api_instance = ClerkHttpClient::OrganizationsApi.new
317
+ opts = {
318
+ limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
319
+ 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`.
320
+ include_members_count: true, # Boolean | Flag to denote whether the member counts of each organization should be included in the response or not.
321
+ query: 'query_example', # String | Returns organizations with ID, name, or slug that match the given query. Uses exact match for organization ID and partial match for name and slug.
322
+ order_by: 'order_by_example' # String | Allows to return organizations in a particular order. At the moment, you can order the returned organizations either by their `name`, `created_at` or `members_count`. In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by. For example, if you want organizations 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. Defaults to `-created_at`.
323
+ }
324
+
325
+ begin
326
+ # Get a list of organizations for an instance
327
+ result = api_instance.list_organizations(opts)
328
+ p result
329
+ rescue ClerkHttpClient::ApiError => e
330
+ puts "Error when calling OrganizationsApi->list_organizations: #{e}"
331
+ end
332
+ ```
333
+
334
+ #### Using the list_organizations_with_http_info variant
335
+
336
+ This returns an Array which contains the response data, status code and headers.
337
+
338
+ > <Array(<Organizations>, Integer, Hash)> list_organizations_with_http_info(opts)
339
+
340
+ ```ruby
341
+ begin
342
+ # Get a list of organizations for an instance
343
+ data, status_code, headers = api_instance.list_organizations_with_http_info(opts)
344
+ p status_code # => 2xx
345
+ p headers # => { ... }
346
+ p data # => <Organizations>
347
+ rescue ClerkHttpClient::ApiError => e
348
+ puts "Error when calling OrganizationsApi->list_organizations_with_http_info: #{e}"
349
+ end
350
+ ```
351
+
352
+ ### Parameters
353
+
354
+ | Name | Type | Description | Notes |
355
+ | ---- | ---- | ----------- | ----- |
356
+ | **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] |
357
+ | **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] |
358
+ | **include_members_count** | **Boolean** | Flag to denote whether the member counts of each organization should be included in the response or not. | [optional] |
359
+ | **query** | **String** | Returns organizations with ID, name, or slug that match the given query. Uses exact match for organization ID and partial match for name and slug. | [optional] |
360
+ | **order_by** | **String** | Allows to return organizations in a particular order. At the moment, you can order the returned organizations either by their &#x60;name&#x60;, &#x60;created_at&#x60; or &#x60;members_count&#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 organizations 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. Defaults to &#x60;-created_at&#x60;. | [optional][default to &#39;-created_at&#39;] |
361
+
362
+ ### Return type
363
+
364
+ [**Organizations**](Organizations.md)
365
+
366
+ ### Authorization
367
+
368
+ [bearerAuth](../README.md#bearerAuth)
369
+
370
+ ### HTTP request headers
371
+
372
+ - **Content-Type**: Not defined
373
+ - **Accept**: application/json
374
+
375
+
376
+ ## merge_organization_metadata
377
+
378
+ > <Organization> merge_organization_metadata(organization_id, merge_organization_metadata_request)
379
+
380
+ Merge and update metadata for an organization
381
+
382
+ Update organization metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep meaning that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to `null`.
383
+
384
+ ### Examples
385
+
386
+ ```ruby
387
+ require 'time'
388
+ require 'clerk-http-client'
389
+ # setup authorization
390
+ ClerkHttpClient.configure do |config|
391
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
392
+ config.access_token = 'YOUR_BEARER_TOKEN'
393
+ end
394
+
395
+ api_instance = ClerkHttpClient::OrganizationsApi.new
396
+ organization_id = 'organization_id_example' # String | The ID of the organization for which metadata will be merged or updated
397
+ merge_organization_metadata_request = ClerkHttpClient::MergeOrganizationMetadataRequest.new # MergeOrganizationMetadataRequest |
398
+
399
+ begin
400
+ # Merge and update metadata for an organization
401
+ result = api_instance.merge_organization_metadata(organization_id, merge_organization_metadata_request)
402
+ p result
403
+ rescue ClerkHttpClient::ApiError => e
404
+ puts "Error when calling OrganizationsApi->merge_organization_metadata: #{e}"
405
+ end
406
+ ```
407
+
408
+ #### Using the merge_organization_metadata_with_http_info variant
409
+
410
+ This returns an Array which contains the response data, status code and headers.
411
+
412
+ > <Array(<Organization>, Integer, Hash)> merge_organization_metadata_with_http_info(organization_id, merge_organization_metadata_request)
413
+
414
+ ```ruby
415
+ begin
416
+ # Merge and update metadata for an organization
417
+ data, status_code, headers = api_instance.merge_organization_metadata_with_http_info(organization_id, merge_organization_metadata_request)
418
+ p status_code # => 2xx
419
+ p headers # => { ... }
420
+ p data # => <Organization>
421
+ rescue ClerkHttpClient::ApiError => e
422
+ puts "Error when calling OrganizationsApi->merge_organization_metadata_with_http_info: #{e}"
423
+ end
424
+ ```
425
+
426
+ ### Parameters
427
+
428
+ | Name | Type | Description | Notes |
429
+ | ---- | ---- | ----------- | ----- |
430
+ | **organization_id** | **String** | The ID of the organization for which metadata will be merged or updated | |
431
+ | **merge_organization_metadata_request** | [**MergeOrganizationMetadataRequest**](MergeOrganizationMetadataRequest.md) | | |
432
+
433
+ ### Return type
434
+
435
+ [**Organization**](Organization.md)
436
+
437
+ ### Authorization
438
+
439
+ [bearerAuth](../README.md#bearerAuth)
440
+
441
+ ### HTTP request headers
442
+
443
+ - **Content-Type**: application/json
444
+ - **Accept**: application/json
445
+
446
+
447
+ ## update_organization
448
+
449
+ > <Organization> update_organization(organization_id, update_organization_request)
450
+
451
+ Update an organization
452
+
453
+ Updates an existing organization
454
+
455
+ ### Examples
456
+
457
+ ```ruby
458
+ require 'time'
459
+ require 'clerk-http-client'
460
+ # setup authorization
461
+ ClerkHttpClient.configure do |config|
462
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
463
+ config.access_token = 'YOUR_BEARER_TOKEN'
464
+ end
465
+
466
+ api_instance = ClerkHttpClient::OrganizationsApi.new
467
+ organization_id = 'organization_id_example' # String | The ID of the organization to update
468
+ update_organization_request = ClerkHttpClient::UpdateOrganizationRequest.new # UpdateOrganizationRequest |
469
+
470
+ begin
471
+ # Update an organization
472
+ result = api_instance.update_organization(organization_id, update_organization_request)
473
+ p result
474
+ rescue ClerkHttpClient::ApiError => e
475
+ puts "Error when calling OrganizationsApi->update_organization: #{e}"
476
+ end
477
+ ```
478
+
479
+ #### Using the update_organization_with_http_info variant
480
+
481
+ This returns an Array which contains the response data, status code and headers.
482
+
483
+ > <Array(<Organization>, Integer, Hash)> update_organization_with_http_info(organization_id, update_organization_request)
484
+
485
+ ```ruby
486
+ begin
487
+ # Update an organization
488
+ data, status_code, headers = api_instance.update_organization_with_http_info(organization_id, update_organization_request)
489
+ p status_code # => 2xx
490
+ p headers # => { ... }
491
+ p data # => <Organization>
492
+ rescue ClerkHttpClient::ApiError => e
493
+ puts "Error when calling OrganizationsApi->update_organization_with_http_info: #{e}"
494
+ end
495
+ ```
496
+
497
+ ### Parameters
498
+
499
+ | Name | Type | Description | Notes |
500
+ | ---- | ---- | ----------- | ----- |
501
+ | **organization_id** | **String** | The ID of the organization to update | |
502
+ | **update_organization_request** | [**UpdateOrganizationRequest**](UpdateOrganizationRequest.md) | | |
503
+
504
+ ### Return type
505
+
506
+ [**Organization**](Organization.md)
507
+
508
+ ### Authorization
509
+
510
+ [bearerAuth](../README.md#bearerAuth)
511
+
512
+ ### HTTP request headers
513
+
514
+ - **Content-Type**: application/json
515
+ - **Accept**: application/json
516
+
517
+
518
+ ## upload_organization_logo
519
+
520
+ > <OrganizationWithLogo> upload_organization_logo(organization_id, file, opts)
521
+
522
+ Upload a logo for the organization
523
+
524
+ Set or replace an organization's logo, by uploading an image file. This endpoint uses the `multipart/form-data` request content type and accepts a file of image type. The file size cannot exceed 10MB. Only the following file content types are supported: `image/jpeg`, `image/png`, `image/gif`, `image/webp`, `image/x-icon`, `image/vnd.microsoft.icon`.
525
+
526
+ ### Examples
527
+
528
+ ```ruby
529
+ require 'time'
530
+ require 'clerk-http-client'
531
+ # setup authorization
532
+ ClerkHttpClient.configure do |config|
533
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
534
+ config.access_token = 'YOUR_BEARER_TOKEN'
535
+ end
536
+
537
+ api_instance = ClerkHttpClient::OrganizationsApi.new
538
+ organization_id = 'organization_id_example' # String | The ID of the organization for which to upload a logo
539
+ file = File.new('/path/to/some/file') # File |
540
+ opts = {
541
+ uploader_user_id: 'uploader_user_id_example' # String | The ID of the user that will be credited with the image upload.
542
+ }
543
+
544
+ begin
545
+ # Upload a logo for the organization
546
+ result = api_instance.upload_organization_logo(organization_id, file, opts)
547
+ p result
548
+ rescue ClerkHttpClient::ApiError => e
549
+ puts "Error when calling OrganizationsApi->upload_organization_logo: #{e}"
550
+ end
551
+ ```
552
+
553
+ #### Using the upload_organization_logo_with_http_info variant
554
+
555
+ This returns an Array which contains the response data, status code and headers.
556
+
557
+ > <Array(<OrganizationWithLogo>, Integer, Hash)> upload_organization_logo_with_http_info(organization_id, file, opts)
558
+
559
+ ```ruby
560
+ begin
561
+ # Upload a logo for the organization
562
+ data, status_code, headers = api_instance.upload_organization_logo_with_http_info(organization_id, file, opts)
563
+ p status_code # => 2xx
564
+ p headers # => { ... }
565
+ p data # => <OrganizationWithLogo>
566
+ rescue ClerkHttpClient::ApiError => e
567
+ puts "Error when calling OrganizationsApi->upload_organization_logo_with_http_info: #{e}"
568
+ end
569
+ ```
570
+
571
+ ### Parameters
572
+
573
+ | Name | Type | Description | Notes |
574
+ | ---- | ---- | ----------- | ----- |
575
+ | **organization_id** | **String** | The ID of the organization for which to upload a logo | |
576
+ | **file** | **File** | | |
577
+ | **uploader_user_id** | **String** | The ID of the user that will be credited with the image upload. | [optional] |
578
+
579
+ ### Return type
580
+
581
+ [**OrganizationWithLogo**](OrganizationWithLogo.md)
582
+
583
+ ### Authorization
584
+
585
+ [bearerAuth](../README.md#bearerAuth)
586
+
587
+ ### HTTP request headers
588
+
589
+ - **Content-Type**: multipart/form-data
590
+ - **Accept**: application/json
591
+
data/docs/Passkey.md ADDED
@@ -0,0 +1,26 @@
1
+ # ClerkHttpClient::Passkey
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **strategy** | **String** | | |
9
+ | **nonce** | **String** | | [optional] |
10
+ | **attempts** | **Integer** | | [optional] |
11
+ | **expire_at** | **Integer** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'clerk-http-client'
17
+
18
+ instance = ClerkHttpClient::Passkey.new(
19
+ status: null,
20
+ strategy: null,
21
+ nonce: null,
22
+ attempts: null,
23
+ expire_at: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,38 @@
1
+ # ClerkHttpClient::PhoneNumber
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **object** | **String** | String representing the object&#39;s type. Objects of the same type share the same value. | |
9
+ | **phone_number** | **String** | | |
10
+ | **reserved_for_second_factor** | **Boolean** | | [optional] |
11
+ | **default_second_factor** | **Boolean** | | [optional] |
12
+ | **reserved** | **Boolean** | | |
13
+ | **verification** | [**PhoneNumberVerification**](PhoneNumberVerification.md) | | |
14
+ | **linked_to** | [**Array&lt;IdentificationLink&gt;**](IdentificationLink.md) | | |
15
+ | **backup_codes** | **Array&lt;String&gt;** | | [optional] |
16
+ | **created_at** | **Integer** | Unix timestamp of creation | |
17
+ | **updated_at** | **Integer** | Unix timestamp of creation | |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'clerk-http-client'
23
+
24
+ instance = ClerkHttpClient::PhoneNumber.new(
25
+ id: null,
26
+ object: null,
27
+ phone_number: null,
28
+ reserved_for_second_factor: null,
29
+ default_second_factor: null,
30
+ reserved: null,
31
+ verification: null,
32
+ linked_to: null,
33
+ backup_codes: null,
34
+ created_at: null,
35
+ updated_at: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,49 @@
1
+ # ClerkHttpClient::PhoneNumberVerification
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::PhoneNumberVerification.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'Admin',
18
+ # :'OTP'
19
+ # ]
20
+ ```
21
+
22
+ ### build
23
+
24
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'clerk-http-client'
30
+
31
+ ClerkHttpClient::PhoneNumberVerification.build(data)
32
+ # => #<Admin:0x00007fdd4aab02a0>
33
+
34
+ ClerkHttpClient::PhoneNumberVerification.build(data_that_doesnt_match)
35
+ # => nil
36
+ ```
37
+
38
+ #### Parameters
39
+
40
+ | Name | Type | Description |
41
+ | ---- | ---- | ----------- |
42
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
+
44
+ #### Return type
45
+
46
+ - `Admin`
47
+ - `OTP`
48
+ - `nil` (if no type matches)
49
+