@aifeatures/admin-react 0.13.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -129,11 +129,38 @@ interface ApiError {
129
129
  * request, which makes showing an outage and a Retry actively misleading —
130
130
  * the retry repeats the same 400 forever, and the thing to change is a goal.
131
131
  *
132
- * All four are EXPECTED consequences of the request, never outages, so a
132
+ * `goal_not_found` says the named goal does not exist on this site. Emitted
133
+ * by the goals CRUD and by the conversions drill-down, which resolves a goal
134
+ * by display name.
135
+ *
136
+ * `goal_has_no_targets` is the drill-down's own, and it is a fact about the
137
+ * GOAL rather than the request: the goal matches events that carry no link,
138
+ * so there are no values to break down. `Form: Submission` has thousands of
139
+ * conversions and no recorded targets, because nothing says WHICH form. A
140
+ * client must not render this as "no conversions" — the number above it says
141
+ * otherwise — and must not offer a Retry.
142
+ *
143
+ * `filters_unsupported` (plural) is NOT `filter_unsupported` above. The
144
+ * singular one says a filter cannot be answered for this site and period;
145
+ * this one says the report refuses filters outright, because answering an
146
+ * unfiltered report under a filtered request is indistinguishable from
147
+ * honouring it. Conversions and its drill-down both emit it.
148
+ *
149
+ * `invalid_limit` is an ordinary bad parameter, included because a consumer
150
+ * narrowing on this union otherwise cannot name it.
151
+ *
152
+ * All of these are EXPECTED consequences of the request, never outages, so a
133
153
  * client that cannot tell them apart from an unreachable source shows the
134
154
  * wrong recovery for every one of them.
135
- */
136
- code?: 'filter_unsupported' | 'range_invalid' | 'dimension_unsupported' | 'goals_exceed_report_budget';
155
+ *
156
+ * NOT EXHAUSTIVE, and worth knowing before you narrow on it: the API emits
157
+ * several more codes this union has never listed — `goal_invalid`,
158
+ * `goal_conflict`, `goal_name_taken`, `goal_limit_reached`,
159
+ * `funnel_not_found`, `funnel_step_missing` and
160
+ * `funnel_window_precedes_coverage` among them. They belong here, but adding
161
+ * them is a change to the goals and funnels surfaces rather than this one.
162
+ */
163
+ code?: 'filter_unsupported' | 'filters_unsupported' | 'range_invalid' | 'dimension_unsupported' | 'goals_exceed_report_budget' | 'goal_not_found' | 'goal_has_no_targets' | 'invalid_limit';
137
164
  }
138
165
  /**
139
166
  * A site's payment readiness (sites.paymentsStatus)
package/dist/index.d.ts CHANGED
@@ -129,11 +129,38 @@ interface ApiError {
129
129
  * request, which makes showing an outage and a Retry actively misleading —
130
130
  * the retry repeats the same 400 forever, and the thing to change is a goal.
131
131
  *
132
- * All four are EXPECTED consequences of the request, never outages, so a
132
+ * `goal_not_found` says the named goal does not exist on this site. Emitted
133
+ * by the goals CRUD and by the conversions drill-down, which resolves a goal
134
+ * by display name.
135
+ *
136
+ * `goal_has_no_targets` is the drill-down's own, and it is a fact about the
137
+ * GOAL rather than the request: the goal matches events that carry no link,
138
+ * so there are no values to break down. `Form: Submission` has thousands of
139
+ * conversions and no recorded targets, because nothing says WHICH form. A
140
+ * client must not render this as "no conversions" — the number above it says
141
+ * otherwise — and must not offer a Retry.
142
+ *
143
+ * `filters_unsupported` (plural) is NOT `filter_unsupported` above. The
144
+ * singular one says a filter cannot be answered for this site and period;
145
+ * this one says the report refuses filters outright, because answering an
146
+ * unfiltered report under a filtered request is indistinguishable from
147
+ * honouring it. Conversions and its drill-down both emit it.
148
+ *
149
+ * `invalid_limit` is an ordinary bad parameter, included because a consumer
150
+ * narrowing on this union otherwise cannot name it.
151
+ *
152
+ * All of these are EXPECTED consequences of the request, never outages, so a
133
153
  * client that cannot tell them apart from an unreachable source shows the
134
154
  * wrong recovery for every one of them.
135
- */
136
- code?: 'filter_unsupported' | 'range_invalid' | 'dimension_unsupported' | 'goals_exceed_report_budget';
155
+ *
156
+ * NOT EXHAUSTIVE, and worth knowing before you narrow on it: the API emits
157
+ * several more codes this union has never listed — `goal_invalid`,
158
+ * `goal_conflict`, `goal_name_taken`, `goal_limit_reached`,
159
+ * `funnel_not_found`, `funnel_step_missing` and
160
+ * `funnel_window_precedes_coverage` among them. They belong here, but adding
161
+ * them is a change to the goals and funnels surfaces rather than this one.
162
+ */
163
+ code?: 'filter_unsupported' | 'filters_unsupported' | 'range_invalid' | 'dimension_unsupported' | 'goals_exceed_report_budget' | 'goal_not_found' | 'goal_has_no_targets' | 'invalid_limit';
137
164
  }
138
165
  /**
139
166
  * A site's payment readiness (sites.paymentsStatus)