syspropertyep

type GetLatestSysPropertyValueEndpoint struct{}

type GetLatestSysPropertyValueRequest struct {
	// Code identifying which number series to read.
	//
	// - `transaction_number`: numbering for financial transactions such as payments, credit memos, adjustments, and rebates.
	// - `settlement_number`: numbering for settlements that apply transactions to invoices.
	// - `sales_order_number`: numbering for sales orders.
	// - `purchase_order_number`: numbering for purchase orders.
	// - `customer_number`: identifiers assigned to new customers.
	// - `supplier_number`: identifiers assigned to new suppliers.
	// - `production_run_number`: numbering for production runs.
	// - `sscc_count`: serial component of the GS1 SSCC-18 codes assigned to shipping cases.
	TypeCode constants.SysPropertyTypeCode `path:"type_code" validate:"required"`
}

type ListSysPropertiesEndpoint struct{}

type ListSysPropertiesRequest struct {
	apiresource.PaginationRequest
}

type RetrieveSysPropertyEndpoint struct{}

type RetrieveSysPropertyRequest struct {
	// System property ID.
	SysPropertyID string `path:"id" validate:"required"`
}

type SysPropertySvc interface {
	ListSysProperties(ctx context.Context, req *ListSysPropertiesRequest) (*apiresource.List[apiresource.SysProperty], *apierror.APIError)
	GetSysProperty(ctx context.Context, req *RetrieveSysPropertyRequest) (*apiresource.SysProperty, *apierror.APIError)
	UpdateSysProperty(ctx context.Context, req *UpdateSysPropertyRequest) (*apiresource.SysProperty, *apierror.APIError)
	GetLatestSysPropertyValue(ctx context.Context, req *GetLatestSysPropertyValueRequest) (*apiresource.SysPropertyValue, *apierror.APIError)
}

type SysPropertySvcConfig struct {
	// CoreClient (required) is the core-service gRPC client.
	CoreClient pb.CoreServiceClient
}

type UpdateSysPropertyEndpoint struct{}

type UpdateSysPropertyRequest struct {
	// System property ID.
	SysPropertyID string `path:"id" validate:"required"`
	// The number to move the counter to, so the series carries on from there.
	Value field.Optional[int32] `json:"value,omitzero"`
}