@shopify/shopify-api 13.0.0 → 14.0.0

package/rest/admin/2026-07/refund.ts

@@ -0,0 +1,126 @@
+/***********************************************************************************************************************
+* 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 {Transaction} from './transaction';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  order_id?: number | string | null;
+  fields?: unknown;
+  in_shop_currency?: unknown;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  order_id?: number | string | null;
+  limit?: unknown;
+  fields?: unknown;
+  in_shop_currency?: unknown;
+}
+interface CalculateArgs {
+  [key: string]: unknown;
+  shipping?: unknown;
+  refund_line_items?: unknown;
+  currency?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class Refund extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {
+    "transactions": Transaction
+  };
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": ["order_id"], "path": "orders/<order_id>/refunds.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id", "id"], "path": "orders/<order_id>/refunds/<id>.json"},
+    {"http_method": "post", "operation": "calculate", "ids": ["order_id"], "path": "orders/<order_id>/refunds/calculate.json"},
+    {"http_method": "post", "operation": "post", "ids": ["order_id"], "path": "orders/<order_id>/refunds.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "refund",
+      "plural": "refunds"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      order_id = null,
+      fields = null,
+      in_shop_currency = null
+    }: FindArgs
+  ): Promise<Refund | null> {
+    const result = await this.baseFind<Refund>({
+      session: session,
+      urlIds: {"id": id, "order_id": order_id},
+      params: {"fields": fields, "in_shop_currency": in_shop_currency},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      order_id = null,
+      limit = null,
+      fields = null,
+      in_shop_currency = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Refund>> {
+    const response = await this.baseFind<Refund>({
+      session: session,
+      urlIds: {"order_id": order_id},
+      params: {"limit": limit, "fields": fields, "in_shop_currency": in_shop_currency, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public async calculate(
+    {
+      shipping = null,
+      refund_line_items = null,
+      currency = null,
+      body = null,
+      ...otherArgs
+    }: CalculateArgs
+  ): Promise<unknown> {
+    const response = await this.request<Refund>({
+      http_method: "post",
+      operation: "calculate",
+      session: this.session,
+      urlIds: {"order_id": this.order_id},
+      params: {"shipping": shipping, "refund_line_items": refund_line_items, "currency": currency, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public created_at: string | null;
+  public duties: {[key: string]: unknown}[] | null;
+  public id: string | null;
+  public note: string | null;
+  public order_adjustments: {[key: string]: unknown}[] | null;
+  public order_id: string | null;
+  public processed_at: string | null;
+  public refund_duties: {[key: string]: unknown}[] | null;
+  public refund_line_items: {[key: string]: unknown}[] | null;
+  public refund_shipping_lines: {[key: string]: unknown}[] | null;
+  public restock: boolean | null;
+  public transactions: Transaction[] | null | {[key: string]: any};
+  public user_id: string | null;
+}

package/rest/admin/2026-07/resource_feedback.ts

@@ -0,0 +1,53 @@
+/***********************************************************************************************************************
+* 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 ResourceFeedback extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  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": "resource_feedback.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "resource_feedback.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "resource_feedback",
+      "plural": "resource_feedbacks"
+    }
+  ];
+
+  public static async all(
+    {
+      session,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<ResourceFeedback>> {
+    const response = await this.baseFind<ResourceFeedback>({
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public created_at: string | null;
+  public feedback_generated_at: string | null;
+  public messages: string[] | null;
+  public resource_id: string | null;
+  public resource_type: string | null;
+  public state: string | null;
+  public updated_at: string | null;
+}

package/rest/admin/2026-07/script_tag.ts

@@ -0,0 +1,139 @@
+/***********************************************************************************************************************
+* 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;
+  fields?: unknown;
+}
+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;
+  src?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  src?: unknown;
+}
+
+export class ScriptTag extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  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": "script_tags/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "script_tags/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "script_tags.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "script_tags/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "script_tags.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "script_tags/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "script_tag",
+      "plural": "script_tags"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<ScriptTag | null> {
+    const result = await this.baseFind<ScriptTag>({
+      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<ScriptTag>({
+      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,
+      src = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<ScriptTag>> {
+    const response = await this.baseFind<ScriptTag>({
+      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, "src": src, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      src = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<ScriptTag>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"src": src, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public event: string | null;
+  public src: string | null;
+  public cache: boolean | null;
+  public created_at: string | null;
+  public display_scope: string | null;
+  public id: string | null;
+  public updated_at: string | null;
+}

package/rest/admin/2026-07/shipping_zone.ts

@@ -0,0 +1,62 @@
+/***********************************************************************************************************************
+* 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 {Country} from './country';
+import {Province} from './province';
+
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  fields?: unknown;
+}
+
+export class ShippingZone extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {
+    "countries": Country,
+    "provinces": Province
+  };
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": [], "path": "shipping_zones.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "shipping_zone",
+      "plural": "shipping_zones"
+    }
+  ];
+
+  public static async all(
+    {
+      session,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<ShippingZone>> {
+    const response = await this.baseFind<ShippingZone>({
+      session: session,
+      urlIds: {},
+      params: {"fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public carrier_shipping_rate_providers: unknown | null;
+  public countries: Country[] | null | {[key: string]: any};
+  public id: string | null;
+  public location_group_id: string | null;
+  public name: string | null;
+  public price_based_shipping_rates: {[key: string]: unknown}[] | null;
+  public profile_id: string | null;
+  public provinces: Province[] | null | {[key: string]: any};
+  public weight_based_shipping_rates: {[key: string]: unknown}[] | null;
+}

package/rest/admin/2026-07/shop.ts

@@ -0,0 +1,118 @@
+/***********************************************************************************************************************
+* 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;
+  fields?: unknown;
+}
+
+export class Shop extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  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": "shop.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "shop",
+      "plural": "shops"
+    }
+  ];
+
+  public static async current(
+    {
+      session,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<Shop | null> {
+    const result = await this.baseFind<Shop>({
+      session: session,
+      urlIds: {},
+      params: {"fields": fields, ...otherArgs},
+    });
+
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Shop>> {
+    const response = await this.baseFind<Shop>({
+      session: session,
+      urlIds: {},
+      params: {"fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public address1: string | null;
+  public address2: string | null;
+  public auto_configure_tax_inclusivity: boolean | null;
+  public checkout_api_supported: boolean | null;
+  public city: string | null;
+  public country: string | null;
+  public country_code: string | null;
+  public country_name: string | null;
+  public county_taxes: boolean | null;
+  public created_at: string | null;
+  public currency: string | null;
+  public customer_email: string | null;
+  public domain: string | null;
+  public eligible_for_payments: boolean | null;
+  public email: string | null;
+  public enabled_presentment_currencies: string[] | null;
+  public finances: boolean | null;
+  public force_ssl: boolean | null;
+  public google_apps_domain: string | null;
+  public google_apps_login_enabled: string | null;
+  public has_discounts: boolean | null;
+  public has_gift_cards: boolean | null;
+  public has_storefront: boolean | null;
+  public iana_timezone: string | null;
+  public id: string | null;
+  public latitude: number | null;
+  public longitude: number | null;
+  public marketing_sms_consent_enabled_at_checkout: boolean | null;
+  public money_format: string | null;
+  public money_in_emails_format: string | null;
+  public money_with_currency_format: string | null;
+  public money_with_currency_in_emails_format: string | null;
+  public multi_location_enabled: boolean | null;
+  public myshopify_domain: string | null;
+  public name: string | null;
+  public password_enabled: boolean | null;
+  public phone: string | null;
+  public plan_display_name: string | null;
+  public plan_name: string | null;
+  public pre_launch_enabled: boolean | null;
+  public primary_locale: string | null;
+  public primary_location_id: string | null;
+  public province: string | null;
+  public province_code: string | null;
+  public requires_extra_payments_agreement: boolean | null;
+  public setup_required: boolean | null;
+  public shop_owner: string | null;
+  public source: string | null;
+  public tax_shipping: string | null;
+  public taxes_included: boolean | null;
+  public timezone: string | null;
+  public transactional_sms_disabled: boolean | null;
+  public updated_at: string | null;
+  public weight_unit: string | null;
+  public zip: string | null;
+}

package/rest/admin/2026-07/smart_collection.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';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  fields?: unknown;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  limit?: unknown;
+  ids?: unknown;
+  since_id?: unknown;
+  title?: unknown;
+  product_id?: unknown;
+  handle?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  published_at_min?: unknown;
+  published_at_max?: unknown;
+  published_status?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  title?: unknown;
+  product_id?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  published_at_min?: unknown;
+  published_at_max?: unknown;
+  published_status?: unknown;
+}
+interface OrderArgs {
+  [key: string]: unknown;
+  products?: unknown;
+  sort_order?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class SmartCollection extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  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": "smart_collections/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "smart_collections/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "smart_collections.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "smart_collections/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "smart_collections.json"},
+    {"http_method": "put", "operation": "order", "ids": ["id"], "path": "smart_collections/<id>/order.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "smart_collections/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "smart_collection",
+      "plural": "smart_collections"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<SmartCollection | null> {
+    const result = await this.baseFind<SmartCollection>({
+      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<SmartCollection>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      ids = null,
+      since_id = null,
+      title = null,
+      product_id = null,
+      handle = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      published_at_min = null,
+      published_at_max = null,
+      published_status = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<SmartCollection>> {
+    const response = await this.baseFind<SmartCollection>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "ids": ids, "since_id": since_id, "title": title, "product_id": product_id, "handle": handle, "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, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      title = null,
+      product_id = 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<SmartCollection>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"title": title, "product_id": product_id, "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 async order(
+    {
+      products = null,
+      sort_order = null,
+      body = null,
+      ...otherArgs
+    }: OrderArgs
+  ): Promise<unknown> {
+    const response = await this.request<SmartCollection>({
+      http_method: "put",
+      operation: "order",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"products": products, "sort_order": sort_order, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public rules: {[key: string]: unknown} | {[key: string]: unknown}[] | null;
+  public title: string | null;
+  public body_html: string | null;
+  public disjunctive: boolean | null;
+  public handle: string | null;
+  public id: string | null;
+  public image: string | {[key: string]: unknown} | null;
+  public published_at: string | null;
+  public published_scope: string | null;
+  public sort_order: string | null;
+  public template_suffix: string | null;
+  public updated_at: string | null;
+}