operatingcalendarep

type CreateOperatingCalendarClosureEndpoint struct{}

type CreateOperatingCalendarClosureRequest struct {
	// Operating calendar ID.
	OperatingCalendarID string `path:"id" validate:"required"`
	// The date nothing operates. Truncated to a day.
	ClosedOn time.Time `json:"closed_on" validate:"required"`
	// What the closure is, such as "Thanksgiving Day" or "Summer shutdown".
	Name string `json:"name" validate:"required,max=255"`
}

type CreateOperatingCalendarEndpoint struct{}

type CreateOperatingCalendarRequest struct {
	// Short stable identifier, unique per account.
	Code string `json:"code" validate:"required,max=32"`
	// Human-readable name.
	Name string `json:"name" validate:"required,max=255"`
	// Which side of a shipment this calendar describes.
	Kind constants.OperatingCalendarKind `json:"kind" validate:"required"`
	// Open weekdays as seven characters of '0' or '1', Monday first. "1111100" is Monday to Friday; "1111000" is a Monday-to-Thursday plant. At least one day must be open.
	DaysOfWeek string `json:"days_of_week" validate:"required,len=7"`
	// Local time freight has to be tendered by, as "15:00". Only a shipping calendar accepts one.
	CutoffAt field.Optional[string] `json:"cutoff_at,omitzero" validate:"omitempty,max=8"`
	// IANA zone the cutoff is read in, such as "America/Chicago". On a receiving calendar, leave it unset to take the zone from the ship-to address.
	Timezone field.Optional[string] `json:"timezone,omitzero" validate:"omitempty,max=64"`
	// Make this the calendar used when nothing more specific is linked. Setting it demotes whichever calendar of the same kind held the role.
	IsDefault field.Optional[bool] `json:"is_default,omitzero"`
}

type DeleteOperatingCalendarClosureEndpoint struct{}

type DeleteOperatingCalendarClosureRequest struct {
	// Operating calendar ID.
	OperatingCalendarID string `path:"id" validate:"required"`
	// Closure ID.
	ClosureID string `path:"closure_id" validate:"required"`
}

type DeleteOperatingCalendarEndpoint struct{}

type DeleteOperatingCalendarRequest struct {
	// Operating calendar ID.
	OperatingCalendarID string `path:"id" validate:"required"`
}

type ListOperatingCalendarClosuresEndpoint struct{}

type ListOperatingCalendarClosuresRequest struct {
	// Operating calendar ID.
	OperatingCalendarID string `path:"id" validate:"required"`
	// Earliest closure date to return. Defaults to a year ago.
	FromDate *time.Time `query:"from_date" validate:"omitempty"`
	// Latest closure date to return. Defaults to a year ahead.
	ToDate *time.Time `query:"to_date" validate:"omitempty"`
}

type ListOperatingCalendarsEndpoint struct{}

type ListOperatingCalendarsRequest struct {
	// Return only shipping or only receiving calendars.
	Kind *constants.OperatingCalendarKind `query:"kind" validate:"omitempty"`
}

type OperatingCalendarSvc interface {
	ListOperatingCalendars(ctx context.Context, req *ListOperatingCalendarsRequest) (*apiresource.List[apiresource.OperatingCalendar], *apierror.APIError)
	RetrieveOperatingCalendar(ctx context.Context, req *RetrieveOperatingCalendarRequest) (*apiresource.OperatingCalendar, *apierror.APIError)
	CreateOperatingCalendar(ctx context.Context, req *CreateOperatingCalendarRequest) (*apiresource.OperatingCalendar, *apierror.APIError)
	UpdateOperatingCalendar(ctx context.Context, req *UpdateOperatingCalendarRequest) (*apiresource.OperatingCalendar, *apierror.APIError)
	DeleteOperatingCalendar(ctx context.Context, req *DeleteOperatingCalendarRequest) (*apiresource.EmptyResource, *apierror.APIError)
	ListOperatingCalendarClosures(ctx context.Context, req *ListOperatingCalendarClosuresRequest) (*apiresource.List[apiresource.OperatingCalendarClosure], *apierror.APIError)
	CreateOperatingCalendarClosure(ctx context.Context, req *CreateOperatingCalendarClosureRequest) (*apiresource.OperatingCalendarClosure, *apierror.APIError)
	DeleteOperatingCalendarClosure(ctx context.Context, req *DeleteOperatingCalendarClosureRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

type OperatingCalendarSvcConfig struct {
	// CoreClient (required) is the core-service production-schedule gRPC client, which carries the calendar RPCs.
	CoreClient pb.CoreProductionScheduleServiceClient
}

type RetrieveOperatingCalendarEndpoint struct{}

type RetrieveOperatingCalendarRequest struct {
	// Operating calendar ID.
	OperatingCalendarID string `path:"id" validate:"required"`
}

type UpdateOperatingCalendarEndpoint struct{}

type UpdateOperatingCalendarRequest struct {
	// Operating calendar ID.
	OperatingCalendarID string `path:"id" validate:"required"`
	// Human-readable name.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Open weekdays as seven characters of '0' or '1', Monday first. At least one day must be open.
	DaysOfWeek field.Optional[string] `json:"days_of_week,omitzero" validate:"omitempty,len=7"`
	// Local time freight has to be tendered by. Clearing it leaves the ship-by date a day with no time of day attached.
	CutoffAt field.Clearable[string] `json:"cutoff_at,omitzero" validate:"omitempty,max=8"`
	// IANA zone the cutoff is read in. Clearing it on a receiving calendar returns to taking the zone from the ship-to address.
	Timezone field.Clearable[string] `json:"timezone,omitzero" validate:"omitempty,max=64"`
	// Make this the calendar used when nothing more specific is linked. Setting it demotes whichever calendar of the same kind held the role.
	IsDefault field.Optional[bool] `json:"is_default,omitzero"`
}