customerep

type BulkDeleteCustomersEndpoint struct{}

type BulkDeleteCustomersRequest struct {
	// Customer IDs to delete.
	CustomerIDs []string `json:"customer_ids" validate:"required"`
}

type CreateCustomerEndpoint struct{}

type CreateCustomerRequest struct {
	// The customer's business name, as shown throughout the app and on documents.
	Name string `json:"name" validate:"required,max=255"`
	// Human-readable customer number used to identify the account, distinct from the `id`.
	//
	// Must be unique within your account. If omitted, the next sequential number is assigned automatically.
	Number field.Optional[string] `json:"number,omitzero" validate:"omitempty,max=255"`
	// Free-form note about the customer.
	Note field.Optional[string] `json:"note,omitzero"`
	// Email address.
	Email field.Optional[string] `json:"email,omitzero" validate:"omitempty,max=255"`
	// Phone number.
	Phone field.Optional[string] `json:"phone,omitzero" validate:"omitempty,max=255"`
	// Website URL.
	URL field.Optional[string] `json:"url,omitzero" validate:"omitempty,max=255"`
	// The customer's account standing.
	//
	// - `normal`: standard account with no restrictions.
	// - `preferred`: account flagged for prioritized handling.
	// - `hold_shipment`: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
	// - `hold_all`: all activity for the customer should be held.
	StatusCode field.Optional[constants.AccountStatusCode] `json:"status,omitzero" default:"normal"`
	// Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.
	EDIStatus field.Optional[constants.EDIStatus] `json:"edi_status,omitzero" default:"disabled"`
	// How sales commission applies to this customer's orders.
	//
	// - `commission_exempt`: this customer's orders are exempt from sales commission.
	// - `commission_applied`: sales commission is calculated on this customer's orders.
	CommissionPolicy field.Optional[constants.CommissionPolicy] `json:"commission_policy,omitzero" default:"commission_exempt"`
	// Whether this customer is billed for freight on their orders.
	//
	// - `free_freight`: the customer is not billed for freight.
	// - `billed_freight`: freight is billed to the customer.
	//
	// Freight is also waived when the customer's type group, one of its price groups, or a product line the ordered products belong to is `free_freight`.
	FreightPolicy field.Optional[constants.FreightPolicy] `json:"freight_policy,omitzero" default:"billed_freight"`
	// Calendar days between an order being issued and it being due to ship.
	//
	// Sets each order's `ship_by_date` when it is issued. Leave unset to inherit the parent account's lead time, then the customer's account group lead time, then the account default.
	LeadTimeDays field.Optional[int32] `json:"lead_time_days,omitzero" validate:"omitempty,gte=0,lte=3650"`
	// The operating calendar naming the days this customer's dock accepts freight.
	//
	// Sits in the same chain as lead_time_days: leaving it unset falls through to the customer's group, then the account default, then Monday to Friday. A promised delivery date is never worked back from a day nobody is there to receive on.
	ReceiveCalendarID field.Optional[string] `json:"receive_calendar_id,omitzero" validate:"omitempty"`
	// How this customer's orders are produced.
	//
	// - `make_to_stock`: their order history feeds the production-schedule forecast, so stock is built ahead of their demand.
	// - `make_to_order`: their history is left out of the forecast; their orders are produced only once placed, and fit into the schedule on their own ship-by dates.
	//
	// Leave unset to inherit the customer's account group policy, then the make-to-stock default.
	FulfillmentPolicy field.Optional[constants.FulfillmentPolicy] `json:"fulfillment_policy,omitzero"`
	// ID of the carrier used on this customer's orders when the order does not specify one.
	DefaultCarrierID string `json:"default_carrier_id" validate:"required"`
	// ID of the carrier service level used when an order takes its carrier from this customer's default.
	DefaultServiceLevelID field.Optional[string] `json:"default_service_level_id,omitzero" validate:"omitempty"`
	// ID of the payment term used on this customer's orders when the order does not specify one.
	DefaultPaymentTermID string `json:"default_payment_term_id" validate:"required"`
	// ID of the shipping term used on this customer's orders when the order does not specify one.
	DefaultShippingTermID string `json:"default_shipping_term_id" validate:"required"`
	// Priority used to pre-fill new orders for this customer.
	DefaultPriorityCode field.Optional[constants.PriorityCode] `json:"default_priority,omitzero" default:"normal"`
	// The ID of the account user to credit as the sales rep on this customer's orders.
	//
	// Must be an account user on your own account.
	DefaultSalesRepID field.Optional[string] `json:"default_sales_rep_id,omitzero" validate:"omitempty"`
	// IDs of the account groups of type `pricing_group` to assign to this customer, used to apply pricing rules.
	CustomerPriceGroupIDs []string `json:"customer_price_group_ids,omitzero"`
	// ID of the account group of type `type_group` that categorizes this customer (for example "Distributors").
	CustomerTypeGroupID string `json:"customer_type_group_id" validate:"required"`
	// Who pays the carrier for shipments.
	//
	// - `sender`: the shipper (you) pays the carrier.
	// - `third_party`: a third party is billed, using `carrier_billing_account`.
	CarrierBillingType field.Optional[constants.CarrierBillingType] `json:"carrier_billing_type,omitzero" default:"sender"`
	// Carrier billing account number charged when `carrier_billing_type` is `third_party`.
	CarrierBillingAccount field.Optional[string] `json:"carrier_billing_account,omitzero" validate:"omitempty,max=255"`
	// Maximum credit extended to this customer.
	CreditLimit field.Optional[apirequest.QuantityInput] `json:"credit_limit,omitzero"`
	// Default billing address, created along with the customer.
	BillToAddress apirequest.AddressInput `json:"bill_to_address" validate:"required"`
	// Default shipping address, created along with the customer.
	//
	// If identical to `bill_to_address`, a single shared address record is created.
	ShipToAddress apirequest.AddressInput `json:"ship_to_address" validate:"required"`
}

type CustomerSvc interface {
	ListCustomers(ctx context.Context, req *ListCustomersRequest) (*apiresource.List[apiresource.Customer], *apierror.APIError)
	GetCustomer(ctx context.Context, req *RetrieveCustomerRequest) (*apiresource.Customer, *apierror.APIError)
	CreateCustomer(ctx context.Context, req *CreateCustomerRequest) (*apiresource.Customer, *apierror.APIError)
	DeleteCustomer(ctx context.Context, req *DeleteCustomerRequest) (*apiresource.EmptyResource, *apierror.APIError)
	BulkDeleteCustomers(ctx context.Context, req *BulkDeleteCustomersRequest) (*apiresource.EmptyResource, *apierror.APIError)
	GetFrequentlyOrderedProducts(ctx context.Context, req *GetFrequentlyOrderedProductsRequest) (*apiresource.List[apiresource.FrequentlyOrderedProduct], *apierror.APIError)
	GetCustomerLeadTime(ctx context.Context, req *RetrieveCustomerLeadTimeRequest) (*apiresource.CustomerLeadTime, *apierror.APIError)
	ListNotificationRecipients(ctx context.Context, req *ListNotificationRecipientsRequest) (*apiresource.List[apiresource.OrderNotificationRecipient], *apierror.APIError)
	UpdateNotificationRecipients(ctx context.Context, req *UpdateNotificationRecipientsRequest) (*apiresource.List[apiresource.OrderNotificationRecipient], *apierror.APIError)
	MergeCustomers(ctx context.Context, req *MergeCustomersRequest) (*apiresource.Customer, *apierror.APIError)
	UpdateCustomer(ctx context.Context, req *UpdateCustomerRequest) (*apiresource.Customer, *apierror.APIError)
}

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

type DeleteCustomerEndpoint struct{}

type DeleteCustomerRequest struct {
	// Customer ID.
	CustomerID string `path:"id" validate:"required"`
}

type GetFrequentlyOrderedProductsEndpoint struct{}

type GetFrequentlyOrderedProductsRequest struct {
	// Customer ID.
	CustomerID string `path:"id" validate:"required"`
}

type ListCustomersEndpoint struct{}

type ListCustomersRequest struct {
	apiresource.PaginationRequest
	// Filter by customer type group IDs (the account group of type `type_group` returned in the customer's `type` field).
	CustomerGroupIDs []string `query:"customer_group_ids"`
	// Filter to customers that belong to any of these pricing groups.
	PricingGroupIDs []string `query:"pricing_group_ids"`
	// Filter to customers whose default sales rep is one of these account users.
	SalesRepIDs []string `query:"sales_rep_ids"`
	// Filter by the customer's account standing.
	StatusCodes []constants.AccountStatusCode `query:"status_codes"`
	// Filter by default shipping term IDs.
	ShippingTermIDs []string `query:"shipping_term_ids"`
	// Filter by default payment term IDs.
	PaymentTermIDs []string `query:"payment_term_ids"`
	// Filter by the commission policy set on the customer itself.
	//
	// Policies inherited from the customer's type group or price groups are not considered here.
	CommissionPolicyCodes []constants.CommissionPolicy `query:"commission_status_codes"`
	// Filter by the freight policy set on the customer itself.
	//
	// Policies inherited from the customer's type group or price groups are not considered here.
	FreightPolicyCodes []constants.FreightPolicy `query:"freight_status_codes"`
	// Filter by default carrier IDs.
	CarrierIDs []string `query:"carrier_ids"`
	// Filter by default service level IDs.
	ServiceLevelIDs []string `query:"service_level_ids"`
	// Filter by whether the customer has child accounts.
	ParentAccountStatus *constants.CustomerParentAccountStatus `query:"parent_account_status"`
	// Filter to customers with any address in this city (exact match).
	//
	// When combined with `state` or `postal_code`, a single address must match all provided values.
	City *string `query:"city"`
	// Filter to customers with any address in this state (exact match).
	State *string `query:"state"`
	// Filter to customers with any address in this postal code (exact match).
	PostalCode *string `query:"postal_code"`
	// Filter to customers created at or after this timestamp (inclusive).
	StartDate *time.Time `query:"starts_at"`
	// Filter to customers created at or before this timestamp (inclusive).
	EndDate *time.Time `query:"ends_at"`
}

type ListNotificationRecipientsEndpoint struct{}

type ListNotificationRecipientsRequest struct {
	// Customer ID.
	CustomerID string `path:"id" validate:"required"`
}

type MergeCustomersEndpoint struct{}

type MergeCustomersRequest struct {
	// ID of the target customer that receives the merged records.
	CustomerID string `path:"id" validate:"required"`
	// IDs of the source customers to merge into the target.
	//
	// Sources are deleted after the merge. The list must not contain duplicates or the target customer's ID.
	SourceCustomerIDs []string `json:"source_customer_ids" validate:"required"`
}

type NotificationRecipientInput struct {
	// ID of the account user to receive the notifications.
	//
	// Must be an account user on the customer's own account.
	AccountUserID string `json:"account_user_id" validate:"required"`
	// Order notification types this recipient should receive.
	//
	// Only `order_acknowledgement` and `invoice` can be set here; any other type is rejected.
	NotificationTypes []constants.AccountRelationNotificationType `json:"notification_types" validate:"required,min=1"`
}

type RetrieveCustomerEndpoint struct{}

type RetrieveCustomerLeadTimeEndpoint struct{}

type RetrieveCustomerLeadTimeRequest struct {
	// Customer ID.
	CustomerID string `path:"id" validate:"required"`
}

type RetrieveCustomerRequest struct {
	// Customer ID.
	CustomerID string `path:"id" validate:"required"`
}

type UpdateCustomerEndpoint struct{}

type UpdateCustomerRequest struct {
	// Customer ID.
	CustomerID string `path:"id" validate:"required"`
	// The customer's business name, as shown throughout the app and on documents.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Human-readable customer number used to identify the account, distinct from the `id`.
	//
	// Must be unique within your account.
	Number field.Optional[string] `json:"number,omitzero" validate:"omitempty,max=255"`
	// Free-form note about the customer.
	Note field.Clearable[string] `json:"note,omitzero"`
	// The customer's account standing.
	//
	// - `normal`: standard account with no restrictions.
	// - `preferred`: account flagged for prioritized handling.
	// - `hold_shipment`: the customer's shipments should be held, typically over a credit problem, while orders can still be placed.
	// - `hold_all`: all activity for the customer should be held.
	StatusCode field.Optional[constants.AccountStatusCode] `json:"status,omitzero"`
	// Email address.
	Email field.Clearable[string] `json:"email,omitzero" validate:"omitempty,max=255"`
	// Phone number.
	Phone field.Clearable[string] `json:"phone,omitzero" validate:"omitempty,max=255"`
	// Website URL.
	URL field.Clearable[string] `json:"url,omitzero" validate:"omitempty,max=255"`
	// Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.
	EDIStatus field.Optional[constants.EDIStatus] `json:"edi_status,omitzero"`
	// How sales commission applies to this customer's orders.
	//
	// - `commission_exempt`: this customer's orders are exempt from sales commission.
	// - `commission_applied`: sales commission is calculated on this customer's orders.
	CommissionPolicy field.Optional[constants.CommissionPolicy] `json:"commission_policy,omitzero"`
	// Whether this customer is billed for freight on their orders.
	//
	// - `free_freight`: the customer is not billed for freight.
	// - `billed_freight`: freight is billed to the customer.
	//
	// Freight is also waived when the customer's type group, one of its price groups, or a product line the ordered products belong to is `free_freight`.
	FreightPolicy field.Optional[constants.FreightPolicy] `json:"freight_policy,omitzero"`
	// Calendar days between an order being issued and it being due to ship.
	//
	// Sets each order's `ship_by_date` when it is issued. Clear it to inherit the parent account's lead time, then the customer's account group lead time, then the account default.
	LeadTimeDays field.Clearable[int32] `json:"lead_time_days,omitzero" validate:"omitempty,gte=0,lte=3650"`
	// The operating calendar naming the days this customer's dock accepts freight. Clearing it returns the customer to their group's calendar, then the account default.
	ReceiveCalendarID field.Clearable[string] `json:"receive_calendar_id,omitzero" validate:"omitempty"`
	// How this customer's orders are produced.
	//
	// - `make_to_stock`: their order history feeds the production-schedule forecast, so stock is built ahead of their demand.
	// - `make_to_order`: their history is left out of the forecast; their orders are produced only once placed, and fit into the schedule on their own ship-by dates.
	//
	// Clearing it returns the customer to their account group policy, then the make-to-stock default.
	FulfillmentPolicy field.Clearable[constants.FulfillmentPolicy] `json:"fulfillment_policy,omitzero"`
	// ID of the carrier used on this customer's orders when the order does not specify one.
	DefaultCarrierID field.Optional[string] `json:"default_carrier_id,omitzero" validate:"omitempty"`
	// ID of the carrier service level used when an order takes its carrier from this customer's default.
	DefaultServiceLevelID field.Clearable[string] `json:"default_service_level_id,omitzero" validate:"omitempty"`
	// ID of the payment term used on this customer's orders when the order does not specify one.
	DefaultPaymentTermID field.Optional[string] `json:"default_payment_term_id,omitzero" validate:"omitempty"`
	// ID of the shipping term used on this customer's orders when the order does not specify one.
	DefaultShippingTermID field.Optional[string] `json:"default_shipping_term_id,omitzero" validate:"omitempty"`
	// Priority used to pre-fill new orders for this customer.
	DefaultPriorityCode field.Optional[constants.PriorityCode] `json:"default_priority,omitzero"`
	// The ID of the account user to credit as the sales rep on this customer's orders.
	//
	// Must be an account user on your own account.
	DefaultSalesRepID field.Clearable[string] `json:"default_sales_rep_id,omitzero" validate:"omitempty"`
	// ID of an existing address to use as the default billing address.
	//
	// The address is linked to the customer's account if it is not already.
	BillToAddressID field.Clearable[string] `json:"bill_to_address_id,omitzero" validate:"omitempty"`
	// ID of an existing address to use as the default shipping address.
	//
	// The address is linked to the customer's account if it is not already.
	ShipToAddressID field.Clearable[string] `json:"ship_to_address_id,omitzero" validate:"omitempty"`
	// IDs of the account groups of type `pricing_group` to assign to this customer, used to apply pricing rules.
	//
	// When provided, replaces the customer's full set of existing price groups.
	CustomerPriceGroupIDs field.Optional[[]string] `json:"customer_price_group_ids,omitzero"`
	// ID of the account group of type `type_group` that categorizes this customer (for example "Distributors").
	CustomerTypeGroupID field.Optional[string] `json:"customer_type_group_id,omitzero" validate:"omitempty"`
	// Who pays the carrier for shipments.
	//
	// - `sender`: the shipper (you) pays the carrier.
	// - `third_party`: a third party is billed, using `carrier_billing_account`.
	CarrierBillingType field.Optional[constants.CarrierBillingType] `json:"carrier_billing_type,omitzero"`
	// Carrier billing account number charged when `carrier_billing_type` is `third_party`.
	CarrierBillingAccount field.Clearable[string] `json:"carrier_billing_account,omitzero" validate:"omitempty,max=255"`
	// Maximum credit extended to this customer.
	CreditLimit field.Clearable[apirequest.QuantityInput] `json:"credit_limit,omitzero"`
}

type UpdateNotificationRecipientsEndpoint struct{}

type UpdateNotificationRecipientsRequest struct {
	// Customer ID.
	CustomerID string `path:"id" validate:"required"`
	// The complete desired set of default notification recipients.
	//
	// Any recipient not included is removed; send an empty list to remove them all.
	Recipients []NotificationRecipientInput `json:"recipients" validate:"dive"`
}