supplierep

type BulkDeleteSuppliersEndpoint struct{}

type BulkDeleteSuppliersRequest struct {
	// Supplier IDs to delete.
	SupplierIDs []string `json:"supplier_ids" validate:"required"`
}

type CreateSupplierEndpoint struct{}

type CreateSupplierRequest struct {
	// The supplier's name, as shown in the dashboard and on documents.
	Name string `json:"name" validate:"required,max=255"`
	// Human-facing supplier code, such as `SUP-001`.
	//
	// Must be unique per account; creating a supplier with a number already in use returns a conflict error.
	Number string `json:"number" validate:"required,max=255"`
	// Free-form notes about the supplier.
	Note field.Optional[string] `json:"note,omitzero"`
	// Default billing address to create for the supplier.
	//
	// A new address record is created from these values and saved to the supplier; existing addresses cannot be reused here.
	BillToAddress field.Optional[apirequest.AddressInput] `json:"bill_to_address,omitzero"`
	// Default shipping address to create for the supplier.
	//
	// If omitted and `bill_to_address` is provided, the billing address is also used as the default shipping address.
	ShipToAddress field.Optional[apirequest.AddressInput] `json:"ship_to_address,omitzero"`
}

type DeleteSupplierEndpoint struct{}

type DeleteSupplierRequest struct {
	// Supplier ID.
	SupplierID string `path:"id" validate:"required"`
}

type ListSuppliersEndpoint struct{}

type ListSuppliersRequest struct {
	apiresource.PaginationRequest
	// Filter to suppliers that can source any of these items.
	//
	// A supplier matches when it provides a material for one of the items, whether or not that material link is active.
	ItemIDs []string `query:"item_ids"`
	// Only return suppliers created at or after this timestamp.
	StartDate *time.Time `query:"starts_at"`
	// Only return suppliers created at or before this timestamp.
	EndDate *time.Time `query:"ends_at"`
}

type RetrieveSupplierEndpoint struct{}

type RetrieveSupplierRequest struct {
	// Supplier ID.
	SupplierID string `path:"id" validate:"required"`
}

type SupplierSvc interface {
	ListSuppliers(ctx context.Context, req *ListSuppliersRequest) (*apiresource.List[apiresource.SupplierSummary], *apierror.APIError)
	GetSupplier(ctx context.Context, req *RetrieveSupplierRequest) (*apiresource.SupplierDetail, *apierror.APIError)
	CreateSupplier(ctx context.Context, req *CreateSupplierRequest) (*apiresource.SupplierDetail, *apierror.APIError)
	UpdateSupplier(ctx context.Context, req *UpdateSupplierRequest) (*apiresource.SupplierDetail, *apierror.APIError)
	DeleteSupplier(ctx context.Context, req *DeleteSupplierRequest) (*apiresource.SupplierDetail, *apierror.APIError)
	BulkDeleteSuppliers(ctx context.Context, req *BulkDeleteSuppliersRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

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

type UpdateSupplierEndpoint struct{}

type UpdateSupplierRequest struct {
	// Supplier ID.
	SupplierID string `path:"id" validate:"required"`
	// The supplier's name, as shown in the dashboard and on documents.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Human-facing supplier code, such as `SUP-001`.
	//
	// Must be unique per account; updating to a number already used by another supplier returns a conflict error.
	Number field.Optional[string] `json:"number,omitzero" validate:"omitempty,max=255"`
	// New value for the supplier's note.
	//
	// Ignored unless `update_note` is `true`.
	Note field.Optional[string] `json:"note,omitzero"`
	// Whether to apply the `note` field.
	//
	// When `true`, the note is set to the provided `note` value, or cleared if `note` is omitted. When `false`, the note is left unchanged.
	UpdateNote bool `json:"update_note"`
	// ID of an existing address to set as the supplier's default billing address.
	BillToAddressID field.Optional[string] `json:"bill_to_address_id,omitzero" validate:"omitempty"`
	// ID of an existing address to set as the supplier's default shipping address.
	ShipToAddressID field.Optional[string] `json:"ship_to_address_id,omitzero" validate:"omitempty"`
}