Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(tem): improve reputation score doc #1894

Merged
merged 1 commit into from
Oct 25, 2023
Merged

docs(tem): improve reputation score doc #1894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions api/tem/v1alpha1/tem_sdk.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,22 +78,22 @@ func (enum *DomainLastStatusRecordStatus) UnmarshalJSON(data []byte) error {
type DomainReputationStatus string

const (
// If unspecified, the status of the domain reputation is unknown by default.
DomainReputationStatusUnknown = DomainReputationStatus("unknown")
// If unspecified, the status of the domain's reputation is unknown by default.
DomainReputationStatusUnknownStatus = DomainReputationStatus("unknown_status")
// The domain has an excellent reputation.
DomainReputationStatusExcellent = DomainReputationStatus("excellent")
// The domain has a good reputation.
DomainReputationStatusGood = DomainReputationStatus("good")
// The domain has an average reputation. Look at our documentation to find how to improving it.
// The domain has an average reputation.
DomainReputationStatusAverage = DomainReputationStatus("average")
// The domain has a bad reputation. You should check your email activity tab in the Scaleway console and look at our documentation to find how to improving it.
// The domain has a bad reputation.
DomainReputationStatusBad = DomainReputationStatus("bad")
)

func (enum DomainReputationStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
return "unknown_status"
}
return string(enum)
}
Expand Down Expand Up @@ -128,7 +128,7 @@ const (
DomainStatusLocked = DomainStatus("locked")
// The domain is revoked.
DomainStatusRevoked = DomainStatus("revoked")
// The domain is pending for check.
// The domain is pending, waiting to be checked.
DomainStatusPending = DomainStatus("pending")
)

Expand Down Expand Up @@ -344,20 +344,20 @@ type EmailTry struct {

// DomainReputation: domain reputation.
type DomainReputation struct {
// Status: status of your domain reputation.
// Default value: unknown
// Status: status of your domain's reputation.
// Default value: unknown_status
Status DomainReputationStatus `json:"status"`

// Score: represent a number between 0 and 100 of your domain reputation score.
// Score: a range from 0 to 100 that determines your domain's reputation score. A score of `0` means a bad domain reputation and a score of `100` means an excellent domain reputation.
Score uint32 `json:"score"`

// ScoredAt: time and date the score was calculated.
ScoredAt *time.Time `json:"scored_at"`

// PreviousScore: the domain reputation score previously calculated.
// PreviousScore: the previously-calculated domain's reputation score.
PreviousScore *uint32 `json:"previous_score"`

// PreviousScoredAt: time and date the previous score was calculated.
// PreviousScoredAt: time and date the previous reputation score was calculated.
PreviousScoredAt *time.Time `json:"previous_scored_at"`
}

Expand Down Expand Up @@ -511,7 +511,7 @@ type Domain struct {
// Statistics: domain's statistics.
Statistics *DomainStatistics `json:"statistics"`

// Reputation: domain's reputation, available when your domain is checked and has sent enough emails.
// Reputation: the domain's reputation is available when your domain is checked and has sent enough emails.
Reputation *DomainReputation `json:"reputation"`

// Region: region to target. If none is passed will use default region from the config.
Expand Down
Loading