accountuserep

type AccountUserSvc interface {
	ListAccountUsers(ctx context.Context, req *ListAccountUsersRequest) (*apiresource.List[apiresource.AccountUser], *apierror.APIError)
	GetAccountUser(ctx context.Context, req *RetrieveAccountUserRequest) (*apiresource.AccountUser, *apierror.APIError)
	CreateAccountUser(ctx context.Context, req *CreateAccountUserRequest) (*apiresource.AccountUser, *apierror.APIError)
	UpdateAccountUser(ctx context.Context, req *UpdateAccountUserRequest) (*apiresource.AccountUser, *apierror.APIError)
	ActivateAccountUser(ctx context.Context, req *ActivateAccountUserRequest) (*apiresource.EmptyResource, *apierror.APIError)
	DisableAccountUser(ctx context.Context, req *DisableAccountUserRequest) (*apiresource.EmptyResource, *apierror.APIError)
	RemoveAccountUser(ctx context.Context, req *RemoveAccountUserRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

type AccountUserSvcConfig struct {
	// CoreClient (required) is the core-service gRPC client.
	CoreClient pb.CoreServiceClient
}

type ActivateAccountUserEndpoint struct{}

type ActivateAccountUserRequest struct {
	// ID of the account user to activate.
	AccountUserID string `path:"id" validate:"required"`
}

type CreateAccountUserEndpoint struct{}

type CreateAccountUserRequest struct {
	// User display name.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// User email address.
	//
	// Either `email` or `username` must be provided. If a user with this email already exists, that user is added to the account instead of a new user being created, and the request fails with a conflict if they are already an active member of it.
	Email field.Optional[string] `json:"email,omitzero" validate:"omitempty,custom_email,max=255"`
	// Unique username.
	//
	// 3–255 characters; letters, numbers, underscores, and hyphens. Either `email` or `username` must be provided. Providing a username without an email creates a scanning station user.
	Username field.Optional[string] `json:"username,omitzero" validate:"omitempty,username"`
	// Password for scanning station users.
	//
	// Required when creating a scanning station user (username without email) and rejected for all other users, who instead receive a generated password in their welcome email. Must be 8–72 characters and include an uppercase letter, a lowercase letter, a number, and a special character.
	Password field.Optional[string] `json:"password,omitzero" validate:"omitempty,password" sensitive:"true"` // #nosec G117 -- API request field for user password input
	// ID of the role to assign to the user.
	//
	// The role you supply can be overridden: users added to a customer account always receive the shared customer role so their portal capabilities stay permission-driven, and scanning station users in any other account receive the scanner role. Supplying a role whose type is `sales_rep` normalizes to the account's canonical sales-rep role.
	RoleID field.Optional[string] `json:"role_id,omitzero"`
	// ID of the department to assign to the user.
	//
	// The department must already exist in the account you are acting in.
	DepartmentID field.Optional[string] `json:"department_id,omitzero"`
	// Whether the user can be assigned as a sales representative on orders, territories, and targets.
	//
	// Defaults to false. Forced true for the `sales_rep` role type and rejected for scanner and agent roles.
	IsCommissionEligible field.Optional[bool] `json:"is_commission_eligible,omitzero"`
	// Notification preference toggles for the new user.
	//
	// Only applies when creating a user in another account you manage (cross-account); ignored when creating a user in your own account.
	Preferences []NotificationPreferenceItem `json:"preferences,omitzero"`
}

type DisableAccountUserEndpoint struct{}

type DisableAccountUserRequest struct {
	// ID of the account user to disable.
	AccountUserID string `path:"id" validate:"required"`
}

type ListAccountUsersEndpoint struct{}

type ListAccountUsersRequest struct {
	apiresource.PaginationRequest
	// Filter by role type.
	//
	// - `admin`: account administrators.
	// - `user`: users with a custom role.
	// - `scanner`: scanning station users.
	// - `sales_rep`: sales representatives.
	// - `agent`: automated agents.
	RoleType *constants.RoleType `query:"role_type"`
	// Filter by commission eligibility.
	//
	// Exact match on the column. Pass `true` to list users who can be assigned as sales representatives, including dedicated `sales_rep` users.
	IsCommissionEligible *bool `query:"is_commission_eligible"`
	// Controls whether removed (soft-deleted) account users appear in the list.
	//
	// Removed users are left out unless you pass `included`, so a user removed with the remove action disappears from the default listing.
	RemovedScope *constants.RemovedResourceScope `query:"removed_scope"`
}

type NotificationPreferenceItem struct {
	// Notification type.
	NotificationTypeCode constants.AccountRelationNotificationType `json:"notification_type" validate:"required"`
	// Whether this notification type is enabled for the account user.
	Enabled bool `json:"enabled"`
}

type RemoveAccountUserEndpoint struct{}

type RemoveAccountUserRequest struct {
	// ID of the account user to remove.
	AccountUserID string `path:"id" validate:"required"`
}

type RetrieveAccountUserEndpoint struct{}

type RetrieveAccountUserRequest struct {
	// ID of the account user to retrieve.
	AccountUserID string `path:"id" validate:"required"`
}

type UpdateAccountUserEndpoint struct{}

type UpdateAccountUserRequest struct {
	// ID of the account user to update.
	AccountUserID string `path:"id" validate:"required"`
	// User display name.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// User email address.
	//
	// Must not already be in use by another user.
	Email field.Optional[string] `json:"email,omitzero" validate:"omitempty,custom_email,max=255"`
	// Unique username.
	//
	// 3–255 characters; letters, numbers, underscores, and hyphens. Must not already be in use by another user.
	Username field.Optional[string] `json:"username,omitzero" validate:"omitempty,username"`
	// ID of the role to assign to the user.
	//
	// Set to `null` to clear the role.
	RoleID field.Clearable[string] `json:"role_id,omitzero" validate:"omitempty"`
	// ID of the department to assign to the user.
	//
	// Set to `null` to clear the department. The department must already exist in the account.
	DepartmentID field.Clearable[string] `json:"department_id,omitzero" validate:"omitempty"`
	// Whether the user can be assigned as a sales representative on orders, territories, and targets.
	//
	// Forced true for the `sales_rep` role type and rejected for scanner and agent roles. Cannot be turned off while the user stays on a `sales_rep` role.
	IsCommissionEligible field.Optional[bool] `json:"is_commission_eligible,omitzero"`
	// Notification preference toggles to apply.
	//
	// Only allowed when updating a user in another account you manage (cross-account); rejected otherwise. Notification types omitted from the list are left unchanged.
	Preferences []NotificationPreferenceItem `json:"preferences,omitzero"`
}