@shopify/shopify-api 13.1.0 → 14.0.1

package/rest/admin/2026-07/collect.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';
+
+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;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+
+export class Collect 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": "collects/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "collects/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "collects.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "collects/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "collects.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "collect",
+      "plural": "collects"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Collect | null> {
+    const result = await this.baseFind<Collect>({
+      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<Collect>({
+      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,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Collect>> {
+    const response = await this.baseFind<Collect>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "since_id": since_id, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Collect>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public collection_id: string | null;
+  public created_at: string | null;
+  public id: string | null;
+  public position: number | null;
+  public product_id: string | null;
+  public sort_value: string | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,88 @@
+/***********************************************************************************************************************
+* 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 {Image} from './image';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  fields?: unknown;
+}
+interface ProductsArgs {
+  [key: string]: unknown;
+  session: Session;
+  id: number | string;
+  limit?: unknown;
+}
+
+export class Collection extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "image": Image
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "collections/<id>.json"},
+    {"http_method": "get", "operation": "products", "ids": ["id"], "path": "collections/<id>/products.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "collection",
+      "plural": "collections"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Collection | null> {
+    const result = await this.baseFind<Collection>({
+      session: session,
+      urlIds: {"id": id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async products(
+    {
+      session,
+      id,
+      limit = null,
+      ...otherArgs
+    }: ProductsArgs
+  ): Promise<unknown> {
+    const response = await this.request<Collection>({
+      http_method: "get",
+      operation: "products",
+      session: session,
+      urlIds: {"id": id},
+      params: {"limit": limit, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public title: string | null;
+  public body_html: string | null;
+  public handle: string | null;
+  public id: string | null;
+  public image: Image | null | {[key: string]: any};
+  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;
+}

package/rest/admin/2026-07/collection_listing.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';
+
+import {Image} from './image';
+
+interface FindArgs {
+  session: Session;
+  collection_id: number | string;
+}
+interface DeleteArgs {
+  session: Session;
+  collection_id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  limit?: unknown;
+}
+interface ProductIdsArgs {
+  [key: string]: unknown;
+  session: Session;
+  collection_id: number | string;
+  limit?: unknown;
+}
+
+export class CollectionListing extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "image": Image
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["collection_id"], "path": "collection_listings/<collection_id>.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "collection_listings.json"},
+    {"http_method": "get", "operation": "get", "ids": ["collection_id"], "path": "collection_listings/<collection_id>.json"},
+    {"http_method": "get", "operation": "product_ids", "ids": ["collection_id"], "path": "collection_listings/<collection_id>/product_ids.json"},
+    {"http_method": "put", "operation": "put", "ids": ["collection_id"], "path": "collection_listings/<collection_id>.json"}
+  ];
+  protected static primaryKey: string = "collection_id";
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "collection_listing",
+      "plural": "collection_listings"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      collection_id
+    }: FindArgs
+  ): Promise<CollectionListing | null> {
+    const result = await this.baseFind<CollectionListing>({
+      session: session,
+      urlIds: {"collection_id": collection_id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      collection_id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<CollectionListing>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"collection_id": collection_id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<CollectionListing>> {
+    const response = await this.baseFind<CollectionListing>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async product_ids(
+    {
+      session,
+      collection_id,
+      limit = null,
+      ...otherArgs
+    }: ProductIdsArgs
+  ): Promise<unknown> {
+    const response = await this.request<CollectionListing>({
+      http_method: "get",
+      operation: "product_ids",
+      session: session,
+      urlIds: {"collection_id": collection_id},
+      params: {"limit": limit, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public body_html: string | null;
+  public collection_id: string | null;
+  public default_product_image: {[key: string]: unknown}[] | null;
+  public handle: string | null;
+  public image: Image | null | {[key: string]: any};
+  public published_at: string | null;
+  public sort_order: string | null;
+  public title: string | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,263 @@
+/***********************************************************************************************************************
+* 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 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;
+  published_at_min?: unknown;
+  published_at_max?: unknown;
+  fields?: unknown;
+  published_status?: unknown;
+  status?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  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;
+  status?: unknown;
+}
+interface ApproveArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface NotSpamArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface RemoveArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface RestoreArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface SpamArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class Comment 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": "count", "ids": [], "path": "comments/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "comments.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "comments/<id>.json"},
+    {"http_method": "post", "operation": "approve", "ids": ["id"], "path": "comments/<id>/approve.json"},
+    {"http_method": "post", "operation": "not_spam", "ids": ["id"], "path": "comments/<id>/not_spam.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "comments.json"},
+    {"http_method": "post", "operation": "remove", "ids": ["id"], "path": "comments/<id>/remove.json"},
+    {"http_method": "post", "operation": "restore", "ids": ["id"], "path": "comments/<id>/restore.json"},
+    {"http_method": "post", "operation": "spam", "ids": ["id"], "path": "comments/<id>/spam.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "comments/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "comment",
+      "plural": "comments"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Comment | null> {
+    const result = await this.baseFind<Comment>({
+      session: session,
+      urlIds: {"id": id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : 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,
+      published_at_min = null,
+      published_at_max = null,
+      fields = null,
+      published_status = null,
+      status = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Comment>> {
+    const response = await this.baseFind<Comment>({
+      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, "published_at_min": published_at_min, "published_at_max": published_at_max, "fields": fields, "published_status": published_status, "status": status, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      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,
+      status = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Comment>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"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, "status": status, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async approve(
+    {
+      body = null,
+      ...otherArgs
+    }: ApproveArgs
+  ): Promise<unknown> {
+    const response = await this.request<Comment>({
+      http_method: "post",
+      operation: "approve",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async not_spam(
+    {
+      body = null,
+      ...otherArgs
+    }: NotSpamArgs
+  ): Promise<unknown> {
+    const response = await this.request<Comment>({
+      http_method: "post",
+      operation: "not_spam",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async remove(
+    {
+      body = null,
+      ...otherArgs
+    }: RemoveArgs
+  ): Promise<unknown> {
+    const response = await this.request<Comment>({
+      http_method: "post",
+      operation: "remove",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async restore(
+    {
+      body = null,
+      ...otherArgs
+    }: RestoreArgs
+  ): Promise<unknown> {
+    const response = await this.request<Comment>({
+      http_method: "post",
+      operation: "restore",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async spam(
+    {
+      body = null,
+      ...otherArgs
+    }: SpamArgs
+  ): Promise<unknown> {
+    const response = await this.request<Comment>({
+      http_method: "post",
+      operation: "spam",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public article_id: string | null;
+  public author: string | null;
+  public blog_id: string | null;
+  public body: string | null;
+  public body_html: string | null;
+  public created_at: string | null;
+  public email: string | null;
+  public id: string | null;
+  public ip: string | null;
+  public published_at: string | null;
+  public status: string | null;
+  public updated_at: string | null;
+  public user_agent: string | null;
+}