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,533 @@
1
+ # ClerkHttpClient::OrganizationInvitationsApi
2
+
3
+ All URIs are relative to *https://api.clerk.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_organization_invitation**](OrganizationInvitationsApi.md#create_organization_invitation) | **POST** /organizations/{organization_id}/invitations | Create and send an organization invitation |
8
+ | [**create_organization_invitation_bulk**](OrganizationInvitationsApi.md#create_organization_invitation_bulk) | **POST** /organizations/{organization_id}/invitations/bulk | Bulk create and send organization invitations |
9
+ | [**get_organization_invitation**](OrganizationInvitationsApi.md#get_organization_invitation) | **GET** /organizations/{organization_id}/invitations/{invitation_id} | Retrieve an organization invitation by ID |
10
+ | [**list_instance_organization_invitations**](OrganizationInvitationsApi.md#list_instance_organization_invitations) | **GET** /organization_invitations | Get a list of organization invitations for the current instance |
11
+ | [**list_organization_invitations**](OrganizationInvitationsApi.md#list_organization_invitations) | **GET** /organizations/{organization_id}/invitations | Get a list of organization invitations |
12
+ | [**list_pending_organization_invitations**](OrganizationInvitationsApi.md#list_pending_organization_invitations) | **GET** /organizations/{organization_id}/invitations/pending | Get a list of pending organization invitations |
13
+ | [**revoke_organization_invitation**](OrganizationInvitationsApi.md#revoke_organization_invitation) | **POST** /organizations/{organization_id}/invitations/{invitation_id}/revoke | Revoke a pending organization invitation |
14
+
15
+
16
+ ## create_organization_invitation
17
+
18
+ > <OrganizationInvitation> create_organization_invitation(organization_id, create_organization_invitation_request)
19
+
20
+ Create and send an organization invitation
21
+
22
+ Creates a new organization invitation and sends an email to the provided `email_address` with a link to accept the invitation and join the organization. You can specify the `role` for the invited organization member. New organization invitations get a \"pending\" status until they are revoked by an organization administrator or accepted by the invitee. The request body supports passing an optional `redirect_url` parameter. When the invited user clicks the link to accept the invitation, they will be redirected to the URL provided. Use this parameter to implement a custom invitation acceptance flow. You can specify the ID of the user that will send the invitation with the `inviter_user_id` parameter. That user must be a member with administrator privileges in the organization. Only \"admin\" members can create organization invitations. You can optionally provide public and private metadata for the organization invitation. The public metadata are visible by both the Frontend and the Backend whereas the private ones only by the Backend. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
23
+
24
+ ### Examples
25
+
26
+ ```ruby
27
+ require 'time'
28
+ require 'clerk-http-client'
29
+ # setup authorization
30
+ ClerkHttpClient.configure do |config|
31
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
32
+ config.access_token = 'YOUR_BEARER_TOKEN'
33
+ end
34
+
35
+ api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
36
+ organization_id = 'organization_id_example' # String | The ID of the organization for which to send the invitation
37
+ create_organization_invitation_request = ClerkHttpClient::CreateOrganizationInvitationRequest.new({email_address: 'email_address_example', role: 'role_example'}) # CreateOrganizationInvitationRequest |
38
+
39
+ begin
40
+ # Create and send an organization invitation
41
+ result = api_instance.create_organization_invitation(organization_id, create_organization_invitation_request)
42
+ p result
43
+ rescue ClerkHttpClient::ApiError => e
44
+ puts "Error when calling OrganizationInvitationsApi->create_organization_invitation: #{e}"
45
+ end
46
+ ```
47
+
48
+ #### Using the create_organization_invitation_with_http_info variant
49
+
50
+ This returns an Array which contains the response data, status code and headers.
51
+
52
+ > <Array(<OrganizationInvitation>, Integer, Hash)> create_organization_invitation_with_http_info(organization_id, create_organization_invitation_request)
53
+
54
+ ```ruby
55
+ begin
56
+ # Create and send an organization invitation
57
+ data, status_code, headers = api_instance.create_organization_invitation_with_http_info(organization_id, create_organization_invitation_request)
58
+ p status_code # => 2xx
59
+ p headers # => { ... }
60
+ p data # => <OrganizationInvitation>
61
+ rescue ClerkHttpClient::ApiError => e
62
+ puts "Error when calling OrganizationInvitationsApi->create_organization_invitation_with_http_info: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ | Name | Type | Description | Notes |
69
+ | ---- | ---- | ----------- | ----- |
70
+ | **organization_id** | **String** | The ID of the organization for which to send the invitation | |
71
+ | **create_organization_invitation_request** | [**CreateOrganizationInvitationRequest**](CreateOrganizationInvitationRequest.md) | | |
72
+
73
+ ### Return type
74
+
75
+ [**OrganizationInvitation**](OrganizationInvitation.md)
76
+
77
+ ### Authorization
78
+
79
+ [bearerAuth](../README.md#bearerAuth)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: application/json
84
+ - **Accept**: application/json
85
+
86
+
87
+ ## create_organization_invitation_bulk
88
+
89
+ > <OrganizationInvitations> create_organization_invitation_bulk(organization_id, create_organization_invitation_bulk_request_inner)
90
+
91
+ Bulk create and send organization invitations
92
+
93
+ Creates new organization invitations in bulk and sends out emails to the provided email addresses with a link to accept the invitation and join the organization. You can specify a different `role` for each invited organization member. New organization invitations get a \"pending\" status until they are revoked by an organization administrator or accepted by the invitee. The request body supports passing an optional `redirect_url` parameter for each invitation. When the invited user clicks the link to accept the invitation, they will be redirected to the provided URL. Use this parameter to implement a custom invitation acceptance flow. You can specify the ID of the user that will send the invitation with the `inviter_user_id` parameter. Each invitation can have a different inviter user. Inviter users must be members with administrator privileges in the organization. Only \"admin\" members can create organization invitations. You can optionally provide public and private metadata for each organization invitation. The public metadata are visible by both the Frontend and the Backend, whereas the private metadata are only visible by the Backend. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
94
+
95
+ ### Examples
96
+
97
+ ```ruby
98
+ require 'time'
99
+ require 'clerk-http-client'
100
+ # setup authorization
101
+ ClerkHttpClient.configure do |config|
102
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
103
+ config.access_token = 'YOUR_BEARER_TOKEN'
104
+ end
105
+
106
+ api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
107
+ organization_id = 'organization_id_example' # String | The organization ID.
108
+ create_organization_invitation_bulk_request_inner = [ClerkHttpClient::CreateOrganizationInvitationBulkRequestInner.new({email_address: 'email_address_example', role: 'role_example'})] # Array<CreateOrganizationInvitationBulkRequestInner> |
109
+
110
+ begin
111
+ # Bulk create and send organization invitations
112
+ result = api_instance.create_organization_invitation_bulk(organization_id, create_organization_invitation_bulk_request_inner)
113
+ p result
114
+ rescue ClerkHttpClient::ApiError => e
115
+ puts "Error when calling OrganizationInvitationsApi->create_organization_invitation_bulk: #{e}"
116
+ end
117
+ ```
118
+
119
+ #### Using the create_organization_invitation_bulk_with_http_info variant
120
+
121
+ This returns an Array which contains the response data, status code and headers.
122
+
123
+ > <Array(<OrganizationInvitations>, Integer, Hash)> create_organization_invitation_bulk_with_http_info(organization_id, create_organization_invitation_bulk_request_inner)
124
+
125
+ ```ruby
126
+ begin
127
+ # Bulk create and send organization invitations
128
+ data, status_code, headers = api_instance.create_organization_invitation_bulk_with_http_info(organization_id, create_organization_invitation_bulk_request_inner)
129
+ p status_code # => 2xx
130
+ p headers # => { ... }
131
+ p data # => <OrganizationInvitations>
132
+ rescue ClerkHttpClient::ApiError => e
133
+ puts "Error when calling OrganizationInvitationsApi->create_organization_invitation_bulk_with_http_info: #{e}"
134
+ end
135
+ ```
136
+
137
+ ### Parameters
138
+
139
+ | Name | Type | Description | Notes |
140
+ | ---- | ---- | ----------- | ----- |
141
+ | **organization_id** | **String** | The organization ID. | |
142
+ | **create_organization_invitation_bulk_request_inner** | [**Array&lt;CreateOrganizationInvitationBulkRequestInner&gt;**](CreateOrganizationInvitationBulkRequestInner.md) | | |
143
+
144
+ ### Return type
145
+
146
+ [**OrganizationInvitations**](OrganizationInvitations.md)
147
+
148
+ ### Authorization
149
+
150
+ [bearerAuth](../README.md#bearerAuth)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: application/json
155
+ - **Accept**: application/json
156
+
157
+
158
+ ## get_organization_invitation
159
+
160
+ > <OrganizationInvitation> get_organization_invitation(organization_id, invitation_id)
161
+
162
+ Retrieve an organization invitation by ID
163
+
164
+ Use this request to get an existing organization invitation by ID.
165
+
166
+ ### Examples
167
+
168
+ ```ruby
169
+ require 'time'
170
+ require 'clerk-http-client'
171
+ # setup authorization
172
+ ClerkHttpClient.configure do |config|
173
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
174
+ config.access_token = 'YOUR_BEARER_TOKEN'
175
+ end
176
+
177
+ api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
178
+ organization_id = 'organization_id_example' # String | The organization ID.
179
+ invitation_id = 'invitation_id_example' # String | The organization invitation ID.
180
+
181
+ begin
182
+ # Retrieve an organization invitation by ID
183
+ result = api_instance.get_organization_invitation(organization_id, invitation_id)
184
+ p result
185
+ rescue ClerkHttpClient::ApiError => e
186
+ puts "Error when calling OrganizationInvitationsApi->get_organization_invitation: #{e}"
187
+ end
188
+ ```
189
+
190
+ #### Using the get_organization_invitation_with_http_info variant
191
+
192
+ This returns an Array which contains the response data, status code and headers.
193
+
194
+ > <Array(<OrganizationInvitation>, Integer, Hash)> get_organization_invitation_with_http_info(organization_id, invitation_id)
195
+
196
+ ```ruby
197
+ begin
198
+ # Retrieve an organization invitation by ID
199
+ data, status_code, headers = api_instance.get_organization_invitation_with_http_info(organization_id, invitation_id)
200
+ p status_code # => 2xx
201
+ p headers # => { ... }
202
+ p data # => <OrganizationInvitation>
203
+ rescue ClerkHttpClient::ApiError => e
204
+ puts "Error when calling OrganizationInvitationsApi->get_organization_invitation_with_http_info: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ | Name | Type | Description | Notes |
211
+ | ---- | ---- | ----------- | ----- |
212
+ | **organization_id** | **String** | The organization ID. | |
213
+ | **invitation_id** | **String** | The organization invitation ID. | |
214
+
215
+ ### Return type
216
+
217
+ [**OrganizationInvitation**](OrganizationInvitation.md)
218
+
219
+ ### Authorization
220
+
221
+ [bearerAuth](../README.md#bearerAuth)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: Not defined
226
+ - **Accept**: application/json
227
+
228
+
229
+ ## list_instance_organization_invitations
230
+
231
+ > <OrganizationInvitationsWithPublicOrganizationData> list_instance_organization_invitations(opts)
232
+
233
+ Get a list of organization invitations for the current instance
234
+
235
+ This request returns the list of organization invitations for the instance. Results can be paginated using the optional `limit` and `offset` query parameters. You can filter them by providing the 'status' query parameter, that accepts multiple values. You can change the order by providing the 'order' query parameter, that accepts multiple values. You can filter by the invited user email address providing the `query` query parameter. The organization invitations are ordered by descending creation date by default.
236
+
237
+ ### Examples
238
+
239
+ ```ruby
240
+ require 'time'
241
+ require 'clerk-http-client'
242
+ # setup authorization
243
+ ClerkHttpClient.configure do |config|
244
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
245
+ config.access_token = 'YOUR_BEARER_TOKEN'
246
+ end
247
+
248
+ api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
249
+ opts = {
250
+ limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
251
+ 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`.
252
+ order_by: 'order_by_example', # String | Allows to return organization invitations in a particular order. At the moment, you can order the returned organization invitations either by their `created_at` or `email_address`. In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by. For example, if you want organization invitations 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`.
253
+ status: 'pending', # String | Filter organization invitations based on their status
254
+ query: 'query_example' # String | Filter organization invitations based on their `email_address`
255
+ }
256
+
257
+ begin
258
+ # Get a list of organization invitations for the current instance
259
+ result = api_instance.list_instance_organization_invitations(opts)
260
+ p result
261
+ rescue ClerkHttpClient::ApiError => e
262
+ puts "Error when calling OrganizationInvitationsApi->list_instance_organization_invitations: #{e}"
263
+ end
264
+ ```
265
+
266
+ #### Using the list_instance_organization_invitations_with_http_info variant
267
+
268
+ This returns an Array which contains the response data, status code and headers.
269
+
270
+ > <Array(<OrganizationInvitationsWithPublicOrganizationData>, Integer, Hash)> list_instance_organization_invitations_with_http_info(opts)
271
+
272
+ ```ruby
273
+ begin
274
+ # Get a list of organization invitations for the current instance
275
+ data, status_code, headers = api_instance.list_instance_organization_invitations_with_http_info(opts)
276
+ p status_code # => 2xx
277
+ p headers # => { ... }
278
+ p data # => <OrganizationInvitationsWithPublicOrganizationData>
279
+ rescue ClerkHttpClient::ApiError => e
280
+ puts "Error when calling OrganizationInvitationsApi->list_instance_organization_invitations_with_http_info: #{e}"
281
+ end
282
+ ```
283
+
284
+ ### Parameters
285
+
286
+ | Name | Type | Description | Notes |
287
+ | ---- | ---- | ----------- | ----- |
288
+ | **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] |
289
+ | **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] |
290
+ | **order_by** | **String** | Allows to return organization invitations in a particular order. At the moment, you can order the returned organization invitations either by their &#x60;created_at&#x60; or &#x60;email_address&#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 organization invitations 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;] |
291
+ | **status** | **String** | Filter organization invitations based on their status | [optional] |
292
+ | **query** | **String** | Filter organization invitations based on their &#x60;email_address&#x60; | [optional] |
293
+
294
+ ### Return type
295
+
296
+ [**OrganizationInvitationsWithPublicOrganizationData**](OrganizationInvitationsWithPublicOrganizationData.md)
297
+
298
+ ### Authorization
299
+
300
+ [bearerAuth](../README.md#bearerAuth)
301
+
302
+ ### HTTP request headers
303
+
304
+ - **Content-Type**: Not defined
305
+ - **Accept**: application/json
306
+
307
+
308
+ ## list_organization_invitations
309
+
310
+ > <OrganizationInvitations> list_organization_invitations(organization_id, opts)
311
+
312
+ Get a list of organization invitations
313
+
314
+ This request returns the list of organization invitations. Results can be paginated using the optional `limit` and `offset` query parameters. You can filter them by providing the 'status' query parameter, that accepts multiple values. The organization invitations are ordered by descending creation date. Most recent invitations will be returned first. Any invitations created as a result of an Organization Domain are not included in the results.
315
+
316
+ ### Examples
317
+
318
+ ```ruby
319
+ require 'time'
320
+ require 'clerk-http-client'
321
+ # setup authorization
322
+ ClerkHttpClient.configure do |config|
323
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
324
+ config.access_token = 'YOUR_BEARER_TOKEN'
325
+ end
326
+
327
+ api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
328
+ organization_id = 'organization_id_example' # String | The organization ID.
329
+ opts = {
330
+ limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
331
+ 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`.
332
+ status: 'pending' # String | Filter organization invitations based on their status
333
+ }
334
+
335
+ begin
336
+ # Get a list of organization invitations
337
+ result = api_instance.list_organization_invitations(organization_id, opts)
338
+ p result
339
+ rescue ClerkHttpClient::ApiError => e
340
+ puts "Error when calling OrganizationInvitationsApi->list_organization_invitations: #{e}"
341
+ end
342
+ ```
343
+
344
+ #### Using the list_organization_invitations_with_http_info variant
345
+
346
+ This returns an Array which contains the response data, status code and headers.
347
+
348
+ > <Array(<OrganizationInvitations>, Integer, Hash)> list_organization_invitations_with_http_info(organization_id, opts)
349
+
350
+ ```ruby
351
+ begin
352
+ # Get a list of organization invitations
353
+ data, status_code, headers = api_instance.list_organization_invitations_with_http_info(organization_id, opts)
354
+ p status_code # => 2xx
355
+ p headers # => { ... }
356
+ p data # => <OrganizationInvitations>
357
+ rescue ClerkHttpClient::ApiError => e
358
+ puts "Error when calling OrganizationInvitationsApi->list_organization_invitations_with_http_info: #{e}"
359
+ end
360
+ ```
361
+
362
+ ### Parameters
363
+
364
+ | Name | Type | Description | Notes |
365
+ | ---- | ---- | ----------- | ----- |
366
+ | **organization_id** | **String** | The organization ID. | |
367
+ | **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] |
368
+ | **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] |
369
+ | **status** | **String** | Filter organization invitations based on their status | [optional] |
370
+
371
+ ### Return type
372
+
373
+ [**OrganizationInvitations**](OrganizationInvitations.md)
374
+
375
+ ### Authorization
376
+
377
+ [bearerAuth](../README.md#bearerAuth)
378
+
379
+ ### HTTP request headers
380
+
381
+ - **Content-Type**: Not defined
382
+ - **Accept**: application/json
383
+
384
+
385
+ ## list_pending_organization_invitations
386
+
387
+ > <OrganizationInvitations> list_pending_organization_invitations(organization_id, opts)
388
+
389
+ Get a list of pending organization invitations
390
+
391
+ This request returns the list of organization invitations with \"pending\" status. These are the organization invitations that can still be used to join the organization, but have not been accepted by the invited user yet. Results can be paginated using the optional `limit` and `offset` query parameters. The organization invitations are ordered by descending creation date. Most recent invitations will be returned first. Any invitations created as a result of an Organization Domain are not included in the results.
392
+
393
+ ### Examples
394
+
395
+ ```ruby
396
+ require 'time'
397
+ require 'clerk-http-client'
398
+ # setup authorization
399
+ ClerkHttpClient.configure do |config|
400
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
401
+ config.access_token = 'YOUR_BEARER_TOKEN'
402
+ end
403
+
404
+ api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
405
+ organization_id = 'organization_id_example' # String | The organization ID.
406
+ opts = {
407
+ limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
408
+ 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`.
409
+ }
410
+
411
+ begin
412
+ # Get a list of pending organization invitations
413
+ result = api_instance.list_pending_organization_invitations(organization_id, opts)
414
+ p result
415
+ rescue ClerkHttpClient::ApiError => e
416
+ puts "Error when calling OrganizationInvitationsApi->list_pending_organization_invitations: #{e}"
417
+ end
418
+ ```
419
+
420
+ #### Using the list_pending_organization_invitations_with_http_info variant
421
+
422
+ This returns an Array which contains the response data, status code and headers.
423
+
424
+ > <Array(<OrganizationInvitations>, Integer, Hash)> list_pending_organization_invitations_with_http_info(organization_id, opts)
425
+
426
+ ```ruby
427
+ begin
428
+ # Get a list of pending organization invitations
429
+ data, status_code, headers = api_instance.list_pending_organization_invitations_with_http_info(organization_id, opts)
430
+ p status_code # => 2xx
431
+ p headers # => { ... }
432
+ p data # => <OrganizationInvitations>
433
+ rescue ClerkHttpClient::ApiError => e
434
+ puts "Error when calling OrganizationInvitationsApi->list_pending_organization_invitations_with_http_info: #{e}"
435
+ end
436
+ ```
437
+
438
+ ### Parameters
439
+
440
+ | Name | Type | Description | Notes |
441
+ | ---- | ---- | ----------- | ----- |
442
+ | **organization_id** | **String** | The organization ID. | |
443
+ | **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] |
444
+ | **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] |
445
+
446
+ ### Return type
447
+
448
+ [**OrganizationInvitations**](OrganizationInvitations.md)
449
+
450
+ ### Authorization
451
+
452
+ [bearerAuth](../README.md#bearerAuth)
453
+
454
+ ### HTTP request headers
455
+
456
+ - **Content-Type**: Not defined
457
+ - **Accept**: application/json
458
+
459
+
460
+ ## revoke_organization_invitation
461
+
462
+ > <OrganizationInvitation> revoke_organization_invitation(organization_id, invitation_id, opts)
463
+
464
+ Revoke a pending organization invitation
465
+
466
+ Use this request to revoke a previously issued organization invitation. Revoking an organization invitation makes it invalid; the invited user will no longer be able to join the organization with the revoked invitation. Only organization invitations with \"pending\" status can be revoked. The request accepts the `requesting_user_id` parameter to specify the user which revokes the invitation. Only users with \"admin\" role can revoke invitations.
467
+
468
+ ### Examples
469
+
470
+ ```ruby
471
+ require 'time'
472
+ require 'clerk-http-client'
473
+ # setup authorization
474
+ ClerkHttpClient.configure do |config|
475
+ # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
476
+ config.access_token = 'YOUR_BEARER_TOKEN'
477
+ end
478
+
479
+ api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
480
+ organization_id = 'organization_id_example' # String | The organization ID.
481
+ invitation_id = 'invitation_id_example' # String | The organization invitation ID.
482
+ opts = {
483
+ revoke_organization_invitation_request: ClerkHttpClient::RevokeOrganizationInvitationRequest.new # RevokeOrganizationInvitationRequest |
484
+ }
485
+
486
+ begin
487
+ # Revoke a pending organization invitation
488
+ result = api_instance.revoke_organization_invitation(organization_id, invitation_id, opts)
489
+ p result
490
+ rescue ClerkHttpClient::ApiError => e
491
+ puts "Error when calling OrganizationInvitationsApi->revoke_organization_invitation: #{e}"
492
+ end
493
+ ```
494
+
495
+ #### Using the revoke_organization_invitation_with_http_info variant
496
+
497
+ This returns an Array which contains the response data, status code and headers.
498
+
499
+ > <Array(<OrganizationInvitation>, Integer, Hash)> revoke_organization_invitation_with_http_info(organization_id, invitation_id, opts)
500
+
501
+ ```ruby
502
+ begin
503
+ # Revoke a pending organization invitation
504
+ data, status_code, headers = api_instance.revoke_organization_invitation_with_http_info(organization_id, invitation_id, opts)
505
+ p status_code # => 2xx
506
+ p headers # => { ... }
507
+ p data # => <OrganizationInvitation>
508
+ rescue ClerkHttpClient::ApiError => e
509
+ puts "Error when calling OrganizationInvitationsApi->revoke_organization_invitation_with_http_info: #{e}"
510
+ end
511
+ ```
512
+
513
+ ### Parameters
514
+
515
+ | Name | Type | Description | Notes |
516
+ | ---- | ---- | ----------- | ----- |
517
+ | **organization_id** | **String** | The organization ID. | |
518
+ | **invitation_id** | **String** | The organization invitation ID. | |
519
+ | **revoke_organization_invitation_request** | [**RevokeOrganizationInvitationRequest**](RevokeOrganizationInvitationRequest.md) | | [optional] |
520
+
521
+ ### Return type
522
+
523
+ [**OrganizationInvitation**](OrganizationInvitation.md)
524
+
525
+ ### Authorization
526
+
527
+ [bearerAuth](../README.md#bearerAuth)
528
+
529
+ ### HTTP request headers
530
+
531
+ - **Content-Type**: application/json
532
+ - **Accept**: application/json
533
+
@@ -0,0 +1,20 @@
1
+ # ClerkHttpClient::OrganizationInvitationsWithPublicOrganizationData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;OrganizationInvitationWithPublicOrganizationData&gt;**](OrganizationInvitationWithPublicOrganizationData.md) | | |
8
+ | **total_count** | **Integer** | Total number of organization invitations | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'clerk-http-client'
14
+
15
+ instance = ClerkHttpClient::OrganizationInvitationsWithPublicOrganizationData.new(
16
+ data: null,
17
+ total_count: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,38 @@
1
+ # ClerkHttpClient::OrganizationMembership
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. | [optional] |
9
+ | **role** | **String** | | [optional] |
10
+ | **role_name** | **String** | | [optional] |
11
+ | **permissions** | **Array&lt;String&gt;** | | [optional] |
12
+ | **public_metadata** | **Object** | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | [optional] |
13
+ | **private_metadata** | **Object** | Metadata saved on the organization membership, accessible only from the Backend API | [optional] |
14
+ | **organization** | [**Organization**](Organization.md) | | [optional] |
15
+ | **public_user_data** | [**OrganizationMembershipPublicUserData**](OrganizationMembershipPublicUserData.md) | | [optional] |
16
+ | **created_at** | **Integer** | Unix timestamp of creation. | [optional] |
17
+ | **updated_at** | **Integer** | Unix timestamp of last update. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'clerk-http-client'
23
+
24
+ instance = ClerkHttpClient::OrganizationMembership.new(
25
+ id: null,
26
+ object: null,
27
+ role: null,
28
+ role_name: null,
29
+ permissions: null,
30
+ public_metadata: null,
31
+ private_metadata: null,
32
+ organization: null,
33
+ public_user_data: null,
34
+ created_at: null,
35
+ updated_at: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,30 @@
1
+ # ClerkHttpClient::OrganizationMembershipPublicUserData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **user_id** | **String** | | [optional] |
8
+ | **first_name** | **String** | | [optional] |
9
+ | **last_name** | **String** | | [optional] |
10
+ | **profile_image_url** | **String** | | [optional] |
11
+ | **image_url** | **String** | | [optional] |
12
+ | **has_image** | **Boolean** | | [optional] |
13
+ | **identifier** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'clerk-http-client'
19
+
20
+ instance = ClerkHttpClient::OrganizationMembershipPublicUserData.new(
21
+ user_id: null,
22
+ first_name: null,
23
+ last_name: null,
24
+ profile_image_url: null,
25
+ image_url: null,
26
+ has_image: null,
27
+ identifier: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # ClerkHttpClient::OrganizationMemberships
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;OrganizationMembership&gt;**](OrganizationMembership.md) | | |
8
+ | **total_count** | **Integer** | Total number of organization memberships | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'clerk-http-client'
14
+
15
+ instance = ClerkHttpClient::OrganizationMemberships.new(
16
+ data: null,
17
+ total_count: null
18
+ )
19
+ ```
20
+