mdd-printful-client 0.2.1

package/src/resources/warehouse/products.ts

@@ -0,0 +1,412 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Products extends APIResource {
+  /**
+   * Returns warehouse product data by ID
+   */
+  retrieve(
+    id: number | string,
+    params: ProductRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductRetrieveResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.get(path`/warehouse/products/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Returns a list of warehouse products from your store
+   *
+   * <div class="alert alert-info">
+   *   The response for this endpoint was documented as paginated, although it was not paginated. The behavior will be
+   *   fixed and the paginated result will be set as the default. Currently to get paginated results please send
+   *   <code>true</code>or <code>1</code> in <code>X-PF-Force-Pagination</code> header.
+   * </div>
+   */
+  list(
+    params: ProductListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductListResponse> {
+    const {
+      'X-PF-Force-Pagination': xPfForcePagination,
+      'X-PF-Store-Id': xPfStoreID,
+      ...query
+    } = params ?? {};
+    return this._client.get('/warehouse/products', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xPfForcePagination?.toString() != null ?
+            { 'X-PF-Force-Pagination': xPfForcePagination?.toString() }
+          : undefined),
+          ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined),
+        },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+}
+
+export interface ProductRetrieveResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Warehouse product data
+   */
+  result?: ProductRetrieveResponse.Result;
+}
+
+export namespace ProductRetrieveResponse {
+  /**
+   * Warehouse product data
+   */
+  export interface Result {
+    /**
+     * Product ID
+     */
+    id?: number;
+
+    /**
+     * Currency
+     */
+    currency?: string;
+
+    /**
+     * Image URL of product
+     */
+    image_url?: string;
+
+    /**
+     * Product name
+     */
+    name?: string;
+
+    /**
+     * Retail price of product
+     */
+    retail_price?: number;
+
+    /**
+     * Product status:
+     *
+     * **created** - product request created,
+     *
+     * **active** - product request approved
+     *
+     * **suspended** - product suspended
+     *
+     * **declined** - product request declined
+     *
+     * **draft** - product created as a draft
+     */
+    status?: 'created' | 'active' | 'suspended' | 'declined' | 'draft';
+
+    /**
+     * Array of product variants
+     */
+    variants?: Array<Result.Variant>;
+  }
+
+  export namespace Result {
+    /**
+     * Warehouse product variant data
+     */
+    export interface Variant {
+      /**
+       * Product variant ID
+       */
+      id?: number;
+
+      /**
+       * Height of product variant
+       */
+      height?: number;
+
+      /**
+       * Image URL of product variant
+       */
+      image_url?: string;
+
+      /**
+       * Length of product variant
+       */
+      length?: number;
+
+      /**
+       * Name of product variant
+       */
+      name?: string;
+
+      /**
+       * Total available quantity of product variant in our stock
+       */
+      quantity?: number;
+
+      /**
+       * Retail price of product variant
+       */
+      retail_price?: number;
+
+      /**
+       * SKU of product variant
+       */
+      sku?: string;
+
+      /**
+       * Product variant quantities in the warehouse stock
+       */
+      stock_locations?: Array<Variant.StockLocation>;
+
+      /**
+       * Weight of product variant
+       */
+      weight?: number;
+
+      /**
+       * Width of product variant
+       */
+      width?: number;
+    }
+
+    export namespace Variant {
+      export interface StockLocation {
+        /**
+         * Available quantity of product variant in our stock
+         */
+        available?: number;
+
+        /**
+         * Name of the warehouse facility
+         */
+        facility?: string;
+
+        /**
+         * Total quantity of product variant in our stock
+         */
+        stocked?: number;
+      }
+    }
+  }
+}
+
+export interface ProductListResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Paging information
+   */
+  paging?: Shared.Paging;
+
+  /**
+   * Array of WarehouseProducts
+   */
+  result?: Array<ProductListResponse.Result>;
+}
+
+export namespace ProductListResponse {
+  /**
+   * Warehouse product data
+   */
+  export interface Result {
+    /**
+     * Product ID
+     */
+    id?: number;
+
+    /**
+     * Currency
+     */
+    currency?: string;
+
+    /**
+     * Image URL of product
+     */
+    image_url?: string;
+
+    /**
+     * Product name
+     */
+    name?: string;
+
+    /**
+     * Retail price of product
+     */
+    retail_price?: number;
+
+    /**
+     * Product status:
+     *
+     * **created** - product request created,
+     *
+     * **active** - product request approved
+     *
+     * **suspended** - product suspended
+     *
+     * **declined** - product request declined
+     *
+     * **draft** - product created as a draft
+     */
+    status?: 'created' | 'active' | 'suspended' | 'declined' | 'draft';
+
+    /**
+     * Array of product variants
+     */
+    variants?: Array<Result.Variant>;
+  }
+
+  export namespace Result {
+    /**
+     * Warehouse product variant data
+     */
+    export interface Variant {
+      /**
+       * Product variant ID
+       */
+      id?: number;
+
+      /**
+       * Height of product variant
+       */
+      height?: number;
+
+      /**
+       * Image URL of product variant
+       */
+      image_url?: string;
+
+      /**
+       * Length of product variant
+       */
+      length?: number;
+
+      /**
+       * Name of product variant
+       */
+      name?: string;
+
+      /**
+       * Total available quantity of product variant in our stock
+       */
+      quantity?: number;
+
+      /**
+       * Retail price of product variant
+       */
+      retail_price?: number;
+
+      /**
+       * SKU of product variant
+       */
+      sku?: string;
+
+      /**
+       * Product variant quantities in the warehouse stock
+       */
+      stock_locations?: Array<Variant.StockLocation>;
+
+      /**
+       * Weight of product variant
+       */
+      weight?: number;
+
+      /**
+       * Width of product variant
+       */
+      width?: number;
+    }
+
+    export namespace Variant {
+      export interface StockLocation {
+        /**
+         * Available quantity of product variant in our stock
+         */
+        available?: number;
+
+        /**
+         * Name of the warehouse facility
+         */
+        facility?: string;
+
+        /**
+         * Total quantity of product variant in our stock
+         */
+        stocked?: number;
+      }
+    }
+  }
+}
+
+export interface ProductRetrieveParams {
+  /**
+   * 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 interface ProductListParams {
+  /**
+   * Query param: Number of items per page (max 100)
+   */
+  limit?: number;
+
+  /**
+   * Query param: Result set offset
+   */
+  offset?: number;
+
+  /**
+   * Query param: Filter by partial or full product name
+   */
+  query?: string;
+
+  /**
+   * Header param: Whether the pagination behavior should be forced. The response
+   * will be paginated if the value is `true` or `1`.
+   */
+  'X-PF-Force-Pagination'?: boolean | number;
+
+  /**
+   * 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 Products {
+  export {
+    type ProductRetrieveResponse as ProductRetrieveResponse,
+    type ProductListResponse as ProductListResponse,
+    type ProductRetrieveParams as ProductRetrieveParams,
+    type ProductListParams as ProductListParams,
+  };
+}

package/src/resources/warehouse/warehouse.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ProductsAPI from './products';
+import {
+  ProductListParams,
+  ProductListResponse,
+  ProductRetrieveParams,
+  ProductRetrieveResponse,
+  Products,
+} from './products';
+
+export class Warehouse extends APIResource {
+  products: ProductsAPI.Products = new ProductsAPI.Products(this._client);
+}
+
+Warehouse.Products = Products;
+
+export declare namespace Warehouse {
+  export {
+    Products as Products,
+    type ProductRetrieveResponse as ProductRetrieveResponse,
+    type ProductListResponse as ProductListResponse,
+    type ProductRetrieveParams as ProductRetrieveParams,
+    type ProductListParams as ProductListParams,
+  };
+}

package/src/resources/warehouse.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './warehouse/index';

package/src/resources/webhooks.ts

@@ -0,0 +1,192 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+export class Webhooks extends APIResource {
+  /**
+   * Use this endpoint to enable a webhook URL for a store and select webhook event
+   * types that will be sent to this URL.
+   *
+   * Note that only one webhook URL can be active for a store, so calling this method
+   * disables all existing webhook configuration.
+   *
+   * Setting up the [Stock updated](#operation/stockUpdated) webhook requires passing
+   * IDs for products that need to be monitored for changes. Stock update webhook
+   * will only include information for specified products. These product IDs need to
+   * be set up using the params property.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.create({
+   *   types: ['package_shipped', 'stock_updated'],
+   *   url: '​https://www.example.com/printful/webhook',
+   * });
+   * ```
+   */
+  create(params: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID, ...body } = params;
+    return this._client.post('/webhooks', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Returns configured webhook URL and list of webhook event types enabled for the
+   * store
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.retrieve();
+   * ```
+   */
+  retrieve(
+    params: WebhookRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WebhookRetrieveResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.get('/webhooks', {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Removes the webhook URL and all event types from the store.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.delete();
+   * ```
+   */
+  delete(
+    params: WebhookDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WebhookDeleteResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.delete('/webhooks', {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+}
+
+export interface WebhookInfo {
+  params?: { [key: string]: unknown };
+
+  /**
+   * Array of enabled webhook event types
+   */
+  types?: Array<string>;
+
+  /**
+   * Webhook URL that will receive store's event notifications
+   */
+  url?: string;
+}
+
+export interface WebhookCreateResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: WebhookInfo;
+}
+
+export interface WebhookRetrieveResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: WebhookInfo;
+}
+
+export interface WebhookDeleteResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: WebhookInfo;
+}
+
+export interface WebhookCreateParams {
+  /**
+   * Body param: Array of enabled webhook event types
+   */
+  types: Array<string>;
+
+  /**
+   * Body param: Webhook URL that will receive store's event notifications
+   */
+  url: string;
+
+  /**
+   * Body param
+   */
+  params?: { [key: string]: unknown };
+
+  /**
+   * 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 interface WebhookRetrieveParams {
+  /**
+   * 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 interface WebhookDeleteParams {
+  /**
+   * 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 Webhooks {
+  export {
+    type WebhookInfo as WebhookInfo,
+    type WebhookCreateResponse as WebhookCreateResponse,
+    type WebhookRetrieveResponse as WebhookRetrieveResponse,
+    type WebhookDeleteResponse as WebhookDeleteResponse,
+    type WebhookCreateParams as WebhookCreateParams,
+    type WebhookRetrieveParams as WebhookRetrieveParams,
+    type WebhookDeleteParams as WebhookDeleteParams,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.2.1'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.2.1";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.2.1";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}