client

type Attribute struct {
	// The `Key` field is defining a string property named `Key` for the `Attribute` struct. This property
	// represents the name of the attribute.
	Key string
	// The `Value` field is defining a string property named `Value` for the `Attribute` struct. This
	// property represents the value of an HTML attribute. In the context of the `Attribute` struct, it is
	// used to store the value of an attribute that can be used to provide additional information about the
	// message being sent to the queue.
	Value string
	// The `Type` field in the `Attribute` struct is defining a string property named `Type` that
	// represents the data type of the attribute's value. It could be "text", "number", "date", "boolean",
	// or any other data type that is relevant to the attribute's purpose. This field is optional and can
	// be used to provide additional information about the attribute.
	Type string
}

type AwsConfig struct {
	// `Endpoint` is a field in the `AwsConfig` struct that represents the endpoint for the AWS service. It
	// is a string type. The `WithEndpoint` function is an `AwsConfigOption` that sets the value of this
	// field when passed as an argument to `NewAwsConfig` function.
	Endpoint string
	// `Region` is a field in the `AwsConfig` struct that represents the region for the AWS service. It is
	// a string type. The `WithRegion` function is an `AwsConfigOption` that sets the value of this field
	// when passed as an argument to `NewAwsConfig` function.
	Region string
	// `Profile` is a field in the `AwsConfig` struct that represents the AWS profile to use for
	// authentication. It is a string type. The `WithProfile` function is an `AwsConfigOption` that sets
	// the value of this field when passed as an argument to `NewAwsConfig` function.
	Profile string
	// The `ID` field is a string type field in the `AwsConfig` struct that represents the AWS access key
	// ID to use for authentication. It can be set using the `WithID` function, which is an
	// `AwsConfigOption` that sets the value of this field when passed as an argument to the `NewAwsConfig`
	// function.
	ID string
	// The `Secret` field is a string type field in the `AwsConfig` struct that represents the AWS secret
	// access key to use for authentication. It can be set using the `WithSecret` function, which is an
	// `AwsConfigOption` that sets the value of this field when passed as an argument to the `NewAwsConfig`
	// function.
	Secret string
	// `UseS3PathStyleAddressing` is a boolean field in the `AwsConfig` struct that determines whether to
	// use path-style or virtual-hosted style addressing when making requests to Amazon S3. If it is set
	// to `true`, path-style addressing will be used, and if it is set to `false`, virtual-hosted style
	// addressing will be used. This option is set using the `WithUseS3PathStyleAddressing` function,
	// which is an `AwsConfigOption` that sets the value of this field when passed as an argument to the
	// `NewAwsConfig` function.
	UseS3PathStyleAddressing bool
}

type AwsConfigOption func(*AwsConfig)

type Client struct {
	// `SqsClient sqsiface.SQSAPI` is defining a field in the `Client` struct that holds an interface for
	// the SQS API. This allows for the use of a mock SQS client for testing purposes.
	SqsClient sqsiface.SQSAPI
	// Timeout is the timeout for the client.
	// `Timeout time.Duration` is a field in the `Client` struct that holds the timeout duration for
	// operations performed by the SQS client. This timeout duration specifies the maximum amount of time
	// that the client will wait for an operation to complete before timing out.
	Timeout time.Duration
	// `ReadTimeout time.Duration` is a field in the `Client` struct that holds the timeout duration for
	// read operations performed by the SQS client. This timeout duration specifies the maximum amount of
	// time that the client will wait for a read operation to complete before timing out.
	ReadTimeout time.Duration
	// `WriteTimeout time.Duration` is a field in the `Client` struct that holds the timeout duration for
	// write operations performed by the SQS client. This timeout duration specifies the maximum amount of
	// time that the client will wait for a write operation to complete before timing out.
	WriteTimeout time.Duration
	// `Config *Config` is a field in the `Client` struct that holds the configuration for the SQS client.
	// It is used to configure various settings such as the maximum number of messages to receive,
	// the visibility timeout, and the wait time for long polling. The `Config` struct is defined
	// elsewhere in the codebase and contains fields for these settings.
	Config *Config

	// `AwsConfig    *AwsConfig` is a field in the `Client` struct that holds the AWS configuration for
	// the SQS client. It is used to configure the AWS credentials and region for the SQS client.
	AwsConfig *AwsConfig
}

type Config struct {
	// The maximum number of messages to return. Amazon SQS never returns
	// more messages than this value (however, fewer messages might be returned).
	// Valid values: 1 to 10. Default: 1.
	MaxNumberOfMessages *int
	// The duration (in seconds) that the received messages are hidden from subsequent
	// retrieve requests after being retrieved by a ReceiveMessage request.
	MaxWaitTimeInSeconds *time.Duration
	// A list of attributes that need to be returned along with each message.
	Attributes *[]string
}

type ConfigOption func(*Config)

type Message struct {
	// The `ID` field is defining a string property named `ID` for the `Message` struct. This property
	// represents the unique identifier for the message.
	ID string
	// The `ReceiptHandle` field in the `Message` struct is defining a string property named
	// `ReceiptHandle` that represents a unique identifier for a message that has been received from an
	// Amazon Simple Queue Service (SQS) queue. It is used to acknowledge the receipt of a message and to
	// delete it from the queue.
	ReceiptHandle string
	// The `Body` field is defining a string property named `Body` for the `Message` struct. This property
	// represents the message body, which contains the content of the message being sent or received.
	Body string
	// The `Attributes` field in the `Message` struct is defining a map of key-value pairs that provide
	// additional information about the message. These attributes can include metadata such as message
	// timestamps, message grouping IDs, and message deduplication IDs. The specific attributes available
	// depend on the messaging service being used. The `map[string]string` type indicates that the keys and
	// values in the map are both strings.
	Attributes map[string]string
}

type MessageClientInterface interface {
	// The `Send` method is used to send a message to an SQS queue. It takes a context and a `SendRequest`
	// struct as input, and returns a string and an error. The string returned is the message ID of the
	// sent message, and the error returned indicates whether there was an error sending the message.
	Send(ctx context.Context, req *SendRequest) (string, error)
	// The `SendMessage` method is used to send a message to an SQS queue using the `sqs.SendMessageInput`
	// struct as input. It takes a context and a `SendMessageInput` struct as input, and returns a string
	// and an error. The string returned is the message ID of the sent message, and the error returned
	// indicates whether there was an error sending the message.
	SendMessage(ctx context.Context, msg *sqs.SendMessageInput) (*string, error)
	// The `Receive` method is used to receive messages from an SQS queue. It takes a context and a queue
	// URL as input, and returns a slice of `Message` structs and an error. The `Message` struct contains
	// information about the received message, such as the message ID, receipt handle, and message body.
	// The error returned indicates whether there was an error receiving the messages.
	Receive(ctx context.Context, queueURL string) ([]*Message, error)
	// The `Delete` method is used to delete a message from an SQS queue. It takes a context, a queue URL,
	// and a receipt handle as input, and returns an error indicating whether there was an error deleting
	// the message. The receipt handle is a unique identifier for the message that was received from the
	// queue, and is used to identify the message to be deleted.
	Delete(ctx context.Context, queueURL, rcvHandle string) error
}

type Option func(*Client)

type SendRequest struct {
	// `QueueURL string` is defining a string property named `QueueURL` for the `SendRequest` struct. This
	// property represents the URL of the Amazon SQS queue to which the message will be sent.
	QueueURL string
	// The `Body` property is defining a string property named `Body` for the `SendRequest` struct. This
	// property represents the message body that will be sent to the specified queue.
	Body string
	// The `Attributes []Attribute` field in the `SendRequest` struct is defining a slice of `Attribute`
	// structs that can be used to add custom metadata to the message being sent to the queue. These
	// attributes can be used to provide additional information about the message, such as message type,
	// priority, or any other relevant information. The `Attribute` struct typically contains a `Key` and a
	// `Value`, and an optional `Type` field.
	Attributes []Attribute
}