smsgateway

type Client struct {
	*rest.Client
	// contains filtered or unexported fields
}

type Config struct {
	Client   *http.Client // Optional HTTP Client, defaults to `http.DefaultClient`
	BaseURL  string       // Optional base URL, defaults to `https://api.sms-gate.app/3rdparty/v1`
	User     string       // Basic Auth username
	Password string       // Basic Auth password
	Token    string       // Bearer token, has priority over Basic Auth
}

type DataMessage struct {
	// Data is the base64-encoded payload.
	Data string `json:"data" validate:"required,base64,min=4,max=65535" example:"SGVsbG8gV29ybGQh" format:"byte"`
	// Port is the destination port.
	Port uint16 `json:"port" validate:"required,min=1,max=65535" example:"53739"`
}

type Device struct {
	ID        string     `json:"id"                  example:"PyDmBQZZXYmyxMwED8Fzy"` // ID
	Name      string     `json:"name"                example:"My Device"`             // Name
	CreatedAt time.Time  `json:"createdAt"           example:"2020-01-01T00:00:00Z"`  // Created at (read only)
	UpdatedAt time.Time  `json:"updatedAt"           example:"2020-01-01T00:00:00Z"`  // Updated at (read only)
	DeletedAt *time.Time `json:"deletedAt,omitempty" example:"2020-01-01T00:00:00Z"`  // Deleted at (read only)

	LastSeen time.Time `json:"lastSeen" example:"2020-01-01T00:00:00Z"` // Last seen at (read only)
}

type DeviceSettings struct {
	// Encryption contains settings related to message encryption.
	Encryption *SettingsEncryption `json:"encryption,omitempty"`

	// Messages contains settings related to message handling.
	Messages *SettingsMessages `json:"messages,omitempty"`

	// Ping contains settings related to ping functionality.
	Ping *SettingsPing `json:"ping,omitempty"`

	// Logs contains settings related to logging.
	Logs *SettingsLogs `json:"logs,omitempty"`

	// Webhooks contains settings related to webhook functionality.
	Webhooks *SettingsWebhooks `json:"webhooks,omitempty"`

	// Gateway contains settings related to the gateway.
	Gateway *SettingsGateway `json:"gateway,omitempty"`
}

type ErrorResponse struct {
	Message string `json:"message"        example:"An error occurred"` // Error message
	Code    int32  `json:"code,omitempty"`                             // Error code
	Data    any    `json:"data,omitempty"`                             // Error context
}

type GetLogsResponse []LogEntry

type GetMessageResponse MessageState

type GetMessagesResponse []MessageState

type HashedMessage struct {
	Hash string `json:"hash" validate:"required,sha256" example:"1d4b6e3b1b6e3b1b6e3b1b6e3b1b6e3b1b6e3b1b"`
}

type HealthCheck struct {
	// A human-readable description of the check.
	Description string `json:"description,omitempty"`
	// Unit of measurement for the observed value.
	ObservedUnit string `json:"observedUnit,omitempty"`
	// Observed value of the check.
	ObservedValue int `json:"observedValue"`
	// Status of the check.
	// It can be one of the following values: "pass", "warn", or "fail".
	Status HealthStatus `json:"status"`
}

type HealthChecks map[string]HealthCheck

type HealthResponse struct {
	// Overall status of the application.
	// It can be one of the following values: "pass", "warn", or "fail".
	Status HealthStatus `json:"status"`
	// Version of the application.
	Version string `json:"version,omitempty"`
	// Release ID of the application.
	// It is used to identify the version of the application.
	ReleaseID int `json:"releaseId,omitempty"`
	// A map of check names to their respective details.
	Checks HealthChecks `json:"checks,omitempty"`
}

type HealthStatus string

type LimitPeriod string

type LogEntry struct {
	// A unique identifier for the log entry.
	ID uint64 `json:"id"`
	// The priority level of the log entry.
	Priority LogEntryPriority `json:"priority"`
	// The module or component of the system that generated the log entry.
	Module string `json:"module"`
	// A message describing the log event.
	Message string `json:"message"`
	// Additional context information related to the log entry, typically including data relevant to the log event.
	Context map[string]any `json:"context"`
	// The timestamp when this log entry was created.
	CreatedAt time.Time `json:"createdAt" format:"date-time"`
}

type LogEntryPriority string

type Message struct {
	ID       string `json:"id,omitempty"       validate:"omitempty,max=36" example:"PyDmBQZZXYmyxMwED8Fzy"` // ID (if not set - will be generated)
	DeviceID string `json:"deviceId,omitempty" validate:"omitempty,max=21" example:"PyDmBQZZXYmyxMwED8Fzy"` // Optional device ID for explicit selection

	Message string `json:"message,omitempty" validate:"omitempty,max=65535" example:"Hello World!"` // Message content (deprecated, use TextMessage instead)

	TextMessage *TextMessage `json:"textMessage,omitempty" validate:"omitempty"` // Text message
	DataMessage *DataMessage `json:"dataMessage,omitempty" validate:"omitempty"` // Data message

	PhoneNumbers []string `json:"phoneNumbers"          validate:"required,min=1,max=100,dive,required,min=1,max=128" example:"79990001234"` // Recipients (phone numbers)
	IsEncrypted  bool     `json:"isEncrypted,omitempty"                                                               example:"true"`        // Is encrypted

	SimNumber          *uint8          `json:"simNumber,omitempty"          validate:"omitempty,min=1,max=3"      example:"1"`                // SIM card number (1-3), if not set - default SIM will be used
	WithDeliveryReport *bool           `json:"withDeliveryReport,omitempty"                                       example:"true"`             // With delivery report
	Priority           MessagePriority `json:"priority,omitempty"           validate:"omitempty,min=-128,max=127" example:"0"    default:"0"` // Priority, messages with values greater than `99` will bypass limits and delays

	TTL        *uint64    `json:"ttl,omitempty"        validate:"omitempty,min=5" example:"86400"`                // Time to live in seconds (conflicts with `ValidUntil`)
	ValidUntil *time.Time `json:"validUntil,omitempty"                            example:"2020-01-01T00:00:00Z"` // Valid until (conflicts with `TTL`)
}

type MessagePriority int8

type MessageState struct {
	ID          string               `json:"id"          validate:"required,max=36"     example:"PyDmBQZZXYmyxMwED8Fzy"` // Message ID
	DeviceID    string               `json:"deviceId"    validate:"required,max=21"     example:"PyDmBQZZXYmyxMwED8Fzy"` // Device ID
	State       ProcessingState      `json:"state"       validate:"required"            example:"Pending"`               // State
	IsHashed    bool                 `json:"isHashed"                                   example:"false"`                 // Hashed
	IsEncrypted bool                 `json:"isEncrypted"                                example:"false"`                 // Encrypted
	Recipients  []RecipientState     `json:"recipients"  validate:"required,min=1,dive"`                                 // Recipients states
	States      map[string]time.Time `json:"states"`                                                                     // History of states

	TextMessage   *TextMessage   `json:"textMessage,omitempty"`   // Present only when `includeContent=true` and the message type is text.
	DataMessage   *DataMessage   `json:"dataMessage,omitempty"`   // Present only when `includeContent=true` and the message type is data.
	HashedMessage *HashedMessage `json:"hashedMessage,omitempty"` // Hashed message content, if isHashed is true

}

type MessagesExportRequest struct {
	// DeviceID is the ID of the device to export messages for.
	DeviceID string `json:"deviceId" example:"PyDmBQZZXYmyxMwED8Fzy" validate:"required,max=21"`
	// Since is the start of the time range to export.
	Since time.Time `json:"since" example:"2024-01-01T00:00:00Z" validate:"required,ltefield=Until"`
	// Until is the end of the time range to export.
	Until time.Time `json:"until" example:"2024-01-01T23:59:59Z" validate:"required,gtefield=Since"`
}

type MessagesProcessingOrder string

type MobileChangePasswordRequest struct {
	CurrentPassword string `json:"currentPassword" validate:"required"        example:"cp2pydvxd2zwpx"` // Current password
	NewPassword     string `json:"newPassword"     validate:"required,min=14" example:"cp2pydvxd2zwpx"` // New password, at least 14 characters
}

type MobileDeviceResponse struct {
	// Device information, empty if device is not registered on the server
	Device *Device `json:"device,omitempty"`
	// External IP address
	ExternalIP string `json:"externalIp,omitempty"`
}

type MobileGetMessagesResponse []MobileMessage

type MobileMessage struct {
	Message // Message information

	CreatedAt time.Time `json:"createdAt" example:"2020-01-01T00:00:00Z"` // Message creation time
}

type MobilePatchMessageItem struct {
	// Message ID
	ID string `json:"id" validate:"required,max=36" example:"PyDmBQZZXYmyxMwED8Fzy"`
	// State
	State ProcessingState `json:"state" validate:"required" example:"Pending"`
	// Recipients states
	Recipients []RecipientState `json:"recipients" validate:"required,min=1,dive"`
	// History of states
	States map[string]time.Time `json:"states"`
}

type MobilePatchMessageRequest []MobilePatchMessageItem

type MobileRegisterRequest struct {
	// Name of the device (optional)
	// +optional
	Name *string `json:"name,omitempty" validate:"omitempty,max=128" example:"Android Phone"`
	// FCM token of the device (optional)
	// +optional
	PushToken *string `json:"pushToken" validate:"omitempty,max=256" example:"gHz-T6NezDlOfllr7F-Be"`
}

type MobileRegisterResponse struct {
	//nolint:revive,staticcheck // backward compatibility
	Id       string `json:"id"                 example:"QslD_GefqiYV6RQXdkM6V"` // New device ID
	Token    string `json:"token"              example:"bP0ZdK6rC6hCYZSjzmqhQ"` // Device access token
	Login    string `json:"login"              example:"VQ4GII"`                // User login
	Password string `json:"password,omitempty" example:"cp2pydvxd2zwpx"`        // User password, empty for existing user
}

type MobileUpdateRequest struct {
	//nolint:revive,staticcheck // backward compatibility
	Id        string `json:"id"        example:"QslD_GefqiYV6RQXdkM6V"`                              // Device ID
	PushToken string `json:"pushToken" example:"gHz-T6NezDlOfllr7F-Be" validate:"omitempty,max=256"` // FCM token of the device (optional)
}

type MobileUserCodeResponse struct {
	Code       string    `json:"code"       example:"123456"`               // One-time code sent to the user
	ValidUntil time.Time `json:"validUntil" example:"2020-01-01T00:00:00Z"` // One-time code expiration time
}

type ProcessingState string

type PushEventType string

type PushNotification struct {
	Token string `` // The token of the device that receives the notification.
	/* 133-byte string literal not displayed */
	Event PushEventType `` // The type of event.
	/* 127-byte string literal not displayed */
	Data map[string]string `json:"data"` // The additional data associated with the event.
}

type RecipientState struct {
	PhoneNumber string          `json:"phoneNumber"     validate:"required,min=1,max=128" example:"79990001234"` // Phone number or first 16 symbols of SHA256 hash
	State       ProcessingState `json:"state"           validate:"required"               example:"Pending"`     // State
	Error       *string         `json:"error,omitempty"                                   example:"timeout"`     // Error (for `Failed` state)
}

type SendOption func(*SendOptions)

type SendOptions struct {
	// contains filtered or unexported fields
}

type SettingsEncryption struct {
	// Passphrase is the encryption passphrase. If nil or empty, encryption is disabled. Must not be used with Cloud Server.
	Passphrase *string `json:"passphrase,omitempty" validate:"omitempty,isdefault"`
}

type SettingsGateway struct {
	// CloudURL is the URL of the cloud server. Must not be used with Cloud Server.
	CloudURL *string `json:"cloud_url,omitempty" validate:"omitempty,isdefault,url"`

	// PrivateToken is the auth token for the private server. Must not be used with Cloud Server.
	PrivateToken *string `json:"private_token,omitempty" validate:"omitempty,isdefault"`

	// NotificationChannel is the way device receives notifications.
	NotificationChannel *string `json:"notification_channel,omitempty" validate:"omitempty,oneof=AUTO SSE_ONLY"`
}

type SettingsLogs struct {
	// LifetimeDays is the number of days to retain logs.
	// Must be at least 1 when provided.
	LifetimeDays *int `json:"lifetime_days,omitempty" validate:"omitempty,min=1"`
}

type SettingsMessages struct {
	// SendIntervalMin is the minimum interval between message sends (in seconds).
	// Must be at least 1 when provided.
	SendIntervalMin *int `json:"send_interval_min,omitempty" validate:"omitempty,min=1"`

	// SendIntervalMax is the maximum interval between message sends (in seconds).
	// Must be at least 1 when provided and greater than or equal to SendIntervalMin.
	SendIntervalMax *int `json:"send_interval_max,omitempty" validate:"omitempty,min=1"`

	// LimitPeriod defines the period for message sending limits.
	// Valid values are "Disabled", "PerMinute", "PerHour", or "PerDay".
	LimitPeriod *LimitPeriod `json:"limit_period,omitempty" validate:"omitempty,oneof=Disabled PerMinute PerHour PerDay"`

	// LimitValue is the maximum number of messages allowed per limit period.
	// Must be at least 1 when provided.
	LimitValue *int `json:"limit_value,omitempty" validate:"omitempty,min=1"`

	// SimSelectionMode defines how SIM cards are selected for sending messages.
	// Valid values are "OSDefault", "RoundRobin", or "Random".
	SimSelectionMode *SimSelectionMode `json:"sim_selection_mode,omitempty" validate:"omitempty,oneof=OSDefault RoundRobin Random"`

	// LogLifetimeDays is the number of days to retain message logs.
	// Must be at least 1 when provided.
	LogLifetimeDays *int `json:"log_lifetime_days,omitempty" validate:"omitempty,min=1"`

	// MessagesProcessingOrder defines the order in which messages are processed.
	// Valid values are "LIFO" or "FIFO".
	ProcessingOrder *MessagesProcessingOrder `json:"processing_order,omitempty" validate:"omitempty,oneof=LIFO FIFO"`
}

type SettingsPing struct {
	// IntervalSeconds is the interval between ping requests (in seconds).
	// Must be at least 1 when provided.
	IntervalSeconds *int `json:"interval_seconds,omitempty" validate:"omitempty,min=1"`
}

type SettingsWebhooks struct {
	// InternetRequired indicates whether internet access is required for webhooks.
	InternetRequired *bool `json:"internet_required,omitempty"`

	// RetryCount is the number of times to retry failed webhook deliveries.
	// Must be at least 1 when provided.
	RetryCount *int `json:"retry_count,omitempty" validate:"omitempty,min=1"`

	// SigningKey is the secret key used for signing webhook payloads. Must not be used with Cloud Server.
	SigningKey *string `json:"signing_key,omitempty" validate:"omitempty,isdefault"`
}

type SimSelectionMode string

type TextMessage struct {
	// Text is the message text.
	Text string `json:"text" validate:"required,min=1,max=65535" example:"Hello World!"`
}

type TokenRequest struct {
	TTL    uint64   `json:"ttl,omitempty"`                                         // lifetime of the access token in seconds
	Scopes []string `json:"scopes"        validate:"required,min=1,dive,required"` // scopes for which the access token is valid
}

type TokenResponse struct {
	ID           string    `json:"id"`                                         // unique identifier for the access token
	TokenType    string    `json:"token_type"`                                 // type of the access token
	AccessToken  string    `json:"access_token"`                               // actual access token
	RefreshToken string    `json:"refresh_token,omitempty"`                    // refresh token
	ExpiresAt    time.Time `json:"expires_at"              format:"date-time"` // time at which the access token is no longer valid
}

type UpstreamPushRequest = []PushNotification

type Webhook struct {
	ID       string       `json:"id,omitempty" validate:"max=36"            example:"123e4567-e89b-12d3-a456-426614174000"` // The unique identifier of the webhook.
	DeviceID *string      `json:"deviceId"     validate:"omitempty,max=21"  example:"PyDmBQZZXYmyxMwED8Fzy"`                // The unique identifier of the device the webhook is associated with.
	URL      string       `json:"url"          validate:"required,http_url" example:"https://example.com/webhook"`          // The URL the webhook will be sent to.
	Event    WebhookEvent `json:"event"        validate:"required"          example:"sms:received"`                         // The type of event the webhook is triggered for.
}

type WebhookEvent = string