regsessionep

type CompleteRegistrationEndpoint struct{}

type CompleteRegistrationRequest struct {
	// Session ID.
	SessionID string `json:"-" path:"session_id" validate:"required"`
}

type ConfirmPaymentEndpoint struct{}

type ConfirmPaymentRequest struct {
	// Session ID.
	SessionID string `json:"-" path:"session_id" validate:"required"`
	// ID of the Stripe Setup Intent to verify.
	//
	// Must be the Setup Intent most recently created for this session by Setup Registration Billing, and its status must be `succeeded`.
	SetupIntentID string `json:"setup_intent_id" validate:"required"`
}

type CreateRegistrationSessionRequest struct {
	// Email address of the registering user.
	//
	// A verification email is sent to this address to start the registration.
	Email string `json:"email" validate:"required,custom_email,max=255"`
	// Code of the pricing plan to register for.
	//
	// Free plans skip the payment step; paid plans require a payment method to be collected and confirmed before the registration can complete.
	PlanCode constants.PublicPlanCode `json:"plan_code" validate:"required"`
}

type CreateSessionEndpoint struct{}

type CreateUserEndpoint struct{}

type CreateUserRequest struct {
	// Session ID.
	SessionID string `json:"-" path:"session_id" validate:"required"`
	// The user's display name.
	Name string `json:"name" validate:"required,max=255"`
	// Password for the new user.
	//
	// Must be 8–72 characters and contain at least one lowercase letter, one uppercase letter, one digit, and one special character.
	Password string `json:"password" validate:"required,password" sensitive:"true"` // #nosec G117 - Struct field, not a hardcoded credential
}

type ListSessionsEndpoint struct{}

type RegistrationSessionSvc interface {
	CreateSession(ctx context.Context, req *CreateRegistrationSessionRequest) (*apiresource.CreateSessionResponse, *apierror.APIError)
	ResendVerificationEmail(ctx context.Context, req *ResendEmailRequest) (*apiresource.EmptyResource, *apierror.APIError)
	VerifyToken(ctx context.Context, req *VerifyTokenRequest) (*apiresource.RegistrationSession, *apierror.APIError)
	GetSession(ctx context.Context, req *RetrieveSessionRequest) (*apiresource.RegistrationSession, *apierror.APIError)
	CreateUser(ctx context.Context, req *CreateUserRequest) (*apiresource.CreateUserResponse, *apierror.APIError)
	UpdateSession(ctx context.Context, req *UpdateSessionRequest) (*apiresource.RegistrationSession, *apierror.APIError)
	ListSessions(ctx context.Context, req *apiresource.PaginationRequest) (*apiresource.List[apiresource.RegistrationSession], *apierror.APIError)
	SetupBilling(ctx context.Context, req *SetupBillingRequest) (*apiresource.SetupBillingResponse, *apierror.APIError)
	ConfirmPayment(ctx context.Context, req *ConfirmPaymentRequest) (*apiresource.ConfirmPaymentResponse, *apierror.APIError)
	CompleteRegistration(ctx context.Context, req *CompleteRegistrationRequest) (*apiresource.CompleteRegistrationResponse, *apierror.APIError)
}

type RegistrationSessionSvcConfig struct {
	// AuthClient (required) is the auth-service gRPC client.
	AuthClient pb.AuthServiceClient
}

type ResendEmailEndpoint struct{}

type ResendEmailRequest struct {
	// Session ID.
	SessionID string `json:"-" path:"session_id" validate:"required"`
}

type RetrieveSessionEndpoint struct{}

type RetrieveSessionRequest struct {
	// Session ID.
	SessionID string `json:"-" path:"session_id" validate:"required"`
}

type SetupBillingEndpoint struct{}

type SetupBillingRequest struct {
	// Session ID.
	SessionID string `json:"-" path:"session_id" validate:"required"`
}

type UpdateSessionDataRequest struct {
	// Display name for the user.
	UserName field.Optional[string] `json:"user_name,omitzero" validate:"omitempty,max=255"`
	// Display name for the account.
	//
	// Becomes the name of the account created when the registration completes, and must be set before Complete Registration will succeed.
	AccountName field.Optional[string] `json:"account_name,omitzero" validate:"omitempty,max=255"`
	// Billing address line 1.
	BillingAddressLine1 field.Optional[string] `json:"billing_address_line1,omitzero" validate:"omitempty,max=255"`
	// Billing address line 2.
	BillingAddressLine2 field.Optional[string] `json:"billing_address_line2,omitzero" validate:"omitempty,max=255"`
	// Billing address city.
	BillingAddressCity field.Optional[string] `json:"billing_address_city,omitzero" validate:"omitempty,max=255"`
	// Billing address state.
	BillingAddressState field.Optional[string] `json:"billing_address_state,omitzero" validate:"omitempty,max=255"`
	// Billing address postal code.
	BillingAddressPostalCode field.Optional[string] `json:"billing_address_postal_code,omitzero" validate:"omitempty,max=255"`
	// Billing address country as a two-letter country code.
	BillingAddressCountry field.Optional[string] `json:"billing_address_country,omitzero" validate:"omitempty,max=2"`
}

type UpdateSessionEndpoint struct{}

type UpdateSessionRequest struct {
	// Session ID.
	SessionID string `json:"-" path:"session_id" validate:"required"`
	// Step to advance the session to.
	//
	// Must be later than the session's current step; moving backwards is rejected. See the session resource's `step` field for the step order.
	Step field.Optional[constants.RegistrationStep] `json:"step,omitzero"`
	// Session data to merge into the existing session.
	SessionData field.Optional[UpdateSessionDataRequest] `json:"session_data,omitzero"`
}

type VerifyTokenEndpoint struct{}

type VerifyTokenRequest struct {
	// Verification token from the email link.
	Token string `json:"-" path:"token" validate:"required"`
}