schedule

Documentation

Index

• type ChargeDetail
• type DaysOfMonth
• type OccurrenceStatus
• type On
• type Period
• type Status
• type TransferDetail
• type Weekday
• type Weekdays

Types

type ChargeDetail

type ChargeDetail struct {
	Amount      int     `json:"amount"`
	Currency    string  `json:"currency"`
	Customer    string  `json:"customer"`
	Card        *string `json:"card"`
	Description string  `json:"description"`
}

ChargeDetail represents charge detail for schedule object.

type DaysOfMonth

type DaysOfMonth []int

DaysOfMonth represents slice of day of month

type OccurrenceStatus

type OccurrenceStatus string

OccurrenceStatus represents an enumeration of possible status of a Occurrence object.

const (
	OccurrenceSkip       OccurrenceStatus = "skipped"
	OccurrenceFailed     OccurrenceStatus = "failed"
	OccurrenceSuccessful OccurrenceStatus = "successful"
)

OccurrenceStatus can be one of the following list of constants:

type On

type On struct {
	Weekdays       Weekdays    `json:"weekdays"`
	DaysOfMonth    DaysOfMonth `json:"days_of_month"`
	WeekdayOfMonth *string     `json:"weekday_of_month"`
}

On represents on field of Schedule object.

type Period

type Period string

Period represents an enumeration of possible period of a Schedule object.

const (
	PeriodDay   Period = "day"
	PeriodWeek  Period = "week"
	PeriodMonth Period = "month"
)

Period can be one of the following list of constants:

type Status

type Status string

Status represents an enumeration of possible status of a Schedule object.

const (
	Active    Status = "active"
	Expiring  Status = "expiring"
	Expired   Status = "expired"
	Deleted   Status = "deleted"
	Suspended Status = "suspended"
)

Status can be one of the following list of constants:

type TransferDetail

type TransferDetail struct {
	Recipient           string   `json:"recipient"`
	Amount              *int     `json:"amount"`
	PercentageOfBalance *float64 `json:"percentage_of_balance"`
	Currency            string   `json:"currency"`
}

TransferDetail represents transfer detail for schedule object.

type Weekday

type Weekday string

WeekDay represents set of weekday

const (
	Monday    Weekday = "monday"
	Tuesday   Weekday = "tuesday"
	Wednesday Weekday = "wednesday"
	Thursday  Weekday = "thursday"
	Friday    Weekday = "friday"
	Saturday  Weekday = "saturday"
	Sunday    Weekday = "sunday"
)

type Weekdays

type Weekdays []Weekday

Weekdays represents slice of weekday