analyticsep

type AnalyticsSvc interface {
	AnalyzeSales(ctx context.Context, req *AnalyzeSalesRequest) (*apiresource.AnalyzeSalesResponse, *apierror.APIError)
	AnalyzeOpenBatches(ctx context.Context, req *AnalyzeOpenBatchesRequest) (*apiresource.AnalyzeOpenBatchesResponse, *apierror.APIError)
	AnalyzeProductionCosts(ctx context.Context, req *AnalyzeProductionCostsRequest) (*apiresource.AnalyzeProductionCostsResponse, *apierror.APIError)
	AnalyzeDeliveries(ctx context.Context, req *AnalyzeDeliveriesRequest) (*apiresource.AnalyzeDeliveriesResponse, *apierror.APIError)
	AnalyzeManufacturing(ctx context.Context, req *AnalyzeManufacturingRequest) (*apiresource.AnalyzeManufacturingResponse, *apierror.APIError)
	AnalyzeManufacturingBatch(ctx context.Context, req *AnalyzeManufacturingBatchRequest) (*apiresource.AnalyzeManufacturingBatchResponse, *apierror.APIError)
	AnalyzeOrders(ctx context.Context, req *AnalyzeOrdersRequest) (*apiresource.AnalyzeOrdersResponse, *apierror.APIError)
	AnalyzeQuarterlyOrders(ctx context.Context, req *AnalyzeQuarterlyOrdersRequest) (*apiresource.AnalyzeQuarterlyOrdersResponse, *apierror.APIError)
	AnalyzeMaterials(ctx context.Context, req *AnalyzeMaterialsRequest) (*apiresource.AnalyzeMaterialsResponse, *apierror.APIError)
	AnalyzeInventoryReceipts(ctx context.Context, req *AnalyzeInventoryReceiptsRequest) (*apiresource.AnalyzeInventoryReceiptsResponse, *apierror.APIError)
	AnalyzeNewCustomers(ctx context.Context, req *AnalyzeNewCustomersRequest) (*apiresource.AnalyzeNewCustomersResponse, *apierror.APIError)
	AnalyzeDemandForecast(ctx context.Context, req *AnalyzeDemandForecastRequest) (*apiresource.AnalyzeDemandForecastResponse, *apierror.APIError)
	AnalyzeOee(ctx context.Context, req *AnalyzeOeeRequest) (*apiresource.AnalyzeOeeResponse, *apierror.APIError)
	AnalyzeOeeTrend(ctx context.Context, req *AnalyzeOeeTrendRequest) (*apiresource.AnalyzeOeeTrendResponse, *apierror.APIError)
	AnalyzeScheduleAttainment(ctx context.Context, req *AnalyzeScheduleAttainmentRequest) (*apiresource.AnalyzeScheduleAttainmentResponse, *apierror.APIError)
	AnalyzeDeliveryPerformance(ctx context.Context, req *AnalyzeDeliveryPerformanceRequest) (*apiresource.AnalyzeDeliveryPerformanceResponse, *apierror.APIError)
	AnalyzeWeeksOfSales(ctx context.Context, req *AnalyzeWeeksOfSalesRequest) (*apiresource.AnalyzeWeeksOfSalesResponse, *apierror.APIError)
	AnalyzeCustomerPricing(ctx context.Context, req *AnalyzeCustomerPricingRequest) (*apiresource.AnalyzeCustomerPricingResponse, *apierror.APIError)
	AnalyzeRealizedMargins(ctx context.Context, req *AnalyzeRealizedMarginsRequest) (*apiresource.AnalyzeRealizedMarginsResponse, *apierror.APIError)
}

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

type AnalyzeCustomerPricingEndpoint struct{}

type AnalyzeCustomerPricingRequest struct {
	// Restrict the analysis to these customers. Omit to cover every customer with a contracted price.
	//
	// Peer medians are still computed across all customers, so narrowing the result does not change what a price is compared against.
	CustomerIDs []string `json:"customer_ids,omitzero"`
	// Restrict the analysis to customers in these customer groups.
	CustomerGroupIDs []string `json:"customer_group_ids,omitzero"`
	// The gross margin a price is expected to clear, as a fraction between 0 and 1.
	TargetGrossMargin field.Optional[string] `json:"target_gross_margin,omitzero" format:"decimal"`
	// How far below the peer median a price must sit to be flagged, as a fraction between 0 and 1.
	OutlierTolerance field.Optional[string] `json:"outlier_tolerance,omitzero" format:"decimal"`
}

type AnalyzeDeliveriesEndpoint struct{}

type AnalyzeDeliveriesRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Optional customer IDs to filter by.
	CustomerIDs []string `json:"customer_ids,omitempty"`
	// Optional customer group IDs to filter by.
	CustomerGroupIDs []string `json:"customer_group_ids,omitempty"`
	// Optional sales rep IDs to filter by.
	SalesRepIDs []string `json:"sales_rep_ids,omitempty"`
	// Optional target delivery time in days.
	TargetDeliveryTimeDays *int64 `json:"target_delivery_time_days,omitempty"`
	// Whether to override promised dates with the target delivery time.
	OverridePromisedDates *bool `json:"override_promised_dates,omitempty"`
}

type AnalyzeDeliveryPerformanceEndpoint struct{}

type AnalyzeDeliveryPerformanceRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// The period to break the results down by. Defaults to `week`.
	Granularity field.Optional[constants.DeliveryGranularity] `json:"granularity,omitzero"`
	// Only measure orders bought by these customers. Their child accounts are included, matching how the sales analytics resolve a customer.
	CustomerIDs []string `json:"customer_ids,omitempty"`
	// Only measure orders whose customer sits in these groups.
	CustomerGroupIDs []string `json:"customer_group_ids,omitempty"`
	// Only measure orders containing at least one line in these product lines.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Only measure orders owned by these sales reps.
	SalesRepIDs []string `json:"sales_rep_ids,omitempty"`
}

type AnalyzeDemandForecastEndpoint struct{}

type AnalyzeDemandForecastRequest struct {
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Optional item IDs to filter by.
	ItemIDs []string `json:"item_ids,omitempty"`
	// Optional number of months of historical data to use.
	HistoryMonths *int64 `json:"history_months,omitempty"`
	// Optional number of months to forecast.
	ForecastMonths *int64 `json:"forecast_months,omitempty"`
}

type AnalyzeInventoryReceiptsEndpoint struct{}

type AnalyzeInventoryReceiptsRequest struct {
	// Optional item IDs to filter by.
	ItemIDs []string `json:"item_ids,omitempty"`
	// Optional location IDs to filter by.
	LocationIDs []string `json:"location_ids,omitempty"`
	// Optional lot IDs to filter by.
	LotIDs []string `json:"lot_ids,omitempty"`
}

type AnalyzeManufacturingBatchEndpoint struct{}

type AnalyzeManufacturingBatchRequest struct {
	// The start date for the current analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the current analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// The start date for the comparison period.
	ComparisonStartDate time.Time `json:"comparison_starts_at" validate:"required"`
	// The end date for the comparison period.
	ComparisonEndDate time.Time `json:"comparison_ends_at" validate:"required"`
	// Optional customer IDs to filter by.
	CustomerIDs []string `json:"customer_ids,omitempty"`
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Optional customer group IDs to filter by.
	CustomerGroupIDs []string `json:"customer_group_ids,omitempty"`
	// Optional item IDs to filter by.
	ItemIDs []string `json:"item_ids,omitempty"`
}

type AnalyzeManufacturingEndpoint struct{}

type AnalyzeManufacturingRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// The type of manufacturing analytics to compute.
	Type string `json:"type" validate:"required"`
}

type AnalyzeMaterialsEndpoint struct{}

type AnalyzeMaterialsRequest struct {
	// Optional sales order IDs to filter by.
	SalesOrderIDs []string `json:"sales_order_ids,omitempty"`
	// Optional supplier IDs to filter by.
	SupplierIDs []string `json:"supplier_ids,omitempty"`
}

type AnalyzeNewCustomersEndpoint struct{}

type AnalyzeNewCustomersRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// Optional customer group IDs to filter by.
	CustomerGroupIDs []string `json:"customer_group_ids,omitempty"`
	// Optional sales rep IDs to filter by.
	SalesRepIDs []string `json:"sales_rep_ids,omitempty"`
}

type AnalyzeOeeEndpoint struct{}

type AnalyzeOeeRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// Optional department IDs to filter by.
	DepartmentIDs []string `json:"department_ids,omitzero"`
	// Scheduled production time per department for the period. Availability, performance and OEE are only returned for departments this covers.
	PlannedTime []OeeDepartmentPlannedTime `json:"planned_time,omitzero"`
}

type AnalyzeOeeTrendEndpoint struct{}

type AnalyzeOeeTrendRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// Restrict the analysis to these departments.
	DepartmentIDs []string `json:"department_ids,omitzero"`
}

type AnalyzeOpenBatchesEndpoint struct{}

type AnalyzeOpenBatchesRequest struct {
	// Optional item IDs to filter by.
	ItemIDs []string `json:"item_ids,omitempty"`
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
}

type AnalyzeOrdersEndpoint struct{}

type AnalyzeOrdersRequest struct {
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Optional customer IDs to filter by.
	CustomerIDs []string `json:"customer_ids,omitempty"`
	// Optional sales rep IDs to filter by.
	SalesRepIDs []string `json:"sales_rep_ids,omitempty"`
	// Optional customer group IDs to filter by.
	CustomerGroupIDs []string `json:"customer_group_ids,omitempty"`
}

type AnalyzeProductionCostsEndpoint struct{}

type AnalyzeProductionCostsRequest struct {
	// Optional start date for the analysis period.
	StartDate *time.Time `json:"starts_at,omitempty"`
	// Optional end date for the analysis period.
	EndDate *time.Time `json:"ends_at,omitempty"`
	// Optional item IDs to filter by.
	ItemIDs []string `json:"item_ids,omitempty"`
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Optional department IDs to filter by.
	DepartmentIDs []string `json:"department_ids,omitempty"`
	// Optional category IDs to filter by.
	CategoryIDs []string `json:"category_ids,omitempty"`
}

type AnalyzeQuarterlyOrdersEndpoint struct{}

type AnalyzeQuarterlyOrdersRequest struct {
	// Optional sales rep IDs to filter by.
	SalesRepIDs []string `json:"sales_rep_ids,omitempty"`
	// Optional item IDs to filter by.
	ItemIDs []string `json:"item_ids,omitempty"`
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Optional customer IDs to filter by.
	CustomerIDs []string `json:"customer_ids,omitempty"`
	// Optional customer group IDs to filter by.
	CustomerGroupIDs []string `json:"customer_group_ids,omitempty"`
}

type AnalyzeRealizedMarginsEndpoint struct{}

type AnalyzeRealizedMarginsRequest struct {
	// Start of the invoiced window.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// End of the invoiced window.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// Restrict the result to these customers.
	//
	// Peer medians are still computed across every customer that bought the SKU, so narrowing the result does not change what a price is compared against.
	CustomerIDs []string `json:"customer_ids,omitzero"`
	// Restrict the result to customers in these customer groups.
	CustomerGroupIDs []string `json:"customer_group_ids,omitzero"`
	// Restrict the result to these product lines.
	ProductLineIDs []string `json:"product_line_ids,omitzero"`
	// The gross margin a sale is expected to clear, as a fraction between 0 and 1.
	TargetGrossMargin field.Optional[string] `json:"target_gross_margin,omitzero" format:"decimal"`
	// How far below the peer median an achieved price must sit to be flagged, as a fraction between 0 and 1.
	OutlierTolerance field.Optional[string] `json:"outlier_tolerance,omitzero" format:"decimal"`
}

type AnalyzeSalesEndpoint struct{}

type AnalyzeSalesRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// Optional product line IDs to filter by.
	ProductLineIDs []string `json:"product_line_ids,omitempty"`
	// Optional customer IDs to filter by.
	CustomerIDs []string `json:"customer_ids,omitempty"`
	// Optional sales rep IDs to filter by.
	SalesRepIDs []string `json:"sales_rep_ids,omitempty"`
	// Optional customer group IDs to filter by.
	CustomerGroupIDs []string `json:"customer_group_ids,omitempty"`
	// Optional search query.
	Query *string `json:"query,omitempty"`
}

type AnalyzeScheduleAttainmentEndpoint struct{}

type AnalyzeScheduleAttainmentRequest struct {
	// The start date for the analysis period.
	StartDate time.Time `json:"starts_at" validate:"required"`
	// The end date for the analysis period.
	EndDate time.Time `json:"ends_at" validate:"required"`
	// The dimension to break the results down by. Defaults to `week`.
	GroupBy field.Optional[constants.AttainmentGroupBy] `json:"group_by,omitzero"`
	// Only measure production on these machines.
	MachineIDs []string `json:"machine_ids,omitzero"`
	// Only measure production in these departments.
	DepartmentIDs []string `json:"department_ids,omitzero"`
}

type AnalyzeWeeksOfSalesEndpoint struct{}

type AnalyzeWeeksOfSalesRequest struct {
	// The number of weeks to use for the sales period. Defaults to 4.
	//
	// A period is a divisor of demand, so zero and negative values are rejected rather than quietly substituted with the default — a caller who asked for an impossible period should be told, not handed the answer to a different question.
	PeriodInWeeks *int32 `query:"period_in_weeks" validate:"omitempty,min=1,max=520"`
}

type OeeDepartmentPlannedTime struct {
	// The department ID.
	DepartmentID string `json:"department_id" validate:"required"`
	// Scheduled production hours for the period.
	PlannedHours float64 `json:"planned_hours" validate:"required"`
}