Skip to content

Send and receive SMS messages using your Android phone programmatically via a simple HTTP API

1.1 KB
Raw Blame
package repositories

import (
	"context"

	"github.com/google/uuid"

	"github.com/NdoleStudio/httpsms/pkg/entities"
)

// PhoneRepository loads and persists an entities.Phone
type PhoneRepository interface {
	// Save Upsert a new entities.Phone
	Save(ctx context.Context, phone *entities.Phone) error

	// Index entities.Phone of a user
	Index(ctx context.Context, userID entities.UserID, params IndexParams) (*[]entities.Phone, error)

	// Load a phone by user and phone number
	Load(ctx context.Context, userID entities.UserID, phoneNumber string) (*entities.Phone, error)

	// LoadByID a phone by ID
	LoadByID(ctx context.Context, userID entities.UserID, phoneID uuid.UUID) (*entities.Phone, error)

	// Delete an entities.Phone
	Delete(ctx context.Context, userID entities.UserID, phoneID uuid.UUID) error

	// NullifyScheduleID sets MessageSendScheduleID to NULL for all phones referencing the given schedule
	NullifyScheduleID(ctx context.Context, userID entities.UserID, scheduleID uuid.UUID) error

	// DeleteAllForUser deletes all entities.Phone for a user
	DeleteAllForUser(ctx context.Context, userID entities.UserID) error
}