@shopify/shopify-api 13.0.0 → 13.1.0

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

@@ -0,0 +1,167 @@
+/***********************************************************************************************************************
+* 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;
+  product_id: number | string;
+}
+interface DeleteArgs {
+  session: Session;
+  product_id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  product_ids?: unknown;
+  limit?: unknown;
+  collection_id?: unknown;
+  updated_at_min?: unknown;
+  handle?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+interface ProductIdsArgs {
+  [key: string]: unknown;
+  session: Session;
+  limit?: unknown;
+}
+
+export class ProductListing 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": ["product_id"], "path": "product_listings/<product_id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "product_listings/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "product_listings.json"},
+    {"http_method": "get", "operation": "get", "ids": ["product_id"], "path": "product_listings/<product_id>.json"},
+    {"http_method": "get", "operation": "product_ids", "ids": [], "path": "product_listings/product_ids.json"},
+    {"http_method": "put", "operation": "put", "ids": ["product_id"], "path": "product_listings/<product_id>.json"}
+  ];
+  protected static primaryKey: string = "product_id";
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "product_listing",
+      "plural": "product_listings"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      product_id
+    }: FindArgs
+  ): Promise<ProductListing | null> {
+    const result = await this.baseFind<ProductListing>({
+      session: session,
+      urlIds: {"product_id": product_id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      product_id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<ProductListing>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"product_id": product_id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      product_ids = null,
+      limit = null,
+      collection_id = null,
+      updated_at_min = null,
+      handle = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<ProductListing>> {
+    const response = await this.baseFind<ProductListing>({
+      session: session,
+      urlIds: {},
+      params: {"product_ids": product_ids, "limit": limit, "collection_id": collection_id, "updated_at_min": updated_at_min, "handle": handle, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<ProductListing>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async product_ids(
+    {
+      session,
+      limit = null,
+      ...otherArgs
+    }: ProductIdsArgs
+  ): Promise<unknown> {
+    const response = await this.request<ProductListing>({
+      http_method: "get",
+      operation: "product_ids",
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public body_html: string | null;
+  public created_at: string | null;
+  public handle: string | null;
+  public images: Image[] | null | {[key: string]: any};
+  public options: {[key: string]: unknown}[] | null;
+  public product_id: string | null;
+  public product_type: string | null;
+  public published_at: string | null;
+  public tags: string | null;
+  public title: string | null;
+  public updated_at: string | null;
+  public variants: Variant[] | null | {[key: string]: any};
+  public vendor: string | null;
+}

package/rest/admin/2026-04/product_resource_feedback.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';
+
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  product_id?: number | string | null;
+}
+
+export class ProductResourceFeedback 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": ["product_id"], "path": "products/<product_id>/resource_feedback.json"},
+    {"http_method": "post", "operation": "post", "ids": ["product_id"], "path": "products/<product_id>/resource_feedback.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "product_resource_feedback",
+      "plural": "product_resource_feedbacks"
+    }
+  ];
+
+  protected static getJsonBodyName(): string
+  {
+    return "resource_feedback";
+  }
+
+  public static async all(
+    {
+      session,
+      product_id = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<ProductResourceFeedback>> {
+    const response = await this.baseFind<ProductResourceFeedback>({
+      session: session,
+      urlIds: {"product_id": product_id},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public created_at: string | null;
+  public feedback_generated_at: string | null;
+  public messages: string[] | null;
+  public product_id: string | null;
+  public resource_id: string | null;
+  public resource_type: string | null;
+  public resource_updated_at: string | null;
+  public state: string | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,110 @@
+/***********************************************************************************************************************
+* 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;
+  country_id?: number | string | null;
+  fields?: unknown;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  country_id?: number | string | null;
+  since_id?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  country_id?: number | string | null;
+}
+
+export class Province 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": "count", "ids": ["country_id"], "path": "countries/<country_id>/provinces/count.json"},
+    {"http_method": "get", "operation": "get", "ids": ["country_id"], "path": "countries/<country_id>/provinces.json"},
+    {"http_method": "get", "operation": "get", "ids": ["country_id", "id"], "path": "countries/<country_id>/provinces/<id>.json"},
+    {"http_method": "put", "operation": "put", "ids": ["country_id", "id"], "path": "countries/<country_id>/provinces/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "province",
+      "plural": "provinces"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      country_id = null,
+      fields = null
+    }: FindArgs
+  ): Promise<Province | null> {
+    const result = await this.baseFind<Province>({
+      session: session,
+      urlIds: {"id": id, "country_id": country_id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      country_id = null,
+      since_id = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Province>> {
+    const response = await this.baseFind<Province>({
+      session: session,
+      urlIds: {"country_id": country_id},
+      params: {"since_id": since_id, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      country_id = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Province>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {"country_id": country_id},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public code: string | null;
+  public country_id: string | null;
+  public id: string | null;
+  public name: string | null;
+  public shipping_zone_id: string | null;
+  public tax: number | null;
+  public tax_name: string | null;
+  public tax_percentage: number | null;
+  public tax_type: string | null;
+}

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

@@ -0,0 +1,138 @@
+/***********************************************************************************************************************
+* 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 {Currency} from './currency';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  fields?: unknown;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  since_id?: unknown;
+  fields?: unknown;
+}
+interface CustomizeArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class RecurringApplicationCharge 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": "delete", "operation": "delete", "ids": ["id"], "path": "recurring_application_charges/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "recurring_application_charges.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "recurring_application_charges/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "recurring_application_charges.json"},
+    {"http_method": "put", "operation": "customize", "ids": ["id"], "path": "recurring_application_charges/<id>/customize.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "recurring_application_charge",
+      "plural": "recurring_application_charges"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<RecurringApplicationCharge | null> {
+    const result = await this.baseFind<RecurringApplicationCharge>({
+      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<RecurringApplicationCharge>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      since_id = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<RecurringApplicationCharge>> {
+    const response = await this.baseFind<RecurringApplicationCharge>({
+      session: session,
+      urlIds: {},
+      params: {"since_id": since_id, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public async customize(
+    {
+      body = null,
+      ...otherArgs
+    }: CustomizeArgs
+  ): Promise<unknown> {
+    const response = await this.request<RecurringApplicationCharge>({
+      http_method: "put",
+      operation: "customize",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public activated_on: string | null;
+  public billing_on: string | null;
+  public cancelled_on: string | null;
+  public capped_amount: string | number | null;
+  public confirmation_url: string | null;
+  public created_at: string | null;
+  public currency: Currency | null | {[key: string]: any};
+  public id: string | null;
+  public name: string | null;
+  public price: string | number | null;
+  public return_url: string | null;
+  public status: string | null;
+  public terms: string | null;
+  public test: boolean | null;
+  public trial_days: number | null;
+  public trial_ends_on: string | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,131 @@
+/***********************************************************************************************************************
+* 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;
+  path?: unknown;
+  target?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  path?: unknown;
+  target?: unknown;
+}
+
+export class Redirect 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": "redirects/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "redirects/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "redirects.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "redirects/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "redirects.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "redirects/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "redirect",
+      "plural": "redirects"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Redirect | null> {
+    const result = await this.baseFind<Redirect>({
+      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<Redirect>({
+      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,
+      path = null,
+      target = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Redirect>> {
+    const response = await this.baseFind<Redirect>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "since_id": since_id, "path": path, "target": target, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      path = null,
+      target = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Redirect>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"path": path, "target": target, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public id: string | null;
+  public path: string | null;
+  public target: string | null;
+}