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
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
Contact: support@clerk.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
Generator version:
|
9
|
+
Generator version: unset
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -22,23 +22,23 @@ module ClerkHttpClient
|
|
22
22
|
# Create and send an organization invitation
|
23
23
|
# Creates a new organization invitation and sends an email to the provided `email_address` with a link to accept the invitation and join the organization. You can specify the `role` for the invited organization member. New organization invitations get a \"pending\" status until they are revoked by an organization administrator or accepted by the invitee. The request body supports passing an optional `redirect_url` parameter. When the invited user clicks the link to accept the invitation, they will be redirected to the URL provided. Use this parameter to implement a custom invitation acceptance flow. You can specify the ID of the user that will send the invitation with the `inviter_user_id` parameter. That user must be a member with administrator privileges in the organization. Only \"admin\" members can create organization invitations. You can optionally provide public and private metadata for the organization invitation. The public metadata are visible by both the Frontend and the Backend whereas the private ones only by the Backend. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
|
24
24
|
# @param organization_id [String] The ID of the organization for which to send the invitation
|
25
|
-
# @param create_organization_invitation_request [CreateOrganizationInvitationRequest]
|
26
25
|
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [CreateOrganizationInvitationRequest] :create_organization_invitation_request
|
27
27
|
# @return [OrganizationInvitation]
|
28
28
|
|
29
|
-
def
|
30
|
-
data, _status_code, _headers =
|
29
|
+
def create_organization_invitation(organization_id, opts = {})
|
30
|
+
data, _status_code, _headers = create_organization_invitation_with_http_info(organization_id, opts)
|
31
31
|
data
|
32
32
|
end
|
33
33
|
|
34
34
|
# Create and send an organization invitation
|
35
35
|
# Creates a new organization invitation and sends an email to the provided `email_address` with a link to accept the invitation and join the organization. You can specify the `role` for the invited organization member. New organization invitations get a \"pending\" status until they are revoked by an organization administrator or accepted by the invitee. The request body supports passing an optional `redirect_url` parameter. When the invited user clicks the link to accept the invitation, they will be redirected to the URL provided. Use this parameter to implement a custom invitation acceptance flow. You can specify the ID of the user that will send the invitation with the `inviter_user_id` parameter. That user must be a member with administrator privileges in the organization. Only \"admin\" members can create organization invitations. You can optionally provide public and private metadata for the organization invitation. The public metadata are visible by both the Frontend and the Backend whereas the private ones only by the Backend. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
|
36
36
|
# @param organization_id [String] The ID of the organization for which to send the invitation
|
37
|
-
# @param create_organization_invitation_request [CreateOrganizationInvitationRequest]
|
38
37
|
# @param [Hash] opts the optional parameters
|
38
|
+
# @option opts [CreateOrganizationInvitationRequest] :create_organization_invitation_request
|
39
39
|
# @return [Array<(OrganizationInvitation, Integer, Hash)>] OrganizationInvitation data, response status code and response headers
|
40
40
|
# POST
|
41
|
-
def
|
41
|
+
def create_organization_invitation_with_http_info(organization_id, opts = {})
|
42
42
|
if @api_client.config.debugging
|
43
43
|
@api_client.config.logger.debug 'Calling API: OrganizationInvitationsApi.create_organization_invitation ...'
|
44
44
|
end
|
@@ -46,10 +46,6 @@ module ClerkHttpClient
|
|
46
46
|
if @api_client.config.client_side_validation && organization_id.nil?
|
47
47
|
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationInvitationsApi.create_organization_invitation"
|
48
48
|
end
|
49
|
-
# verify the required parameter 'create_organization_invitation_request' is set
|
50
|
-
if @api_client.config.client_side_validation && create_organization_invitation_request.nil?
|
51
|
-
fail ArgumentError, "Missing the required parameter 'create_organization_invitation_request' when calling OrganizationInvitationsApi.create_organization_invitation"
|
52
|
-
end
|
53
49
|
# resource path
|
54
50
|
local_var_path = '/organizations/{organization_id}/invitations'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))
|
55
51
|
|
@@ -70,7 +66,7 @@ module ClerkHttpClient
|
|
70
66
|
form_params = opts[:form_params] || {}
|
71
67
|
|
72
68
|
# http body (model)
|
73
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_organization_invitation_request)
|
69
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_organization_invitation_request'])
|
74
70
|
|
75
71
|
# return_type
|
76
72
|
return_type = opts[:debug_return_type] || 'OrganizationInvitation'
|
@@ -102,8 +98,8 @@ module ClerkHttpClient
|
|
102
98
|
# @param [Hash] opts the optional parameters
|
103
99
|
# @return [OrganizationInvitations]
|
104
100
|
|
105
|
-
def
|
106
|
-
data, _status_code, _headers =
|
101
|
+
def create_organization_invitation_bulk(organization_id, create_organization_invitation_bulk_request_inner, opts = {})
|
102
|
+
data, _status_code, _headers = create_organization_invitation_bulk_with_http_info(organization_id, create_organization_invitation_bulk_request_inner, opts)
|
107
103
|
data
|
108
104
|
end
|
109
105
|
|
@@ -114,7 +110,7 @@ module ClerkHttpClient
|
|
114
110
|
# @param [Hash] opts the optional parameters
|
115
111
|
# @return [Array<(OrganizationInvitations, Integer, Hash)>] OrganizationInvitations data, response status code and response headers
|
116
112
|
# POST
|
117
|
-
def
|
113
|
+
def create_organization_invitation_bulk_with_http_info(organization_id, create_organization_invitation_bulk_request_inner, opts = {})
|
118
114
|
if @api_client.config.debugging
|
119
115
|
@api_client.config.logger.debug 'Calling API: OrganizationInvitationsApi.create_organization_invitation_bulk ...'
|
120
116
|
end
|
@@ -178,8 +174,8 @@ module ClerkHttpClient
|
|
178
174
|
# @param [Hash] opts the optional parameters
|
179
175
|
# @return [OrganizationInvitation]
|
180
176
|
|
181
|
-
def
|
182
|
-
data, _status_code, _headers =
|
177
|
+
def get_organization_invitation(organization_id, invitation_id, opts = {})
|
178
|
+
data, _status_code, _headers = get_organization_invitation_with_http_info(organization_id, invitation_id, opts)
|
183
179
|
data
|
184
180
|
end
|
185
181
|
|
@@ -190,7 +186,7 @@ module ClerkHttpClient
|
|
190
186
|
# @param [Hash] opts the optional parameters
|
191
187
|
# @return [Array<(OrganizationInvitation, Integer, Hash)>] OrganizationInvitation data, response status code and response headers
|
192
188
|
# GET
|
193
|
-
def
|
189
|
+
def get_organization_invitation_with_http_info(organization_id, invitation_id, opts = {})
|
194
190
|
if @api_client.config.debugging
|
195
191
|
@api_client.config.logger.debug 'Calling API: OrganizationInvitationsApi.get_organization_invitation ...'
|
196
192
|
end
|
@@ -252,8 +248,8 @@ module ClerkHttpClient
|
|
252
248
|
# @option opts [String] :query Filter organization invitations based on their `email_address`
|
253
249
|
# @return [OrganizationInvitationsWithPublicOrganizationData]
|
254
250
|
|
255
|
-
def
|
256
|
-
data, _status_code, _headers =
|
251
|
+
def list_instance_organization_invitations(opts = {})
|
252
|
+
data, _status_code, _headers = list_instance_organization_invitations_with_http_info(opts)
|
257
253
|
data
|
258
254
|
end
|
259
255
|
|
@@ -267,7 +263,7 @@ module ClerkHttpClient
|
|
267
263
|
# @option opts [String] :query Filter organization invitations based on their `email_address`
|
268
264
|
# @return [Array<(OrganizationInvitationsWithPublicOrganizationData, Integer, Hash)>] OrganizationInvitationsWithPublicOrganizationData data, response status code and response headers
|
269
265
|
# GET
|
270
|
-
def
|
266
|
+
def list_instance_organization_invitations_with_http_info(opts = {})
|
271
267
|
if @api_client.config.debugging
|
272
268
|
@api_client.config.logger.debug 'Calling API: OrganizationInvitationsApi.list_instance_organization_invitations ...'
|
273
269
|
end
|
@@ -341,8 +337,8 @@ module ClerkHttpClient
|
|
341
337
|
# @option opts [String] :status Filter organization invitations based on their status
|
342
338
|
# @return [OrganizationInvitations]
|
343
339
|
|
344
|
-
def
|
345
|
-
data, _status_code, _headers =
|
340
|
+
def list_organization_invitations(organization_id, opts = {})
|
341
|
+
data, _status_code, _headers = list_organization_invitations_with_http_info(organization_id, opts)
|
346
342
|
data
|
347
343
|
end
|
348
344
|
|
@@ -355,7 +351,7 @@ module ClerkHttpClient
|
|
355
351
|
# @option opts [String] :status Filter organization invitations based on their status
|
356
352
|
# @return [Array<(OrganizationInvitations, Integer, Hash)>] OrganizationInvitations data, response status code and response headers
|
357
353
|
# GET
|
358
|
-
def
|
354
|
+
def list_organization_invitations_with_http_info(organization_id, opts = {})
|
359
355
|
if @api_client.config.debugging
|
360
356
|
@api_client.config.logger.debug 'Calling API: OrganizationInvitationsApi.list_organization_invitations ...'
|
361
357
|
end
|
@@ -430,8 +426,8 @@ module ClerkHttpClient
|
|
430
426
|
# @option opts [Float] :offset Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. (default to 0)
|
431
427
|
# @return [OrganizationInvitations]
|
432
428
|
|
433
|
-
def
|
434
|
-
data, _status_code, _headers =
|
429
|
+
def list_pending_organization_invitations(organization_id, opts = {})
|
430
|
+
data, _status_code, _headers = list_pending_organization_invitations_with_http_info(organization_id, opts)
|
435
431
|
data
|
436
432
|
end
|
437
433
|
|
@@ -443,7 +439,7 @@ module ClerkHttpClient
|
|
443
439
|
# @option opts [Float] :offset Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. (default to 0)
|
444
440
|
# @return [Array<(OrganizationInvitations, Integer, Hash)>] OrganizationInvitations data, response status code and response headers
|
445
441
|
# GET
|
446
|
-
def
|
442
|
+
def list_pending_organization_invitations_with_http_info(organization_id, opts = {})
|
447
443
|
if @api_client.config.debugging
|
448
444
|
@api_client.config.logger.debug 'Calling API: OrganizationInvitationsApi.list_pending_organization_invitations ...'
|
449
445
|
end
|
@@ -513,8 +509,8 @@ module ClerkHttpClient
|
|
513
509
|
# @option opts [RevokeOrganizationInvitationRequest] :revoke_organization_invitation_request
|
514
510
|
# @return [OrganizationInvitation]
|
515
511
|
|
516
|
-
def
|
517
|
-
data, _status_code, _headers =
|
512
|
+
def revoke_organization_invitation(organization_id, invitation_id, opts = {})
|
513
|
+
data, _status_code, _headers = revoke_organization_invitation_with_http_info(organization_id, invitation_id, opts)
|
518
514
|
data
|
519
515
|
end
|
520
516
|
|
@@ -526,7 +522,7 @@ module ClerkHttpClient
|
|
526
522
|
# @option opts [RevokeOrganizationInvitationRequest] :revoke_organization_invitation_request
|
527
523
|
# @return [Array<(OrganizationInvitation, Integer, Hash)>] OrganizationInvitation data, response status code and response headers
|
528
524
|
# POST
|
529
|
-
def
|
525
|
+
def revoke_organization_invitation_with_http_info(organization_id, invitation_id, opts = {})
|
530
526
|
if @api_client.config.debugging
|
531
527
|
@api_client.config.logger.debug 'Calling API: OrganizationInvitationsApi.revoke_organization_invitation ...'
|
532
528
|
end
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
Contact: support@clerk.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
Generator version:
|
9
|
+
Generator version: unset
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -26,8 +26,8 @@ module ClerkHttpClient
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [OrganizationMembership]
|
28
28
|
|
29
|
-
def
|
30
|
-
data, _status_code, _headers =
|
29
|
+
def create_organization_membership(organization_id, create_organization_membership_request, opts = {})
|
30
|
+
data, _status_code, _headers = create_organization_membership_with_http_info(organization_id, create_organization_membership_request, opts)
|
31
31
|
data
|
32
32
|
end
|
33
33
|
|
@@ -38,7 +38,7 @@ module ClerkHttpClient
|
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
39
|
# @return [Array<(OrganizationMembership, Integer, Hash)>] OrganizationMembership data, response status code and response headers
|
40
40
|
# POST
|
41
|
-
def
|
41
|
+
def create_organization_membership_with_http_info(organization_id, create_organization_membership_request, opts = {})
|
42
42
|
if @api_client.config.debugging
|
43
43
|
@api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.create_organization_membership ...'
|
44
44
|
end
|
@@ -102,8 +102,8 @@ module ClerkHttpClient
|
|
102
102
|
# @param [Hash] opts the optional parameters
|
103
103
|
# @return [OrganizationMembership]
|
104
104
|
|
105
|
-
def
|
106
|
-
data, _status_code, _headers =
|
105
|
+
def delete_organization_membership(organization_id, user_id, opts = {})
|
106
|
+
data, _status_code, _headers = delete_organization_membership_with_http_info(organization_id, user_id, opts)
|
107
107
|
data
|
108
108
|
end
|
109
109
|
|
@@ -114,7 +114,7 @@ module ClerkHttpClient
|
|
114
114
|
# @param [Hash] opts the optional parameters
|
115
115
|
# @return [Array<(OrganizationMembership, Integer, Hash)>] OrganizationMembership data, response status code and response headers
|
116
116
|
# DELETE
|
117
|
-
def
|
117
|
+
def delete_organization_membership_with_http_info(organization_id, user_id, opts = {})
|
118
118
|
if @api_client.config.debugging
|
119
119
|
@api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.delete_organization_membership ...'
|
120
120
|
end
|
@@ -174,8 +174,8 @@ module ClerkHttpClient
|
|
174
174
|
# @option opts [String] :order_by Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.
|
175
175
|
# @return [OrganizationMemberships]
|
176
176
|
|
177
|
-
def
|
178
|
-
data, _status_code, _headers =
|
177
|
+
def instance_get_organization_memberships(opts = {})
|
178
|
+
data, _status_code, _headers = instance_get_organization_memberships_with_http_info(opts)
|
179
179
|
data
|
180
180
|
end
|
181
181
|
|
@@ -187,7 +187,7 @@ module ClerkHttpClient
|
|
187
187
|
# @option opts [String] :order_by Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.
|
188
188
|
# @return [Array<(OrganizationMemberships, Integer, Hash)>] OrganizationMemberships data, response status code and response headers
|
189
189
|
# GET
|
190
|
-
def
|
190
|
+
def instance_get_organization_memberships_with_http_info(opts = {})
|
191
191
|
if @api_client.config.debugging
|
192
192
|
@api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.instance_get_organization_memberships ...'
|
193
193
|
end
|
@@ -255,8 +255,8 @@ module ClerkHttpClient
|
|
255
255
|
# @option opts [String] :order_by Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.\"
|
256
256
|
# @return [OrganizationMemberships]
|
257
257
|
|
258
|
-
def
|
259
|
-
data, _status_code, _headers =
|
258
|
+
def list_organization_memberships(organization_id, opts = {})
|
259
|
+
data, _status_code, _headers = list_organization_memberships_with_http_info(organization_id, opts)
|
260
260
|
data
|
261
261
|
end
|
262
262
|
|
@@ -269,7 +269,7 @@ module ClerkHttpClient
|
|
269
269
|
# @option opts [String] :order_by Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username. By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.\"
|
270
270
|
# @return [Array<(OrganizationMemberships, Integer, Hash)>] OrganizationMemberships data, response status code and response headers
|
271
271
|
# GET
|
272
|
-
def
|
272
|
+
def list_organization_memberships_with_http_info(organization_id, opts = {})
|
273
273
|
if @api_client.config.debugging
|
274
274
|
@api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.list_organization_memberships ...'
|
275
275
|
end
|
@@ -340,8 +340,8 @@ module ClerkHttpClient
|
|
340
340
|
# @param [Hash] opts the optional parameters
|
341
341
|
# @return [OrganizationMembership]
|
342
342
|
|
343
|
-
def
|
344
|
-
data, _status_code, _headers =
|
343
|
+
def update_organization_membership(organization_id, user_id, update_organization_membership_request, opts = {})
|
344
|
+
data, _status_code, _headers = update_organization_membership_with_http_info(organization_id, user_id, update_organization_membership_request, opts)
|
345
345
|
data
|
346
346
|
end
|
347
347
|
|
@@ -353,7 +353,7 @@ module ClerkHttpClient
|
|
353
353
|
# @param [Hash] opts the optional parameters
|
354
354
|
# @return [Array<(OrganizationMembership, Integer, Hash)>] OrganizationMembership data, response status code and response headers
|
355
355
|
# PATCH
|
356
|
-
def
|
356
|
+
def update_organization_membership_with_http_info(organization_id, user_id, update_organization_membership_request, opts = {})
|
357
357
|
if @api_client.config.debugging
|
358
358
|
@api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.update_organization_membership ...'
|
359
359
|
end
|
@@ -418,12 +418,12 @@ module ClerkHttpClient
|
|
418
418
|
# Update an organization membership's metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to `null`.
|
419
419
|
# @param organization_id [String] The ID of the organization the membership belongs to
|
420
420
|
# @param user_id [String] The ID of the user that this membership belongs to
|
421
|
-
# @param update_organization_membership_metadata_request [UpdateOrganizationMembershipMetadataRequest]
|
422
421
|
# @param [Hash] opts the optional parameters
|
422
|
+
# @option opts [UpdateOrganizationMembershipMetadataRequest] :update_organization_membership_metadata_request
|
423
423
|
# @return [OrganizationMembership]
|
424
424
|
|
425
|
-
def
|
426
|
-
data, _status_code, _headers =
|
425
|
+
def update_organization_membership_metadata(organization_id, user_id, opts = {})
|
426
|
+
data, _status_code, _headers = update_organization_membership_metadata_with_http_info(organization_id, user_id, opts)
|
427
427
|
data
|
428
428
|
end
|
429
429
|
|
@@ -431,11 +431,11 @@ module ClerkHttpClient
|
|
431
431
|
# Update an organization membership's metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to `null`.
|
432
432
|
# @param organization_id [String] The ID of the organization the membership belongs to
|
433
433
|
# @param user_id [String] The ID of the user that this membership belongs to
|
434
|
-
# @param update_organization_membership_metadata_request [UpdateOrganizationMembershipMetadataRequest]
|
435
434
|
# @param [Hash] opts the optional parameters
|
435
|
+
# @option opts [UpdateOrganizationMembershipMetadataRequest] :update_organization_membership_metadata_request
|
436
436
|
# @return [Array<(OrganizationMembership, Integer, Hash)>] OrganizationMembership data, response status code and response headers
|
437
437
|
# PATCH
|
438
|
-
def
|
438
|
+
def update_organization_membership_metadata_with_http_info(organization_id, user_id, opts = {})
|
439
439
|
if @api_client.config.debugging
|
440
440
|
@api_client.config.logger.debug 'Calling API: OrganizationMembershipsApi.update_organization_membership_metadata ...'
|
441
441
|
end
|
@@ -447,10 +447,6 @@ module ClerkHttpClient
|
|
447
447
|
if @api_client.config.client_side_validation && user_id.nil?
|
448
448
|
fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationMembershipsApi.update_organization_membership_metadata"
|
449
449
|
end
|
450
|
-
# verify the required parameter 'update_organization_membership_metadata_request' is set
|
451
|
-
if @api_client.config.client_side_validation && update_organization_membership_metadata_request.nil?
|
452
|
-
fail ArgumentError, "Missing the required parameter 'update_organization_membership_metadata_request' when calling OrganizationMembershipsApi.update_organization_membership_metadata"
|
453
|
-
end
|
454
450
|
# resource path
|
455
451
|
local_var_path = '/organizations/{organization_id}/memberships/{user_id}/metadata'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
|
456
452
|
|
@@ -471,7 +467,7 @@ module ClerkHttpClient
|
|
471
467
|
form_params = opts[:form_params] || {}
|
472
468
|
|
473
469
|
# http body (model)
|
474
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_organization_membership_metadata_request)
|
470
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_organization_membership_metadata_request'])
|
475
471
|
|
476
472
|
# return_type
|
477
473
|
return_type = opts[:debug_return_type] || 'OrganizationMembership'
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
Contact: support@clerk.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
Generator version:
|
9
|
+
Generator version: unset
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -20,30 +20,26 @@ module ClerkHttpClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create an organization
|
23
|
-
# Creates a new organization with the given name for an instance.
|
24
|
-
# @param create_organization_request [CreateOrganizationRequest]
|
23
|
+
# Creates a new organization with the given name for an instance. You can specify an optional slug for the new organization. If provided, the organization slug can contain only lowercase alphanumeric characters (letters and digits) and the dash \"-\". Organization slugs must be unique for the instance. You can provide additional metadata for the organization and set any custom attribute you want. Organizations support private and public metadata. Private metadata can only be accessed from the Backend API. Public metadata can be accessed from the Backend API, and are read-only from the Frontend API. The `created_by` user will see this as their [active organization] (https://clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don't explicitly set a different organization as active before then.
|
25
24
|
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [CreateOrganizationRequest] :create_organization_request
|
26
26
|
# @return [Organization]
|
27
27
|
|
28
|
-
def
|
29
|
-
data, _status_code, _headers =
|
28
|
+
def create_organization(opts = {})
|
29
|
+
data, _status_code, _headers = create_organization_with_http_info(opts)
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
33
|
# Create an organization
|
34
|
-
# Creates a new organization with the given name for an instance.
|
35
|
-
# @param create_organization_request [CreateOrganizationRequest]
|
34
|
+
# Creates a new organization with the given name for an instance. You can specify an optional slug for the new organization. If provided, the organization slug can contain only lowercase alphanumeric characters (letters and digits) and the dash \"-\". Organization slugs must be unique for the instance. You can provide additional metadata for the organization and set any custom attribute you want. Organizations support private and public metadata. Private metadata can only be accessed from the Backend API. Public metadata can be accessed from the Backend API, and are read-only from the Frontend API. The `created_by` user will see this as their [active organization] (https://clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don't explicitly set a different organization as active before then.
|
36
35
|
# @param [Hash] opts the optional parameters
|
36
|
+
# @option opts [CreateOrganizationRequest] :create_organization_request
|
37
37
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
38
38
|
# POST
|
39
|
-
def
|
39
|
+
def create_organization_with_http_info(opts = {})
|
40
40
|
if @api_client.config.debugging
|
41
41
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.create_organization ...'
|
42
42
|
end
|
43
|
-
# verify the required parameter 'create_organization_request' is set
|
44
|
-
if @api_client.config.client_side_validation && create_organization_request.nil?
|
45
|
-
fail ArgumentError, "Missing the required parameter 'create_organization_request' when calling OrganizationsApi.create_organization"
|
46
|
-
end
|
47
43
|
# resource path
|
48
44
|
local_var_path = '/organizations'
|
49
45
|
|
@@ -64,7 +60,7 @@ module ClerkHttpClient
|
|
64
60
|
form_params = opts[:form_params] || {}
|
65
61
|
|
66
62
|
# http body (model)
|
67
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_organization_request)
|
63
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_organization_request'])
|
68
64
|
|
69
65
|
# return_type
|
70
66
|
return_type = opts[:debug_return_type] || 'Organization'
|
@@ -95,8 +91,8 @@ module ClerkHttpClient
|
|
95
91
|
# @param [Hash] opts the optional parameters
|
96
92
|
# @return [DeletedObject]
|
97
93
|
|
98
|
-
def
|
99
|
-
data, _status_code, _headers =
|
94
|
+
def delete_organization(organization_id, opts = {})
|
95
|
+
data, _status_code, _headers = delete_organization_with_http_info(organization_id, opts)
|
100
96
|
data
|
101
97
|
end
|
102
98
|
|
@@ -106,7 +102,7 @@ module ClerkHttpClient
|
|
106
102
|
# @param [Hash] opts the optional parameters
|
107
103
|
# @return [Array<(DeletedObject, Integer, Hash)>] DeletedObject data, response status code and response headers
|
108
104
|
# DELETE
|
109
|
-
def
|
105
|
+
def delete_organization_with_http_info(organization_id, opts = {})
|
110
106
|
if @api_client.config.debugging
|
111
107
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.delete_organization ...'
|
112
108
|
end
|
@@ -159,8 +155,8 @@ module ClerkHttpClient
|
|
159
155
|
# @param [Hash] opts the optional parameters
|
160
156
|
# @return [Organization]
|
161
157
|
|
162
|
-
def
|
163
|
-
data, _status_code, _headers =
|
158
|
+
def delete_organization_logo(organization_id, opts = {})
|
159
|
+
data, _status_code, _headers = delete_organization_logo_with_http_info(organization_id, opts)
|
164
160
|
data
|
165
161
|
end
|
166
162
|
|
@@ -169,7 +165,7 @@ module ClerkHttpClient
|
|
169
165
|
# @param [Hash] opts the optional parameters
|
170
166
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
171
167
|
# DELETE
|
172
|
-
def
|
168
|
+
def delete_organization_logo_with_http_info(organization_id, opts = {})
|
173
169
|
if @api_client.config.debugging
|
174
170
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.delete_organization_logo ...'
|
175
171
|
end
|
@@ -224,8 +220,8 @@ module ClerkHttpClient
|
|
224
220
|
# @option opts [Boolean] :include_members_count Flag to denote whether or not the organization's members count should be included in the response.
|
225
221
|
# @return [Organization]
|
226
222
|
|
227
|
-
def
|
228
|
-
data, _status_code, _headers =
|
223
|
+
def get_organization(organization_id, opts = {})
|
224
|
+
data, _status_code, _headers = get_organization_with_http_info(organization_id, opts)
|
229
225
|
data
|
230
226
|
end
|
231
227
|
|
@@ -236,7 +232,7 @@ module ClerkHttpClient
|
|
236
232
|
# @option opts [Boolean] :include_members_count Flag to denote whether or not the organization's members count should be included in the response.
|
237
233
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
238
234
|
# GET
|
239
|
-
def
|
235
|
+
def get_organization_with_http_info(organization_id, opts = {})
|
240
236
|
if @api_client.config.debugging
|
241
237
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization ...'
|
242
238
|
end
|
@@ -295,8 +291,8 @@ module ClerkHttpClient
|
|
295
291
|
# @option opts [String] :order_by Allows to return organizations in a particular order. At the moment, you can order the returned organizations either by their `name`, `created_at` or `members_count`. In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by. For example, if you want organizations to be returned in descending order according to their `created_at` property, you can use `-created_at`. If you don't use `+` or `-`, then `+` is implied. Defaults to `-created_at`. (default to '-created_at')
|
296
292
|
# @return [Organizations]
|
297
293
|
|
298
|
-
def
|
299
|
-
data, _status_code, _headers =
|
294
|
+
def list_organizations(opts = {})
|
295
|
+
data, _status_code, _headers = list_organizations_with_http_info(opts)
|
300
296
|
data
|
301
297
|
end
|
302
298
|
|
@@ -310,7 +306,7 @@ module ClerkHttpClient
|
|
310
306
|
# @option opts [String] :order_by Allows to return organizations in a particular order. At the moment, you can order the returned organizations either by their `name`, `created_at` or `members_count`. In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by. For example, if you want organizations to be returned in descending order according to their `created_at` property, you can use `-created_at`. If you don't use `+` or `-`, then `+` is implied. Defaults to `-created_at`. (default to '-created_at')
|
311
307
|
# @return [Array<(Organizations, Integer, Hash)>] Organizations data, response status code and response headers
|
312
308
|
# GET
|
313
|
-
def
|
309
|
+
def list_organizations_with_http_info(opts = {})
|
314
310
|
if @api_client.config.debugging
|
315
311
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.list_organizations ...'
|
316
312
|
end
|
@@ -378,8 +374,8 @@ module ClerkHttpClient
|
|
378
374
|
# @param [Hash] opts the optional parameters
|
379
375
|
# @return [Organization]
|
380
376
|
|
381
|
-
def
|
382
|
-
data, _status_code, _headers =
|
377
|
+
def merge_organization_metadata(organization_id, merge_organization_metadata_request, opts = {})
|
378
|
+
data, _status_code, _headers = merge_organization_metadata_with_http_info(organization_id, merge_organization_metadata_request, opts)
|
383
379
|
data
|
384
380
|
end
|
385
381
|
|
@@ -390,7 +386,7 @@ module ClerkHttpClient
|
|
390
386
|
# @param [Hash] opts the optional parameters
|
391
387
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
392
388
|
# PATCH
|
393
|
-
def
|
389
|
+
def merge_organization_metadata_with_http_info(organization_id, merge_organization_metadata_request, opts = {})
|
394
390
|
if @api_client.config.debugging
|
395
391
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.merge_organization_metadata ...'
|
396
392
|
end
|
@@ -454,8 +450,8 @@ module ClerkHttpClient
|
|
454
450
|
# @param [Hash] opts the optional parameters
|
455
451
|
# @return [Organization]
|
456
452
|
|
457
|
-
def
|
458
|
-
data, _status_code, _headers =
|
453
|
+
def update_organization(organization_id, update_organization_request, opts = {})
|
454
|
+
data, _status_code, _headers = update_organization_with_http_info(organization_id, update_organization_request, opts)
|
459
455
|
data
|
460
456
|
end
|
461
457
|
|
@@ -466,7 +462,7 @@ module ClerkHttpClient
|
|
466
462
|
# @param [Hash] opts the optional parameters
|
467
463
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
468
464
|
# PATCH
|
469
|
-
def
|
465
|
+
def update_organization_with_http_info(organization_id, update_organization_request, opts = {})
|
470
466
|
if @api_client.config.debugging
|
471
467
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.update_organization ...'
|
472
468
|
end
|
@@ -531,8 +527,8 @@ module ClerkHttpClient
|
|
531
527
|
# @option opts [String] :uploader_user_id The ID of the user that will be credited with the image upload.
|
532
528
|
# @return [OrganizationWithLogo]
|
533
529
|
|
534
|
-
def
|
535
|
-
data, _status_code, _headers =
|
530
|
+
def upload_organization_logo(organization_id, file, opts = {})
|
531
|
+
data, _status_code, _headers = upload_organization_logo_with_http_info(organization_id, file, opts)
|
536
532
|
data
|
537
533
|
end
|
538
534
|
|
@@ -544,7 +540,7 @@ module ClerkHttpClient
|
|
544
540
|
# @option opts [String] :uploader_user_id The ID of the user that will be credited with the image upload.
|
545
541
|
# @return [Array<(OrganizationWithLogo, Integer, Hash)>] OrganizationWithLogo data, response status code and response headers
|
546
542
|
# PUT
|
547
|
-
def
|
543
|
+
def upload_organization_logo_with_http_info(organization_id, file, opts = {})
|
548
544
|
if @api_client.config.debugging
|
549
545
|
@api_client.config.logger.debug 'Calling API: OrganizationsApi.upload_organization_logo ...'
|
550
546
|
end
|