clerk-http-client 1.0.0 → 2.0.0.beta1
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.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +155 -191
- data/clerk-http-client.gemspec +1 -1
- data/docs/ActorTokensApi.md +26 -26
- data/docs/AllowListBlockListApi.md +72 -74
- data/docs/BetaFeaturesApi.md +42 -41
- data/docs/ClientsApi.md +36 -37
- data/docs/CreateBulkInvitationsRequestInner.md +28 -0
- data/docs/CreateInvitationRequest.md +6 -4
- data/docs/{CreateOAuthApplicationRequest.md → CreateOauthApplicationRequest.md} +1 -1
- data/docs/CreateOrganizationInvitationBulkRequestInner.md +2 -2
- data/docs/CreateOrganizationInvitationRequest.md +5 -3
- data/docs/CreateOrganizationRequest.md +3 -3
- data/docs/CreateSAMLConnectionRequest.md +2 -0
- data/docs/CreateSessionRequest.md +18 -0
- data/docs/CreateSessionToken200Response.md +20 -0
- data/docs/CreateSessionTokenFromTemplateRequest.md +18 -0
- data/docs/CreateSessionTokenRequest.md +18 -0
- data/docs/CreateUserRequest.md +3 -3
- data/docs/CreateWaitlistEntryRequest.md +20 -0
- data/docs/DomainsApi.md +46 -48
- data/docs/EmailAddress.md +2 -0
- data/docs/EmailAddressVerification.md +3 -3
- data/docs/EmailAddressesApi.md +52 -52
- data/docs/EmailSMSTemplatesApi.md +60 -66
- data/docs/FromOauth.md +26 -0
- data/docs/FromOauthError.md +47 -0
- data/docs/{GetOAuthAccessToken200ResponseInner.md → GetOauthAccessToken200ResponseInner.md} +4 -2
- data/docs/Instance.md +24 -0
- data/docs/InstanceSettingsApi.md +114 -45
- data/docs/Invitation.md +1 -1
- data/docs/InvitationsApi.md +110 -38
- data/docs/JWKS.md +18 -0
- data/docs/JWKSApi.md +14 -15
- data/docs/JWKSKeysInner.md +32 -0
- data/docs/JWTTemplatesApi.md +62 -63
- data/docs/ListWaitlistEntries200Response.md +20 -0
- data/docs/MergeOrganizationMetadataRequest.md +2 -2
- data/docs/MiscellaneousApi.md +11 -7
- data/docs/{OAuthApplication.md → OauthApplication.md} +4 -0
- data/docs/{OAuthApplicationWithSecret.md → OauthApplicationWithSecret.md} +4 -0
- data/docs/{OAuthApplicationsApi.md → OauthApplicationsApi.md} +90 -94
- data/docs/Organization.md +2 -2
- data/docs/OrganizationDomainApi.md +15 -13
- data/docs/OrganizationDomainsApi.md +103 -33
- data/docs/OrganizationInvitation.md +6 -2
- data/docs/OrganizationInvitationWithPublicOrganizationData.md +4 -2
- data/docs/OrganizationInvitationsApi.md +76 -81
- data/docs/OrganizationMembership.md +2 -2
- data/docs/OrganizationMembershipsApi.md +66 -70
- data/docs/OrganizationWithLogo.md +2 -2
- data/docs/OrganizationsApi.md +87 -93
- data/docs/PhoneNumbersApi.md +52 -52
- data/docs/ProxyChecksApi.md +16 -15
- data/docs/{RedirectURLsApi.md → RedirectUrlsApi.md} +46 -48
- data/docs/RevokeInvitation200Response.md +1 -1
- data/docs/SAML.md +1 -1
- data/docs/SAMLAccount.md +1 -1
- data/docs/SAMLConnectionsApi.md +59 -60
- data/docs/SchemasSAMLConnection.md +2 -0
- data/docs/SessionsApi.md +203 -60
- data/docs/SignInTokensApi.md +26 -26
- data/docs/SignUp.md +4 -2
- data/docs/SignUpsApi.md +16 -15
- data/docs/TestingTokensApi.md +11 -12
- data/docs/UpdateOrganizationMembershipMetadataRequest.md +2 -2
- data/docs/UpdateOrganizationRequest.md +2 -2
- data/docs/UpdateSAMLConnectionRequest.md +2 -0
- data/docs/UpdateUserRequest.md +3 -3
- data/docs/User.md +3 -3
- data/docs/UsersApi.md +297 -294
- data/docs/WaitlistEntriesApi.md +157 -0
- data/docs/WaitlistEntry.md +32 -0
- data/docs/WaitlistEntryInvitation.md +36 -0
- data/docs/WebhooksApi.md +30 -33
- data/lib/clerk-http-client/api/actor_tokens_api.rb +10 -14
- data/lib/clerk-http-client/api/allow_list_block_list_api.rb +25 -33
- data/lib/clerk-http-client/api/beta_features_api.rb +13 -21
- data/lib/clerk-http-client/api/clients_api.rb +13 -17
- data/lib/clerk-http-client/api/domains_api.rb +16 -20
- data/lib/clerk-http-client/api/email_addresses_api.rb +19 -27
- data/lib/clerk-http-client/api/email_sms_templates_api.rb +19 -19
- data/lib/clerk-http-client/api/instance_settings_api.rb +78 -31
- data/lib/clerk-http-client/api/invitations_api.rb +82 -17
- data/lib/clerk-http-client/api/jwks_api.rb +7 -7
- data/lib/clerk-http-client/api/jwt_templates_api.rb +22 -30
- data/lib/clerk-http-client/api/miscellaneous_api.rb +4 -4
- data/lib/clerk-http-client/api/{o_auth_applications_api.rb → oauth_applications_api.rb} +53 -57
- data/lib/clerk-http-client/api/organization_domains_api.rb +92 -10
- data/lib/clerk-http-client/api/organization_invitations_api.rb +25 -29
- data/lib/clerk-http-client/api/organization_memberships_api.rb +22 -26
- data/lib/clerk-http-client/api/organizations_api.rb +30 -34
- data/lib/clerk-http-client/api/phone_numbers_api.rb +19 -27
- data/lib/clerk-http-client/api/proxy_checks_api.rb +7 -11
- data/lib/clerk-http-client/api/redirect_urls_api.rb +16 -20
- data/lib/clerk-http-client/api/saml_connections_api.rb +22 -23
- data/lib/clerk-http-client/api/sessions_api.rb +165 -20
- data/lib/clerk-http-client/api/sign_in_tokens_api.rb +10 -14
- data/lib/clerk-http-client/api/sign_ups_api.rb +7 -11
- data/lib/clerk-http-client/api/testing_tokens_api.rb +6 -6
- data/lib/clerk-http-client/api/users_api.rb +149 -92
- data/lib/clerk-http-client/api/waitlist_entries_api.rb +178 -0
- data/lib/clerk-http-client/api/webhooks_api.rb +10 -10
- data/lib/clerk-http-client/api_client.rb +1 -1
- data/lib/clerk-http-client/api_error.rb +1 -1
- data/lib/clerk-http-client/configuration.rb +1 -1
- data/lib/clerk-http-client/models/actor_token.rb +1 -1
- data/lib/clerk-http-client/models/add_domain_request.rb +1 -1
- data/lib/clerk-http-client/models/admin.rb +1 -1
- data/lib/clerk-http-client/models/allowlist_identifier.rb +1 -1
- data/lib/clerk-http-client/models/blocklist_identifier.rb +1 -1
- data/lib/clerk-http-client/models/blocklist_identifiers.rb +1 -1
- data/lib/clerk-http-client/models/change_production_instance_domain_request.rb +1 -1
- data/lib/clerk-http-client/models/clerk_error.rb +1 -1
- data/lib/clerk-http-client/models/clerk_errors.rb +1 -1
- data/lib/clerk-http-client/models/client.rb +1 -1
- data/lib/clerk-http-client/models/{c_name_target.rb → cname_target.rb} +1 -1
- data/lib/clerk-http-client/models/create_actor_token_request.rb +1 -1
- data/lib/clerk-http-client/models/create_allowlist_identifier_request.rb +1 -1
- data/lib/clerk-http-client/models/create_blocklist_identifier_request.rb +1 -1
- data/lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb +305 -0
- data/lib/clerk-http-client/models/create_email_address_request.rb +1 -1
- data/lib/clerk-http-client/models/create_invitation_request.rb +57 -10
- data/lib/clerk-http-client/models/create_jwt_template_request.rb +1 -1
- data/lib/clerk-http-client/models/{create_o_auth_application_request.rb → create_oauth_application_request.rb} +1 -8
- data/lib/clerk-http-client/models/create_organization_domain_request.rb +1 -1
- data/lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb +11 -7
- data/lib/clerk-http-client/models/create_organization_invitation_request.rb +50 -11
- data/lib/clerk-http-client/models/create_organization_membership_request.rb +1 -1
- data/lib/clerk-http-client/models/create_organization_request.rb +9 -12
- data/lib/clerk-http-client/models/create_phone_number_request.rb +1 -1
- data/lib/clerk-http-client/models/create_redirect_url_request.rb +1 -1
- data/lib/clerk-http-client/models/create_saml_connection_request.rb +13 -2
- data/lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb +1 -1
- data/lib/clerk-http-client/models/create_session_request.rb +215 -0
- data/lib/clerk-http-client/models/create_session_token200_response.rb +257 -0
- data/lib/clerk-http-client/models/create_session_token_from_template_request.rb +240 -0
- data/lib/clerk-http-client/models/create_session_token_request.rb +240 -0
- data/lib/clerk-http-client/models/create_sign_in_token_request.rb +1 -1
- data/lib/clerk-http-client/models/create_user_request.rb +13 -7
- data/lib/clerk-http-client/models/create_waitlist_entry_request.rb +232 -0
- data/lib/clerk-http-client/models/deleted_object.rb +1 -1
- data/lib/clerk-http-client/models/disable_mfa200_response.rb +1 -1
- data/lib/clerk-http-client/models/domain.rb +1 -1
- data/lib/clerk-http-client/models/domains.rb +1 -1
- data/lib/clerk-http-client/models/email_address.rb +12 -2
- data/lib/clerk-http-client/models/email_address_verification.rb +3 -3
- data/lib/clerk-http-client/models/from_o_auth.rb +324 -0
- data/{resources/templates/partial_anyof_module.mustache → lib/clerk-http-client/models/from_o_auth_error.rb} +29 -19
- data/lib/clerk-http-client/models/from_oauth.rb +324 -0
- data/{resources/templates/partial_oneof_module.mustache → lib/clerk-http-client/models/from_oauth_error.rb} +21 -54
- data/lib/clerk-http-client/models/{get_o_auth_access_token200_response_inner.rb → get_oauth_access_token200_response_inner.rb} +20 -7
- data/lib/clerk-http-client/models/identification_link.rb +3 -3
- data/lib/clerk-http-client/models/instance.rb +279 -0
- data/lib/clerk-http-client/models/instance_restrictions.rb +1 -1
- data/lib/clerk-http-client/models/invitation.rb +5 -3
- data/lib/clerk-http-client/models/jwks.rb +216 -0
- data/lib/clerk-http-client/models/jwks_keys_inner.rb +277 -0
- data/lib/clerk-http-client/models/jwt_template.rb +1 -1
- data/lib/clerk-http-client/models/list_waitlist_entries200_response.rb +240 -0
- data/lib/clerk-http-client/models/merge_organization_metadata_request.rb +9 -5
- data/lib/clerk-http-client/models/o_auth_application.rb +34 -2
- data/lib/clerk-http-client/models/o_auth_application_with_secret.rb +34 -2
- data/lib/clerk-http-client/models/o_auth_applications.rb +1 -1
- data/lib/clerk-http-client/models/oauth.rb +2 -2
- data/lib/clerk-http-client/models/oauth_application.rb +481 -0
- data/lib/clerk-http-client/models/oauth_application_with_secret.rb +498 -0
- data/lib/clerk-http-client/models/oauth_applications.rb +240 -0
- data/lib/clerk-http-client/models/organization.rb +10 -5
- data/lib/clerk-http-client/models/organization_domain.rb +1 -1
- data/lib/clerk-http-client/models/organization_domain_verification.rb +1 -1
- data/lib/clerk-http-client/models/organization_domains.rb +1 -1
- data/lib/clerk-http-client/models/organization_invitation.rb +31 -6
- data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb +20 -6
- data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb +1 -1
- data/lib/clerk-http-client/models/organization_invitations.rb +1 -1
- data/lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb +1 -1
- data/lib/clerk-http-client/models/organization_membership.rb +9 -5
- data/lib/clerk-http-client/models/organization_membership_public_user_data.rb +1 -1
- data/lib/clerk-http-client/models/organization_memberships.rb +1 -1
- data/lib/clerk-http-client/models/organization_settings.rb +1 -1
- data/lib/clerk-http-client/models/organization_with_logo.rb +10 -5
- data/lib/clerk-http-client/models/organizations.rb +1 -1
- data/lib/clerk-http-client/models/otp.rb +1 -1
- data/lib/clerk-http-client/models/passkey.rb +1 -1
- data/lib/clerk-http-client/models/phone_number.rb +1 -1
- data/lib/clerk-http-client/models/phone_number_verification.rb +1 -1
- data/lib/clerk-http-client/models/preview_template_request.rb +1 -1
- data/lib/clerk-http-client/models/proxy_check.rb +1 -1
- data/lib/clerk-http-client/models/redirect_url.rb +1 -1
- data/lib/clerk-http-client/models/revoke_invitation200_response.rb +5 -3
- data/lib/clerk-http-client/models/revoke_organization_invitation_request.rb +1 -1
- data/lib/clerk-http-client/models/saml.rb +2 -2
- data/lib/clerk-http-client/models/saml_account.rb +5 -3
- data/lib/clerk-http-client/models/saml_account_saml_connection.rb +1 -1
- data/lib/clerk-http-client/models/saml_account_verification.rb +1 -1
- data/lib/clerk-http-client/models/saml_connection.rb +1 -1
- data/lib/clerk-http-client/models/saml_connections.rb +1 -1
- data/lib/clerk-http-client/models/schemas_passkey.rb +1 -1
- data/lib/clerk-http-client/models/schemas_passkey_verification.rb +1 -1
- data/lib/clerk-http-client/models/schemas_saml_connection.rb +12 -2
- data/lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb +1 -1
- data/lib/clerk-http-client/models/session.rb +1 -1
- data/lib/clerk-http-client/models/session_latest_activity.rb +1 -1
- data/lib/clerk-http-client/models/sign_in_token.rb +1 -1
- data/lib/clerk-http-client/models/sign_up.rb +21 -6
- data/lib/clerk-http-client/models/svix_url.rb +1 -1
- data/lib/clerk-http-client/models/template.rb +1 -1
- data/lib/clerk-http-client/models/testing_token.rb +1 -1
- data/lib/clerk-http-client/models/ticket.rb +1 -1
- data/lib/clerk-http-client/models/toggle_template_delivery_request.rb +1 -1
- data/lib/clerk-http-client/models/total_count.rb +1 -1
- data/lib/clerk-http-client/models/totp.rb +1 -1
- data/lib/clerk-http-client/models/update_domain_request.rb +1 -1
- data/lib/clerk-http-client/models/update_email_address_request.rb +1 -1
- data/lib/clerk-http-client/models/update_instance_auth_config200_response.rb +1 -1
- data/lib/clerk-http-client/models/update_instance_auth_config_request.rb +1 -1
- data/lib/clerk-http-client/models/update_instance_organization_settings_request.rb +1 -1
- data/lib/clerk-http-client/models/update_instance_request.rb +1 -1
- data/lib/clerk-http-client/models/update_instance_restrictions_request.rb +1 -1
- data/lib/clerk-http-client/models/{update_o_auth_application_request.rb → update_oauth_application_request.rb} +1 -1
- data/lib/clerk-http-client/models/update_organization_domain_request.rb +1 -1
- data/lib/clerk-http-client/models/update_organization_membership_metadata_request.rb +9 -5
- data/lib/clerk-http-client/models/update_organization_membership_request.rb +1 -1
- data/lib/clerk-http-client/models/update_organization_request.rb +9 -5
- data/lib/clerk-http-client/models/update_phone_number_request.rb +1 -1
- data/lib/clerk-http-client/models/update_production_instance_domain_request.rb +1 -1
- data/lib/clerk-http-client/models/update_saml_connection_request.rb +13 -2
- data/lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb +1 -1
- data/lib/clerk-http-client/models/update_sign_up_request.rb +1 -1
- data/lib/clerk-http-client/models/update_user_metadata_request.rb +1 -1
- data/lib/clerk-http-client/models/update_user_request.rb +13 -7
- data/lib/clerk-http-client/models/upsert_template_request.rb +1 -1
- data/lib/clerk-http-client/models/user.rb +13 -7
- data/lib/clerk-http-client/models/verify_client_request.rb +1 -1
- data/lib/clerk-http-client/models/verify_domain_proxy_request.rb +1 -1
- data/lib/clerk-http-client/models/verify_password200_response.rb +1 -1
- data/lib/clerk-http-client/models/verify_password_request.rb +1 -1
- data/lib/clerk-http-client/models/verify_session_request.rb +1 -1
- data/lib/clerk-http-client/models/verify_totp200_response.rb +1 -1
- data/lib/clerk-http-client/models/verify_totp_request.rb +1 -1
- data/lib/clerk-http-client/models/waitlist_entry.rb +369 -0
- data/lib/clerk-http-client/models/waitlist_entry_invitation.rb +397 -0
- data/lib/clerk-http-client/models/web3_signature.rb +3 -3
- data/lib/clerk-http-client/models/web3_wallet.rb +1 -1
- data/lib/clerk-http-client/models/web3_wallet_verification.rb +1 -1
- data/lib/clerk-http-client/version.rb +1 -1
- data/lib/clerk-http-client.rb +54 -59
- data/spec/api/actor_tokens_api_spec.rb +1 -1
- data/spec/api/allow_list_block_list_api_spec.rb +2 -2
- data/spec/api/beta_features_api_spec.rb +2 -2
- data/spec/api/clients_api_spec.rb +1 -1
- data/spec/api/domains_api_spec.rb +1 -1
- data/spec/api/email_addresses_api_spec.rb +2 -2
- data/spec/api/instance_settings_api_spec.rb +3 -3
- data/spec/api/invitations_api_spec.rb +1 -1
- data/spec/api/jwt_templates_api_spec.rb +2 -2
- data/spec/api/{o_auth_applications_api_spec.rb → oauth_applications_api_spec.rb} +15 -15
- data/spec/api/organizations_api_spec.rb +1 -1
- data/spec/api/phone_numbers_api_spec.rb +2 -2
- data/spec/api/proxy_checks_api_spec.rb +1 -1
- data/spec/api/redirect_urls_api_spec.rb +1 -1
- data/spec/api/saml_connections_api_spec.rb +1 -1
- data/spec/api/sign_in_tokens_api_spec.rb +1 -1
- data/spec/api/sign_ups_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +3 -3
- data/spec/api/waitlist_entries_api_spec.rb +63 -0
- data/spec/models/cname_target_spec.rb +48 -0
- data/spec/models/create_bulk_invitations_request_inner_spec.rb +66 -0
- data/spec/models/create_oauth_application_request_spec.rb +54 -0
- data/spec/models/create_session_request_spec.rb +36 -0
- data/spec/models/create_session_token200_response_spec.rb +46 -0
- data/spec/models/create_session_token_from_template_request_spec.rb +36 -0
- data/spec/models/create_session_token_request_spec.rb +36 -0
- data/spec/models/create_waitlist_entry_request_spec.rb +42 -0
- data/spec/models/from_o_auth_error_spec.rb +32 -0
- data/spec/models/from_o_auth_spec.rb +64 -0
- data/spec/models/from_oauth_error_spec.rb +32 -0
- data/spec/models/from_oauth_spec.rb +64 -0
- data/spec/models/get_oauth_access_token200_response_inner_spec.rb +90 -0
- data/spec/models/identification_link_spec.rb +1 -1
- data/spec/models/instance_spec.rb +58 -0
- data/spec/models/jwks_keys_inner_spec.rb +78 -0
- data/spec/models/jwks_spec.rb +36 -0
- data/spec/models/list_waitlist_entries200_response_spec.rb +42 -0
- data/spec/models/oauth_application_spec.rb +124 -0
- data/spec/models/oauth_application_with_secret_spec.rb +130 -0
- data/spec/models/oauth_applications_spec.rb +42 -0
- data/spec/models/oauth_spec.rb +1 -1
- data/spec/models/update_oauth_application_request_spec.rb +48 -0
- data/spec/models/waitlist_entry_invitation_spec.rb +98 -0
- data/spec/models/waitlist_entry_spec.rb +86 -0
- data/spec/spec_helper.rb +1 -1
- metadata +104 -65
- data/bin/fmt +0 -5
- data/bin/generate +0 -8
- data/bin/setup +0 -7
- data/openapitools.json +0 -7
- data/pkg/clerk-http-client-1.0.0.gem +0 -0
- data/resources/.DS_Store +0 -0
- data/resources/oas/bapi-2024-10-01.yml +0 -7238
- data/resources/templates/Gemfile.mustache +0 -9
- data/resources/templates/README.mustache +0 -163
- data/resources/templates/Rakefile.mustache +0 -10
- data/resources/templates/api.mustache +0 -257
- data/resources/templates/api_client.mustache +0 -246
- data/resources/templates/api_client_faraday_partial.mustache +0 -200
- data/resources/templates/api_client_httpx_partial.mustache +0 -134
- data/resources/templates/api_client_typhoeus_partial.mustache +0 -161
- data/resources/templates/api_doc.mustache +0 -132
- data/resources/templates/api_error.mustache +0 -50
- data/resources/templates/api_info.mustache +0 -12
- data/resources/templates/api_test.mustache +0 -47
- data/resources/templates/base_object.mustache +0 -114
- data/resources/templates/configuration.mustache +0 -491
- data/resources/templates/configuration_faraday_partial.mustache +0 -40
- data/resources/templates/configuration_httpx_partial.mustache +0 -11
- data/resources/templates/configuration_typhoeus_partial.mustache +0 -41
- data/resources/templates/gem.mustache +0 -89
- data/resources/templates/gemspec.mustache +0 -41
- data/resources/templates/git_push.sh.mustache +0 -57
- data/resources/templates/gitignore.mustache +0 -39
- data/resources/templates/gitlab-ci.mustache +0 -26
- data/resources/templates/model.mustache +0 -33
- data/resources/templates/model_doc.mustache +0 -12
- data/resources/templates/model_test.mustache +0 -82
- data/resources/templates/partial_model_enum_class.mustache +0 -23
- data/resources/templates/partial_model_generic.mustache +0 -377
- data/resources/templates/partial_model_generic_doc.mustache +0 -28
- data/resources/templates/partial_oneof_module_doc.mustache +0 -93
- data/resources/templates/rspec.mustache +0 -2
- data/resources/templates/rubocop.mustache +0 -148
- data/resources/templates/spec_helper.mustache +0 -103
- data/resources/templates/travis.mustache +0 -11
- data/resources/templates/version.mustache +0 -7
- data/sdk-generator-config.json +0 -25
- /data/docs/{CNameTarget.md → CnameTarget.md} +0 -0
- /data/docs/{CreateRedirectURLRequest.md → CreateRedirectUrlRequest.md} +0 -0
- /data/docs/{OAuthApplications.md → OauthApplications.md} +0 -0
- /data/docs/{RedirectURL.md → RedirectUrl.md} +0 -0
- /data/docs/{SvixURL.md → SvixUrl.md} +0 -0
- /data/docs/{UpdateOAuthApplicationRequest.md → UpdateOauthApplicationRequest.md} +0 -0
@@ -9,10 +9,11 @@
|
|
9
9
|
| **provider_user_id** | **String** | The unique ID of the user in the external provider's system | [optional] |
|
10
10
|
| **token** | **String** | The access token | [optional] |
|
11
11
|
| **provider** | **String** | The ID of the provider | [optional] |
|
12
|
-
| **public_metadata** | **Object
|
12
|
+
| **public_metadata** | **Hash<String, Object>** | | [optional] |
|
13
13
|
| **label** | **String** | | [optional] |
|
14
14
|
| **scopes** | **Array<String>** | The list of scopes that the token is valid for. Only present for OAuth 2.0 tokens. | [optional] |
|
15
15
|
| **token_secret** | **String** | The token secret. Only present for OAuth 1.0 tokens. | [optional] |
|
16
|
+
| **expires_at** | **Integer** | Unix timestamp of the access token expiration. | [optional] |
|
16
17
|
|
17
18
|
## Example
|
18
19
|
|
@@ -28,7 +29,8 @@ instance = ClerkHttpClient::GetOAuthAccessToken200ResponseInner.new(
|
|
28
29
|
public_metadata: null,
|
29
30
|
label: null,
|
30
31
|
scopes: null,
|
31
|
-
token_secret: null
|
32
|
+
token_secret: null,
|
33
|
+
expires_at: null
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
data/docs/Instance.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# ClerkHttpClient::Instance
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **object** | **String** | String representing the object's type. Objects of the same type share the same value. | [optional] |
|
8
|
+
| **id** | **String** | | [optional] |
|
9
|
+
| **environment_type** | **String** | | [optional] |
|
10
|
+
| **allowed_origins** | **Array<String>** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'clerk-http-client'
|
16
|
+
|
17
|
+
instance = ClerkHttpClient::Instance.new(
|
18
|
+
object: null,
|
19
|
+
id: null,
|
20
|
+
environment_type: development,
|
21
|
+
allowed_origins: ["http://localhost:3000","https://some-domain"]
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/InstanceSettingsApi.md
CHANGED
@@ -4,14 +4,80 @@ All URIs are relative to *https://api.clerk.com/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_instance**](InstanceSettingsApi.md#get_instance) | **GET** /instance | Fetch the current instance |
|
7
8
|
| [**update_instance**](InstanceSettingsApi.md#update_instance) | **PATCH** /instance | Update instance settings |
|
8
9
|
| [**update_instance_organization_settings**](InstanceSettingsApi.md#update_instance_organization_settings) | **PATCH** /instance/organization_settings | Update instance organization settings |
|
9
10
|
| [**update_instance_restrictions**](InstanceSettingsApi.md#update_instance_restrictions) | **PATCH** /instance/restrictions | Update instance restrictions |
|
10
11
|
|
11
12
|
|
13
|
+
## get_instance
|
14
|
+
|
15
|
+
> <Instance> get_instance
|
16
|
+
|
17
|
+
Fetch the current instance
|
18
|
+
|
19
|
+
Fetches the current instance
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'clerk'
|
26
|
+
|
27
|
+
## Setup
|
28
|
+
Clerk.configure do |config|
|
29
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
30
|
+
end
|
31
|
+
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Fetch the current instance
|
35
|
+
result = Clerk::SDK.instance_settings.get_instance
|
36
|
+
p result
|
37
|
+
rescue ClerkHttpClient::ApiError => e
|
38
|
+
puts "Error when calling Clerk::SDK.instance_settings->get_instance: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the `get_instance_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<Instance>, Integer, Hash)> get_instance_with_http_info
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Fetch the current instance
|
51
|
+
data, status_code, headers = Clerk::SDK.instance_settings.get_instance_with_http_info
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <Instance>
|
55
|
+
rescue ClerkHttpClient::ApiError => e
|
56
|
+
puts "Error when calling Clerk::SDK.instance_settings->get_instance_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
This endpoint does not need any parameter.
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
[**Instance**](Instance.md)
|
67
|
+
|
68
|
+
### Authorization
|
69
|
+
|
70
|
+
[bearerAuth](../README.md#bearerAuth)
|
71
|
+
|
72
|
+
### HTTP request headers
|
73
|
+
|
74
|
+
- **Content-Type**: Not defined
|
75
|
+
- **Accept**: application/json
|
76
|
+
|
77
|
+
|
12
78
|
## update_instance
|
13
79
|
|
14
|
-
> update_instance(
|
80
|
+
> update_instance(opts)
|
15
81
|
|
16
82
|
Update instance settings
|
17
83
|
|
@@ -21,39 +87,40 @@ Updates the settings of an instance
|
|
21
87
|
|
22
88
|
```ruby
|
23
89
|
require 'time'
|
24
|
-
require 'clerk
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
config.
|
90
|
+
require 'clerk'
|
91
|
+
|
92
|
+
## Setup
|
93
|
+
Clerk.configure do |config|
|
94
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
29
95
|
end
|
30
96
|
|
31
|
-
|
32
|
-
update_instance_request
|
97
|
+
opts = {
|
98
|
+
update_instance_request: ClerkHttpClient::UpdateInstanceRequest.new # UpdateInstanceRequest |
|
99
|
+
}
|
33
100
|
|
34
101
|
begin
|
35
102
|
# Update instance settings
|
36
|
-
|
103
|
+
Clerk::SDK.instance_settings.update_instance(opts)
|
37
104
|
rescue ClerkHttpClient::ApiError => e
|
38
|
-
puts "Error when calling
|
105
|
+
puts "Error when calling Clerk::SDK.instance_settings->update_instance: #{e}"
|
39
106
|
end
|
40
107
|
```
|
41
108
|
|
42
|
-
#### Using the update_instance_with_http_info variant
|
109
|
+
#### Using the `update_instance_with_http_info variant
|
43
110
|
|
44
111
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
45
112
|
|
46
|
-
> <Array(nil, Integer, Hash)> update_instance_with_http_info(
|
113
|
+
> <Array(nil, Integer, Hash)> update_instance_with_http_info(opts)
|
47
114
|
|
48
115
|
```ruby
|
49
116
|
begin
|
50
117
|
# Update instance settings
|
51
|
-
data, status_code, headers =
|
118
|
+
data, status_code, headers = Clerk::SDK.instance_settings.update_instance_with_http_info(opts)
|
52
119
|
p status_code # => 2xx
|
53
120
|
p headers # => { ... }
|
54
121
|
p data # => nil
|
55
122
|
rescue ClerkHttpClient::ApiError => e
|
56
|
-
puts "Error when calling
|
123
|
+
puts "Error when calling Clerk::SDK.instance_settings->update_instance_with_http_info: #{e}"
|
57
124
|
end
|
58
125
|
```
|
59
126
|
|
@@ -61,7 +128,7 @@ end
|
|
61
128
|
|
62
129
|
| Name | Type | Description | Notes |
|
63
130
|
| ---- | ---- | ----------- | ----- |
|
64
|
-
| **update_instance_request** | [**UpdateInstanceRequest**](UpdateInstanceRequest.md) | |
|
131
|
+
| **update_instance_request** | [**UpdateInstanceRequest**](UpdateInstanceRequest.md) | | [optional] |
|
65
132
|
|
66
133
|
### Return type
|
67
134
|
|
@@ -79,7 +146,7 @@ nil (empty response body)
|
|
79
146
|
|
80
147
|
## update_instance_organization_settings
|
81
148
|
|
82
|
-
> <OrganizationSettings> update_instance_organization_settings(
|
149
|
+
> <OrganizationSettings> update_instance_organization_settings(opts)
|
83
150
|
|
84
151
|
Update instance organization settings
|
85
152
|
|
@@ -89,40 +156,41 @@ Updates the organization settings of the instance
|
|
89
156
|
|
90
157
|
```ruby
|
91
158
|
require 'time'
|
92
|
-
require 'clerk
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
config.
|
159
|
+
require 'clerk'
|
160
|
+
|
161
|
+
## Setup
|
162
|
+
Clerk.configure do |config|
|
163
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
97
164
|
end
|
98
165
|
|
99
|
-
|
100
|
-
update_instance_organization_settings_request
|
166
|
+
opts = {
|
167
|
+
update_instance_organization_settings_request: ClerkHttpClient::UpdateInstanceOrganizationSettingsRequest.new # UpdateInstanceOrganizationSettingsRequest |
|
168
|
+
}
|
101
169
|
|
102
170
|
begin
|
103
171
|
# Update instance organization settings
|
104
|
-
result =
|
172
|
+
result = Clerk::SDK.instance_settings.update_instance_organization_settings(opts)
|
105
173
|
p result
|
106
174
|
rescue ClerkHttpClient::ApiError => e
|
107
|
-
puts "Error when calling
|
175
|
+
puts "Error when calling Clerk::SDK.instance_settings->update_instance_organization_settings: #{e}"
|
108
176
|
end
|
109
177
|
```
|
110
178
|
|
111
|
-
#### Using the update_instance_organization_settings_with_http_info variant
|
179
|
+
#### Using the `update_instance_organization_settings_with_http_info variant
|
112
180
|
|
113
181
|
This returns an Array which contains the response data, status code and headers.
|
114
182
|
|
115
|
-
> <Array(<OrganizationSettings>, Integer, Hash)> update_instance_organization_settings_with_http_info(
|
183
|
+
> <Array(<OrganizationSettings>, Integer, Hash)> update_instance_organization_settings_with_http_info(opts)
|
116
184
|
|
117
185
|
```ruby
|
118
186
|
begin
|
119
187
|
# Update instance organization settings
|
120
|
-
data, status_code, headers =
|
188
|
+
data, status_code, headers = Clerk::SDK.instance_settings.update_instance_organization_settings_with_http_info(opts)
|
121
189
|
p status_code # => 2xx
|
122
190
|
p headers # => { ... }
|
123
191
|
p data # => <OrganizationSettings>
|
124
192
|
rescue ClerkHttpClient::ApiError => e
|
125
|
-
puts "Error when calling
|
193
|
+
puts "Error when calling Clerk::SDK.instance_settings->update_instance_organization_settings_with_http_info: #{e}"
|
126
194
|
end
|
127
195
|
```
|
128
196
|
|
@@ -130,7 +198,7 @@ end
|
|
130
198
|
|
131
199
|
| Name | Type | Description | Notes |
|
132
200
|
| ---- | ---- | ----------- | ----- |
|
133
|
-
| **update_instance_organization_settings_request** | [**UpdateInstanceOrganizationSettingsRequest**](UpdateInstanceOrganizationSettingsRequest.md) | |
|
201
|
+
| **update_instance_organization_settings_request** | [**UpdateInstanceOrganizationSettingsRequest**](UpdateInstanceOrganizationSettingsRequest.md) | | [optional] |
|
134
202
|
|
135
203
|
### Return type
|
136
204
|
|
@@ -148,7 +216,7 @@ end
|
|
148
216
|
|
149
217
|
## update_instance_restrictions
|
150
218
|
|
151
|
-
> <InstanceRestrictions> update_instance_restrictions(
|
219
|
+
> <InstanceRestrictions> update_instance_restrictions(opts)
|
152
220
|
|
153
221
|
Update instance restrictions
|
154
222
|
|
@@ -158,40 +226,41 @@ Updates the restriction settings of an instance
|
|
158
226
|
|
159
227
|
```ruby
|
160
228
|
require 'time'
|
161
|
-
require 'clerk
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
config.
|
229
|
+
require 'clerk'
|
230
|
+
|
231
|
+
## Setup
|
232
|
+
Clerk.configure do |config|
|
233
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
166
234
|
end
|
167
235
|
|
168
|
-
|
169
|
-
update_instance_restrictions_request
|
236
|
+
opts = {
|
237
|
+
update_instance_restrictions_request: ClerkHttpClient::UpdateInstanceRestrictionsRequest.new # UpdateInstanceRestrictionsRequest |
|
238
|
+
}
|
170
239
|
|
171
240
|
begin
|
172
241
|
# Update instance restrictions
|
173
|
-
result =
|
242
|
+
result = Clerk::SDK.instance_settings.update_instance_restrictions(opts)
|
174
243
|
p result
|
175
244
|
rescue ClerkHttpClient::ApiError => e
|
176
|
-
puts "Error when calling
|
245
|
+
puts "Error when calling Clerk::SDK.instance_settings->update_instance_restrictions: #{e}"
|
177
246
|
end
|
178
247
|
```
|
179
248
|
|
180
|
-
#### Using the update_instance_restrictions_with_http_info variant
|
249
|
+
#### Using the `update_instance_restrictions_with_http_info variant
|
181
250
|
|
182
251
|
This returns an Array which contains the response data, status code and headers.
|
183
252
|
|
184
|
-
> <Array(<InstanceRestrictions>, Integer, Hash)> update_instance_restrictions_with_http_info(
|
253
|
+
> <Array(<InstanceRestrictions>, Integer, Hash)> update_instance_restrictions_with_http_info(opts)
|
185
254
|
|
186
255
|
```ruby
|
187
256
|
begin
|
188
257
|
# Update instance restrictions
|
189
|
-
data, status_code, headers =
|
258
|
+
data, status_code, headers = Clerk::SDK.instance_settings.update_instance_restrictions_with_http_info(opts)
|
190
259
|
p status_code # => 2xx
|
191
260
|
p headers # => { ... }
|
192
261
|
p data # => <InstanceRestrictions>
|
193
262
|
rescue ClerkHttpClient::ApiError => e
|
194
|
-
puts "Error when calling
|
263
|
+
puts "Error when calling Clerk::SDK.instance_settings->update_instance_restrictions_with_http_info: #{e}"
|
195
264
|
end
|
196
265
|
```
|
197
266
|
|
@@ -199,7 +268,7 @@ end
|
|
199
268
|
|
200
269
|
| Name | Type | Description | Notes |
|
201
270
|
| ---- | ---- | ----------- | ----- |
|
202
|
-
| **update_instance_restrictions_request** | [**UpdateInstanceRestrictionsRequest**](UpdateInstanceRestrictionsRequest.md) | |
|
271
|
+
| **update_instance_restrictions_request** | [**UpdateInstanceRestrictionsRequest**](UpdateInstanceRestrictionsRequest.md) | | [optional] |
|
203
272
|
|
204
273
|
### Return type
|
205
274
|
|
data/docs/Invitation.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **object** | **String** | | |
|
8
8
|
| **id** | **String** | | |
|
9
9
|
| **email_address** | **String** | | |
|
10
|
-
| **public_metadata** | **Object
|
10
|
+
| **public_metadata** | **Hash<String, Object>** | | [optional] |
|
11
11
|
| **revoked** | **Boolean** | | [optional] |
|
12
12
|
| **status** | **String** | | |
|
13
13
|
| **url** | **String** | | [optional] |
|
data/docs/InvitationsApi.md
CHANGED
@@ -4,14 +4,85 @@ All URIs are relative to *https://api.clerk.com/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_bulk_invitations**](InvitationsApi.md#create_bulk_invitations) | **POST** /invitations/bulk | Create multiple invitations |
|
7
8
|
| [**create_invitation**](InvitationsApi.md#create_invitation) | **POST** /invitations | Create an invitation |
|
8
9
|
| [**list_invitations**](InvitationsApi.md#list_invitations) | **GET** /invitations | List all invitations |
|
9
10
|
| [**revoke_invitation**](InvitationsApi.md#revoke_invitation) | **POST** /invitations/{invitation_id}/revoke | Revokes an invitation |
|
10
11
|
|
11
12
|
|
13
|
+
## create_bulk_invitations
|
14
|
+
|
15
|
+
> <Array<Invitation>> create_bulk_invitations(opts)
|
16
|
+
|
17
|
+
Create multiple invitations
|
18
|
+
|
19
|
+
Use this API operation to create multiple invitations for the provided email addresses. You can choose to send the invitations as emails by setting the `notify` parameter to `true`. There cannot be an existing invitation for any of the email addresses you provide unless you set `ignore_existing` to `true` for specific email addresses. Please note that there must be no existing user for any of the email addresses you provide, and this rule cannot be bypassed.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'clerk'
|
26
|
+
|
27
|
+
## Setup
|
28
|
+
Clerk.configure do |config|
|
29
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
30
|
+
end
|
31
|
+
|
32
|
+
opts = {
|
33
|
+
create_bulk_invitations_request_inner: [ClerkHttpClient::CreateBulkInvitationsRequestInner.new({email_address: 'email_address_example'})] # Array<CreateBulkInvitationsRequestInner> | Required parameters
|
34
|
+
}
|
35
|
+
|
36
|
+
begin
|
37
|
+
# Create multiple invitations
|
38
|
+
result = Clerk::SDK.invitations.create_bulk_invitations(opts)
|
39
|
+
p result
|
40
|
+
rescue ClerkHttpClient::ApiError => e
|
41
|
+
puts "Error when calling Clerk::SDK.invitations->create_bulk_invitations: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the `create_bulk_invitations_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<Array<Invitation>>, Integer, Hash)> create_bulk_invitations_with_http_info(opts)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
# Create multiple invitations
|
54
|
+
data, status_code, headers = Clerk::SDK.invitations.create_bulk_invitations_with_http_info(opts)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <Array<Invitation>>
|
58
|
+
rescue ClerkHttpClient::ApiError => e
|
59
|
+
puts "Error when calling Clerk::SDK.invitations->create_bulk_invitations_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **create_bulk_invitations_request_inner** | [**Array<CreateBulkInvitationsRequestInner>**](CreateBulkInvitationsRequestInner.md) | Required parameters | [optional] |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**Array<Invitation>**](Invitation.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[bearerAuth](../README.md#bearerAuth)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: application/json
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
12
83
|
## create_invitation
|
13
84
|
|
14
|
-
> <Invitation> create_invitation(
|
85
|
+
> <Invitation> create_invitation(opts)
|
15
86
|
|
16
87
|
Create an invitation
|
17
88
|
|
@@ -21,40 +92,41 @@ Creates a new invitation for the given email address and sends the invitation em
|
|
21
92
|
|
22
93
|
```ruby
|
23
94
|
require 'time'
|
24
|
-
require 'clerk
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
config.
|
95
|
+
require 'clerk'
|
96
|
+
|
97
|
+
## Setup
|
98
|
+
Clerk.configure do |config|
|
99
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
29
100
|
end
|
30
101
|
|
31
|
-
|
32
|
-
create_invitation_request
|
102
|
+
opts = {
|
103
|
+
create_invitation_request: ClerkHttpClient::CreateInvitationRequest.new({email_address: 'email_address_example'}) # CreateInvitationRequest | Required parameters
|
104
|
+
}
|
33
105
|
|
34
106
|
begin
|
35
107
|
# Create an invitation
|
36
|
-
result =
|
108
|
+
result = Clerk::SDK.invitations.create_invitation(opts)
|
37
109
|
p result
|
38
110
|
rescue ClerkHttpClient::ApiError => e
|
39
|
-
puts "Error when calling
|
111
|
+
puts "Error when calling Clerk::SDK.invitations->create_invitation: #{e}"
|
40
112
|
end
|
41
113
|
```
|
42
114
|
|
43
|
-
#### Using the create_invitation_with_http_info variant
|
115
|
+
#### Using the `create_invitation_with_http_info variant
|
44
116
|
|
45
117
|
This returns an Array which contains the response data, status code and headers.
|
46
118
|
|
47
|
-
> <Array(<Invitation>, Integer, Hash)> create_invitation_with_http_info(
|
119
|
+
> <Array(<Invitation>, Integer, Hash)> create_invitation_with_http_info(opts)
|
48
120
|
|
49
121
|
```ruby
|
50
122
|
begin
|
51
123
|
# Create an invitation
|
52
|
-
data, status_code, headers =
|
124
|
+
data, status_code, headers = Clerk::SDK.invitations.create_invitation_with_http_info(opts)
|
53
125
|
p status_code # => 2xx
|
54
126
|
p headers # => { ... }
|
55
127
|
p data # => <Invitation>
|
56
128
|
rescue ClerkHttpClient::ApiError => e
|
57
|
-
puts "Error when calling
|
129
|
+
puts "Error when calling Clerk::SDK.invitations->create_invitation_with_http_info: #{e}"
|
58
130
|
end
|
59
131
|
```
|
60
132
|
|
@@ -62,7 +134,7 @@ end
|
|
62
134
|
|
63
135
|
| Name | Type | Description | Notes |
|
64
136
|
| ---- | ---- | ----------- | ----- |
|
65
|
-
| **create_invitation_request** | [**CreateInvitationRequest**](CreateInvitationRequest.md) | Required parameters |
|
137
|
+
| **create_invitation_request** | [**CreateInvitationRequest**](CreateInvitationRequest.md) | Required parameters | [optional] |
|
66
138
|
|
67
139
|
### Return type
|
68
140
|
|
@@ -90,30 +162,30 @@ Returns all non-revoked invitations for your application, sorted by creation dat
|
|
90
162
|
|
91
163
|
```ruby
|
92
164
|
require 'time'
|
93
|
-
require 'clerk
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
config.
|
165
|
+
require 'clerk'
|
166
|
+
|
167
|
+
## Setup
|
168
|
+
Clerk.configure do |config|
|
169
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
98
170
|
end
|
99
171
|
|
100
|
-
api_instance = ClerkHttpClient::InvitationsApi.new
|
101
172
|
opts = {
|
102
173
|
limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
|
103
174
|
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`.
|
104
|
-
status: 'pending' # String | Filter invitations based on their status
|
175
|
+
status: 'pending', # String | Filter invitations based on their status
|
176
|
+
query: 'query_example' # String | Filter invitations based on their `email_address` or `id`
|
105
177
|
}
|
106
178
|
|
107
179
|
begin
|
108
180
|
# List all invitations
|
109
|
-
result =
|
181
|
+
result = Clerk::SDK.invitations.list_invitations(opts)
|
110
182
|
p result
|
111
183
|
rescue ClerkHttpClient::ApiError => e
|
112
|
-
puts "Error when calling
|
184
|
+
puts "Error when calling Clerk::SDK.invitations->list_invitations: #{e}"
|
113
185
|
end
|
114
186
|
```
|
115
187
|
|
116
|
-
#### Using the list_invitations_with_http_info variant
|
188
|
+
#### Using the `list_invitations_with_http_info variant
|
117
189
|
|
118
190
|
This returns an Array which contains the response data, status code and headers.
|
119
191
|
|
@@ -122,12 +194,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
122
194
|
```ruby
|
123
195
|
begin
|
124
196
|
# List all invitations
|
125
|
-
data, status_code, headers =
|
197
|
+
data, status_code, headers = Clerk::SDK.invitations.list_invitations_with_http_info(opts)
|
126
198
|
p status_code # => 2xx
|
127
199
|
p headers # => { ... }
|
128
200
|
p data # => <Array<Invitation>>
|
129
201
|
rescue ClerkHttpClient::ApiError => e
|
130
|
-
puts "Error when calling
|
202
|
+
puts "Error when calling Clerk::SDK.invitations->list_invitations_with_http_info: #{e}"
|
131
203
|
end
|
132
204
|
```
|
133
205
|
|
@@ -138,6 +210,7 @@ end
|
|
138
210
|
| **limit** | **Float** | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`. | [optional][default to 10] |
|
139
211
|
| **offset** | **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`. | [optional][default to 0] |
|
140
212
|
| **status** | **String** | Filter invitations based on their status | [optional] |
|
213
|
+
| **query** | **String** | Filter invitations based on their `email_address` or `id` | [optional] |
|
141
214
|
|
142
215
|
### Return type
|
143
216
|
|
@@ -165,26 +238,25 @@ Revokes the given invitation. Revoking an invitation will prevent the user from
|
|
165
238
|
|
166
239
|
```ruby
|
167
240
|
require 'time'
|
168
|
-
require 'clerk
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
config.
|
241
|
+
require 'clerk'
|
242
|
+
|
243
|
+
## Setup
|
244
|
+
Clerk.configure do |config|
|
245
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
173
246
|
end
|
174
247
|
|
175
|
-
api_instance = ClerkHttpClient::InvitationsApi.new
|
176
248
|
invitation_id = 'invitation_id_example' # String | The ID of the invitation to be revoked
|
177
249
|
|
178
250
|
begin
|
179
251
|
# Revokes an invitation
|
180
|
-
result =
|
252
|
+
result = Clerk::SDK.invitations.revoke_invitation(invitation_id)
|
181
253
|
p result
|
182
254
|
rescue ClerkHttpClient::ApiError => e
|
183
|
-
puts "Error when calling
|
255
|
+
puts "Error when calling Clerk::SDK.invitations->revoke_invitation: #{e}"
|
184
256
|
end
|
185
257
|
```
|
186
258
|
|
187
|
-
#### Using the revoke_invitation_with_http_info variant
|
259
|
+
#### Using the `revoke_invitation_with_http_info variant
|
188
260
|
|
189
261
|
This returns an Array which contains the response data, status code and headers.
|
190
262
|
|
@@ -193,12 +265,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
193
265
|
```ruby
|
194
266
|
begin
|
195
267
|
# Revokes an invitation
|
196
|
-
data, status_code, headers =
|
268
|
+
data, status_code, headers = Clerk::SDK.invitations.revoke_invitation_with_http_info(invitation_id)
|
197
269
|
p status_code # => 2xx
|
198
270
|
p headers # => { ... }
|
199
271
|
p data # => <RevokeInvitation200Response>
|
200
272
|
rescue ClerkHttpClient::ApiError => e
|
201
|
-
puts "Error when calling
|
273
|
+
puts "Error when calling Clerk::SDK.invitations->revoke_invitation_with_http_info: #{e}"
|
202
274
|
end
|
203
275
|
```
|
204
276
|
|
data/docs/JWKS.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# ClerkHttpClient::JWKS
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **keys** | [**Array<JWKSKeysInner>**](JWKSKeysInner.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'clerk-http-client'
|
13
|
+
|
14
|
+
instance = ClerkHttpClient::JWKS.new(
|
15
|
+
keys: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|