@delopay/sdk 0.304.0 → 0.305.0

package/dist/{index-CX18XhHn.d.cts → index-DR2pMx-H.d.cts}

@@ -13222,6 +13222,11 @@ type ParentGroup = 'Operations' | 'Refunds'
  | 'AnalyticsDevices'
 /** Carved out of `Analytics`: the countries & cities surface. */
  | 'AnalyticsGeo'
+/**
+ * Period Reports: calendar weeks and months for the shops the role covers
+ * (todos#346). Read-only. An `Analytics` grant expands to it.
+ */
+ | 'AnalyticsReports'
 /** Carved out of `Workflows`. */
  | 'Routing'
 /**
@@ -13442,6 +13447,11 @@ interface ScopeDrillBase extends DrillListControls<ScopeDrillSortKey> {
     country?: string | null;
     country_source?: string | null;
     device_class?: string | null;
+    /**
+     * The zone the series' day buckets were local days of, so a `YYYY-MM-DD`
+     * `target_bucket` spans that local day.
+     */
+    timezone?: string | null;
     /**
      * Which clicked metric this drill is for, so the list reproduces the number
      * that was clicked.
@@ -13572,6 +13582,15 @@ interface AnalyticsScopeRequest {
      * | `unknown` (rows whose render predates classification).
      */
     device_class?: string | null;
+    /**
+     * IANA time zone the day buckets are local calendar days of, e.g.
+     * `Europe/Berlin`. Omit for UTC days. Only the `day` grain reads it: each
+     * bucket is then one local calendar day, so days sum exactly into calendar
+     * weeks and months, and `end_date`, `days` and the previous window count
+     * local days. A zoned request always aggregates live. Older backends ignore
+     * it and answer UTC days; check the response's `timezone`.
+     */
+    timezone?: string | null;
 }
 /**
  * One bucket of aggregated payment activity — a calendar day, or a single UTC
@@ -13684,6 +13703,11 @@ interface AnalyticsScopeResponse {
      * for daily buckets, where `end_date` + `days` describe the axis.
      */
     bucket_start?: string | null;
+    /**
+     * The IANA zone the day buckets are local days of, in its canonical
+     * spelling; absent for UTC days and on backends that predate zoned days.
+     */
+    timezone?: string | null;
     series: AnalyticsDayBucket[];
     /**
      * Equal-length previous window (for period-over-period deltas + comparison).
@@ -26269,6 +26293,16 @@ declare class Analytics {
      * shop. `GET /analytics/scope`
      */
     scope(params?: AnalyticsScopeRequest): Promise<AnalyticsScopeResponse>;
+    /**
+     * Period Reports: the scoped daily series, pinned exactly like `scope`, but
+     * gated on the Period Reports permission area instead of Payment
+     * Performance. Pass `timezone` and each day bucket is a local calendar day,
+     * which sums exactly into calendar weeks and months. Answers only the
+     * `series`, `previous` and `children` blocks and ignores country and device
+     * filters. Accepts a dashboard session or an API key, including a
+     * `statistics_read` key. `GET /analytics/reports`
+     */
+    reports(params?: AnalyticsScopeRequest): Promise<AnalyticsScopeResponse>;
     /**
      * Shop comparison: one series per shop over one window, with whole-window
      * and previous-window totals, so shops can be drawn side by side. Pinned

package/dist/{index-CX18XhHn.d.ts → index-DR2pMx-H.d.ts}

@@ -13222,6 +13222,11 @@ type ParentGroup = 'Operations' | 'Refunds'
  | 'AnalyticsDevices'
 /** Carved out of `Analytics`: the countries & cities surface. */
  | 'AnalyticsGeo'
+/**
+ * Period Reports: calendar weeks and months for the shops the role covers
+ * (todos#346). Read-only. An `Analytics` grant expands to it.
+ */
+ | 'AnalyticsReports'
 /** Carved out of `Workflows`. */
  | 'Routing'
 /**
@@ -13442,6 +13447,11 @@ interface ScopeDrillBase extends DrillListControls<ScopeDrillSortKey> {
     country?: string | null;
     country_source?: string | null;
     device_class?: string | null;
+    /**
+     * The zone the series' day buckets were local days of, so a `YYYY-MM-DD`
+     * `target_bucket` spans that local day.
+     */
+    timezone?: string | null;
     /**
      * Which clicked metric this drill is for, so the list reproduces the number
      * that was clicked.
@@ -13572,6 +13582,15 @@ interface AnalyticsScopeRequest {
      * | `unknown` (rows whose render predates classification).
      */
     device_class?: string | null;
+    /**
+     * IANA time zone the day buckets are local calendar days of, e.g.
+     * `Europe/Berlin`. Omit for UTC days. Only the `day` grain reads it: each
+     * bucket is then one local calendar day, so days sum exactly into calendar
+     * weeks and months, and `end_date`, `days` and the previous window count
+     * local days. A zoned request always aggregates live. Older backends ignore
+     * it and answer UTC days; check the response's `timezone`.
+     */
+    timezone?: string | null;
 }
 /**
  * One bucket of aggregated payment activity — a calendar day, or a single UTC
@@ -13684,6 +13703,11 @@ interface AnalyticsScopeResponse {
      * for daily buckets, where `end_date` + `days` describe the axis.
      */
     bucket_start?: string | null;
+    /**
+     * The IANA zone the day buckets are local days of, in its canonical
+     * spelling; absent for UTC days and on backends that predate zoned days.
+     */
+    timezone?: string | null;
     series: AnalyticsDayBucket[];
     /**
      * Equal-length previous window (for period-over-period deltas + comparison).
@@ -26269,6 +26293,16 @@ declare class Analytics {
      * shop. `GET /analytics/scope`
      */
     scope(params?: AnalyticsScopeRequest): Promise<AnalyticsScopeResponse>;
+    /**
+     * Period Reports: the scoped daily series, pinned exactly like `scope`, but
+     * gated on the Period Reports permission area instead of Payment
+     * Performance. Pass `timezone` and each day bucket is a local calendar day,
+     * which sums exactly into calendar weeks and months. Answers only the
+     * `series`, `previous` and `children` blocks and ignores country and device
+     * filters. Accepts a dashboard session or an API key, including a
+     * `statistics_read` key. `GET /analytics/reports`
+     */
+    reports(params?: AnalyticsScopeRequest): Promise<AnalyticsScopeResponse>;
     /**
      * Shop comparison: one series per shop over one window, with whole-window
      * and previous-window totals, so shops can be drawn side by side. Pinned

package/dist/index.cjs

@@ -5979,6 +5979,20 @@ var Analytics = class {
       query: params
     });
   }
+  /**
+   * Period Reports: the scoped daily series, pinned exactly like `scope`, but
+   * gated on the Period Reports permission area instead of Payment
+   * Performance. Pass `timezone` and each day bucket is a local calendar day,
+   * which sums exactly into calendar weeks and months. Answers only the
+   * `series`, `previous` and `children` blocks and ignores country and device
+   * filters. Accepts a dashboard session or an API key, including a
+   * `statistics_read` key. `GET /analytics/reports`
+   */
+  async reports(params) {
+    return this.request("GET", "/analytics/reports", {
+      query: params
+    });
+  }
   /**
    * Shop comparison: one series per shop over one window, with whole-window
    * and previous-window totals, so shops can be drawn side by side. Pinned