shippingcaseep

type AdminUpdateShippingCaseTrackingEndpoint struct{}

type AdminUpdateShippingCaseTrackingRequest struct {
	// Shipping case ID.
	ShippingCaseID string `path:"id" validate:"required"`
	// Carrier tracking number the case actually travelled under, replacing any number already recorded.
	TrackingNumber field.Optional[string] `json:"tracking_number,omitzero" validate:"omitempty,max=255"`
}

type DeleteShippingCaseEndpoint struct{}

type DeleteShippingCaseRequest struct {
	// Shipping case ID.
	ShippingCaseID string `path:"id" validate:"required"`
}

type GetShippingCaseLabelEndpoint struct{}

type GetShippingCaseLabelRequest struct {
	// Shipping case ID.
	ShippingCaseID string `path:"id" validate:"required"`
}

type RetrieveShippingCaseEndpoint struct{}

type RetrieveShippingCaseRequest struct {
	// Shipping case ID.
	ShippingCaseID string `path:"id" validate:"required"`
}

type ShippingCaseSvc interface {
	GetShippingCase(ctx context.Context, req *RetrieveShippingCaseRequest) (*apiresource.ShippingCase, *apierror.APIError)
	UpdateShippingCase(ctx context.Context, req *UpdateShippingCaseRequest) (*apiresource.ShippingCase, *apierror.APIError)
	AdminUpdateShippingCaseTracking(ctx context.Context, req *AdminUpdateShippingCaseTrackingRequest) (*apiresource.ShippingCase, *apierror.APIError)
	DeleteShippingCase(ctx context.Context, req *DeleteShippingCaseRequest) (*apiresource.EmptyResource, *apierror.APIError)
	GetShippingCaseLabel(ctx context.Context, req *GetShippingCaseLabelRequest) (*apiresource.ShippingCaseLabelURL, *apierror.APIError)
}

type ShippingCaseSvcConfig struct {
	// CoreClient (required) is the core-service shipping-case gRPC client.
	CoreClient pb.CoreShippingCaseServiceClient
}

type UpdateShippingCaseEndpoint struct{}

type UpdateShippingCaseRequest struct {
	// Shipping case ID.
	ShippingCaseID string `path:"id" validate:"required"`
	// Carrier tracking number to set on the case, replacing any number already recorded.
	TrackingNumber field.Optional[string] `json:"tracking_number,omitzero" validate:"omitempty,max=255"`
	// New value for the case's freight cost, as a decimal string.
	FreightAmountValue field.Optional[string] `json:"freight_amount_value,omitzero"`
	// ID of the currency unit the case's freight cost is expressed in.
	//
	// Changing the unit relabels the stored freight cost; the number itself is never converted, so send `freight_amount_value` alongside it when the amount should change too.
	FreightAmountUnitID field.Optional[string] `json:"freight_amount_unit_id,omitzero" validate:"omitempty"`
	// New value for the case's freight weight, as a decimal string.
	FreightWeightValue field.Optional[string] `json:"freight_weight_value,omitzero"`
	// ID of the unit the case's freight weight is expressed in.
	//
	// Changing the unit relabels the stored weight; the number itself is never converted, so send `freight_weight_value` alongside it when the weight should change too.
	FreightWeightUnitID field.Optional[string] `json:"freight_weight_unit_id,omitzero" validate:"omitempty"`
}