clerk-http-client 0.0.1 → 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 +5 -5
- 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 +108 -74
- 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 -20
- data/test.rb +0 -2
- /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
data/docs/EmailAddress.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **reserved** | **Boolean** | | |
|
11
11
|
| **verification** | [**EmailAddressVerification**](EmailAddressVerification.md) | | |
|
12
12
|
| **linked_to** | [**Array<IdentificationLink>**](IdentificationLink.md) | | |
|
13
|
+
| **matches_sso_connection** | **Boolean** | Indicates whether this email address domain matches an active enterprise connection. | [optional] |
|
13
14
|
| **created_at** | **Integer** | Unix timestamp of creation | |
|
14
15
|
| **updated_at** | **Integer** | Unix timestamp of creation | |
|
15
16
|
|
@@ -25,6 +26,7 @@ instance = ClerkHttpClient::EmailAddress.new(
|
|
25
26
|
reserved: null,
|
26
27
|
verification: null,
|
27
28
|
linked_to: null,
|
29
|
+
matches_sso_connection: null,
|
28
30
|
created_at: null,
|
29
31
|
updated_at: null
|
30
32
|
)
|
@@ -15,8 +15,8 @@ ClerkHttpClient::EmailAddressVerification.openapi_one_of
|
|
15
15
|
# =>
|
16
16
|
# [
|
17
17
|
# :'Admin',
|
18
|
-
# :'
|
19
|
-
# :'
|
18
|
+
# :'FromOAuth',
|
19
|
+
# :'OTP'
|
20
20
|
# ]
|
21
21
|
```
|
22
22
|
|
@@ -45,7 +45,7 @@ ClerkHttpClient::EmailAddressVerification.build(data_that_doesnt_match)
|
|
45
45
|
#### Return type
|
46
46
|
|
47
47
|
- `Admin`
|
48
|
+
- `FromOAuth`
|
48
49
|
- `OTP`
|
49
|
-
- `Oauth`
|
50
50
|
- `nil` (if no type matches)
|
51
51
|
|
data/docs/EmailAddressesApi.md
CHANGED
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.clerk.com/v1*
|
|
12
12
|
|
13
13
|
## create_email_address
|
14
14
|
|
15
|
-
> <EmailAddress> create_email_address(
|
15
|
+
> <EmailAddress> create_email_address(opts)
|
16
16
|
|
17
17
|
Create an email address
|
18
18
|
|
@@ -22,40 +22,41 @@ Create a new email address
|
|
22
22
|
|
23
23
|
```ruby
|
24
24
|
require 'time'
|
25
|
-
require 'clerk
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
config.
|
25
|
+
require 'clerk'
|
26
|
+
|
27
|
+
## Setup
|
28
|
+
Clerk.configure do |config|
|
29
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
30
30
|
end
|
31
31
|
|
32
|
-
|
33
|
-
create_email_address_request
|
32
|
+
opts = {
|
33
|
+
create_email_address_request: ClerkHttpClient::CreateEmailAddressRequest.new # CreateEmailAddressRequest |
|
34
|
+
}
|
34
35
|
|
35
36
|
begin
|
36
37
|
# Create an email address
|
37
|
-
result =
|
38
|
+
result = Clerk::SDK.email_addresses.create_email_address(opts)
|
38
39
|
p result
|
39
40
|
rescue ClerkHttpClient::ApiError => e
|
40
|
-
puts "Error when calling
|
41
|
+
puts "Error when calling Clerk::SDK.email_addresses->create_email_address: #{e}"
|
41
42
|
end
|
42
43
|
```
|
43
44
|
|
44
|
-
#### Using the create_email_address_with_http_info variant
|
45
|
+
#### Using the `create_email_address_with_http_info variant
|
45
46
|
|
46
47
|
This returns an Array which contains the response data, status code and headers.
|
47
48
|
|
48
|
-
> <Array(<EmailAddress>, Integer, Hash)> create_email_address_with_http_info(
|
49
|
+
> <Array(<EmailAddress>, Integer, Hash)> create_email_address_with_http_info(opts)
|
49
50
|
|
50
51
|
```ruby
|
51
52
|
begin
|
52
53
|
# Create an email address
|
53
|
-
data, status_code, headers =
|
54
|
+
data, status_code, headers = Clerk::SDK.email_addresses.create_email_address_with_http_info(opts)
|
54
55
|
p status_code # => 2xx
|
55
56
|
p headers # => { ... }
|
56
57
|
p data # => <EmailAddress>
|
57
58
|
rescue ClerkHttpClient::ApiError => e
|
58
|
-
puts "Error when calling
|
59
|
+
puts "Error when calling Clerk::SDK.email_addresses->create_email_address_with_http_info: #{e}"
|
59
60
|
end
|
60
61
|
```
|
61
62
|
|
@@ -63,7 +64,7 @@ end
|
|
63
64
|
|
64
65
|
| Name | Type | Description | Notes |
|
65
66
|
| ---- | ---- | ----------- | ----- |
|
66
|
-
| **create_email_address_request** | [**CreateEmailAddressRequest**](CreateEmailAddressRequest.md) | |
|
67
|
+
| **create_email_address_request** | [**CreateEmailAddressRequest**](CreateEmailAddressRequest.md) | | [optional] |
|
67
68
|
|
68
69
|
### Return type
|
69
70
|
|
@@ -91,26 +92,25 @@ Delete the email address with the given ID
|
|
91
92
|
|
92
93
|
```ruby
|
93
94
|
require 'time'
|
94
|
-
require 'clerk
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
config.
|
95
|
+
require 'clerk'
|
96
|
+
|
97
|
+
## Setup
|
98
|
+
Clerk.configure do |config|
|
99
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
99
100
|
end
|
100
101
|
|
101
|
-
api_instance = ClerkHttpClient::EmailAddressesApi.new
|
102
102
|
email_address_id = 'email_address_id_example' # String | The ID of the email address to delete
|
103
103
|
|
104
104
|
begin
|
105
105
|
# Delete an email address
|
106
|
-
result =
|
106
|
+
result = Clerk::SDK.email_addresses.delete_email_address(email_address_id)
|
107
107
|
p result
|
108
108
|
rescue ClerkHttpClient::ApiError => e
|
109
|
-
puts "Error when calling
|
109
|
+
puts "Error when calling Clerk::SDK.email_addresses->delete_email_address: #{e}"
|
110
110
|
end
|
111
111
|
```
|
112
112
|
|
113
|
-
#### Using the delete_email_address_with_http_info variant
|
113
|
+
#### Using the `delete_email_address_with_http_info variant
|
114
114
|
|
115
115
|
This returns an Array which contains the response data, status code and headers.
|
116
116
|
|
@@ -119,12 +119,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
119
119
|
```ruby
|
120
120
|
begin
|
121
121
|
# Delete an email address
|
122
|
-
data, status_code, headers =
|
122
|
+
data, status_code, headers = Clerk::SDK.email_addresses.delete_email_address_with_http_info(email_address_id)
|
123
123
|
p status_code # => 2xx
|
124
124
|
p headers # => { ... }
|
125
125
|
p data # => <DeletedObject>
|
126
126
|
rescue ClerkHttpClient::ApiError => e
|
127
|
-
puts "Error when calling
|
127
|
+
puts "Error when calling Clerk::SDK.email_addresses->delete_email_address_with_http_info: #{e}"
|
128
128
|
end
|
129
129
|
```
|
130
130
|
|
@@ -160,26 +160,25 @@ Returns the details of an email address.
|
|
160
160
|
|
161
161
|
```ruby
|
162
162
|
require 'time'
|
163
|
-
require 'clerk
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
config.
|
163
|
+
require 'clerk'
|
164
|
+
|
165
|
+
## Setup
|
166
|
+
Clerk.configure do |config|
|
167
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
168
168
|
end
|
169
169
|
|
170
|
-
api_instance = ClerkHttpClient::EmailAddressesApi.new
|
171
170
|
email_address_id = 'email_address_id_example' # String | The ID of the email address to retrieve
|
172
171
|
|
173
172
|
begin
|
174
173
|
# Retrieve an email address
|
175
|
-
result =
|
174
|
+
result = Clerk::SDK.email_addresses.get_email_address(email_address_id)
|
176
175
|
p result
|
177
176
|
rescue ClerkHttpClient::ApiError => e
|
178
|
-
puts "Error when calling
|
177
|
+
puts "Error when calling Clerk::SDK.email_addresses->get_email_address: #{e}"
|
179
178
|
end
|
180
179
|
```
|
181
180
|
|
182
|
-
#### Using the get_email_address_with_http_info variant
|
181
|
+
#### Using the `get_email_address_with_http_info variant
|
183
182
|
|
184
183
|
This returns an Array which contains the response data, status code and headers.
|
185
184
|
|
@@ -188,12 +187,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
188
187
|
```ruby
|
189
188
|
begin
|
190
189
|
# Retrieve an email address
|
191
|
-
data, status_code, headers =
|
190
|
+
data, status_code, headers = Clerk::SDK.email_addresses.get_email_address_with_http_info(email_address_id)
|
192
191
|
p status_code # => 2xx
|
193
192
|
p headers # => { ... }
|
194
193
|
p data # => <EmailAddress>
|
195
194
|
rescue ClerkHttpClient::ApiError => e
|
196
|
-
puts "Error when calling
|
195
|
+
puts "Error when calling Clerk::SDK.email_addresses->get_email_address_with_http_info: #{e}"
|
197
196
|
end
|
198
197
|
```
|
199
198
|
|
@@ -219,7 +218,7 @@ end
|
|
219
218
|
|
220
219
|
## update_email_address
|
221
220
|
|
222
|
-
> <EmailAddress> update_email_address(email_address_id,
|
221
|
+
> <EmailAddress> update_email_address(email_address_id, opts)
|
223
222
|
|
224
223
|
Update an email address
|
225
224
|
|
@@ -229,41 +228,42 @@ Updates an email address.
|
|
229
228
|
|
230
229
|
```ruby
|
231
230
|
require 'time'
|
232
|
-
require 'clerk
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
config.
|
231
|
+
require 'clerk'
|
232
|
+
|
233
|
+
## Setup
|
234
|
+
Clerk.configure do |config|
|
235
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
237
236
|
end
|
238
237
|
|
239
|
-
api_instance = ClerkHttpClient::EmailAddressesApi.new
|
240
238
|
email_address_id = 'email_address_id_example' # String | The ID of the email address to update
|
241
|
-
|
239
|
+
opts = {
|
240
|
+
update_email_address_request: ClerkHttpClient::UpdateEmailAddressRequest.new # UpdateEmailAddressRequest |
|
241
|
+
}
|
242
242
|
|
243
243
|
begin
|
244
244
|
# Update an email address
|
245
|
-
result =
|
245
|
+
result = Clerk::SDK.email_addresses.update_email_address(email_address_id, opts)
|
246
246
|
p result
|
247
247
|
rescue ClerkHttpClient::ApiError => e
|
248
|
-
puts "Error when calling
|
248
|
+
puts "Error when calling Clerk::SDK.email_addresses->update_email_address: #{e}"
|
249
249
|
end
|
250
250
|
```
|
251
251
|
|
252
|
-
#### Using the update_email_address_with_http_info variant
|
252
|
+
#### Using the `update_email_address_with_http_info variant
|
253
253
|
|
254
254
|
This returns an Array which contains the response data, status code and headers.
|
255
255
|
|
256
|
-
> <Array(<EmailAddress>, Integer, Hash)> update_email_address_with_http_info(email_address_id,
|
256
|
+
> <Array(<EmailAddress>, Integer, Hash)> update_email_address_with_http_info(email_address_id, opts)
|
257
257
|
|
258
258
|
```ruby
|
259
259
|
begin
|
260
260
|
# Update an email address
|
261
|
-
data, status_code, headers =
|
261
|
+
data, status_code, headers = Clerk::SDK.email_addresses.update_email_address_with_http_info(email_address_id, opts)
|
262
262
|
p status_code # => 2xx
|
263
263
|
p headers # => { ... }
|
264
264
|
p data # => <EmailAddress>
|
265
265
|
rescue ClerkHttpClient::ApiError => e
|
266
|
-
puts "Error when calling
|
266
|
+
puts "Error when calling Clerk::SDK.email_addresses->update_email_address_with_http_info: #{e}"
|
267
267
|
end
|
268
268
|
```
|
269
269
|
|
@@ -272,7 +272,7 @@ end
|
|
272
272
|
| Name | Type | Description | Notes |
|
273
273
|
| ---- | ---- | ----------- | ----- |
|
274
274
|
| **email_address_id** | **String** | The ID of the email address to update | |
|
275
|
-
| **update_email_address_request** | [**UpdateEmailAddressRequest**](UpdateEmailAddressRequest.md) | |
|
275
|
+
| **update_email_address_request** | [**UpdateEmailAddressRequest**](UpdateEmailAddressRequest.md) | | [optional] |
|
276
276
|
|
277
277
|
### Return type
|
278
278
|
|
@@ -24,27 +24,26 @@ Returns the details of a template
|
|
24
24
|
|
25
25
|
```ruby
|
26
26
|
require 'time'
|
27
|
-
require 'clerk
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
config.
|
27
|
+
require 'clerk'
|
28
|
+
|
29
|
+
## Setup
|
30
|
+
Clerk.configure do |config|
|
31
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
32
32
|
end
|
33
33
|
|
34
|
-
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
35
34
|
template_type = 'email' # String | The type of templates to retrieve (email or SMS)
|
36
35
|
slug = 'slug_example' # String | The slug (i.e. machine-friendly name) of the template to retrieve
|
37
36
|
|
38
37
|
begin
|
39
38
|
# Retrieve a template
|
40
|
-
result =
|
39
|
+
result = Clerk::SDK.email_sms_templates.get_template(template_type, slug)
|
41
40
|
p result
|
42
41
|
rescue ClerkHttpClient::ApiError => e
|
43
|
-
puts "Error when calling
|
42
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->get_template: #{e}"
|
44
43
|
end
|
45
44
|
```
|
46
45
|
|
47
|
-
#### Using the get_template_with_http_info variant
|
46
|
+
#### Using the `get_template_with_http_info variant
|
48
47
|
|
49
48
|
This returns an Array which contains the response data, status code and headers.
|
50
49
|
|
@@ -53,12 +52,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
53
52
|
```ruby
|
54
53
|
begin
|
55
54
|
# Retrieve a template
|
56
|
-
data, status_code, headers =
|
55
|
+
data, status_code, headers = Clerk::SDK.email_sms_templates.get_template_with_http_info(template_type, slug)
|
57
56
|
p status_code # => 2xx
|
58
57
|
p headers # => { ... }
|
59
58
|
p data # => <Template>
|
60
59
|
rescue ClerkHttpClient::ApiError => e
|
61
|
-
puts "Error when calling
|
60
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->get_template_with_http_info: #{e}"
|
62
61
|
end
|
63
62
|
```
|
64
63
|
|
@@ -95,26 +94,25 @@ Returns a list of all templates. The templates are returned sorted by position.
|
|
95
94
|
|
96
95
|
```ruby
|
97
96
|
require 'time'
|
98
|
-
require 'clerk
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
config.
|
97
|
+
require 'clerk'
|
98
|
+
|
99
|
+
## Setup
|
100
|
+
Clerk.configure do |config|
|
101
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
103
102
|
end
|
104
103
|
|
105
|
-
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
106
104
|
template_type = 'email' # String | The type of templates to list (email or SMS)
|
107
105
|
|
108
106
|
begin
|
109
107
|
# List all templates
|
110
|
-
result =
|
108
|
+
result = Clerk::SDK.email_sms_templates.get_template_list(template_type)
|
111
109
|
p result
|
112
110
|
rescue ClerkHttpClient::ApiError => e
|
113
|
-
puts "Error when calling
|
111
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->get_template_list: #{e}"
|
114
112
|
end
|
115
113
|
```
|
116
114
|
|
117
|
-
#### Using the get_template_list_with_http_info variant
|
115
|
+
#### Using the `get_template_list_with_http_info variant
|
118
116
|
|
119
117
|
This returns an Array which contains the response data, status code and headers.
|
120
118
|
|
@@ -123,12 +121,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
123
121
|
```ruby
|
124
122
|
begin
|
125
123
|
# List all templates
|
126
|
-
data, status_code, headers =
|
124
|
+
data, status_code, headers = Clerk::SDK.email_sms_templates.get_template_list_with_http_info(template_type)
|
127
125
|
p status_code # => 2xx
|
128
126
|
p headers # => { ... }
|
129
127
|
p data # => <Array<Template>>
|
130
128
|
rescue ClerkHttpClient::ApiError => e
|
131
|
-
puts "Error when calling
|
129
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->get_template_list_with_http_info: #{e}"
|
132
130
|
end
|
133
131
|
```
|
134
132
|
|
@@ -164,14 +162,13 @@ Returns a preview of a template for a given template_type, slug and body
|
|
164
162
|
|
165
163
|
```ruby
|
166
164
|
require 'time'
|
167
|
-
require 'clerk
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
config.
|
165
|
+
require 'clerk'
|
166
|
+
|
167
|
+
## Setup
|
168
|
+
Clerk.configure do |config|
|
169
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
172
170
|
end
|
173
171
|
|
174
|
-
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
175
172
|
template_type = 'template_type_example' # String | The type of template to preview
|
176
173
|
slug = 'slug_example' # String | The slug of the template to preview
|
177
174
|
opts = {
|
@@ -180,14 +177,14 @@ opts = {
|
|
180
177
|
|
181
178
|
begin
|
182
179
|
# Preview changes to a template
|
183
|
-
result =
|
180
|
+
result = Clerk::SDK.email_sms_templates.preview_template(template_type, slug, opts)
|
184
181
|
p result
|
185
182
|
rescue ClerkHttpClient::ApiError => e
|
186
|
-
puts "Error when calling
|
183
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->preview_template: #{e}"
|
187
184
|
end
|
188
185
|
```
|
189
186
|
|
190
|
-
#### Using the preview_template_with_http_info variant
|
187
|
+
#### Using the `preview_template_with_http_info variant
|
191
188
|
|
192
189
|
This returns an Array which contains the response data, status code and headers.
|
193
190
|
|
@@ -196,12 +193,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
196
193
|
```ruby
|
197
194
|
begin
|
198
195
|
# Preview changes to a template
|
199
|
-
data, status_code, headers =
|
196
|
+
data, status_code, headers = Clerk::SDK.email_sms_templates.preview_template_with_http_info(template_type, slug, opts)
|
200
197
|
p status_code # => 2xx
|
201
198
|
p headers # => { ... }
|
202
199
|
p data # => Object
|
203
200
|
rescue ClerkHttpClient::ApiError => e
|
204
|
-
puts "Error when calling
|
201
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->preview_template_with_http_info: #{e}"
|
205
202
|
end
|
206
203
|
```
|
207
204
|
|
@@ -239,27 +236,26 @@ Reverts an updated template to its default state
|
|
239
236
|
|
240
237
|
```ruby
|
241
238
|
require 'time'
|
242
|
-
require 'clerk
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
config.
|
239
|
+
require 'clerk'
|
240
|
+
|
241
|
+
## Setup
|
242
|
+
Clerk.configure do |config|
|
243
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
247
244
|
end
|
248
245
|
|
249
|
-
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
250
246
|
template_type = 'email' # String | The type of template to revert
|
251
247
|
slug = 'slug_example' # String | The slug of the template to revert
|
252
248
|
|
253
249
|
begin
|
254
250
|
# Revert a template
|
255
|
-
result =
|
251
|
+
result = Clerk::SDK.email_sms_templates.revert_template(template_type, slug)
|
256
252
|
p result
|
257
253
|
rescue ClerkHttpClient::ApiError => e
|
258
|
-
puts "Error when calling
|
254
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->revert_template: #{e}"
|
259
255
|
end
|
260
256
|
```
|
261
257
|
|
262
|
-
#### Using the revert_template_with_http_info variant
|
258
|
+
#### Using the `revert_template_with_http_info variant
|
263
259
|
|
264
260
|
This returns an Array which contains the response data, status code and headers.
|
265
261
|
|
@@ -268,12 +264,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
268
264
|
```ruby
|
269
265
|
begin
|
270
266
|
# Revert a template
|
271
|
-
data, status_code, headers =
|
267
|
+
data, status_code, headers = Clerk::SDK.email_sms_templates.revert_template_with_http_info(template_type, slug)
|
272
268
|
p status_code # => 2xx
|
273
269
|
p headers # => { ... }
|
274
270
|
p data # => <Template>
|
275
271
|
rescue ClerkHttpClient::ApiError => e
|
276
|
-
puts "Error when calling
|
272
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->revert_template_with_http_info: #{e}"
|
277
273
|
end
|
278
274
|
```
|
279
275
|
|
@@ -310,14 +306,13 @@ Toggles the delivery by Clerk for a template of a given type and slug. If disabl
|
|
310
306
|
|
311
307
|
```ruby
|
312
308
|
require 'time'
|
313
|
-
require 'clerk
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
config.
|
309
|
+
require 'clerk'
|
310
|
+
|
311
|
+
## Setup
|
312
|
+
Clerk.configure do |config|
|
313
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
318
314
|
end
|
319
315
|
|
320
|
-
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
321
316
|
template_type = 'email' # String | The type of template to toggle delivery for
|
322
317
|
slug = 'slug_example' # String | The slug of the template for which to toggle delivery
|
323
318
|
opts = {
|
@@ -326,14 +321,14 @@ opts = {
|
|
326
321
|
|
327
322
|
begin
|
328
323
|
# Toggle the delivery by Clerk for a template of a given type and slug
|
329
|
-
result =
|
324
|
+
result = Clerk::SDK.email_sms_templates.toggle_template_delivery(template_type, slug, opts)
|
330
325
|
p result
|
331
326
|
rescue ClerkHttpClient::ApiError => e
|
332
|
-
puts "Error when calling
|
327
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->toggle_template_delivery: #{e}"
|
333
328
|
end
|
334
329
|
```
|
335
330
|
|
336
|
-
#### Using the toggle_template_delivery_with_http_info variant
|
331
|
+
#### Using the `toggle_template_delivery_with_http_info variant
|
337
332
|
|
338
333
|
This returns an Array which contains the response data, status code and headers.
|
339
334
|
|
@@ -342,12 +337,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
342
337
|
```ruby
|
343
338
|
begin
|
344
339
|
# Toggle the delivery by Clerk for a template of a given type and slug
|
345
|
-
data, status_code, headers =
|
340
|
+
data, status_code, headers = Clerk::SDK.email_sms_templates.toggle_template_delivery_with_http_info(template_type, slug, opts)
|
346
341
|
p status_code # => 2xx
|
347
342
|
p headers # => { ... }
|
348
343
|
p data # => <Template>
|
349
344
|
rescue ClerkHttpClient::ApiError => e
|
350
|
-
puts "Error when calling
|
345
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->toggle_template_delivery_with_http_info: #{e}"
|
351
346
|
end
|
352
347
|
```
|
353
348
|
|
@@ -385,14 +380,13 @@ Updates the existing template of the given type and slug
|
|
385
380
|
|
386
381
|
```ruby
|
387
382
|
require 'time'
|
388
|
-
require 'clerk
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
config.
|
383
|
+
require 'clerk'
|
384
|
+
|
385
|
+
## Setup
|
386
|
+
Clerk.configure do |config|
|
387
|
+
config.secret_key = 'sk_test_xxxxxxxxx'
|
393
388
|
end
|
394
389
|
|
395
|
-
api_instance = ClerkHttpClient::EmailSMSTemplatesApi.new
|
396
390
|
template_type = 'email' # String | The type of template to update
|
397
391
|
slug = 'slug_example' # String | The slug of the template to update
|
398
392
|
opts = {
|
@@ -401,14 +395,14 @@ opts = {
|
|
401
395
|
|
402
396
|
begin
|
403
397
|
# Update a template for a given type and slug
|
404
|
-
result =
|
398
|
+
result = Clerk::SDK.email_sms_templates.upsert_template(template_type, slug, opts)
|
405
399
|
p result
|
406
400
|
rescue ClerkHttpClient::ApiError => e
|
407
|
-
puts "Error when calling
|
401
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->upsert_template: #{e}"
|
408
402
|
end
|
409
403
|
```
|
410
404
|
|
411
|
-
#### Using the upsert_template_with_http_info variant
|
405
|
+
#### Using the `upsert_template_with_http_info variant
|
412
406
|
|
413
407
|
This returns an Array which contains the response data, status code and headers.
|
414
408
|
|
@@ -417,12 +411,12 @@ This returns an Array which contains the response data, status code and headers.
|
|
417
411
|
```ruby
|
418
412
|
begin
|
419
413
|
# Update a template for a given type and slug
|
420
|
-
data, status_code, headers =
|
414
|
+
data, status_code, headers = Clerk::SDK.email_sms_templates.upsert_template_with_http_info(template_type, slug, opts)
|
421
415
|
p status_code # => 2xx
|
422
416
|
p headers # => { ... }
|
423
417
|
p data # => <Template>
|
424
418
|
rescue ClerkHttpClient::ApiError => e
|
425
|
-
puts "Error when calling
|
419
|
+
puts "Error when calling Clerk::SDK.email_sms_templates->upsert_template_with_http_info: #{e}"
|
426
420
|
end
|
427
421
|
```
|
428
422
|
|
data/docs/FromOauth.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# ClerkHttpClient::FromOAuth
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | |
|
8
|
+
| **strategy** | **String** | | |
|
9
|
+
| **error** | [**FromOAuthError**](FromOAuthError.md) | | [optional] |
|
10
|
+
| **expire_at** | **Integer** | | |
|
11
|
+
| **attempts** | **Integer** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'clerk-http-client'
|
17
|
+
|
18
|
+
instance = ClerkHttpClient::FromOAuth.new(
|
19
|
+
status: null,
|
20
|
+
strategy: null,
|
21
|
+
error: null,
|
22
|
+
expire_at: null,
|
23
|
+
attempts: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# ClerkHttpClient::FromOAuthError
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'clerk-http-client'
|
13
|
+
|
14
|
+
ClerkHttpClient::FromOAuthError.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'ClerkError'
|
18
|
+
# ]
|
19
|
+
```
|
20
|
+
|
21
|
+
### build
|
22
|
+
|
23
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
24
|
+
|
25
|
+
#### Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'clerk-http-client'
|
29
|
+
|
30
|
+
ClerkHttpClient::FromOAuthError.build(data)
|
31
|
+
# => #<ClerkError:0x00007fdd4aab02a0>
|
32
|
+
|
33
|
+
ClerkHttpClient::FromOAuthError.build(data_that_doesnt_match)
|
34
|
+
# => nil
|
35
|
+
```
|
36
|
+
|
37
|
+
#### Parameters
|
38
|
+
|
39
|
+
| Name | Type | Description |
|
40
|
+
| ---- | ---- | ----------- |
|
41
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
42
|
+
|
43
|
+
#### Return type
|
44
|
+
|
45
|
+
- `ClerkError`
|
46
|
+
- `nil` (if no type matches)
|
47
|
+
|