@shopify/shopify-api 13.0.0 → 14.0.0

package/rest/admin/2026-04/payment_gateway.ts

@@ -0,0 +1,105 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+
+export class PaymentGateway extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["id"], "path": "payment_gateways/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "payment_gateways.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "payment_gateways/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "payment_gateways.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "payment_gateways/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "payment_gateway",
+      "plural": "payment_gateways"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<PaymentGateway | null> {
+    const result = await this.baseFind<PaymentGateway>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<PaymentGateway>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<PaymentGateway>> {
+    const response = await this.baseFind<PaymentGateway>({
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public attachment: string | null;
+  public created_at: string | null;
+  public credential1: string | null;
+  public credential2: string | null;
+  public credential3: string | null;
+  public credential4: string | null;
+  public disabled: boolean | null;
+  public enabled_card_brands: string[] | null;
+  public id: string | null;
+  public name: string | null;
+  public processing_method: string | null;
+  public provider_id: string | null;
+  public sandbox: boolean | null;
+  public service_name: string | null;
+  public supports_network_tokenization: boolean | null;
+  public type: string | null;
+  public updated_at: string | null;
+}

package/rest/admin/2026-04/payment_transaction.ts

@@ -0,0 +1,79 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+import {Currency} from './currency';
+
+interface TransactionsArgs {
+  [key: string]: unknown;
+  session: Session;
+  since_id?: unknown;
+  last_id?: unknown;
+  test?: unknown;
+  payout_id?: unknown;
+  payout_status?: unknown;
+}
+
+export class PaymentTransaction extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "currency": Currency
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "transactions", "ids": [], "path": "shopify_payments/balance/transactions.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "payment_transaction",
+      "plural": "payment_transactions"
+    }
+  ];
+
+  public static async transactions(
+    {
+      session,
+      since_id = null,
+      last_id = null,
+      test = null,
+      payout_id = null,
+      payout_status = null,
+      ...otherArgs
+    }: TransactionsArgs
+  ): Promise<unknown> {
+    const response = await this.request<PaymentTransaction>({
+      http_method: "get",
+      operation: "transactions",
+      session: session,
+      urlIds: {},
+      params: {"since_id": since_id, "last_id": last_id, "test": test, "payout_id": payout_id, "payout_status": payout_status, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public adjustment_order_transactions: {[key: string]: unknown}[] | null;
+  public adjustment_reason: string | null;
+  public amount: string | null;
+  public currency: Currency | null | {[key: string]: any};
+  public fee: string | null;
+  public id: string | null;
+  public net: string | null;
+  public payout_id: string | null;
+  public payout_status: string | null;
+  public processed_at: string | null;
+  public source_id: string | null;
+  public source_order_id: string | null;
+  public source_order_transaction_id: string | null;
+  public source_type: string | null;
+  public test: boolean | null;
+  public type: string | null;
+}

package/rest/admin/2026-04/payout.ts

@@ -0,0 +1,81 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  since_id?: unknown;
+  last_id?: unknown;
+  date_min?: unknown;
+  date_max?: unknown;
+  date?: unknown;
+  status?: unknown;
+}
+
+export class Payout extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": [], "path": "shopify_payments/payouts.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "shopify_payments/payouts/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "payout",
+      "plural": "payouts"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<Payout | null> {
+    const result = await this.baseFind<Payout>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      since_id = null,
+      last_id = null,
+      date_min = null,
+      date_max = null,
+      date = null,
+      status = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Payout>> {
+    const response = await this.baseFind<Payout>({
+      session: session,
+      urlIds: {},
+      params: {"since_id": since_id, "last_id": last_id, "date_min": date_min, "date_max": date_max, "date": date, "status": status, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public amount: string | null;
+  public currency: string | null;
+  public date: string | null;
+  public id: string | null;
+  public status: string | null;
+}

package/rest/admin/2026-04/policy.ts

@@ -0,0 +1,51 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+
+export class Policy extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": [], "path": "policies.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "policy",
+      "plural": "policies"
+    }
+  ];
+
+  public static async all(
+    {
+      session,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Policy>> {
+    const response = await this.baseFind<Policy>({
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public body: string | null;
+  public created_at: string | null;
+  public handle: string | null;
+  public title: string | null;
+  public updated_at: string | null;
+  public url: string | null;
+}

package/rest/admin/2026-04/price_rule.ts

@@ -0,0 +1,163 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  limit?: unknown;
+  since_id?: unknown;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  starts_at_min?: unknown;
+  starts_at_max?: unknown;
+  ends_at_min?: unknown;
+  ends_at_max?: unknown;
+  times_used?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+
+export class PriceRule extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["id"], "path": "price_rules/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "price_rules/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "price_rules.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "price_rules/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "price_rules.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "price_rules/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "price_rule",
+      "plural": "price_rules"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<PriceRule | null> {
+    const result = await this.baseFind<PriceRule>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<PriceRule>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      since_id = null,
+      created_at_min = null,
+      created_at_max = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      starts_at_min = null,
+      starts_at_max = null,
+      ends_at_min = null,
+      ends_at_max = null,
+      times_used = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<PriceRule>> {
+    const response = await this.baseFind<PriceRule>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "since_id": since_id, "created_at_min": created_at_min, "created_at_max": created_at_max, "updated_at_min": updated_at_min, "updated_at_max": updated_at_max, "starts_at_min": starts_at_min, "starts_at_max": starts_at_max, "ends_at_min": ends_at_min, "ends_at_max": ends_at_max, "times_used": times_used, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<PriceRule>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public allocation_limit: number | null;
+  public allocation_method: string | null;
+  public created_at: string | null;
+  public customer_segment_prerequisite_ids: string[] | null;
+  public customer_selection: string | null;
+  public ends_at: string | null;
+  public entitled_collection_ids: string[] | null;
+  public entitled_country_ids: string[] | null;
+  public entitled_product_ids: string[] | null;
+  public entitled_variant_ids: string[] | null;
+  public id: string | null;
+  public once_per_customer: boolean | null;
+  public prerequisite_collection_ids: string[] | null;
+  public prerequisite_customer_ids: string[] | null;
+  public prerequisite_product_ids: string[] | null;
+  public prerequisite_quantity_range: {[key: string]: unknown} | null;
+  public prerequisite_shipping_price_range: {[key: string]: unknown} | null;
+  public prerequisite_subtotal_range: {[key: string]: unknown} | null;
+  public prerequisite_to_entitlement_purchase: {[key: string]: unknown} | null;
+  public prerequisite_to_entitlement_quantity_ratio: {[key: string]: unknown} | null;
+  public prerequisite_variant_ids: string[] | null;
+  public starts_at: string | null;
+  public target_selection: string | null;
+  public target_type: string | null;
+  public title: string | null;
+  public updated_at: string | null;
+  public usage_limit: number | null;
+  public value: string | null;
+  public value_type: string | null;
+}

package/rest/admin/2026-04/product.ts

@@ -0,0 +1,192 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {Base, FindAllResponse} from '../../base';
+import {ResourcePath, ResourceNames} from '../../types';
+import {Session} from '../../../lib/session/session';
+import {ApiVersion} from '../../../lib/types';
+
+import {Image} from './image';
+import {Variant} from './variant';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  fields?: unknown;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  ids?: unknown;
+  limit?: unknown;
+  since_id?: unknown;
+  title?: unknown;
+  vendor?: unknown;
+  handle?: unknown;
+  product_type?: unknown;
+  status?: unknown;
+  collection_id?: unknown;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  published_at_min?: unknown;
+  published_at_max?: unknown;
+  published_status?: unknown;
+  fields?: unknown;
+  presentment_currencies?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  vendor?: unknown;
+  product_type?: unknown;
+  collection_id?: unknown;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  published_at_min?: unknown;
+  published_at_max?: unknown;
+  published_status?: unknown;
+}
+
+export class Product extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {
+    "images": Image,
+    "variants": Variant
+  };
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["id"], "path": "products/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "products/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "products.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "products/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "products.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "products/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "product",
+      "plural": "products"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Product | null> {
+    const result = await this.baseFind<Product>({
+      session: session,
+      urlIds: {"id": id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<Product>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      ids = null,
+      limit = null,
+      since_id = null,
+      title = null,
+      vendor = null,
+      handle = null,
+      product_type = null,
+      status = null,
+      collection_id = null,
+      created_at_min = null,
+      created_at_max = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      published_at_min = null,
+      published_at_max = null,
+      published_status = null,
+      fields = null,
+      presentment_currencies = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Product>> {
+    const response = await this.baseFind<Product>({
+      session: session,
+      urlIds: {},
+      params: {"ids": ids, "limit": limit, "since_id": since_id, "title": title, "vendor": vendor, "handle": handle, "product_type": product_type, "status": status, "collection_id": collection_id, "created_at_min": created_at_min, "created_at_max": created_at_max, "updated_at_min": updated_at_min, "updated_at_max": updated_at_max, "published_at_min": published_at_min, "published_at_max": published_at_max, "published_status": published_status, "fields": fields, "presentment_currencies": presentment_currencies, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      vendor = null,
+      product_type = null,
+      collection_id = null,
+      created_at_min = null,
+      created_at_max = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      published_at_min = null,
+      published_at_max = null,
+      published_status = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Product>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"vendor": vendor, "product_type": product_type, "collection_id": collection_id, "created_at_min": created_at_min, "created_at_max": created_at_max, "updated_at_min": updated_at_min, "updated_at_max": updated_at_max, "published_at_min": published_at_min, "published_at_max": published_at_max, "published_status": published_status, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public title: string | null;
+  public body_html: string | null;
+  public created_at: string | null;
+  public handle: string | null;
+  public id: string | null;
+  public images: Image[] | null | {[key: string]: any};
+  public options: {[key: string]: unknown} | {[key: string]: unknown}[] | null;
+  public product_type: string | null;
+  public published_at: string | null;
+  public published_scope: string | null;
+  public status: string | null;
+  public tags: string | string[] | null;
+  public template_suffix: string | null;
+  public updated_at: string | null;
+  public variants: Variant[] | null | {[key: string]: any};
+  public vendor: string | null;
+}