mdd-printful-client 0.2.1

package/resources/reports.d.ts

@@ -0,0 +1,363 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Reports extends APIResource {
+    /**
+     * Returns statistics for specified report types.
+     *
+     * You need to specify the report types you want to retrieve in the `report_types`
+     * query parameter as a comma-separated list, e.g.
+     * `report_types=sales_and_costs,profit`.
+     *
+     * **Note**: You cannot get statistics for a period longer than 6 months.
+     *
+     * #### Example
+     *
+     * To get statistics in the default currency of a store for `sales_and_costs` and
+     * `profit` reports for August 2022, you can use the following URL:
+     * https://api.printful.com/reports/statistics?report_types=sales_and_costs,profit&date_from=2022-08-01&date_to=2022-08-31.
+     *
+     * ### Report types
+     *
+     * Currently, the following report types are available:
+     *
+     * | Report type                | Description                                              |
+     * | -------------------------- | -------------------------------------------------------- |
+     * | `sales_and_costs`          | Detailed information on sales and costs grouped by date. |
+     * | `sales_and_costs_summary`  | Short information on sales and costs grouped by date.    |
+     * | `printful_costs`           | Amount paid to Printful for fulfillment and shipping.    |
+     * | `profit`                   | Profit in the specified period.                          |
+     * | `total_paid_orders`        | The number of paid orders in the specified period.       |
+     * | `costs_by_amount`          | Information on costs by amount grouped by date.          |
+     * | `costs_by_product`         | Information on costs grouped by product.                 |
+     * | `costs_by_variant`         | Information on costs grouped by variant.                 |
+     * | `average_fulfillment_time` | Average time it took Printful to fulfill your orders.    |
+     *
+     * The response structure for the specific reports is documented in the response
+     * schema (`result.store_statistics.[reportName]`).
+     */
+    retrieveStatistics(params: ReportRetrieveStatisticsParams, options?: RequestOptions): APIPromise<ReportRetrieveStatisticsResponse>;
+}
+export interface ReportRetrieveStatisticsResponse {
+    /**
+     * Response status code `200`
+     */
+    code?: number;
+    /**
+     * Statistics
+     */
+    result?: ReportRetrieveStatisticsResponse.Result;
+}
+export declare namespace ReportRetrieveStatisticsResponse {
+    /**
+     * Statistics
+     */
+    interface Result {
+        /**
+         * The statistics for each store (currently only a single store is supported).
+         */
+        store_statistics?: Array<Result.StoreStatistic>;
+    }
+    namespace Result {
+        /**
+         * Statistics for a single store
+         */
+        interface StoreStatistic {
+            /**
+             * Average fulfillment time report
+             */
+            average_fulfillment_time?: StoreStatistic.AverageFulfillmentTime;
+            /**
+             * Costs by amount report
+             */
+            costs_by_amount?: Array<StoreStatistic.CostsByAmount>;
+            /**
+             * Costs by product report
+             */
+            costs_by_product?: Array<StoreStatistic.CostsByProduct>;
+            /**
+             * Costs by variant report
+             */
+            costs_by_variant?: Array<StoreStatistic.CostsByVariant>;
+            /**
+             * The code of the currency in which the statistics are returned
+             */
+            currency?: string;
+            /**
+             * Printful costs report
+             */
+            printful_costs?: StoreStatistic.PrintfulCosts;
+            /**
+             * Profit report
+             */
+            profit?: StoreStatistic.Profit;
+            /**
+             * Sales and costs report
+             */
+            sales_and_costs?: Array<StoreStatistic.SalesAndCost>;
+            /**
+             * Sales and costs summary report
+             */
+            sales_and_costs_summary?: Array<StoreStatistic.SalesAndCostsSummary>;
+            /**
+             * The ID of the store for which the statistics are returned
+             */
+            store_id?: number;
+            /**
+             * Total paid orders report
+             */
+            total_paid_orders?: StoreStatistic.TotalPaidOrders;
+        }
+        namespace StoreStatistic {
+            /**
+             * Average fulfillment time report
+             */
+            interface AverageFulfillmentTime {
+                /**
+                 * Relative difference from the value from the previous period. -1 means 100%
+                 * decrease, 1 means 100% increase. 0 is returned if there is no change or the
+                 * previous value was 0.
+                 */
+                relative_difference?: number;
+                /**
+                 * Average time it took Printful to fulfill your orders.
+                 */
+                value?: number;
+            }
+            interface CostsByAmount {
+                /**
+                 * Pack-in costs
+                 */
+                branding?: number;
+                /**
+                 * The date of the value: day in `Y-m-d` format, month in `Y-m` format or "Total"
+                 * for the first element of the list which shows the total values for the whole
+                 * requested period
+                 */
+                date?: string;
+                /**
+                 * Embroidery digitization costs
+                 */
+                digitization?: number;
+                /**
+                 * Any fulfillment discounts (such as the monthly discount) set up on Printful's
+                 * side
+                 */
+                discount?: number;
+                /**
+                 * Product & fulfillment costs
+                 */
+                product_amount?: number;
+                /**
+                 * Tax amounts. If not applicable, it will be 0.
+                 */
+                sales_tax?: number;
+                /**
+                 * Shipping costs that were charged by Printful
+                 */
+                shipping?: number;
+                /**
+                 * Summary of all costs
+                 */
+                total?: number;
+                /**
+                 * Tax amounts. If not applicable, it will be 0.
+                 */
+                vat?: number;
+            }
+            interface CostsByProduct {
+                /**
+                 * All fulfillment costs that are charged by Printful, excluding shipping.
+                 */
+                fulfillment?: number;
+                /**
+                 * Product ID. See [Catalog API](#tag/Catalog-API).
+                 */
+                product_id?: number;
+                /**
+                 * Product name.
+                 */
+                product_name?: string;
+                /**
+                 * Total quantity of items ordered from this product in the selected period.
+                 */
+                quantity?: number;
+                /**
+                 * Order retail price data. Available only if retail price fields are properly set
+                 * up on the integration's side.
+                 */
+                sales?: number;
+            }
+            interface CostsByVariant {
+                /**
+                 * All fulfillment costs that are charged by Printful, excluding shipping.
+                 */
+                fulfillment?: number;
+                /**
+                 * Product ID. See [Catalog API](#tag/Catalog-API).
+                 */
+                product_id?: number;
+                /**
+                 * Total quantity of items ordered from this product in the selected period.
+                 */
+                quantity?: number;
+                /**
+                 * Order retail price data. Available only if retail price fields are properly set
+                 * up on the integration's side.
+                 */
+                sales?: number;
+                /**
+                 * Variant ID. See [Catalog API](#tag/Catalog-API).
+                 */
+                variant_id?: number;
+                /**
+                 * Variant name.
+                 */
+                variant_name?: string;
+            }
+            /**
+             * Printful costs report
+             */
+            interface PrintfulCosts {
+                /**
+                 * Relative difference from the value from the previous period. -1 means 100%
+                 * decrease, 1 means 100% increase. 0 is returned if there is no change or the
+                 * previous value was 0.
+                 */
+                relative_difference?: number;
+                /**
+                 * Amount paid to Printful for fulfillment and shipping.
+                 */
+                value?: number;
+            }
+            /**
+             * Profit report
+             */
+            interface Profit {
+                /**
+                 * Relative difference from the value from the previous period. -1 means 100%
+                 * decrease, 1 means 100% increase. 0 is returned if there is no change or the
+                 * previous value was 0.
+                 */
+                relative_difference?: number;
+                /**
+                 * The difference between Sales and Fulfillment. If retail price data is not
+                 * available, profit might be negative
+                 */
+                value?: number;
+            }
+            interface SalesAndCost {
+                /**
+                 * The date of the value: day in `Y-m-d` format, month in `Y-m` format or "Total"
+                 * for the first element of the list which shows the total values for the whole
+                 * requested period
+                 */
+                date?: string;
+                /**
+                 * Product fulfillment, digitization, branding, shipping costs and taxes that are
+                 * charged by Printful
+                 */
+                fulfillment?: number;
+                /**
+                 * Any fulfillment discounts (such as the monthly discount) set up on Printful's
+                 * side
+                 */
+                fulfillment_discount?: number;
+                /**
+                 * Shipping costs that were charged by Printful
+                 */
+                fulfillment_shipping?: number;
+                /**
+                 * The difference between Sales and Fulfillment. If retail price data is not
+                 * available, profit might be negative
+                 */
+                profit?: number;
+                /**
+                 * Order retail price data. Available only if retail price fields are properly set
+                 * up on the integration's side
+                 */
+                sales?: number;
+                /**
+                 * Any retail price discounts set up on the integration's side
+                 */
+                sales_discount?: number;
+                /**
+                 * The retail shipping price that was paid by the buyer
+                 */
+                sales_shipping?: number;
+            }
+            interface SalesAndCostsSummary {
+                /**
+                 * Product fulfillment, digitization, branding, shipping costs and taxes that are
+                 * charged by Printful
+                 */
+                costs?: number;
+                /**
+                 * The date of the value: day in `Y-m-d` format, month in `Y-m` format or "Total"
+                 * for the first element of the list which shows the total values for the whole
+                 * requested period
+                 */
+                date?: string;
+                /**
+                 * The order count in the aggregation period
+                 */
+                order_count?: number;
+                /**
+                 * The difference between Sales and Fulfillment. If retail price data is not
+                 * available, profit might be negative
+                 */
+                profit?: number;
+            }
+            /**
+             * Total paid orders report
+             */
+            interface TotalPaidOrders {
+                /**
+                 * Relative difference from the value from the previous period. -1 means 100%
+                 * decrease, 1 means 100% increase. 0 is returned if there is no change or the
+                 * previous value was 0.
+                 */
+                relative_difference?: number;
+                /**
+                 * Number of unique orders for period
+                 */
+                value?: number;
+            }
+        }
+    }
+}
+export interface ReportRetrieveStatisticsParams {
+    /**
+     * Query param: The beginning of the period to get the statistics from (date in
+     * `Y-m-d` format).
+     */
+    date_from: string;
+    /**
+     * Query param: The end of the period to get the statistics from (date in `Y-m-d`
+     * format).
+     */
+    date_to: string;
+    /**
+     * Query param: A comma-separated list of report types to be retrieved.
+     */
+    report_types: string;
+    /**
+     * Query param: The currency (3-letter code) to return the statistics in. You can
+     * also specify `display_currency` as the value to get the statistics in the
+     * account's display currency. The store currency will be used by default.
+     */
+    currency?: string;
+    /**
+     * Header param: Use this to specify which store you want to use (required only for
+     * account level token).
+     *
+     * The store IDs can be retrieved with the
+     * [Get basic information about stores](#tag/Store-Information-API/operation/getStores)
+     * endpoint.
+     */
+    'X-PF-Store-Id'?: string;
+}
+export declare namespace Reports {
+    export { type ReportRetrieveStatisticsResponse as ReportRetrieveStatisticsResponse, type ReportRetrieveStatisticsParams as ReportRetrieveStatisticsParams, };
+}
+//# sourceMappingURL=reports.d.ts.map

package/resources/reports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,kBAAkB,CAChB,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAYhD;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,gCAAgC,CAAC,MAAM,CAAC;CAClD;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;KACjD;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,wBAAwB,CAAC,EAAE,cAAc,CAAC,sBAAsB,CAAC;YAEjE;;eAEG;YACH,eAAe,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;YAEtD;;eAEG;YACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;YAExD;;eAEG;YACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;YAExD;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC;YAE9C;;eAEG;YACH,MAAM,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC;YAE/B;;eAEG;YACH,eAAe,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;YAErD;;eAEG;YACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;YAErE;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,iBAAiB,CAAC,EAAE,cAAc,CAAC,eAAe,CAAC;SACpD;QAED,UAAiB,cAAc,CAAC;YAC9B;;eAEG;YACH,UAAiB,sBAAsB;gBACrC;;;;mBAIG;gBACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAE7B;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED,UAAiB,aAAa;gBAC5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;;mBAIG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,cAAc,CAAC,EAAE,MAAM,CAAC;gBAExB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;aACd;YAED,UAAiB,cAAc;gBAC7B;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED,UAAiB,cAAc;gBAC7B;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC;aACvB;YAED;;eAEG;YACH,UAAiB,aAAa;gBAC5B;;;;mBAIG;gBACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAE7B;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED;;eAEG;YACH,UAAiB,MAAM;gBACrB;;;;mBAIG;gBACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAE7B;;;mBAGG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED,UAAiB,YAAY;gBAC3B;;;;mBAIG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd;;;mBAGG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;;mBAGG;gBACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;gBAE9B;;mBAEG;gBACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;gBAE9B;;;mBAGG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;;mBAGG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,cAAc,CAAC,EAAE,MAAM,CAAC;gBAExB;;mBAEG;gBACH,cAAc,CAAC,EAAE,MAAM,CAAC;aACzB;YAED,UAAiB,oBAAoB;gBACnC;;;mBAGG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;;;mBAIG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;;mBAGG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;aACjB;YAED;;eAEG;YACH,UAAiB,eAAe;gBAC9B;;;;mBAIG;gBACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAE7B;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;SACF;KACF;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/reports.js

@@ -0,0 +1,56 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reports = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+class Reports extends resource_1.APIResource {
+    /**
+     * Returns statistics for specified report types.
+     *
+     * You need to specify the report types you want to retrieve in the `report_types`
+     * query parameter as a comma-separated list, e.g.
+     * `report_types=sales_and_costs,profit`.
+     *
+     * **Note**: You cannot get statistics for a period longer than 6 months.
+     *
+     * #### Example
+     *
+     * To get statistics in the default currency of a store for `sales_and_costs` and
+     * `profit` reports for August 2022, you can use the following URL:
+     * https://api.printful.com/reports/statistics?report_types=sales_and_costs,profit&date_from=2022-08-01&date_to=2022-08-31.
+     *
+     * ### Report types
+     *
+     * Currently, the following report types are available:
+     *
+     * | Report type                | Description                                              |
+     * | -------------------------- | -------------------------------------------------------- |
+     * | `sales_and_costs`          | Detailed information on sales and costs grouped by date. |
+     * | `sales_and_costs_summary`  | Short information on sales and costs grouped by date.    |
+     * | `printful_costs`           | Amount paid to Printful for fulfillment and shipping.    |
+     * | `profit`                   | Profit in the specified period.                          |
+     * | `total_paid_orders`        | The number of paid orders in the specified period.       |
+     * | `costs_by_amount`          | Information on costs by amount grouped by date.          |
+     * | `costs_by_product`         | Information on costs grouped by product.                 |
+     * | `costs_by_variant`         | Information on costs grouped by variant.                 |
+     * | `average_fulfillment_time` | Average time it took Printful to fulfill your orders.    |
+     *
+     * The response structure for the specific reports is documented in the response
+     * schema (`result.store_statistics.[reportName]`).
+     */
+    retrieveStatistics(params, options) {
+        const { 'X-PF-Store-Id': xPfStoreID, ...query } = params;
+        return this._client.get('/reports/statistics', {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+                options?.headers,
+            ]),
+            __security: {},
+        });
+    }
+}
+exports.Reports = Reports;
+//# sourceMappingURL=reports.js.map

package/resources/reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.js","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAGnD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,kBAAkB,CAChB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE;YAC7C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACzE,OAAO,EAAE,OAAO;aACjB,CAAC;YACF,UAAU,EAAE,EAAE;SACf,CAAC,CAAC;IACL,CAAC;CACF;AAlDD,0BAkDC"}

package/resources/reports.mjs

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+export class Reports extends APIResource {
+    /**
+     * Returns statistics for specified report types.
+     *
+     * You need to specify the report types you want to retrieve in the `report_types`
+     * query parameter as a comma-separated list, e.g.
+     * `report_types=sales_and_costs,profit`.
+     *
+     * **Note**: You cannot get statistics for a period longer than 6 months.
+     *
+     * #### Example
+     *
+     * To get statistics in the default currency of a store for `sales_and_costs` and
+     * `profit` reports for August 2022, you can use the following URL:
+     * https://api.printful.com/reports/statistics?report_types=sales_and_costs,profit&date_from=2022-08-01&date_to=2022-08-31.
+     *
+     * ### Report types
+     *
+     * Currently, the following report types are available:
+     *
+     * | Report type                | Description                                              |
+     * | -------------------------- | -------------------------------------------------------- |
+     * | `sales_and_costs`          | Detailed information on sales and costs grouped by date. |
+     * | `sales_and_costs_summary`  | Short information on sales and costs grouped by date.    |
+     * | `printful_costs`           | Amount paid to Printful for fulfillment and shipping.    |
+     * | `profit`                   | Profit in the specified period.                          |
+     * | `total_paid_orders`        | The number of paid orders in the specified period.       |
+     * | `costs_by_amount`          | Information on costs by amount grouped by date.          |
+     * | `costs_by_product`         | Information on costs grouped by product.                 |
+     * | `costs_by_variant`         | Information on costs grouped by variant.                 |
+     * | `average_fulfillment_time` | Average time it took Printful to fulfill your orders.    |
+     *
+     * The response structure for the specific reports is documented in the response
+     * schema (`result.store_statistics.[reportName]`).
+     */
+    retrieveStatistics(params, options) {
+        const { 'X-PF-Store-Id': xPfStoreID, ...query } = params;
+        return this._client.get('/reports/statistics', {
+            query,
+            ...options,
+            headers: buildHeaders([
+                { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+                options?.headers,
+            ]),
+            __security: {},
+        });
+    }
+}
+//# sourceMappingURL=reports.mjs.map

package/resources/reports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../src/resources/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,kBAAkB,CAChB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE;YAC7C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACzE,OAAO,EAAE,OAAO;aACjB,CAAC;YACF,UAAU,EAAE,EAAE;SACf,CAAC,CAAC;IACL,CAAC;CACF"}