Classes
UserApi
Parameters | |
---|---|
api_client=None | |
METHODS
accept_eula
GetUserResponse
.
Parameters | |
---|---|
self | |
accept_eula_request | edgeimpulse_api.models.accept_eula_request.AcceptEulaRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
accept_terms_of_service
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
activate_current_user
Parameters | |
---|---|
self | |
activate_user_or_verify_email_request | edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
activate_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
activate_user_or_verify_email_request | edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
activate_user_by_third_party_activation_code
Parameters | |
---|---|
self | |
activate_user_by_third_party_activation_code_request | edgeimpulse_api.models.activate_user_by_third_party_activation_code_request.ActivateUserByThirdPartyActivationCodeRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_jwt_response.GetJWTResponse |
change_password_current_user
Parameters | |
---|---|
self | |
change_password_request | edgeimpulse_api.models.change_password_request.ChangePasswordRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
change_password_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
change_password_request | edgeimpulse_api.models.change_password_request.ChangePasswordRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
convert_current_user
Parameters | |
---|---|
self | |
convert_user_request | edgeimpulse_api.models.convert_user_request.ConvertUserRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
create_developer_profile
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.create_developer_profile_response.CreateDeveloperProfileResponse |
create_enterprise_trial_user
Parameters | |
---|---|
self | |
create_enterprise_trial_user_request | Annotated[edgeimpulse_api.models.create_enterprise_trial_user_request.CreateEnterpriseTrialUserRequest, FieldInfo(annotation=NoneType, required=True, description='Trial request')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.create_enterprise_trial_response.CreateEnterpriseTrialResponse |
create_pro_tier_user
Parameters | |
---|---|
self | |
create_pro_tier_user_request | edgeimpulse_api.models.create_pro_tier_user_request.CreateProTierUserRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.create_user_response.CreateUserResponse |
create_user
Parameters | |
---|---|
self | |
create_user_request | edgeimpulse_api.models.create_user_request.CreateUserRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.create_user_response.CreateUserResponse |
delete_current_user
Parameters | |
---|---|
self | |
delete_user_request | edgeimpulse_api.models.delete_user_request.DeleteUserRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
delete_photo_current_user
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
delete_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
delete_user_request | edgeimpulse_api.models.delete_user_request.DeleteUserRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
get_current_user
Parameters | |
---|---|
self | |
exclude_projects | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set to "true", the "projects" field is left empty (will be faster if you call this function a lot). Use getCurrentUserProjects to get the project list in a separate call.')] = None |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_user_response.GetUserResponse |
get_current_user_projects
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_user_projects_response.GetUserProjectsResponse |
get_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_user_response.GetUserResponse |
get_user_by_third_party_activation_code
Parameters | |
---|---|
self | |
user_by_third_party_activation_request | edgeimpulse_api.models.user_by_third_party_activation_request.UserByThirdPartyActivationRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_user_response.GetUserResponse |
get_user_need_to_set_password
Parameters | |
---|---|
self | |
username_or_email | Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Username or email')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.get_user_need_to_set_password_response.GetUserNeedToSetPasswordResponse |
list_emails_current_user
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_email_response.ListEmailResponse |
list_emails_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_email_response.ListEmailResponse |
list_enterprise_trials_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_enterprise_trials_response.ListEnterpriseTrialsResponse |
list_organization_buckets_current_user
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_organization_buckets_user_response.ListOrganizationBucketsUserResponse |
list_organization_buckets_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_organization_buckets_user_response.ListOrganizationBucketsUserResponse |
list_organizations_current_user
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse |
list_organizations_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse |
request_activation_code_current_user
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
request_activation_code_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
request_reset_password
Parameters | |
---|---|
self | |
request_reset_password_request | edgeimpulse_api.models.request_reset_password_request.RequestResetPasswordRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
reset_password
Parameters | |
---|---|
self | |
reset_password_request | edgeimpulse_api.models.reset_password_request.ResetPasswordRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
send_user_feedback
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
send_user_feedback_request | edgeimpulse_api.models.send_user_feedback_request.SendUserFeedbackRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
send_user_upgrade_request
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
enterprise_upgrade_or_trial_extension_request | edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request.EnterpriseUpgradeOrTrialExtensionRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_user_password
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
set_user_password_request | edgeimpulse_api.models.set_user_password_request.SetUserPasswordRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
start_enterprise_trial
Parameters | |
---|---|
self | |
start_enterprise_trial_request | edgeimpulse_api.models.start_enterprise_trial_request.StartEnterpriseTrialRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.create_enterprise_trial_response.CreateEnterpriseTrialResponse |
update_current_user
Parameters | |
---|---|
self | |
update_user_request | edgeimpulse_api.models.update_user_request.UpdateUserRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
update_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
update_user_request | edgeimpulse_api.models.update_user_request.UpdateUserRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
upload_photo_current_user
Parameters | |
---|---|
self | |
photo | Annotated[str, Strict(strict=True)] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.upload_user_photo_response.UploadUserPhotoResponse |
upload_photo_user
Parameters | |
---|---|
self | |
user_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='User ID')] |
photo | Annotated[str, Strict(strict=True)] |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.upload_user_photo_response.UploadUserPhotoResponse |
user_cancel_subscription
Parameters | |
---|---|
self | |
downgrade_subscription_request | edgeimpulse_api.models.downgrade_subscription_request.DowngradeSubscriptionRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
user_delete_totp_mfa_key
Parameters | |
---|---|
self | |
user_delete_totp_mfa_key_request | edgeimpulse_api.models.user_delete_totp_mfa_key_request.UserDeleteTotpMfaKeyRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
user_dismiss_notification
Parameters | |
---|---|
self | |
user_dismiss_notification_request | edgeimpulse_api.models.user_dismiss_notification_request.UserDismissNotificationRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
user_generate_new_totp_mfa_key
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.user_generate_new_mfa_key_response.UserGenerateNewMfaKeyResponse |
user_get_subscription_metrics
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.user_subscription_metrics_response.UserSubscriptionMetricsResponse |
user_set_totp_mfa_key
userGenerateNewTotpMfaKey
.
Parameters | |
---|---|
self | |
user_set_totp_mfa_key_request | edgeimpulse_api.models.user_set_totp_mfa_key_request.UserSetTotpMfaKeyRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.user_set_totp_mfa_key_response.UserSetTotpMfaKeyResponse |
user_undo_cancel_subscription
Parameters | |
---|---|
self | |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
user_upgrade_subscription
Parameters | |
---|---|
self | |
upgrade_subscription_request | edgeimpulse_api.models.upgrade_subscription_request.UpgradeSubscriptionRequest |
**kwargs | |
Returns |
---|
None |
verify_reset_password
Parameters | |
---|---|
self | |
verify_reset_password_request | edgeimpulse_api.models.verify_reset_password_request.VerifyResetPasswordRequest |
**kwargs | |
Returns |
---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |