utilsep

type CheckDuplicateEndpoint struct{}

type CheckDuplicateRequest struct {
	// The kind of record number to check.
	//
	// - `invoice_number`: checks invoice numbers.
	// - `order_number`: checks sales order numbers.
	// - `customer_po_number`: checks customer PO numbers on sales orders; requires `customer_id`.
	Type string `json:"type" validate:"required"`
	// The record number to check for an existing match.
	//
	// Surrounding whitespace is trimmed before the number is compared against existing records.
	RecordNumber string `json:"record_number" validate:"required"`
	// ID of the customer to scope the check to.
	//
	// Required when `type` is `customer_po_number`; ignored for other types.
	CustomerID field.Optional[string] `json:"customer_id,omitzero"`
}

type EmailRecordEndpoint struct{}

type EmailRecordRequest struct {
	// ID of the record to email.
	ID string `json:"id" validate:"required"`
	// The type of record to email.
	//
	// - `invoice`: emails the invoice to the contacts on its sales order that are set to receive invoice emails.
	// - `sales_order`: sends an order acknowledgement to the order's acknowledgement recipients.
	// - `purchase_order`: sends the purchase order submission to the order's submission recipients.
	Type constants.EmailRecordType `json:"type" validate:"required"`
}

type RequestDemoEndpoint struct{}

type RequestDemoRequest struct {
	// Full name of the person requesting the demo.
	Name string `json:"name" validate:"required"`
	// Email address to reach the requester at.
	Email string `json:"email" validate:"required,custom_email"`
	// Name of the company the requester represents.
	Company string `json:"company" validate:"required"`
	// Phone number to reach the requester at.
	PhoneNumber field.Optional[string] `json:"phone_number,omitzero"`
	// Free-form note from the requester about what they would like to see.
	Message field.Optional[string] `json:"message,omitzero"`
}

type SubmitFeedbackEndpoint struct{}

type SubmitFeedbackRequest struct {
	// The question the user was prompted with.
	Question string `json:"question" validate:"required"`
	// The user's response to the question.
	Answer string `json:"answer" validate:"required"`
	// URL of the page the user was on when they answered, recorded so the feedback can be read in context.
	PageURL field.Optional[string] `json:"page_url,omitzero"`
}

type UtilsSvc interface {
	CheckDuplicate(ctx context.Context, req *CheckDuplicateRequest) (*apiresource.CheckDuplicateResult, *apierror.APIError)
	EmailRecord(ctx context.Context, req *EmailRecordRequest) (*apiresource.EmptyResource, *apierror.APIError)
	RequestDemo(ctx context.Context, req *RequestDemoRequest) (*apiresource.MessageResource, *apierror.APIError)
	SubmitFeedback(ctx context.Context, req *SubmitFeedbackRequest) (*apiresource.MessageResource, *apierror.APIError)
}

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