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
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.clerk.com/v1*
|
|
7
7
|
| [**create_organization_domain**](OrganizationDomainsApi.md#create_organization_domain) | **POST** /organizations/{organization_id}/domains | Create a new organization domain. |
|
8
8
|
| [**delete_organization_domain**](OrganizationDomainsApi.md#delete_organization_domain) | **DELETE** /organizations/{organization_id}/domains/{domain_id} | Remove a domain from an organization. |
|
9
9
|
| [**list_organization_domains**](OrganizationDomainsApi.md#list_organization_domains) | **GET** /organizations/{organization_id}/domains | Get a list of all domains of an organization. |
|
10
|
+
| [**update_organization_domain**](OrganizationDomainsApi.md#update_organization_domain) | **PATCH** /organizations/{organization_id}/domains/{domain_id} | Update an organization domain. |
|
10
11
|
|
11
12
|
|
12
13
|
## create_organization_domain
|
@@ -21,27 +22,26 @@ Creates a new organization domain. By default the domain is verified, but can be
|
|
21
22
|
|
22
23
|
```ruby
|
23
24
|
require 'time'
|
24
|
-
require 'clerk
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
config.
|
25
|
+
require 'clerk'
|
26
|
+
|
27
|
+
## Setup
|
28
|
+
Clerk.configure do |config|
|
29
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
29
30
|
end
|
30
31
|
|
31
|
-
api_instance = ClerkHttpClient::OrganizationDomainsApi.new
|
32
32
|
organization_id = 'organization_id_example' # String | The ID of the organization where the new domain will be created.
|
33
33
|
create_organization_domain_request = ClerkHttpClient::CreateOrganizationDomainRequest.new # CreateOrganizationDomainRequest |
|
34
34
|
|
35
35
|
begin
|
36
36
|
# Create a new organization domain.
|
37
|
-
result =
|
37
|
+
result = Clerk::SDK.organization_domains.create_organization_domain(organization_id, create_organization_domain_request)
|
38
38
|
p result
|
39
39
|
rescue ClerkHttpClient::ApiError => e
|
40
|
-
puts "Error when calling
|
40
|
+
puts "Error when calling Clerk::SDK.organization_domains->create_organization_domain: #{e}"
|
41
41
|
end
|
42
42
|
```
|
43
43
|
|
44
|
-
#### Using the create_organization_domain_with_http_info variant
|
44
|
+
#### Using the `create_organization_domain_with_http_info variant
|
45
45
|
|
46
46
|
This returns an Array which contains the response data, status code and headers.
|
47
47
|
|
@@ -50,12 +50,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
50
50
|
```ruby
|
51
51
|
begin
|
52
52
|
# Create a new organization domain.
|
53
|
-
data, status_code, headers =
|
53
|
+
data, status_code, headers = Clerk::SDK.organization_domains.create_organization_domain_with_http_info(organization_id, create_organization_domain_request)
|
54
54
|
p status_code # => 2xx
|
55
55
|
p headers # => { ... }
|
56
56
|
p data # => <OrganizationDomain>
|
57
57
|
rescue ClerkHttpClient::ApiError => e
|
58
|
-
puts "Error when calling
|
58
|
+
puts "Error when calling Clerk::SDK.organization_domains->create_organization_domain_with_http_info: #{e}"
|
59
59
|
end
|
60
60
|
```
|
61
61
|
|
@@ -92,27 +92,26 @@ Removes the given domain from the organization.
|
|
92
92
|
|
93
93
|
```ruby
|
94
94
|
require 'time'
|
95
|
-
require 'clerk
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
config.
|
95
|
+
require 'clerk'
|
96
|
+
|
97
|
+
## Setup
|
98
|
+
Clerk.configure do |config|
|
99
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
100
100
|
end
|
101
101
|
|
102
|
-
api_instance = ClerkHttpClient::OrganizationDomainsApi.new
|
103
102
|
organization_id = 'organization_id_example' # String | The ID of the organization the domain belongs to
|
104
103
|
domain_id = 'domain_id_example' # String | The ID of the domain
|
105
104
|
|
106
105
|
begin
|
107
106
|
# Remove a domain from an organization.
|
108
|
-
result =
|
107
|
+
result = Clerk::SDK.organization_domains.delete_organization_domain(organization_id, domain_id)
|
109
108
|
p result
|
110
109
|
rescue ClerkHttpClient::ApiError => e
|
111
|
-
puts "Error when calling
|
110
|
+
puts "Error when calling Clerk::SDK.organization_domains->delete_organization_domain: #{e}"
|
112
111
|
end
|
113
112
|
```
|
114
113
|
|
115
|
-
#### Using the delete_organization_domain_with_http_info variant
|
114
|
+
#### Using the `delete_organization_domain_with_http_info variant
|
116
115
|
|
117
116
|
This returns an Array which contains the response data, status code and headers.
|
118
117
|
|
@@ -121,12 +120,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
121
120
|
```ruby
|
122
121
|
begin
|
123
122
|
# Remove a domain from an organization.
|
124
|
-
data, status_code, headers =
|
123
|
+
data, status_code, headers = Clerk::SDK.organization_domains.delete_organization_domain_with_http_info(organization_id, domain_id)
|
125
124
|
p status_code # => 2xx
|
126
125
|
p headers # => { ... }
|
127
126
|
p data # => <DeletedObject>
|
128
127
|
rescue ClerkHttpClient::ApiError => e
|
129
|
-
puts "Error when calling
|
128
|
+
puts "Error when calling Clerk::SDK.organization_domains->delete_organization_domain_with_http_info: #{e}"
|
130
129
|
end
|
131
130
|
```
|
132
131
|
|
@@ -163,14 +162,13 @@ Get a list of all domains of an organization.
|
|
163
162
|
|
164
163
|
```ruby
|
165
164
|
require 'time'
|
166
|
-
require 'clerk
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
config.
|
165
|
+
require 'clerk'
|
166
|
+
|
167
|
+
## Setup
|
168
|
+
Clerk.configure do |config|
|
169
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
171
170
|
end
|
172
171
|
|
173
|
-
api_instance = ClerkHttpClient::OrganizationDomainsApi.new
|
174
172
|
organization_id = 'organization_id_example' # String | The organization ID.
|
175
173
|
opts = {
|
176
174
|
limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
|
@@ -181,14 +179,14 @@ opts = {
|
|
181
179
|
|
182
180
|
begin
|
183
181
|
# Get a list of all domains of an organization.
|
184
|
-
result =
|
182
|
+
result = Clerk::SDK.organization_domains.list_organization_domains(organization_id, opts)
|
185
183
|
p result
|
186
184
|
rescue ClerkHttpClient::ApiError => e
|
187
|
-
puts "Error when calling
|
185
|
+
puts "Error when calling Clerk::SDK.organization_domains->list_organization_domains: #{e}"
|
188
186
|
end
|
189
187
|
```
|
190
188
|
|
191
|
-
#### Using the list_organization_domains_with_http_info variant
|
189
|
+
#### Using the `list_organization_domains_with_http_info variant
|
192
190
|
|
193
191
|
This returns an Array which contains the response data, status code and headers.
|
194
192
|
|
@@ -197,12 +195,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
197
195
|
```ruby
|
198
196
|
begin
|
199
197
|
# Get a list of all domains of an organization.
|
200
|
-
data, status_code, headers =
|
198
|
+
data, status_code, headers = Clerk::SDK.organization_domains.list_organization_domains_with_http_info(organization_id, opts)
|
201
199
|
p status_code # => 2xx
|
202
200
|
p headers # => { ... }
|
203
201
|
p data # => <OrganizationDomains>
|
204
202
|
rescue ClerkHttpClient::ApiError => e
|
205
|
-
puts "Error when calling
|
203
|
+
puts "Error when calling Clerk::SDK.organization_domains->list_organization_domains_with_http_info: #{e}"
|
206
204
|
end
|
207
205
|
```
|
208
206
|
|
@@ -229,3 +227,75 @@ end
|
|
229
227
|
- **Content-Type**: Not defined
|
230
228
|
- **Accept**: application/json
|
231
229
|
|
230
|
+
|
231
|
+
## update_organization_domain
|
232
|
+
|
233
|
+
> <OrganizationDomain> update_organization_domain(organization_id, domain_id, update_organization_domain_request)
|
234
|
+
|
235
|
+
Update an organization domain.
|
236
|
+
|
237
|
+
Updates the properties of an existing organization domain.
|
238
|
+
|
239
|
+
### Examples
|
240
|
+
|
241
|
+
```ruby
|
242
|
+
require 'time'
|
243
|
+
require 'clerk'
|
244
|
+
|
245
|
+
## Setup
|
246
|
+
Clerk.configure do |config|
|
247
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
248
|
+
end
|
249
|
+
|
250
|
+
organization_id = 'organization_id_example' # String | The ID of the organization the domain belongs to
|
251
|
+
domain_id = 'domain_id_example' # String | The ID of the domain
|
252
|
+
update_organization_domain_request = ClerkHttpClient::UpdateOrganizationDomainRequest.new # UpdateOrganizationDomainRequest |
|
253
|
+
|
254
|
+
begin
|
255
|
+
# Update an organization domain.
|
256
|
+
result = Clerk::SDK.organization_domains.update_organization_domain(organization_id, domain_id, update_organization_domain_request)
|
257
|
+
p result
|
258
|
+
rescue ClerkHttpClient::ApiError => e
|
259
|
+
puts "Error when calling Clerk::SDK.organization_domains->update_organization_domain: #{e}"
|
260
|
+
end
|
261
|
+
```
|
262
|
+
|
263
|
+
#### Using the `update_organization_domain_with_http_info variant
|
264
|
+
|
265
|
+
This returns an Array which contains the response data, status code and headers.
|
266
|
+
|
267
|
+
> <Array(<OrganizationDomain>, Integer, Hash)> update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)
|
268
|
+
|
269
|
+
```ruby
|
270
|
+
begin
|
271
|
+
# Update an organization domain.
|
272
|
+
data, status_code, headers = Clerk::SDK.organization_domains.update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)
|
273
|
+
p status_code # => 2xx
|
274
|
+
p headers # => { ... }
|
275
|
+
p data # => <OrganizationDomain>
|
276
|
+
rescue ClerkHttpClient::ApiError => e
|
277
|
+
puts "Error when calling Clerk::SDK.organization_domains->update_organization_domain_with_http_info: #{e}"
|
278
|
+
end
|
279
|
+
```
|
280
|
+
|
281
|
+
### Parameters
|
282
|
+
|
283
|
+
| Name | Type | Description | Notes |
|
284
|
+
| ---- | ---- | ----------- | ----- |
|
285
|
+
| **organization_id** | **String** | The ID of the organization the domain belongs to | |
|
286
|
+
| **domain_id** | **String** | The ID of the domain | |
|
287
|
+
| **update_organization_domain_request** | [**UpdateOrganizationDomainRequest**](UpdateOrganizationDomainRequest.md) | | |
|
288
|
+
|
289
|
+
### Return type
|
290
|
+
|
291
|
+
[**OrganizationDomain**](OrganizationDomain.md)
|
292
|
+
|
293
|
+
### Authorization
|
294
|
+
|
295
|
+
[bearerAuth](../README.md#bearerAuth)
|
296
|
+
|
297
|
+
### HTTP request headers
|
298
|
+
|
299
|
+
- **Content-Type**: application/json
|
300
|
+
- **Accept**: application/json
|
301
|
+
|
@@ -11,8 +11,10 @@
|
|
11
11
|
| **role_name** | **String** | | [optional] |
|
12
12
|
| **organization_id** | **String** | | [optional] |
|
13
13
|
| **status** | **String** | | [optional] |
|
14
|
-
| **public_metadata** | **Object
|
15
|
-
| **private_metadata** | **Object
|
14
|
+
| **public_metadata** | **Hash<String, Object>** | | [optional] |
|
15
|
+
| **private_metadata** | **Hash<String, Object>** | | [optional] |
|
16
|
+
| **url** | **String** | | [optional] |
|
17
|
+
| **expires_at** | **Integer** | Unix timestamp of expiration. | [optional] |
|
16
18
|
| **created_at** | **Integer** | Unix timestamp of creation. | [optional] |
|
17
19
|
| **updated_at** | **Integer** | Unix timestamp of last update. | [optional] |
|
18
20
|
|
@@ -31,6 +33,8 @@ instance = ClerkHttpClient::OrganizationInvitation.new(
|
|
31
33
|
status: null,
|
32
34
|
public_metadata: null,
|
33
35
|
private_metadata: null,
|
36
|
+
url: null,
|
37
|
+
expires_at: null,
|
34
38
|
created_at: null,
|
35
39
|
updated_at: null
|
36
40
|
)
|
@@ -11,8 +11,9 @@
|
|
11
11
|
| **role_name** | **String** | | [optional] |
|
12
12
|
| **organization_id** | **String** | | [optional] |
|
13
13
|
| **status** | **String** | | [optional] |
|
14
|
-
| **public_metadata** | **Object
|
15
|
-
| **private_metadata** | **Object
|
14
|
+
| **public_metadata** | **Hash<String, Object>** | | [optional] |
|
15
|
+
| **private_metadata** | **Hash<String, Object>** | | [optional] |
|
16
|
+
| **url** | **String** | | [optional] |
|
16
17
|
| **public_organization_data** | [**OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData**](OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData.md) | | [optional] |
|
17
18
|
| **created_at** | **Integer** | Unix timestamp of creation. | [optional] |
|
18
19
|
| **updated_at** | **Integer** | Unix timestamp of last update. | [optional] |
|
@@ -32,6 +33,7 @@ instance = ClerkHttpClient::OrganizationInvitationWithPublicOrganizationData.new
|
|
32
33
|
status: null,
|
33
34
|
public_metadata: null,
|
34
35
|
private_metadata: null,
|
36
|
+
url: null,
|
35
37
|
public_organization_data: null,
|
36
38
|
created_at: null,
|
37
39
|
updated_at: null
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.clerk.com/v1*
|
|
15
15
|
|
16
16
|
## create_organization_invitation
|
17
17
|
|
18
|
-
> <OrganizationInvitation> create_organization_invitation(organization_id,
|
18
|
+
> <OrganizationInvitation> create_organization_invitation(organization_id, opts)
|
19
19
|
|
20
20
|
Create and send an organization invitation
|
21
21
|
|
@@ -25,41 +25,42 @@ Creates a new organization invitation and sends an email to the provided `email_
|
|
25
25
|
|
26
26
|
```ruby
|
27
27
|
require 'time'
|
28
|
-
require 'clerk
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
config.
|
28
|
+
require 'clerk'
|
29
|
+
|
30
|
+
## Setup
|
31
|
+
Clerk.configure do |config|
|
32
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
33
33
|
end
|
34
34
|
|
35
|
-
api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
|
36
35
|
organization_id = 'organization_id_example' # String | The ID of the organization for which to send the invitation
|
37
|
-
|
36
|
+
opts = {
|
37
|
+
create_organization_invitation_request: ClerkHttpClient::CreateOrganizationInvitationRequest.new({email_address: 'email_address_example', role: 'role_example'}) # CreateOrganizationInvitationRequest |
|
38
|
+
}
|
38
39
|
|
39
40
|
begin
|
40
41
|
# Create and send an organization invitation
|
41
|
-
result =
|
42
|
+
result = Clerk::SDK.organization_invitations.create_organization_invitation(organization_id, opts)
|
42
43
|
p result
|
43
44
|
rescue ClerkHttpClient::ApiError => e
|
44
|
-
puts "Error when calling
|
45
|
+
puts "Error when calling Clerk::SDK.organization_invitations->create_organization_invitation: #{e}"
|
45
46
|
end
|
46
47
|
```
|
47
48
|
|
48
|
-
#### Using the create_organization_invitation_with_http_info variant
|
49
|
+
#### Using the `create_organization_invitation_with_http_info variant
|
49
50
|
|
50
51
|
This returns an Array which contains the response data, status code and headers.
|
51
52
|
|
52
|
-
> <Array(<OrganizationInvitation>, Integer, Hash)> create_organization_invitation_with_http_info(organization_id,
|
53
|
+
> <Array(<OrganizationInvitation>, Integer, Hash)> create_organization_invitation_with_http_info(organization_id, opts)
|
53
54
|
|
54
55
|
```ruby
|
55
56
|
begin
|
56
57
|
# Create and send an organization invitation
|
57
|
-
data, status_code, headers =
|
58
|
+
data, status_code, headers = Clerk::SDK.organization_invitations.create_organization_invitation_with_http_info(organization_id, opts)
|
58
59
|
p status_code # => 2xx
|
59
60
|
p headers # => { ... }
|
60
61
|
p data # => <OrganizationInvitation>
|
61
62
|
rescue ClerkHttpClient::ApiError => e
|
62
|
-
puts "Error when calling
|
63
|
+
puts "Error when calling Clerk::SDK.organization_invitations->create_organization_invitation_with_http_info: #{e}"
|
63
64
|
end
|
64
65
|
```
|
65
66
|
|
@@ -68,7 +69,7 @@ end
|
|
68
69
|
| Name | Type | Description | Notes |
|
69
70
|
| ---- | ---- | ----------- | ----- |
|
70
71
|
| **organization_id** | **String** | The ID of the organization for which to send the invitation | |
|
71
|
-
| **create_organization_invitation_request** | [**CreateOrganizationInvitationRequest**](CreateOrganizationInvitationRequest.md) | |
|
72
|
+
| **create_organization_invitation_request** | [**CreateOrganizationInvitationRequest**](CreateOrganizationInvitationRequest.md) | | [optional] |
|
72
73
|
|
73
74
|
### Return type
|
74
75
|
|
@@ -96,27 +97,26 @@ Creates new organization invitations in bulk and sends out emails to the provide
|
|
96
97
|
|
97
98
|
```ruby
|
98
99
|
require 'time'
|
99
|
-
require 'clerk
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
config.
|
100
|
+
require 'clerk'
|
101
|
+
|
102
|
+
## Setup
|
103
|
+
Clerk.configure do |config|
|
104
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
104
105
|
end
|
105
106
|
|
106
|
-
api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
|
107
107
|
organization_id = 'organization_id_example' # String | The organization ID.
|
108
108
|
create_organization_invitation_bulk_request_inner = [ClerkHttpClient::CreateOrganizationInvitationBulkRequestInner.new({email_address: 'email_address_example', role: 'role_example'})] # Array<CreateOrganizationInvitationBulkRequestInner> |
|
109
109
|
|
110
110
|
begin
|
111
111
|
# Bulk create and send organization invitations
|
112
|
-
result =
|
112
|
+
result = Clerk::SDK.organization_invitations.create_organization_invitation_bulk(organization_id, create_organization_invitation_bulk_request_inner)
|
113
113
|
p result
|
114
114
|
rescue ClerkHttpClient::ApiError => e
|
115
|
-
puts "Error when calling
|
115
|
+
puts "Error when calling Clerk::SDK.organization_invitations->create_organization_invitation_bulk: #{e}"
|
116
116
|
end
|
117
117
|
```
|
118
118
|
|
119
|
-
#### Using the create_organization_invitation_bulk_with_http_info variant
|
119
|
+
#### Using the `create_organization_invitation_bulk_with_http_info variant
|
120
120
|
|
121
121
|
This returns an Array which contains the response data, status code and headers.
|
122
122
|
|
@@ -125,12 +125,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
125
125
|
```ruby
|
126
126
|
begin
|
127
127
|
# Bulk create and send organization invitations
|
128
|
-
data, status_code, headers =
|
128
|
+
data, status_code, headers = Clerk::SDK.organization_invitations.create_organization_invitation_bulk_with_http_info(organization_id, create_organization_invitation_bulk_request_inner)
|
129
129
|
p status_code # => 2xx
|
130
130
|
p headers # => { ... }
|
131
131
|
p data # => <OrganizationInvitations>
|
132
132
|
rescue ClerkHttpClient::ApiError => e
|
133
|
-
puts "Error when calling
|
133
|
+
puts "Error when calling Clerk::SDK.organization_invitations->create_organization_invitation_bulk_with_http_info: #{e}"
|
134
134
|
end
|
135
135
|
```
|
136
136
|
|
@@ -167,27 +167,26 @@ Use this request to get an existing organization invitation by ID.
|
|
167
167
|
|
168
168
|
```ruby
|
169
169
|
require 'time'
|
170
|
-
require 'clerk
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
config.
|
170
|
+
require 'clerk'
|
171
|
+
|
172
|
+
## Setup
|
173
|
+
Clerk.configure do |config|
|
174
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
175
175
|
end
|
176
176
|
|
177
|
-
api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
|
178
177
|
organization_id = 'organization_id_example' # String | The organization ID.
|
179
178
|
invitation_id = 'invitation_id_example' # String | The organization invitation ID.
|
180
179
|
|
181
180
|
begin
|
182
181
|
# Retrieve an organization invitation by ID
|
183
|
-
result =
|
182
|
+
result = Clerk::SDK.organization_invitations.get_organization_invitation(organization_id, invitation_id)
|
184
183
|
p result
|
185
184
|
rescue ClerkHttpClient::ApiError => e
|
186
|
-
puts "Error when calling
|
185
|
+
puts "Error when calling Clerk::SDK.organization_invitations->get_organization_invitation: #{e}"
|
187
186
|
end
|
188
187
|
```
|
189
188
|
|
190
|
-
#### Using the get_organization_invitation_with_http_info variant
|
189
|
+
#### Using the `get_organization_invitation_with_http_info variant
|
191
190
|
|
192
191
|
This returns an Array which contains the response data, status code and headers.
|
193
192
|
|
@@ -196,12 +195,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
196
195
|
```ruby
|
197
196
|
begin
|
198
197
|
# Retrieve an organization invitation by ID
|
199
|
-
data, status_code, headers =
|
198
|
+
data, status_code, headers = Clerk::SDK.organization_invitations.get_organization_invitation_with_http_info(organization_id, invitation_id)
|
200
199
|
p status_code # => 2xx
|
201
200
|
p headers # => { ... }
|
202
201
|
p data # => <OrganizationInvitation>
|
203
202
|
rescue ClerkHttpClient::ApiError => e
|
204
|
-
puts "Error when calling
|
203
|
+
puts "Error when calling Clerk::SDK.organization_invitations->get_organization_invitation_with_http_info: #{e}"
|
205
204
|
end
|
206
205
|
```
|
207
206
|
|
@@ -238,14 +237,13 @@ This request returns the list of organization invitations for the instance. Resu
|
|
238
237
|
|
239
238
|
```ruby
|
240
239
|
require 'time'
|
241
|
-
require 'clerk
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
config.
|
240
|
+
require 'clerk'
|
241
|
+
|
242
|
+
## Setup
|
243
|
+
Clerk.configure do |config|
|
244
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
246
245
|
end
|
247
246
|
|
248
|
-
api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
|
249
247
|
opts = {
|
250
248
|
limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
|
251
249
|
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`.
|
@@ -256,14 +254,14 @@ opts = {
|
|
256
254
|
|
257
255
|
begin
|
258
256
|
# Get a list of organization invitations for the current instance
|
259
|
-
result =
|
257
|
+
result = Clerk::SDK.organization_invitations.list_instance_organization_invitations(opts)
|
260
258
|
p result
|
261
259
|
rescue ClerkHttpClient::ApiError => e
|
262
|
-
puts "Error when calling
|
260
|
+
puts "Error when calling Clerk::SDK.organization_invitations->list_instance_organization_invitations: #{e}"
|
263
261
|
end
|
264
262
|
```
|
265
263
|
|
266
|
-
#### Using the list_instance_organization_invitations_with_http_info variant
|
264
|
+
#### Using the `list_instance_organization_invitations_with_http_info variant
|
267
265
|
|
268
266
|
This returns an Array which contains the response data, status code and headers.
|
269
267
|
|
@@ -272,12 +270,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
272
270
|
```ruby
|
273
271
|
begin
|
274
272
|
# Get a list of organization invitations for the current instance
|
275
|
-
data, status_code, headers =
|
273
|
+
data, status_code, headers = Clerk::SDK.organization_invitations.list_instance_organization_invitations_with_http_info(opts)
|
276
274
|
p status_code # => 2xx
|
277
275
|
p headers # => { ... }
|
278
276
|
p data # => <OrganizationInvitationsWithPublicOrganizationData>
|
279
277
|
rescue ClerkHttpClient::ApiError => e
|
280
|
-
puts "Error when calling
|
278
|
+
puts "Error when calling Clerk::SDK.organization_invitations->list_instance_organization_invitations_with_http_info: #{e}"
|
281
279
|
end
|
282
280
|
```
|
283
281
|
|
@@ -317,14 +315,13 @@ This request returns the list of organization invitations. Results can be pagina
|
|
317
315
|
|
318
316
|
```ruby
|
319
317
|
require 'time'
|
320
|
-
require 'clerk
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
config.
|
318
|
+
require 'clerk'
|
319
|
+
|
320
|
+
## Setup
|
321
|
+
Clerk.configure do |config|
|
322
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
325
323
|
end
|
326
324
|
|
327
|
-
api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
|
328
325
|
organization_id = 'organization_id_example' # String | The organization ID.
|
329
326
|
opts = {
|
330
327
|
limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
|
@@ -334,14 +331,14 @@ opts = {
|
|
334
331
|
|
335
332
|
begin
|
336
333
|
# Get a list of organization invitations
|
337
|
-
result =
|
334
|
+
result = Clerk::SDK.organization_invitations.list_organization_invitations(organization_id, opts)
|
338
335
|
p result
|
339
336
|
rescue ClerkHttpClient::ApiError => e
|
340
|
-
puts "Error when calling
|
337
|
+
puts "Error when calling Clerk::SDK.organization_invitations->list_organization_invitations: #{e}"
|
341
338
|
end
|
342
339
|
```
|
343
340
|
|
344
|
-
#### Using the list_organization_invitations_with_http_info variant
|
341
|
+
#### Using the `list_organization_invitations_with_http_info variant
|
345
342
|
|
346
343
|
This returns an Array which contains the response data, status code and headers.
|
347
344
|
|
@@ -350,12 +347,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
350
347
|
```ruby
|
351
348
|
begin
|
352
349
|
# Get a list of organization invitations
|
353
|
-
data, status_code, headers =
|
350
|
+
data, status_code, headers = Clerk::SDK.organization_invitations.list_organization_invitations_with_http_info(organization_id, opts)
|
354
351
|
p status_code # => 2xx
|
355
352
|
p headers # => { ... }
|
356
353
|
p data # => <OrganizationInvitations>
|
357
354
|
rescue ClerkHttpClient::ApiError => e
|
358
|
-
puts "Error when calling
|
355
|
+
puts "Error when calling Clerk::SDK.organization_invitations->list_organization_invitations_with_http_info: #{e}"
|
359
356
|
end
|
360
357
|
```
|
361
358
|
|
@@ -394,14 +391,13 @@ This request returns the list of organization invitations with \"pending\" statu
|
|
394
391
|
|
395
392
|
```ruby
|
396
393
|
require 'time'
|
397
|
-
require 'clerk
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
config.
|
394
|
+
require 'clerk'
|
395
|
+
|
396
|
+
## Setup
|
397
|
+
Clerk.configure do |config|
|
398
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
402
399
|
end
|
403
400
|
|
404
|
-
api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
|
405
401
|
organization_id = 'organization_id_example' # String | The organization ID.
|
406
402
|
opts = {
|
407
403
|
limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
|
@@ -410,14 +406,14 @@ opts = {
|
|
410
406
|
|
411
407
|
begin
|
412
408
|
# Get a list of pending organization invitations
|
413
|
-
result =
|
409
|
+
result = Clerk::SDK.organization_invitations.list_pending_organization_invitations(organization_id, opts)
|
414
410
|
p result
|
415
411
|
rescue ClerkHttpClient::ApiError => e
|
416
|
-
puts "Error when calling
|
412
|
+
puts "Error when calling Clerk::SDK.organization_invitations->list_pending_organization_invitations: #{e}"
|
417
413
|
end
|
418
414
|
```
|
419
415
|
|
420
|
-
#### Using the list_pending_organization_invitations_with_http_info variant
|
416
|
+
#### Using the `list_pending_organization_invitations_with_http_info variant
|
421
417
|
|
422
418
|
This returns an Array which contains the response data, status code and headers.
|
423
419
|
|
@@ -426,12 +422,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
426
422
|
```ruby
|
427
423
|
begin
|
428
424
|
# Get a list of pending organization invitations
|
429
|
-
data, status_code, headers =
|
425
|
+
data, status_code, headers = Clerk::SDK.organization_invitations.list_pending_organization_invitations_with_http_info(organization_id, opts)
|
430
426
|
p status_code # => 2xx
|
431
427
|
p headers # => { ... }
|
432
428
|
p data # => <OrganizationInvitations>
|
433
429
|
rescue ClerkHttpClient::ApiError => e
|
434
|
-
puts "Error when calling
|
430
|
+
puts "Error when calling Clerk::SDK.organization_invitations->list_pending_organization_invitations_with_http_info: #{e}"
|
435
431
|
end
|
436
432
|
```
|
437
433
|
|
@@ -469,14 +465,13 @@ Use this request to revoke a previously issued organization invitation. Revoking
|
|
469
465
|
|
470
466
|
```ruby
|
471
467
|
require 'time'
|
472
|
-
require 'clerk
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
config.
|
468
|
+
require 'clerk'
|
469
|
+
|
470
|
+
## Setup
|
471
|
+
Clerk.configure do |config|
|
472
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
477
473
|
end
|
478
474
|
|
479
|
-
api_instance = ClerkHttpClient::OrganizationInvitationsApi.new
|
480
475
|
organization_id = 'organization_id_example' # String | The organization ID.
|
481
476
|
invitation_id = 'invitation_id_example' # String | The organization invitation ID.
|
482
477
|
opts = {
|
@@ -485,14 +480,14 @@ opts = {
|
|
485
480
|
|
486
481
|
begin
|
487
482
|
# Revoke a pending organization invitation
|
488
|
-
result =
|
483
|
+
result = Clerk::SDK.organization_invitations.revoke_organization_invitation(organization_id, invitation_id, opts)
|
489
484
|
p result
|
490
485
|
rescue ClerkHttpClient::ApiError => e
|
491
|
-
puts "Error when calling
|
486
|
+
puts "Error when calling Clerk::SDK.organization_invitations->revoke_organization_invitation: #{e}"
|
492
487
|
end
|
493
488
|
```
|
494
489
|
|
495
|
-
#### Using the revoke_organization_invitation_with_http_info variant
|
490
|
+
#### Using the `revoke_organization_invitation_with_http_info variant
|
496
491
|
|
497
492
|
This returns an Array which contains the response data, status code and headers.
|
498
493
|
|
@@ -501,12 +496,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
501
496
|
```ruby
|
502
497
|
begin
|
503
498
|
# Revoke a pending organization invitation
|
504
|
-
data, status_code, headers =
|
499
|
+
data, status_code, headers = Clerk::SDK.organization_invitations.revoke_organization_invitation_with_http_info(organization_id, invitation_id, opts)
|
505
500
|
p status_code # => 2xx
|
506
501
|
p headers # => { ... }
|
507
502
|
p data # => <OrganizationInvitation>
|
508
503
|
rescue ClerkHttpClient::ApiError => e
|
509
|
-
puts "Error when calling
|
504
|
+
puts "Error when calling Clerk::SDK.organization_invitations->revoke_organization_invitation_with_http_info: #{e}"
|
510
505
|
end
|
511
506
|
```
|
512
507
|
|