Feature: Add marketing opt-in (#957)

Author: daveearley

backend/app/DomainObjects/Generated/UserDomainObjectAbstract.php

@@ -23,6 +23,7 @@ abstract class UserDomainObjectAbstract extends \HiEvents\DomainObjects\Abstract
     final public const PENDING_EMAIL = 'pending_email';
     final public const TIMEZONE = 'timezone';
     final public const LOCALE = 'locale';
+    final public const MARKETING_OPTED_IN_AT = 'marketing_opted_in_at';
 
     protected int $id;
     protected string $email;
@@ -37,6 +38,7 @@ abstract class UserDomainObjectAbstract extends \HiEvents\DomainObjects\Abstract
     protected ?string $pending_email = null;
     protected string $timezone;
     protected string $locale = 'en';
+    protected ?string $marketing_opted_in_at = null;
 
     public function toArray(): array
     {
@@ -54,6 +56,7 @@ public function toArray(): array
                     'pending_email' => $this->pending_email ?? null,
                     'timezone' => $this->timezone ?? null,
                     'locale' => $this->locale ?? null,
+                    'marketing_opted_in_at' => $this->marketing_opted_in_at ?? null,
                 ];
     }
 
@@ -199,4 +202,15 @@ public function getLocale(): string
     {
         return $this->locale;
     }
+
+    public function setMarketingOptedInAt(?string $marketing_opted_in_at): self
+    {
+        $this->marketing_opted_in_at = $marketing_opted_in_at;
+        return $this;
+    }
+
+    public function getMarketingOptedInAt(): ?string
+    {
+        return $this->marketing_opted_in_at;
+    }
 }

backend/app/Http/Actions/Accounts/CreateAccountAction.php

@@ -50,6 +50,7 @@ public function __invoke(CreateAccountRequest $request): JsonResponse
                     ? $request->validated('locale')
                     : $this->localeService->getLocaleOrDefault($request->getPreferredLanguage()),
                 'invite_token' => $request->validated('invite_token'),
+                'marketing_opt_in' => (bool) $request->validated('marketing_opt_in'),
             ]));
         } catch (EmailAlreadyExists $e) {
             throw ValidationException::withMessages([

backend/app/Http/Actions/Users/UpdateMeAction.php

@@ -36,6 +36,7 @@ public function __invoke(UpdateMeRequest $request): JsonResponse
                 'current_password' => $request->validated('current_password'),
                 'timezone' => $request->validated('timezone'),
                 'locale' => $request->validated('locale'),
+                'marketing_opt_in' => $request->has('marketing_opt_in') ? (bool) $request->validated('marketing_opt_in') : null,
             ]));
 
             return $this->resourceResponse(UserResource::class, $user);

backend/app/Http/Request/Account/CreateAccountRequest.php

@@ -25,6 +25,7 @@ public function rules(): array
             'currency_code' => [Rule::in(array_values($currencies))],
             'locale' => ['nullable', Rule::in(Locale::getSupportedLocales())],
             'invite_token' => ['nullable', 'string'],
+            'marketing_opt_in' => 'boolean|nullable',
         ];
     }
 }

backend/app/Http/Request/User/UpdateMeRequest.php

@@ -30,6 +30,7 @@ public function rules(): array
                 'confirmed',
                 Password::min(8)
             ],
+            'marketing_opt_in' => 'boolean|nullable',
         ];
     }
 }

backend/app/Resources/User/UserResource.php

@@ -33,6 +33,7 @@ public function toArray(Request $request): array
             'is_email_verified' => $this->getEmailVerifiedAt() !== null,
             'has_pending_email_change' => $this->getPendingEmail() !== null,
             'locale' => $this->getLocale(),
+            'marketing_opted_in_at' => $this->getMarketingOptedInAt(),
             $this->mergeWhen($isImpersonating, [
                 'is_impersonating' => true,
                 'impersonator_id' => $impersonatorId,

backend/app/Services/Application/Handlers/Account/CreateAccountHandler.php

@@ -76,6 +76,7 @@ public function handle(CreateAccountDTO $accountData): AccountDomainObject
                 'timezone' => $this->getTimezone($accountData),
                 'email_verified_at' => $isSaasMode ? null : now()->toDateTimeString(),
                 'locale' => $accountData->locale,
+                'marketing_opted_in_at' => $accountData->marketing_opt_in ? now()->toDateTimeString() : null,
             ]);
 
             $this->accountUserAssociationService->associate(

backend/app/Services/Application/Handlers/Account/DTO/CreateAccountDTO.php

@@ -15,6 +15,7 @@ public function __construct(
         public readonly ?string $timezone = null,
         public readonly ?string $currency_code = null,
         public readonly ?string $invite_token = null,
+        public readonly bool $marketing_opt_in = false,
     )
     {
     }

backend/app/Services/Application/Handlers/Auth/AcceptInvitationHandler.php

@@ -66,6 +66,7 @@ private function acceptInvitation(AcceptInvitationDTO $invitationData): void
                 'password' => $this->hasher->make($invitationData->password),
                 'timezone' => $invitationData->timezone,
                 'email_verified_at' => now(),
+                'marketing_opted_in_at' => $invitationData->marketing_opt_in ? now()->toDateTimeString() : null,
             ],
             where: [
                 'id' => $userId,

backend/app/Services/Application/Handlers/Auth/DTO/AcceptInvitationDTO.php

@@ -10,8 +10,9 @@ public function __construct(
         public readonly string  $invitation_token,
         public readonly string  $first_name,
         public readonly ?string $last_name = null,
-        public readonly string  $password,
-        public readonly string  $timezone,
+        public readonly string  $password = '',
+        public readonly string  $timezone = '',
+        public readonly bool    $marketing_opt_in = false,
     )
     {
     }