mdd-printful-client 0.2.1

package/src/resources/store/variants.ts

@@ -0,0 +1,227 @@
+// 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 Variants extends APIResource {
+  /**
+   * Get information about a single Sync Variant.
+   *
+   * @example
+   * ```ts
+   * const variant = await client.store.variants.retrieve(0);
+   * ```
+   */
+  retrieve(
+    id: number | string,
+    params: VariantRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<VariantRetrieveResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.get(path`/store/variants/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Modifies an existing Sync Variant.
+   *
+   * Please note that in the request body you only need to specify the fields that
+   * need to be changed. See examples for more insights.
+   *
+   * [See examples](#tag/Examples/Products-API-examples/Modify-a-Sync-Variant)
+   *
+   * @example
+   * ```ts
+   * const variant = await client.store.variants.update(0);
+   * ```
+   */
+  update(
+    pathID: number | string,
+    params: VariantUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<VariantUpdateResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID, ...body } = params;
+    return this._client.put(path`/store/variants/${pathID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Deletes a single Sync Variant.
+   *
+   * @example
+   * ```ts
+   * const variant = await client.store.variants.delete(0);
+   * ```
+   */
+  delete(
+    id: number | string,
+    params: VariantDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<VariantDeleteResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.delete(path`/store/variants/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+}
+
+export interface VariantRetrieveResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Information about the SyncVariant
+   */
+  result?: Shared.SyncVariant;
+}
+
+export interface VariantUpdateResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Information about the SyncVariant
+   */
+  result?: Shared.SyncVariant;
+}
+
+export interface VariantDeleteResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: Array<unknown>;
+}
+
+export interface VariantRetrieveParams {
+  /**
+   * 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 VariantUpdateParams {
+  /**
+   * Body param: Sync Variant ID. Please specify the IDs of all Sync Variants you
+   * wish to keep.
+   */
+  body_id?: number;
+
+  /**
+   * Body param: Indicates the status of the Sync Variant.
+   */
+  availability_status?: 'active' | 'discontinued' | 'out_of_stock' | 'temporary_out_of_stock';
+
+  /**
+   * Body param: Variant ID from the Ecommerce platform
+   */
+  external_id?: string;
+
+  /**
+   * Body param: Array of attached printfiles / preview images
+   */
+  files?: Array<VariantUpdateParams.File>;
+
+  /**
+   * Body param: Indicates if this Sync Variant is ignored
+   */
+  is_ignored?: boolean;
+
+  /**
+   * Body param: Array of additional options for the configured product/variant
+   * [See examples](#tag/Common/Options)
+   */
+  options?: Array<Shared.ItemOption>;
+
+  /**
+   * Body param: Short information about the Printful Product and Variant
+   */
+  product?: Shared.ProductVariant;
+
+  /**
+   * Body param: Retail price that this item is sold for
+   */
+  retail_price?: string;
+
+  /**
+   * Body param: SKU of this Sync Variant
+   */
+  sku?: string | null;
+
+  /**
+   * Body param: Printful Variant ID that this Sync Variant is synced to
+   */
+  variant_id?: 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 namespace VariantUpdateParams {
+  /**
+   * Information about the File
+   */
+  export interface File extends Shared.File {}
+}
+
+export interface VariantDeleteParams {
+  /**
+   * 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 Variants {
+  export {
+    type VariantRetrieveResponse as VariantRetrieveResponse,
+    type VariantUpdateResponse as VariantUpdateResponse,
+    type VariantDeleteResponse as VariantDeleteResponse,
+    type VariantRetrieveParams as VariantRetrieveParams,
+    type VariantUpdateParams as VariantUpdateParams,
+    type VariantDeleteParams as VariantDeleteParams,
+  };
+}

package/src/resources/store.ts

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

package/src/resources/sync/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Products,
+  type ProductRetrieveResponse,
+  type ProductListResponse,
+  type ProductDeleteResponse,
+  type ProductRetrieveParams,
+  type ProductListParams,
+  type ProductDeleteParams,
+} from './products';
+export { Sync } from './sync';
+export {
+  Variant,
+  type VariantRetrieveResponse,
+  type VariantUpdateResponse,
+  type VariantDeleteResponse,
+  type VariantRetrieveParams,
+  type VariantUpdateParams,
+  type VariantDeleteParams,
+} from './variant';

package/src/resources/sync/products.ts

@@ -0,0 +1,212 @@
+// 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 {
+  /**
+   * Get information about a single Sync Product and its Sync Variants
+   *
+   * @example
+   * ```ts
+   * const product = await client.sync.products.retrieve(0);
+   * ```
+   */
+  retrieve(
+    id: number | string,
+    params: ProductRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductRetrieveResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.get(path`/sync/products/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Returns list of Sync Product objects from your store.
+   *
+   * @example
+   * ```ts
+   * const products = await client.sync.products.list();
+   * ```
+   */
+  list(
+    params: ProductListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductListResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID, ...query } = params ?? {};
+    return this._client.get('/sync/products', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+
+  /**
+   * Deletes a Sync Product with all of its Sync Variants
+   *
+   * @example
+   * ```ts
+   * const product = await client.sync.products.delete(0);
+   * ```
+   */
+  delete(
+    id: number | string,
+    params: ProductDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductDeleteResponse> {
+    const { 'X-PF-Store-Id': xPfStoreID } = params ?? {};
+    return this._client.delete(path`/sync/products/${id}`, {
+      ...options,
+      headers: buildHeaders([
+        { ...(xPfStoreID != null ? { 'X-PF-Store-Id': xPfStoreID } : undefined) },
+        options?.headers,
+      ]),
+      __security: {},
+    });
+  }
+}
+
+export interface ProductRetrieveResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: ProductRetrieveResponse.Result;
+}
+
+export namespace ProductRetrieveResponse {
+  export interface Result {
+    /**
+     * Information about the SyncProduct
+     */
+    sync_product?: Shared.SyncProduct;
+
+    /**
+     * Array of Sync Variants available for the selected product
+     */
+    sync_variants?: Array<Shared.SyncVariant>;
+  }
+}
+
+export interface ProductListResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  /**
+   * Paging information
+   */
+  paging?: Shared.Paging;
+
+  /**
+   * Array of SyncProduct
+   */
+  result?: Array<Shared.SyncProduct>;
+}
+
+export interface ProductDeleteResponse {
+  /**
+   * Response status code `200`
+   */
+  code?: number;
+
+  result?: ProductDeleteResponse.Result;
+}
+
+export namespace ProductDeleteResponse {
+  export interface Result {
+    /**
+     * Information about the SyncProduct
+     */
+    sync_product?: Shared.SyncProduct;
+
+    /**
+     * Array of Sync Variants available for the selected product
+     */
+    sync_variants?: Array<Shared.SyncVariant>;
+  }
+}
+
+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: Product search needle
+   */
+  search?: string;
+
+  /**
+   * Query param: Parameter used to filter results by status/group of Sync Products
+   */
+  status?: 'all' | 'synced' | 'unsynced' | 'ignored' | 'imported' | 'discontinued' | 'out_of_stock';
+
+  /**
+   * 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 ProductDeleteParams {
+  /**
+   * 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 ProductDeleteResponse as ProductDeleteResponse,
+    type ProductRetrieveParams as ProductRetrieveParams,
+    type ProductListParams as ProductListParams,
+    type ProductDeleteParams as ProductDeleteParams,
+  };
+}

package/src/resources/sync/sync.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ProductsAPI from './products';
+import {
+  ProductDeleteParams,
+  ProductDeleteResponse,
+  ProductListParams,
+  ProductListResponse,
+  ProductRetrieveParams,
+  ProductRetrieveResponse,
+  Products,
+} from './products';
+import * as VariantAPI from './variant';
+import {
+  Variant,
+  VariantDeleteParams,
+  VariantDeleteResponse,
+  VariantRetrieveParams,
+  VariantRetrieveResponse,
+  VariantUpdateParams,
+  VariantUpdateResponse,
+} from './variant';
+
+export class Sync extends APIResource {
+  products: ProductsAPI.Products = new ProductsAPI.Products(this._client);
+  variant: VariantAPI.Variant = new VariantAPI.Variant(this._client);
+}
+
+Sync.Products = Products;
+Sync.Variant = Variant;
+
+export declare namespace Sync {
+  export {
+    Products as Products,
+    type ProductRetrieveResponse as ProductRetrieveResponse,
+    type ProductListResponse as ProductListResponse,
+    type ProductDeleteResponse as ProductDeleteResponse,
+    type ProductRetrieveParams as ProductRetrieveParams,
+    type ProductListParams as ProductListParams,
+    type ProductDeleteParams as ProductDeleteParams,
+  };
+
+  export {
+    Variant as Variant,
+    type VariantRetrieveResponse as VariantRetrieveResponse,
+    type VariantUpdateResponse as VariantUpdateResponse,
+    type VariantDeleteResponse as VariantDeleteResponse,
+    type VariantRetrieveParams as VariantRetrieveParams,
+    type VariantUpdateParams as VariantUpdateParams,
+    type VariantDeleteParams as VariantDeleteParams,
+  };
+}