clerk-http-client 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +87 -0
- data/README.md +360 -0
- data/Rakefile +10 -0
- data/bin/fmt +5 -0
- data/bin/generate +8 -0
- data/bin/setup +7 -0
- data/clerk-http-client.gemspec +41 -0
- data/docs/ActorToken.md +34 -0
- data/docs/ActorTokensApi.md +147 -0
- data/docs/AddDomainRequest.md +22 -0
- data/docs/Admin.md +24 -0
- data/docs/AllowListBlockListApi.md +421 -0
- data/docs/AllowlistIdentifier.md +32 -0
- data/docs/BetaFeaturesApi.md +217 -0
- data/docs/BlocklistIdentifier.md +30 -0
- data/docs/BlocklistIdentifiers.md +20 -0
- data/docs/CNameTarget.md +22 -0
- data/docs/ChangeProductionInstanceDomainRequest.md +20 -0
- data/docs/ClerkError.md +26 -0
- data/docs/ClerkErrors.md +20 -0
- data/docs/Client.md +34 -0
- data/docs/ClientsApi.md +221 -0
- data/docs/CreateActorTokenRequest.md +24 -0
- data/docs/CreateAllowlistIdentifierRequest.md +20 -0
- data/docs/CreateBlocklistIdentifierRequest.md +18 -0
- data/docs/CreateEmailAddressRequest.md +24 -0
- data/docs/CreateInvitationRequest.md +28 -0
- data/docs/CreateJWTTemplateRequest.md +30 -0
- data/docs/CreateOAuthApplicationRequest.md +24 -0
- data/docs/CreateOrganizationDomainRequest.md +22 -0
- data/docs/CreateOrganizationInvitationBulkRequestInner.md +28 -0
- data/docs/CreateOrganizationInvitationRequest.md +28 -0
- data/docs/CreateOrganizationMembershipRequest.md +20 -0
- data/docs/CreateOrganizationRequest.md +30 -0
- data/docs/CreatePhoneNumberRequest.md +26 -0
- data/docs/CreateRedirectURLRequest.md +18 -0
- data/docs/CreateSAMLConnectionRequest.md +34 -0
- data/docs/CreateSAMLConnectionRequestAttributeMapping.md +24 -0
- data/docs/CreateSessionTokenFromTemplate200Response.md +20 -0
- data/docs/CreateSignInTokenRequest.md +20 -0
- data/docs/CreateUserRequest.md +62 -0
- data/docs/DeletedObject.md +24 -0
- data/docs/DisableMFA200Response.md +18 -0
- data/docs/Domain.md +34 -0
- data/docs/Domains.md +20 -0
- data/docs/DomainsApi.md +286 -0
- data/docs/EmailAddress.md +32 -0
- data/docs/EmailAddressVerification.md +51 -0
- data/docs/EmailAddressesApi.md +289 -0
- data/docs/EmailSMSTemplatesApi.md +449 -0
- data/docs/GetOAuthAccessToken200ResponseInner.md +34 -0
- data/docs/IdentificationLink.md +20 -0
- data/docs/InstanceRestrictions.md +26 -0
- data/docs/InstanceSettingsApi.md +216 -0
- data/docs/Invitation.md +36 -0
- data/docs/InvitationsApi.md +223 -0
- data/docs/JWKSApi.md +74 -0
- data/docs/JWTTemplate.md +36 -0
- data/docs/JWTTemplatesApi.md +354 -0
- data/docs/MergeOrganizationMetadataRequest.md +20 -0
- data/docs/MiscellaneousApi.md +75 -0
- data/docs/OAuthApplication.md +42 -0
- data/docs/OAuthApplicationWithSecret.md +44 -0
- data/docs/OAuthApplications.md +20 -0
- data/docs/OAuthApplicationsApi.md +433 -0
- data/docs/OTP.md +24 -0
- data/docs/Oauth.md +28 -0
- data/docs/OauthError.md +47 -0
- data/docs/Organization.md +40 -0
- data/docs/OrganizationDomain.md +38 -0
- data/docs/OrganizationDomainApi.md +81 -0
- data/docs/OrganizationDomainVerification.md +24 -0
- data/docs/OrganizationDomains.md +20 -0
- data/docs/OrganizationDomainsApi.md +231 -0
- data/docs/OrganizationInvitation.md +38 -0
- data/docs/OrganizationInvitationWithPublicOrganizationData.md +40 -0
- data/docs/OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData.md +26 -0
- data/docs/OrganizationInvitations.md +20 -0
- data/docs/OrganizationInvitationsApi.md +533 -0
- data/docs/OrganizationInvitationsWithPublicOrganizationData.md +20 -0
- data/docs/OrganizationMembership.md +38 -0
- data/docs/OrganizationMembershipPublicUserData.md +30 -0
- data/docs/OrganizationMemberships.md +20 -0
- data/docs/OrganizationMembershipsApi.md +453 -0
- data/docs/OrganizationSettings.md +36 -0
- data/docs/OrganizationWithLogo.md +46 -0
- data/docs/Organizations.md +20 -0
- data/docs/OrganizationsApi.md +591 -0
- data/docs/Passkey.md +26 -0
- data/docs/PhoneNumber.md +38 -0
- data/docs/PhoneNumberVerification.md +49 -0
- data/docs/PhoneNumbersApi.md +289 -0
- data/docs/PreviewTemplateRequest.md +24 -0
- data/docs/ProxyCheck.md +32 -0
- data/docs/ProxyChecksApi.md +77 -0
- data/docs/RedirectURL.md +26 -0
- data/docs/RedirectURLsApi.md +284 -0
- data/docs/RevokeInvitation200Response.md +36 -0
- data/docs/RevokeOrganizationInvitationRequest.md +18 -0
- data/docs/SAML.md +28 -0
- data/docs/SAMLAccount.md +38 -0
- data/docs/SAMLAccountSamlConnection.md +47 -0
- data/docs/SAMLAccountVerification.md +49 -0
- data/docs/SAMLConnection.md +38 -0
- data/docs/SAMLConnections.md +20 -0
- data/docs/SAMLConnectionsApi.md +363 -0
- data/docs/SchemasPasskey.md +26 -0
- data/docs/SchemasPasskeyVerification.md +47 -0
- data/docs/SchemasSAMLConnection.md +60 -0
- data/docs/SchemasSAMLConnectionAttributeMapping.md +24 -0
- data/docs/Session.md +42 -0
- data/docs/SessionLatestActivity.md +34 -0
- data/docs/SessionsApi.md +373 -0
- data/docs/SignInToken.md +32 -0
- data/docs/SignInTokensApi.md +147 -0
- data/docs/SignUp.md +62 -0
- data/docs/SignUpsApi.md +79 -0
- data/docs/SvixURL.md +18 -0
- data/docs/TOTP.md +28 -0
- data/docs/Template.md +60 -0
- data/docs/TestingToken.md +22 -0
- data/docs/TestingTokensApi.md +74 -0
- data/docs/Ticket.md +24 -0
- data/docs/ToggleTemplateDeliveryRequest.md +18 -0
- data/docs/TotalCount.md +20 -0
- data/docs/UpdateDomainRequest.md +22 -0
- data/docs/UpdateEmailAddressRequest.md +20 -0
- data/docs/UpdateInstanceAuthConfig200Response.md +28 -0
- data/docs/UpdateInstanceAuthConfigRequest.md +28 -0
- data/docs/UpdateInstanceOrganizationSettingsRequest.md +30 -0
- data/docs/UpdateInstanceRequest.md +34 -0
- data/docs/UpdateInstanceRestrictionsRequest.md +26 -0
- data/docs/UpdateOAuthApplicationRequest.md +22 -0
- data/docs/UpdateOrganizationDomainRequest.md +20 -0
- data/docs/UpdateOrganizationMembershipMetadataRequest.md +20 -0
- data/docs/UpdateOrganizationMembershipRequest.md +18 -0
- data/docs/UpdateOrganizationRequest.md +30 -0
- data/docs/UpdatePhoneNumberRequest.md +22 -0
- data/docs/UpdateProductionInstanceDomainRequest.md +18 -0
- data/docs/UpdateSAMLConnectionRequest.md +42 -0
- data/docs/UpdateSAMLConnectionRequestAttributeMapping.md +24 -0
- data/docs/UpdateSignUpRequest.md +18 -0
- data/docs/UpdateUserMetadataRequest.md +22 -0
- data/docs/UpdateUserRequest.md +66 -0
- data/docs/UpsertTemplateRequest.md +30 -0
- data/docs/User.md +94 -0
- data/docs/UsersApi.md +1829 -0
- data/docs/VerifyClientRequest.md +18 -0
- data/docs/VerifyDomainProxyRequest.md +20 -0
- data/docs/VerifyPassword200Response.md +18 -0
- data/docs/VerifyPasswordRequest.md +18 -0
- data/docs/VerifySessionRequest.md +18 -0
- data/docs/VerifyTOTP200Response.md +20 -0
- data/docs/VerifyTOTPRequest.md +18 -0
- data/docs/Web3Signature.md +28 -0
- data/docs/Web3Wallet.md +28 -0
- data/docs/Web3WalletVerification.md +49 -0
- data/docs/WebhooksApi.md +207 -0
- data/docs/WellKnownJWKS.md +18 -0
- data/docs/WellKnownJWKSKeysInner.md +28 -0
- data/git_push.sh +57 -0
- data/lib/clerk-http-client/api/actor_tokens_api.rb +157 -0
- data/lib/clerk-http-client/api/allow_list_block_list_api.rb +410 -0
- data/lib/clerk-http-client/api/beta_features_api.rb +228 -0
- data/lib/clerk-http-client/api/clients_api.rb +234 -0
- data/lib/clerk-http-client/api/domains_api.rb +292 -0
- data/lib/clerk-http-client/api/email_addresses_api.rb +298 -0
- data/lib/clerk-http-client/api/email_sms_templates_api.rb +488 -0
- data/lib/clerk-http-client/api/instance_settings_api.rb +232 -0
- data/lib/clerk-http-client/api/invitations_api.rb +241 -0
- data/lib/clerk-http-client/api/jwks_api.rb +81 -0
- data/lib/clerk-http-client/api/jwt_templates_api.rb +355 -0
- data/lib/clerk-http-client/api/miscellaneous_api.rb +85 -0
- data/lib/clerk-http-client/api/o_auth_applications_api.rb +440 -0
- data/lib/clerk-http-client/api/organization_domain_api.rb +104 -0
- data/lib/clerk-http-client/api/organization_domains_api.rb +258 -0
- data/lib/clerk-http-client/api/organization_invitations_api.rb +586 -0
- data/lib/clerk-http-client/api/organization_memberships_api.rb +499 -0
- data/lib/clerk-http-client/api/organizations_api.rb +606 -0
- data/lib/clerk-http-client/api/phone_numbers_api.rb +298 -0
- data/lib/clerk-http-client/api/proxy_checks_api.rb +92 -0
- data/lib/clerk-http-client/api/redirect_urls_api.rb +281 -0
- data/lib/clerk-http-client/api/saml_connections_api.rb +375 -0
- data/lib/clerk-http-client/api/sessions_api.rb +385 -0
- data/lib/clerk-http-client/api/sign_in_tokens_api.rb +157 -0
- data/lib/clerk-http-client/api/sign_ups_api.rb +98 -0
- data/lib/clerk-http-client/api/testing_tokens_api.rb +81 -0
- data/lib/clerk-http-client/api/users_api.rb +1828 -0
- data/lib/clerk-http-client/api/webhooks_api.rb +199 -0
- data/lib/clerk-http-client/api_client.rb +437 -0
- data/lib/clerk-http-client/api_error.rb +58 -0
- data/lib/clerk-http-client/configuration.rb +393 -0
- data/lib/clerk-http-client/models/actor_token.rb +385 -0
- data/lib/clerk-http-client/models/add_domain_request.rb +249 -0
- data/lib/clerk-http-client/models/admin.rb +303 -0
- data/lib/clerk-http-client/models/allowlist_identifier.rb +327 -0
- data/lib/clerk-http-client/models/blocklist_identifier.rb +318 -0
- data/lib/clerk-http-client/models/blocklist_identifiers.rb +240 -0
- data/lib/clerk-http-client/models/c_name_target.rb +254 -0
- data/lib/clerk-http-client/models/change_production_instance_domain_request.rb +225 -0
- data/lib/clerk-http-client/models/clerk_error.rb +271 -0
- data/lib/clerk-http-client/models/clerk_errors.rb +232 -0
- data/lib/clerk-http-client/models/client.rb +380 -0
- data/lib/clerk-http-client/models/create_actor_token_request.rb +263 -0
- data/lib/clerk-http-client/models/create_allowlist_identifier_request.rb +234 -0
- data/lib/clerk-http-client/models/create_blocklist_identifier_request.rb +222 -0
- data/lib/clerk-http-client/models/create_email_address_request.rb +247 -0
- data/lib/clerk-http-client/models/create_invitation_request.rb +303 -0
- data/lib/clerk-http-client/models/create_jwt_template_request.rb +327 -0
- data/lib/clerk-http-client/models/create_o_auth_application_request.rb +261 -0
- data/lib/clerk-http-client/models/create_organization_domain_request.rb +236 -0
- data/lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb +280 -0
- data/lib/clerk-http-client/models/create_organization_invitation_request.rb +280 -0
- data/lib/clerk-http-client/models/create_organization_membership_request.rb +239 -0
- data/lib/clerk-http-client/models/create_organization_request.rb +289 -0
- data/lib/clerk-http-client/models/create_phone_number_request.rb +258 -0
- data/lib/clerk-http-client/models/create_redirect_url_request.rb +215 -0
- data/lib/clerk-http-client/models/create_saml_connection_request.rb +355 -0
- data/lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb +242 -0
- data/lib/clerk-http-client/models/create_session_token_from_template200_response.rb +257 -0
- data/lib/clerk-http-client/models/create_sign_in_token_request.rb +227 -0
- data/lib/clerk-http-client/models/create_user_request.rb +453 -0
- data/lib/clerk-http-client/models/deleted_object.rb +255 -0
- data/lib/clerk-http-client/models/disable_mfa200_response.rb +214 -0
- data/lib/clerk-http-client/models/domain.rb +368 -0
- data/lib/clerk-http-client/models/domains.rb +240 -0
- data/lib/clerk-http-client/models/email_address.rb +361 -0
- data/lib/clerk-http-client/models/email_address_verification.rb +106 -0
- data/lib/clerk-http-client/models/get_o_auth_access_token200_response_inner.rb +295 -0
- data/lib/clerk-http-client/models/identification_link.rb +271 -0
- data/lib/clerk-http-client/models/instance_restrictions.rb +285 -0
- data/lib/clerk-http-client/models/invitation.rb +388 -0
- data/lib/clerk-http-client/models/jwt_template.rb +387 -0
- data/lib/clerk-http-client/models/merge_organization_metadata_request.rb +225 -0
- data/lib/clerk-http-client/models/o_auth_application.rb +449 -0
- data/lib/clerk-http-client/models/o_auth_application_with_secret.rb +466 -0
- data/lib/clerk-http-client/models/o_auth_applications.rb +240 -0
- data/lib/clerk-http-client/models/oauth.rb +328 -0
- data/lib/clerk-http-client/models/oauth_error.rb +104 -0
- data/lib/clerk-http-client/models/organization.rb +413 -0
- data/lib/clerk-http-client/models/organization_domain.rb +364 -0
- data/lib/clerk-http-client/models/organization_domain_verification.rb +281 -0
- data/lib/clerk-http-client/models/organization_domains.rb +240 -0
- data/lib/clerk-http-client/models/organization_invitation.rb +342 -0
- data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb +351 -0
- data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb +250 -0
- data/lib/clerk-http-client/models/organization_invitations.rb +240 -0
- data/lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb +240 -0
- data/lib/clerk-http-client/models/organization_membership.rb +346 -0
- data/lib/clerk-http-client/models/organization_membership_public_user_data.rb +272 -0
- data/lib/clerk-http-client/models/organization_memberships.rb +240 -0
- data/lib/clerk-http-client/models/organization_settings.rb +391 -0
- data/lib/clerk-http-client/models/organization_with_logo.rb +454 -0
- data/lib/clerk-http-client/models/organizations.rb +240 -0
- data/lib/clerk-http-client/models/otp.rb +315 -0
- data/lib/clerk-http-client/models/passkey.rb +324 -0
- data/lib/clerk-http-client/models/phone_number.rb +391 -0
- data/lib/clerk-http-client/models/phone_number_verification.rb +105 -0
- data/lib/clerk-http-client/models/preview_template_request.rb +246 -0
- data/lib/clerk-http-client/models/proxy_check.rb +367 -0
- data/lib/clerk-http-client/models/redirect_url.rb +321 -0
- data/lib/clerk-http-client/models/revoke_invitation200_response.rb +395 -0
- data/lib/clerk-http-client/models/revoke_organization_invitation_request.rb +216 -0
- data/lib/clerk-http-client/models/saml.rb +331 -0
- data/lib/clerk-http-client/models/saml_account.rb +381 -0
- data/lib/clerk-http-client/models/saml_account_saml_connection.rb +104 -0
- data/lib/clerk-http-client/models/saml_account_verification.rb +105 -0
- data/lib/clerk-http-client/models/saml_connection.rb +362 -0
- data/lib/clerk-http-client/models/saml_connections.rb +240 -0
- data/lib/clerk-http-client/models/schemas_passkey.rb +310 -0
- data/lib/clerk-http-client/models/schemas_passkey_verification.rb +104 -0
- data/lib/clerk-http-client/models/schemas_saml_connection.rb +541 -0
- data/lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb +241 -0
- data/lib/clerk-http-client/models/session.rb +444 -0
- data/lib/clerk-http-client/models/session_latest_activity.rb +300 -0
- data/lib/clerk-http-client/models/sign_in_token.rb +368 -0
- data/lib/clerk-http-client/models/sign_up.rb +517 -0
- data/lib/clerk-http-client/models/svix_url.rb +221 -0
- data/lib/clerk-http-client/models/template.rb +460 -0
- data/lib/clerk-http-client/models/testing_token.rb +289 -0
- data/lib/clerk-http-client/models/ticket.rb +303 -0
- data/lib/clerk-http-client/models/toggle_template_delivery_request.rb +216 -0
- data/lib/clerk-http-client/models/total_count.rb +272 -0
- data/lib/clerk-http-client/models/totp.rb +289 -0
- data/lib/clerk-http-client/models/update_domain_request.rb +238 -0
- data/lib/clerk-http-client/models/update_email_address_request.rb +227 -0
- data/lib/clerk-http-client/models/update_instance_auth_config200_response.rb +294 -0
- data/lib/clerk-http-client/models/update_instance_auth_config_request.rb +273 -0
- data/lib/clerk-http-client/models/update_instance_organization_settings_request.rb +277 -0
- data/lib/clerk-http-client/models/update_instance_request.rb +300 -0
- data/lib/clerk-http-client/models/update_instance_restrictions_request.rb +255 -0
- data/lib/clerk-http-client/models/update_o_auth_application_request.rb +237 -0
- data/lib/clerk-http-client/models/update_organization_domain_request.rb +227 -0
- data/lib/clerk-http-client/models/update_organization_membership_metadata_request.rb +225 -0
- data/lib/clerk-http-client/models/update_organization_membership_request.rb +222 -0
- data/lib/clerk-http-client/models/update_organization_request.rb +279 -0
- data/lib/clerk-http-client/models/update_phone_number_request.rb +238 -0
- data/lib/clerk-http-client/models/update_production_instance_domain_request.rb +215 -0
- data/lib/clerk-http-client/models/update_saml_connection_request.rb +347 -0
- data/lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb +242 -0
- data/lib/clerk-http-client/models/update_sign_up_request.rb +216 -0
- data/lib/clerk-http-client/models/update_user_metadata_request.rb +241 -0
- data/lib/clerk-http-client/models/update_user_request.rb +472 -0
- data/lib/clerk-http-client/models/upsert_template_request.rb +278 -0
- data/lib/clerk-http-client/models/user.rb +633 -0
- data/lib/clerk-http-client/models/verify_client_request.rb +215 -0
- data/lib/clerk-http-client/models/verify_domain_proxy_request.rb +225 -0
- data/lib/clerk-http-client/models/verify_password200_response.rb +214 -0
- data/lib/clerk-http-client/models/verify_password_request.rb +222 -0
- data/lib/clerk-http-client/models/verify_session_request.rb +215 -0
- data/lib/clerk-http-client/models/verify_totp200_response.rb +257 -0
- data/lib/clerk-http-client/models/verify_totp_request.rb +222 -0
- data/lib/clerk-http-client/models/web3_signature.rb +323 -0
- data/lib/clerk-http-client/models/web3_wallet.rb +327 -0
- data/lib/clerk-http-client/models/web3_wallet_verification.rb +105 -0
- data/lib/clerk-http-client/models/well_known_jwks.rb +216 -0
- data/lib/clerk-http-client/models/well_known_jwks_keys_inner.rb +259 -0
- data/lib/clerk-http-client/version.rb +15 -0
- data/lib/clerk-http-client.rb +321 -0
- data/openapitools.json +7 -0
- 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 +7238 -0
- data/resources/templates/Gemfile.mustache +9 -0
- data/resources/templates/README.mustache +163 -0
- data/resources/templates/Rakefile.mustache +10 -0
- data/resources/templates/api.mustache +257 -0
- data/resources/templates/api_client.mustache +246 -0
- data/resources/templates/api_client_faraday_partial.mustache +200 -0
- data/resources/templates/api_client_httpx_partial.mustache +134 -0
- data/resources/templates/api_client_typhoeus_partial.mustache +161 -0
- data/resources/templates/api_doc.mustache +132 -0
- data/resources/templates/api_error.mustache +50 -0
- data/resources/templates/api_info.mustache +12 -0
- data/resources/templates/api_test.mustache +47 -0
- data/resources/templates/base_object.mustache +114 -0
- data/resources/templates/configuration.mustache +491 -0
- data/resources/templates/configuration_faraday_partial.mustache +40 -0
- data/resources/templates/configuration_httpx_partial.mustache +11 -0
- data/resources/templates/configuration_typhoeus_partial.mustache +41 -0
- data/resources/templates/gem.mustache +89 -0
- data/resources/templates/gemspec.mustache +41 -0
- data/resources/templates/git_push.sh.mustache +57 -0
- data/resources/templates/gitignore.mustache +39 -0
- data/resources/templates/gitlab-ci.mustache +26 -0
- data/resources/templates/model.mustache +33 -0
- data/resources/templates/model_doc.mustache +12 -0
- data/resources/templates/model_test.mustache +82 -0
- data/resources/templates/partial_anyof_module.mustache +94 -0
- data/resources/templates/partial_model_enum_class.mustache +23 -0
- data/resources/templates/partial_model_generic.mustache +377 -0
- data/resources/templates/partial_model_generic_doc.mustache +28 -0
- data/resources/templates/partial_oneof_module.mustache +137 -0
- data/resources/templates/partial_oneof_module_doc.mustache +93 -0
- data/resources/templates/rspec.mustache +2 -0
- data/resources/templates/rubocop.mustache +148 -0
- data/resources/templates/spec_helper.mustache +103 -0
- data/resources/templates/travis.mustache +11 -0
- data/resources/templates/version.mustache +7 -0
- data/sdk-generator-config.json +20 -0
- data/spec/api/actor_tokens_api_spec.rb +59 -0
- data/spec/api/allow_list_block_list_api_spec.rb +105 -0
- data/spec/api/beta_features_api_spec.rb +71 -0
- data/spec/api/clients_api_spec.rb +72 -0
- data/spec/api/domains_api_spec.rb +83 -0
- data/spec/api/email_addresses_api_spec.rb +84 -0
- data/spec/api/email_sms_templates_api_spec.rb +115 -0
- data/spec/api/instance_settings_api_spec.rb +71 -0
- data/spec/api/invitations_api_spec.rb +73 -0
- data/spec/api/jwks_api_spec.rb +46 -0
- data/spec/api/jwt_templates_api_spec.rb +94 -0
- data/spec/api/miscellaneous_api_spec.rb +48 -0
- data/spec/api/o_auth_applications_api_spec.rb +109 -0
- data/spec/api/organization_domain_api_spec.rb +49 -0
- data/spec/api/organization_domains_api_spec.rb +77 -0
- data/spec/api/organization_invitations_api_spec.rb +133 -0
- data/spec/api/organization_memberships_api_spec.rb +118 -0
- data/spec/api/organizations_api_spec.rb +139 -0
- data/spec/api/phone_numbers_api_spec.rb +84 -0
- data/spec/api/proxy_checks_api_spec.rb +47 -0
- data/spec/api/redirect_urls_api_spec.rb +82 -0
- data/spec/api/saml_connections_api_spec.rb +97 -0
- data/spec/api/sessions_api_spec.rb +101 -0
- data/spec/api/sign_in_tokens_api_spec.rb +59 -0
- data/spec/api/sign_ups_api_spec.rb +48 -0
- data/spec/api/testing_tokens_api_spec.rb +46 -0
- data/spec/api/users_api_spec.rb +366 -0
- data/spec/api/webhooks_api_spec.rb +68 -0
- data/spec/models/actor_token_spec.rb +92 -0
- data/spec/models/add_domain_request_spec.rb +48 -0
- data/spec/models/admin_spec.rb +62 -0
- data/spec/models/allowlist_identifier_spec.rb +86 -0
- data/spec/models/blocklist_identifier_spec.rb +80 -0
- data/spec/models/blocklist_identifiers_spec.rb +42 -0
- data/spec/models/c_name_target_spec.rb +48 -0
- data/spec/models/change_production_instance_domain_request_spec.rb +42 -0
- data/spec/models/clerk_error_spec.rb +60 -0
- data/spec/models/clerk_errors_spec.rb +42 -0
- data/spec/models/client_spec.rb +88 -0
- data/spec/models/create_actor_token_request_spec.rb +54 -0
- data/spec/models/create_allowlist_identifier_request_spec.rb +42 -0
- data/spec/models/create_blocklist_identifier_request_spec.rb +36 -0
- data/spec/models/create_email_address_request_spec.rb +54 -0
- data/spec/models/create_invitation_request_spec.rb +66 -0
- data/spec/models/create_jwt_template_request_spec.rb +72 -0
- data/spec/models/create_o_auth_application_request_spec.rb +54 -0
- data/spec/models/create_organization_domain_request_spec.rb +48 -0
- data/spec/models/create_organization_invitation_bulk_request_inner_spec.rb +66 -0
- data/spec/models/create_organization_invitation_request_spec.rb +66 -0
- data/spec/models/create_organization_membership_request_spec.rb +42 -0
- data/spec/models/create_organization_request_spec.rb +72 -0
- data/spec/models/create_phone_number_request_spec.rb +60 -0
- data/spec/models/create_redirect_url_request_spec.rb +36 -0
- data/spec/models/create_saml_connection_request_attribute_mapping_spec.rb +54 -0
- data/spec/models/create_saml_connection_request_spec.rb +88 -0
- data/spec/models/create_session_token_from_template200_response_spec.rb +46 -0
- data/spec/models/create_sign_in_token_request_spec.rb +42 -0
- data/spec/models/create_user_request_spec.rb +168 -0
- data/spec/models/deleted_object_spec.rb +54 -0
- data/spec/models/disable_mfa200_response_spec.rb +36 -0
- data/spec/models/domain_spec.rb +88 -0
- data/spec/models/domains_spec.rb +42 -0
- data/spec/models/email_address_spec.rb +82 -0
- data/spec/models/email_address_verification_spec.rb +32 -0
- data/spec/models/get_o_auth_access_token200_response_inner_spec.rb +84 -0
- data/spec/models/identification_link_spec.rb +46 -0
- data/spec/models/instance_restrictions_spec.rb +64 -0
- data/spec/models/invitation_spec.rb +98 -0
- data/spec/models/jwt_template_spec.rb +94 -0
- data/spec/models/merge_organization_metadata_request_spec.rb +42 -0
- data/spec/models/o_auth_application_spec.rb +112 -0
- data/spec/models/o_auth_application_with_secret_spec.rb +118 -0
- data/spec/models/o_auth_applications_spec.rb +42 -0
- data/spec/models/oauth_error_spec.rb +32 -0
- data/spec/models/oauth_spec.rb +74 -0
- data/spec/models/organization_domain_spec.rb +104 -0
- data/spec/models/organization_domain_verification_spec.rb +58 -0
- data/spec/models/organization_domains_spec.rb +42 -0
- data/spec/models/organization_invitation_spec.rb +100 -0
- data/spec/models/organization_invitation_with_public_organization_data_public_organization_data_spec.rb +60 -0
- data/spec/models/organization_invitation_with_public_organization_data_spec.rb +106 -0
- data/spec/models/organization_invitations_spec.rb +42 -0
- data/spec/models/organization_invitations_with_public_organization_data_spec.rb +42 -0
- data/spec/models/organization_membership_public_user_data_spec.rb +72 -0
- data/spec/models/organization_membership_spec.rb +100 -0
- data/spec/models/organization_memberships_spec.rb +42 -0
- data/spec/models/organization_settings_spec.rb +98 -0
- data/spec/models/organization_spec.rb +106 -0
- data/spec/models/organization_with_logo_spec.rb +124 -0
- data/spec/models/organizations_spec.rb +42 -0
- data/spec/models/otp_spec.rb +62 -0
- data/spec/models/passkey_spec.rb +72 -0
- data/spec/models/phone_number_spec.rb +100 -0
- data/spec/models/phone_number_verification_spec.rb +32 -0
- data/spec/models/preview_template_request_spec.rb +54 -0
- data/spec/models/proxy_check_spec.rb +82 -0
- data/spec/models/redirect_url_spec.rb +64 -0
- data/spec/models/revoke_invitation200_response_spec.rb +98 -0
- data/spec/models/revoke_organization_invitation_request_spec.rb +36 -0
- data/spec/models/saml_account_saml_connection_spec.rb +32 -0
- data/spec/models/saml_account_spec.rb +100 -0
- data/spec/models/saml_account_verification_spec.rb +32 -0
- data/spec/models/saml_connection_spec.rb +96 -0
- data/spec/models/saml_connections_spec.rb +42 -0
- data/spec/models/saml_spec.rb +74 -0
- data/spec/models/schemas_passkey_spec.rb +64 -0
- data/spec/models/schemas_passkey_verification_spec.rb +32 -0
- data/spec/models/schemas_saml_connection_attribute_mapping_spec.rb +54 -0
- data/spec/models/schemas_saml_connection_spec.rb +166 -0
- data/spec/models/session_latest_activity_spec.rb +84 -0
- data/spec/models/session_spec.rb +116 -0
- data/spec/models/sign_in_token_spec.rb +86 -0
- data/spec/models/sign_up_spec.rb +176 -0
- data/spec/models/svix_url_spec.rb +36 -0
- data/spec/models/template_spec.rb +166 -0
- data/spec/models/testing_token_spec.rb +52 -0
- data/spec/models/ticket_spec.rb +62 -0
- data/spec/models/toggle_template_delivery_request_spec.rb +36 -0
- data/spec/models/total_count_spec.rb +46 -0
- data/spec/models/totp_spec.rb +66 -0
- data/spec/models/update_domain_request_spec.rb +48 -0
- data/spec/models/update_email_address_request_spec.rb +42 -0
- data/spec/models/update_instance_auth_config200_response_spec.rb +70 -0
- data/spec/models/update_instance_auth_config_request_spec.rb +66 -0
- data/spec/models/update_instance_organization_settings_request_spec.rb +72 -0
- data/spec/models/update_instance_request_spec.rb +84 -0
- data/spec/models/update_instance_restrictions_request_spec.rb +60 -0
- data/spec/models/update_o_auth_application_request_spec.rb +48 -0
- data/spec/models/update_organization_domain_request_spec.rb +42 -0
- data/spec/models/update_organization_membership_metadata_request_spec.rb +42 -0
- data/spec/models/update_organization_membership_request_spec.rb +36 -0
- data/spec/models/update_organization_request_spec.rb +72 -0
- data/spec/models/update_phone_number_request_spec.rb +48 -0
- data/spec/models/update_production_instance_domain_request_spec.rb +36 -0
- data/spec/models/update_saml_connection_request_attribute_mapping_spec.rb +54 -0
- data/spec/models/update_saml_connection_request_spec.rb +108 -0
- data/spec/models/update_sign_up_request_spec.rb +36 -0
- data/spec/models/update_user_metadata_request_spec.rb +48 -0
- data/spec/models/update_user_request_spec.rb +180 -0
- data/spec/models/upsert_template_request_spec.rb +72 -0
- data/spec/models/user_spec.rb +268 -0
- data/spec/models/verify_client_request_spec.rb +36 -0
- data/spec/models/verify_domain_proxy_request_spec.rb +42 -0
- data/spec/models/verify_password200_response_spec.rb +36 -0
- data/spec/models/verify_password_request_spec.rb +36 -0
- data/spec/models/verify_session_request_spec.rb +36 -0
- data/spec/models/verify_totp200_response_spec.rb +46 -0
- data/spec/models/verify_totp_request_spec.rb +36 -0
- data/spec/models/web3_signature_spec.rb +74 -0
- data/spec/models/web3_wallet_spec.rb +70 -0
- data/spec/models/web3_wallet_verification_spec.rb +32 -0
- data/spec/models/well_known_jwks_keys_inner_spec.rb +66 -0
- data/spec/models/well_known_jwks_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- data/test.rb +2 -0
- metadata +782 -0
@@ -0,0 +1,449 @@
|
|
1
|
+
# ClerkHttpClient::EmailSMSTemplatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.clerk.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_template**](EmailSMSTemplatesApi.md#get_template) | **GET** /templates/{template_type}/{slug} | Retrieve a template |
|
8
|
+
| [**get_template_list**](EmailSMSTemplatesApi.md#get_template_list) | **GET** /templates/{template_type} | List all templates |
|
9
|
+
| [**preview_template**](EmailSMSTemplatesApi.md#preview_template) | **POST** /templates/{template_type}/{slug}/preview | Preview changes to a template |
|
10
|
+
| [**revert_template**](EmailSMSTemplatesApi.md#revert_template) | **POST** /templates/{template_type}/{slug}/revert | Revert a template |
|
11
|
+
| [**toggle_template_delivery**](EmailSMSTemplatesApi.md#toggle_template_delivery) | **POST** /templates/{template_type}/{slug}/toggle_delivery | Toggle the delivery by Clerk for a template of a given type and slug |
|
12
|
+
| [**upsert_template**](EmailSMSTemplatesApi.md#upsert_template) | **PUT** /templates/{template_type}/{slug} | Update a template for a given type and slug |
|
13
|
+
|
14
|
+
|
15
|
+
## get_template
|
16
|
+
|
17
|
+
> <Template> get_template(template_type, slug)
|
18
|
+
|
19
|
+
Retrieve a template
|
20
|
+
|
21
|
+
Returns the details of a template
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'clerk-http-client'
|
28
|
+
# setup authorization
|
29
|
+
ClerkHttpClient.configure do |config|
|
30
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
31
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
35
|
+
template_type = 'email' # String | The type of templates to retrieve (email or SMS)
|
36
|
+
slug = 'slug_example' # String | The slug (i.e. machine-friendly name) of the template to retrieve
|
37
|
+
|
38
|
+
begin
|
39
|
+
# Retrieve a template
|
40
|
+
result = api_instance.get_template(template_type, slug)
|
41
|
+
p result
|
42
|
+
rescue ClerkHttpClient::ApiError => e
|
43
|
+
puts "Error when calling EmailSMSTemplatesApi->get_template: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the get_template_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
50
|
+
|
51
|
+
> <Array(<Template>, Integer, Hash)> get_template_with_http_info(template_type, slug)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# Retrieve a template
|
56
|
+
data, status_code, headers = api_instance.get_template_with_http_info(template_type, slug)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <Template>
|
60
|
+
rescue ClerkHttpClient::ApiError => e
|
61
|
+
puts "Error when calling EmailSMSTemplatesApi->get_template_with_http_info: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **template_type** | **String** | The type of templates to retrieve (email or SMS) | |
|
70
|
+
| **slug** | **String** | The slug (i.e. machine-friendly name) of the template to retrieve | |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
[**Template**](Template.md)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[bearerAuth](../README.md#bearerAuth)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: Not defined
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
85
|
+
|
86
|
+
## get_template_list
|
87
|
+
|
88
|
+
> <Array<Template>> get_template_list(template_type)
|
89
|
+
|
90
|
+
List all templates
|
91
|
+
|
92
|
+
Returns a list of all templates. The templates are returned sorted by position.
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'clerk-http-client'
|
99
|
+
# setup authorization
|
100
|
+
ClerkHttpClient.configure do |config|
|
101
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
102
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
106
|
+
template_type = 'email' # String | The type of templates to list (email or SMS)
|
107
|
+
|
108
|
+
begin
|
109
|
+
# List all templates
|
110
|
+
result = api_instance.get_template_list(template_type)
|
111
|
+
p result
|
112
|
+
rescue ClerkHttpClient::ApiError => e
|
113
|
+
puts "Error when calling EmailSMSTemplatesApi->get_template_list: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
#### Using the get_template_list_with_http_info variant
|
118
|
+
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
120
|
+
|
121
|
+
> <Array(<Array<Template>>, Integer, Hash)> get_template_list_with_http_info(template_type)
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
begin
|
125
|
+
# List all templates
|
126
|
+
data, status_code, headers = api_instance.get_template_list_with_http_info(template_type)
|
127
|
+
p status_code # => 2xx
|
128
|
+
p headers # => { ... }
|
129
|
+
p data # => <Array<Template>>
|
130
|
+
rescue ClerkHttpClient::ApiError => e
|
131
|
+
puts "Error when calling EmailSMSTemplatesApi->get_template_list_with_http_info: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
| Name | Type | Description | Notes |
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
139
|
+
| **template_type** | **String** | The type of templates to list (email or SMS) | |
|
140
|
+
|
141
|
+
### Return type
|
142
|
+
|
143
|
+
[**Array<Template>**](Template.md)
|
144
|
+
|
145
|
+
### Authorization
|
146
|
+
|
147
|
+
[bearerAuth](../README.md#bearerAuth)
|
148
|
+
|
149
|
+
### HTTP request headers
|
150
|
+
|
151
|
+
- **Content-Type**: Not defined
|
152
|
+
- **Accept**: application/json
|
153
|
+
|
154
|
+
|
155
|
+
## preview_template
|
156
|
+
|
157
|
+
> Object preview_template(template_type, slug, opts)
|
158
|
+
|
159
|
+
Preview changes to a template
|
160
|
+
|
161
|
+
Returns a preview of a template for a given template_type, slug and body
|
162
|
+
|
163
|
+
### Examples
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
require 'time'
|
167
|
+
require 'clerk-http-client'
|
168
|
+
# setup authorization
|
169
|
+
ClerkHttpClient.configure do |config|
|
170
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
171
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
172
|
+
end
|
173
|
+
|
174
|
+
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
175
|
+
template_type = 'template_type_example' # String | The type of template to preview
|
176
|
+
slug = 'slug_example' # String | The slug of the template to preview
|
177
|
+
opts = {
|
178
|
+
preview_template_request: ClerkHttpClient::PreviewTemplateRequest.new # PreviewTemplateRequest | Required parameters
|
179
|
+
}
|
180
|
+
|
181
|
+
begin
|
182
|
+
# Preview changes to a template
|
183
|
+
result = api_instance.preview_template(template_type, slug, opts)
|
184
|
+
p result
|
185
|
+
rescue ClerkHttpClient::ApiError => e
|
186
|
+
puts "Error when calling EmailSMSTemplatesApi->preview_template: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
#### Using the preview_template_with_http_info variant
|
191
|
+
|
192
|
+
This returns an Array which contains the response data, status code and headers.
|
193
|
+
|
194
|
+
> <Array(Object, Integer, Hash)> preview_template_with_http_info(template_type, slug, opts)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
begin
|
198
|
+
# Preview changes to a template
|
199
|
+
data, status_code, headers = api_instance.preview_template_with_http_info(template_type, slug, opts)
|
200
|
+
p status_code # => 2xx
|
201
|
+
p headers # => { ... }
|
202
|
+
p data # => Object
|
203
|
+
rescue ClerkHttpClient::ApiError => e
|
204
|
+
puts "Error when calling EmailSMSTemplatesApi->preview_template_with_http_info: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
| Name | Type | Description | Notes |
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
212
|
+
| **template_type** | **String** | The type of template to preview | |
|
213
|
+
| **slug** | **String** | The slug of the template to preview | |
|
214
|
+
| **preview_template_request** | [**PreviewTemplateRequest**](PreviewTemplateRequest.md) | Required parameters | [optional] |
|
215
|
+
|
216
|
+
### Return type
|
217
|
+
|
218
|
+
**Object**
|
219
|
+
|
220
|
+
### Authorization
|
221
|
+
|
222
|
+
[bearerAuth](../README.md#bearerAuth)
|
223
|
+
|
224
|
+
### HTTP request headers
|
225
|
+
|
226
|
+
- **Content-Type**: application/json
|
227
|
+
- **Accept**: application/json
|
228
|
+
|
229
|
+
|
230
|
+
## revert_template
|
231
|
+
|
232
|
+
> <Template> revert_template(template_type, slug)
|
233
|
+
|
234
|
+
Revert a template
|
235
|
+
|
236
|
+
Reverts an updated template to its default state
|
237
|
+
|
238
|
+
### Examples
|
239
|
+
|
240
|
+
```ruby
|
241
|
+
require 'time'
|
242
|
+
require 'clerk-http-client'
|
243
|
+
# setup authorization
|
244
|
+
ClerkHttpClient.configure do |config|
|
245
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
246
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
247
|
+
end
|
248
|
+
|
249
|
+
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
250
|
+
template_type = 'email' # String | The type of template to revert
|
251
|
+
slug = 'slug_example' # String | The slug of the template to revert
|
252
|
+
|
253
|
+
begin
|
254
|
+
# Revert a template
|
255
|
+
result = api_instance.revert_template(template_type, slug)
|
256
|
+
p result
|
257
|
+
rescue ClerkHttpClient::ApiError => e
|
258
|
+
puts "Error when calling EmailSMSTemplatesApi->revert_template: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
#### Using the revert_template_with_http_info variant
|
263
|
+
|
264
|
+
This returns an Array which contains the response data, status code and headers.
|
265
|
+
|
266
|
+
> <Array(<Template>, Integer, Hash)> revert_template_with_http_info(template_type, slug)
|
267
|
+
|
268
|
+
```ruby
|
269
|
+
begin
|
270
|
+
# Revert a template
|
271
|
+
data, status_code, headers = api_instance.revert_template_with_http_info(template_type, slug)
|
272
|
+
p status_code # => 2xx
|
273
|
+
p headers # => { ... }
|
274
|
+
p data # => <Template>
|
275
|
+
rescue ClerkHttpClient::ApiError => e
|
276
|
+
puts "Error when calling EmailSMSTemplatesApi->revert_template_with_http_info: #{e}"
|
277
|
+
end
|
278
|
+
```
|
279
|
+
|
280
|
+
### Parameters
|
281
|
+
|
282
|
+
| Name | Type | Description | Notes |
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
284
|
+
| **template_type** | **String** | The type of template to revert | |
|
285
|
+
| **slug** | **String** | The slug of the template to revert | |
|
286
|
+
|
287
|
+
### Return type
|
288
|
+
|
289
|
+
[**Template**](Template.md)
|
290
|
+
|
291
|
+
### Authorization
|
292
|
+
|
293
|
+
[bearerAuth](../README.md#bearerAuth)
|
294
|
+
|
295
|
+
### HTTP request headers
|
296
|
+
|
297
|
+
- **Content-Type**: Not defined
|
298
|
+
- **Accept**: application/json
|
299
|
+
|
300
|
+
|
301
|
+
## toggle_template_delivery
|
302
|
+
|
303
|
+
> <Template> toggle_template_delivery(template_type, slug, opts)
|
304
|
+
|
305
|
+
Toggle the delivery by Clerk for a template of a given type and slug
|
306
|
+
|
307
|
+
Toggles the delivery by Clerk for a template of a given type and slug. If disabled, Clerk will not deliver the resulting email or SMS. The app developer will need to listen to the `email.created` or `sms.created` webhooks in order to handle delivery themselves.
|
308
|
+
|
309
|
+
### Examples
|
310
|
+
|
311
|
+
```ruby
|
312
|
+
require 'time'
|
313
|
+
require 'clerk-http-client'
|
314
|
+
# setup authorization
|
315
|
+
ClerkHttpClient.configure do |config|
|
316
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
317
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
318
|
+
end
|
319
|
+
|
320
|
+
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
321
|
+
template_type = 'email' # String | The type of template to toggle delivery for
|
322
|
+
slug = 'slug_example' # String | The slug of the template for which to toggle delivery
|
323
|
+
opts = {
|
324
|
+
toggle_template_delivery_request: ClerkHttpClient::ToggleTemplateDeliveryRequest.new # ToggleTemplateDeliveryRequest |
|
325
|
+
}
|
326
|
+
|
327
|
+
begin
|
328
|
+
# Toggle the delivery by Clerk for a template of a given type and slug
|
329
|
+
result = api_instance.toggle_template_delivery(template_type, slug, opts)
|
330
|
+
p result
|
331
|
+
rescue ClerkHttpClient::ApiError => e
|
332
|
+
puts "Error when calling EmailSMSTemplatesApi->toggle_template_delivery: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
#### Using the toggle_template_delivery_with_http_info variant
|
337
|
+
|
338
|
+
This returns an Array which contains the response data, status code and headers.
|
339
|
+
|
340
|
+
> <Array(<Template>, Integer, Hash)> toggle_template_delivery_with_http_info(template_type, slug, opts)
|
341
|
+
|
342
|
+
```ruby
|
343
|
+
begin
|
344
|
+
# Toggle the delivery by Clerk for a template of a given type and slug
|
345
|
+
data, status_code, headers = api_instance.toggle_template_delivery_with_http_info(template_type, slug, opts)
|
346
|
+
p status_code # => 2xx
|
347
|
+
p headers # => { ... }
|
348
|
+
p data # => <Template>
|
349
|
+
rescue ClerkHttpClient::ApiError => e
|
350
|
+
puts "Error when calling EmailSMSTemplatesApi->toggle_template_delivery_with_http_info: #{e}"
|
351
|
+
end
|
352
|
+
```
|
353
|
+
|
354
|
+
### Parameters
|
355
|
+
|
356
|
+
| Name | Type | Description | Notes |
|
357
|
+
| ---- | ---- | ----------- | ----- |
|
358
|
+
| **template_type** | **String** | The type of template to toggle delivery for | |
|
359
|
+
| **slug** | **String** | The slug of the template for which to toggle delivery | |
|
360
|
+
| **toggle_template_delivery_request** | [**ToggleTemplateDeliveryRequest**](ToggleTemplateDeliveryRequest.md) | | [optional] |
|
361
|
+
|
362
|
+
### Return type
|
363
|
+
|
364
|
+
[**Template**](Template.md)
|
365
|
+
|
366
|
+
### Authorization
|
367
|
+
|
368
|
+
[bearerAuth](../README.md#bearerAuth)
|
369
|
+
|
370
|
+
### HTTP request headers
|
371
|
+
|
372
|
+
- **Content-Type**: application/json
|
373
|
+
- **Accept**: application/json
|
374
|
+
|
375
|
+
|
376
|
+
## upsert_template
|
377
|
+
|
378
|
+
> <Template> upsert_template(template_type, slug, opts)
|
379
|
+
|
380
|
+
Update a template for a given type and slug
|
381
|
+
|
382
|
+
Updates the existing template of the given type and slug
|
383
|
+
|
384
|
+
### Examples
|
385
|
+
|
386
|
+
```ruby
|
387
|
+
require 'time'
|
388
|
+
require 'clerk-http-client'
|
389
|
+
# setup authorization
|
390
|
+
ClerkHttpClient.configure do |config|
|
391
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
392
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
393
|
+
end
|
394
|
+
|
395
|
+
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
396
|
+
template_type = 'email' # String | The type of template to update
|
397
|
+
slug = 'slug_example' # String | The slug of the template to update
|
398
|
+
opts = {
|
399
|
+
upsert_template_request: ClerkHttpClient::UpsertTemplateRequest.new # UpsertTemplateRequest |
|
400
|
+
}
|
401
|
+
|
402
|
+
begin
|
403
|
+
# Update a template for a given type and slug
|
404
|
+
result = api_instance.upsert_template(template_type, slug, opts)
|
405
|
+
p result
|
406
|
+
rescue ClerkHttpClient::ApiError => e
|
407
|
+
puts "Error when calling EmailSMSTemplatesApi->upsert_template: #{e}"
|
408
|
+
end
|
409
|
+
```
|
410
|
+
|
411
|
+
#### Using the upsert_template_with_http_info variant
|
412
|
+
|
413
|
+
This returns an Array which contains the response data, status code and headers.
|
414
|
+
|
415
|
+
> <Array(<Template>, Integer, Hash)> upsert_template_with_http_info(template_type, slug, opts)
|
416
|
+
|
417
|
+
```ruby
|
418
|
+
begin
|
419
|
+
# Update a template for a given type and slug
|
420
|
+
data, status_code, headers = api_instance.upsert_template_with_http_info(template_type, slug, opts)
|
421
|
+
p status_code # => 2xx
|
422
|
+
p headers # => { ... }
|
423
|
+
p data # => <Template>
|
424
|
+
rescue ClerkHttpClient::ApiError => e
|
425
|
+
puts "Error when calling EmailSMSTemplatesApi->upsert_template_with_http_info: #{e}"
|
426
|
+
end
|
427
|
+
```
|
428
|
+
|
429
|
+
### Parameters
|
430
|
+
|
431
|
+
| Name | Type | Description | Notes |
|
432
|
+
| ---- | ---- | ----------- | ----- |
|
433
|
+
| **template_type** | **String** | The type of template to update | |
|
434
|
+
| **slug** | **String** | The slug of the template to update | |
|
435
|
+
| **upsert_template_request** | [**UpsertTemplateRequest**](UpsertTemplateRequest.md) | | [optional] |
|
436
|
+
|
437
|
+
### Return type
|
438
|
+
|
439
|
+
[**Template**](Template.md)
|
440
|
+
|
441
|
+
### Authorization
|
442
|
+
|
443
|
+
[bearerAuth](../README.md#bearerAuth)
|
444
|
+
|
445
|
+
### HTTP request headers
|
446
|
+
|
447
|
+
- **Content-Type**: application/json
|
448
|
+
- **Accept**: application/json
|
449
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# ClerkHttpClient::GetOAuthAccessToken200ResponseInner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **object** | **String** | | [optional] |
|
8
|
+
| **external_account_id** | **String** | External account ID | [optional] |
|
9
|
+
| **provider_user_id** | **String** | The unique ID of the user in the external provider's system | [optional] |
|
10
|
+
| **token** | **String** | The access token | [optional] |
|
11
|
+
| **provider** | **String** | The ID of the provider | [optional] |
|
12
|
+
| **public_metadata** | **Object** | | [optional] |
|
13
|
+
| **label** | **String** | | [optional] |
|
14
|
+
| **scopes** | **Array<String>** | The list of scopes that the token is valid for. Only present for OAuth 2.0 tokens. | [optional] |
|
15
|
+
| **token_secret** | **String** | The token secret. Only present for OAuth 1.0 tokens. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'clerk-http-client'
|
21
|
+
|
22
|
+
instance = ClerkHttpClient::GetOAuthAccessToken200ResponseInner.new(
|
23
|
+
object: null,
|
24
|
+
external_account_id: null,
|
25
|
+
provider_user_id: null,
|
26
|
+
token: null,
|
27
|
+
provider: null,
|
28
|
+
public_metadata: null,
|
29
|
+
label: null,
|
30
|
+
scopes: null,
|
31
|
+
token_secret: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# ClerkHttpClient::IdentificationLink
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | | |
|
8
|
+
| **id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'clerk-http-client'
|
14
|
+
|
15
|
+
instance = ClerkHttpClient::IdentificationLink.new(
|
16
|
+
type: null,
|
17
|
+
id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# ClerkHttpClient::InstanceRestrictions
|
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
|
+
| **allowlist** | **Boolean** | | [optional] |
|
9
|
+
| **blocklist** | **Boolean** | | [optional] |
|
10
|
+
| **block_email_subaddresses** | **Boolean** | | [optional] |
|
11
|
+
| **ignore_dots_for_gmail_addresses** | **Boolean** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'clerk-http-client'
|
17
|
+
|
18
|
+
instance = ClerkHttpClient::InstanceRestrictions.new(
|
19
|
+
object: null,
|
20
|
+
allowlist: null,
|
21
|
+
blocklist: null,
|
22
|
+
block_email_subaddresses: null,
|
23
|
+
ignore_dots_for_gmail_addresses: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|