import { SdPlatformOrganizationMemberRole } from "../commons/SdPlatformOrganizationCommons"; import { SdPlatformUserVisibility } from "../commons/SdPlatformVisibility"; import { SdPlatformUserTokenScopes } from "../commons/SdPlatformUserTokenScopes"; /** * DTO for request a password reset request */ export interface SdPlatformRequestUserPasswordReset { /** * The email. */ email: string; } /** * DTO for confirming a password reset request */ export interface SdPlatformRequestUserPasswordResetConfirm { /** * The token. */ token: string; /** * The password. */ password?: string; /** * The password confirmation. */ password_confirmation?: string; } /** * DTO for registering a new user */ export interface SdPlatformRequestUserRegister { /** * The email. */ email: string; /** * The password. */ password: string; /** * The password confirmation. */ password_confirmation: string; /** * Friendly Captcha solution token. */ friendly_captcha_solution: string; } /** * DTO for patching a user */ export interface SdPlatformRequestUserPatch { /** * Username, minimum 5 characters. */ username?: string; /** * avatar image base64 encoded, maximum 1MB */ avatar?: string; /** * Location of the user. */ location?: string; /** * Website of the user. */ website?: string; /** * Facebook id of the user. */ facebook_id?: string; /** * Instagram id of the user */ instagram_id?: string; /** * McNeel id of the user */ mcneel_id?: string; /** * LinkedIn id of the user. */ linkedin_id?: string; /** * Twitter id of the user. */ twitter_id?: string; /** * Bio of the user. */ bio?: string; /** * Accessdomains of the user. */ global_accessdomains?: Array; /** * Is the user subscribed to the newsletter? */ newsletter_subscribed?: boolean; /** * First name of the user. */ first_name?: string; /** * Last name of the user */ last_name?: string; /** * Country of the user. */ country?: string; /** * Company name. */ company_name?: string; /** * Primary reason of the user to use ShapeDiver (registration field). */ using_reason?: string; /** * User knows ShapeDiver from (registration field). */ know_source?: string; /** * Grasshopper know-how of the user (registration field). */ grasshopper_knowhow?: string; /** * Industry of the user (registration field). */ industry?: string; /** * Should the email address be exposed on the public profile page? Might be influenced by {@link SdPlatformResponseOrganizationMember.expose_email} */ expose_email?: boolean; /** * The old password. */ old_password?: string; /** * The new password. */ new_password?: string; /** * The new password confirmation. */ new_password_confirmation?: string; /** * Visibility of the user (may be limited by the visibility of the user's organization). */ visibility?: SdPlatformUserVisibility; /** * Should sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_sharing} */ allow_sharing?: boolean; /** * Should private link sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_link_sharing } */ allow_link_sharing?: boolean; /** * URL-compatible short name of the user. Used for links to the user's profile on the [ShapeDiver Platform](https://shapediver.com/app/users/{slug}). */ slug?: string; /** * updates the default backend system for the user, requires permission "update_default_backend_system" */ backend_system_id?: string; /** * updates the default backend system for the user based on the given backend system alias, * requires that the user has access to the backend system */ backend_system_alias?: string; /** * Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the user? Might be influenced by {@link SdPlatformResponseOrganizationMember.force_require_token} */ force_require_token?: boolean; /** * Mailing settings of the user. */ mailing?: { [id: string]: boolean; }; /** * Should credit consumption be limited once the monthly quota has been reached? */ limit_credit_consumption?: boolean; /** * Should model transfer requests be accepted without confirmation? */ transfers_accept_any?: boolean; /** * When accepting model transfer requests, should existing sharing relationships be removed? */ transfers_clear_sharing?: boolean; /** * When accepting model transfer requests, should policies requested by the providing user be shared back? */ transfers_accept_shareback?: boolean; /** The webhook receiver status of the user. */ webhook_receiver?: boolean; /** The webhook secret of the user. */ webhook_secret?: string; /** The webhook secret confirmation of the user. */ webhook_secret_confirmation?: string; /** Max excess credit */ max_excess_credits?: number; } /** * DTO for patching a user - admin access level */ export interface SdPlatformRequestUserPatchAdmin extends SdPlatformRequestUserPatch { /** manually activate / deactivate user */ active?: boolean; /** admin roles of the user */ roles?: Array; /** id of chargebee customer */ chargebee_customer_id?: string; /** set this to null to un-delete */ deleted_at?: null; /** manually assign user to an organization */ organization_id?: string; /** role of user in organization */ organization_role?: SdPlatformOrganizationMemberRole; } /** * DTO for getting a user token */ export interface SdPlatformRequestUserToken { timestamp_from: number; timestamp_to: number; scope: SdPlatformUserTokenScopes; } //# sourceMappingURL=SdPlatformRequestUser.d.ts.map