@shopify/shopify-api 13.0.0 → 13.1.0

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

@@ -0,0 +1,237 @@
+/***********************************************************************************************************************
+* 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 {Metafield} from './metafield';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  blog_id?: number | string | null;
+  fields?: unknown;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+  blog_id?: number | string | null;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  blog_id?: number | string | null;
+  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;
+  published_status?: unknown;
+  handle?: unknown;
+  tag?: unknown;
+  author?: unknown;
+  fields?: unknown;
+}
+interface AuthorsArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  blog_id?: number | string | null;
+  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;
+}
+interface TagsArgs {
+  [key: string]: unknown;
+  session: Session;
+  blog_id?: number | string | null;
+  limit?: unknown;
+  popular?: unknown;
+}
+
+export class Article extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {
+    "metafields": Metafield
+  };
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["blog_id", "id"], "path": "blogs/<blog_id>/articles/<id>.json"},
+    {"http_method": "get", "operation": "authors", "ids": [], "path": "articles/authors.json"},
+    {"http_method": "get", "operation": "count", "ids": ["blog_id"], "path": "blogs/<blog_id>/articles/count.json"},
+    {"http_method": "get", "operation": "get", "ids": ["blog_id"], "path": "blogs/<blog_id>/articles.json"},
+    {"http_method": "get", "operation": "get", "ids": ["blog_id", "id"], "path": "blogs/<blog_id>/articles/<id>.json"},
+    {"http_method": "get", "operation": "tags", "ids": [], "path": "articles/tags.json"},
+    {"http_method": "get", "operation": "tags", "ids": ["blog_id"], "path": "blogs/<blog_id>/articles/tags.json"},
+    {"http_method": "post", "operation": "post", "ids": ["blog_id"], "path": "blogs/<blog_id>/articles.json"},
+    {"http_method": "put", "operation": "put", "ids": ["blog_id", "id"], "path": "blogs/<blog_id>/articles/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "article",
+      "plural": "articles"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      blog_id = null,
+      fields = null
+    }: FindArgs
+  ): Promise<Article | null> {
+    const result = await this.baseFind<Article>({
+      session: session,
+      urlIds: {"id": id, "blog_id": blog_id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id,
+      blog_id = null
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<Article>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id, "blog_id": blog_id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      blog_id = null,
+      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,
+      published_status = null,
+      handle = null,
+      tag = null,
+      author = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Article>> {
+    const response = await this.baseFind<Article>({
+      session: session,
+      urlIds: {"blog_id": blog_id},
+      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, "published_status": published_status, "handle": handle, "tag": tag, "author": author, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async authors(
+    {
+      session,
+      ...otherArgs
+    }: AuthorsArgs
+  ): Promise<unknown> {
+    const response = await this.request<Article>({
+      http_method: "get",
+      operation: "authors",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async count(
+    {
+      session,
+      blog_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<Article>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {"blog_id": blog_id},
+      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, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async tags(
+    {
+      session,
+      blog_id = null,
+      limit = null,
+      popular = null,
+      ...otherArgs
+    }: TagsArgs
+  ): Promise<unknown> {
+    const response = await this.request<Article>({
+      http_method: "get",
+      operation: "tags",
+      session: session,
+      urlIds: {"blog_id": blog_id},
+      params: {"limit": limit, "popular": popular, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public author: string | null;
+  public blog_id: string | null;
+  public body_html: string | null;
+  public created_at: string | null;
+  public handle: string | null;
+  public id: string | null;
+  public image: string | {[key: string]: unknown} | null;
+  public metafields: Metafield[] | null | {[key: string]: any};
+  public published: boolean | null;
+  public published_at: string | null;
+  public summary_html: string | null;
+  public tags: string | null;
+  public template_suffix: string | null;
+  public title: string | null;
+  public updated_at: string | null;
+  public user_id: string | null;
+}

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

@@ -0,0 +1,88 @@
+/***********************************************************************************************************************
+* 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 DeleteArgs {
+  session: Session;
+  theme_id?: number | string | null;
+  asset?: {[key: string]: unknown} | null;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  theme_id?: number | string | null;
+  fields?: unknown;
+  asset?: {[key: string]: unknown} | null;
+}
+
+export class Asset 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": ["theme_id"], "path": "themes/<theme_id>/assets.json"},
+    {"http_method": "get", "operation": "get", "ids": ["theme_id"], "path": "themes/<theme_id>/assets.json"},
+    {"http_method": "get", "operation": "get", "ids": ["theme_id"], "path": "themes/<theme_id>/assets.json"},
+    {"http_method": "put", "operation": "put", "ids": ["theme_id"], "path": "themes/<theme_id>/assets.json"}
+  ];
+  protected static primaryKey: string = "key";
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "asset",
+      "plural": "assets"
+    }
+  ];
+
+  public static async delete(
+    {
+      session,
+      theme_id = null,
+      asset = null
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<Asset>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"theme_id": theme_id},
+      params: {"asset": asset},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      theme_id = null,
+      fields = null,
+      asset = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Asset>> {
+    const response = await this.baseFind<Asset>({
+      session: session,
+      urlIds: {"theme_id": theme_id},
+      params: {"fields": fields, "asset": asset, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public attachment: string | null;
+  public checksum: string | null;
+  public content_type: string | null;
+  public created_at: string | null;
+  public key: string | null;
+  public public_url: string | null;
+  public size: number | null;
+  public theme_id: string | null;
+  public updated_at: string | null;
+  public value: string | null;
+}

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

@@ -0,0 +1,57 @@
+/***********************************************************************************************************************
+* 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;
+  assignment_status?: unknown;
+  location_ids?: unknown[] | number | string | null;
+}
+
+export class AssignedFulfillmentOrder 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": "assigned_fulfillment_orders.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "fulfillment_order",
+      "plural": "fulfillment_orders"
+    }
+  ];
+
+  public static async all(
+    {
+      session,
+      assignment_status = null,
+      location_ids = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<AssignedFulfillmentOrder>> {
+    const response = await this.baseFind<AssignedFulfillmentOrder>({
+      session: session,
+      urlIds: {},
+      params: {"assignment_status": assignment_status, "location_ids": location_ids, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public assigned_location_id: string | null;
+  public destination: {[key: string]: unknown} | null;
+  public id: string | null;
+  public line_items: {[key: string]: unknown}[] | null;
+  public order_id: string | null;
+  public request_status: string | null;
+  public shop_id: string | null;
+  public status: string | null;
+}

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

@@ -0,0 +1,46 @@
+/***********************************************************************************************************************
+* 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 Balance 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/balance.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "balance",
+      "plural": "balances"
+    }
+  ];
+
+  public static async all(
+    {
+      session,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Balance>> {
+    const response = await this.baseFind<Balance>({
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public balance: {[key: string]: unknown}[] | null;
+}

package/rest/admin/2026-04/blog.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 {Metafield} from './metafield';
+
+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;
+  handle?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+
+export class Blog extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {
+    "metafields": Metafield
+  };
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["id"], "path": "blogs/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "blogs/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "blogs.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "blogs/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "blogs.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "blogs/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "blog",
+      "plural": "blogs"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Blog | null> {
+    const result = await this.baseFind<Blog>({
+      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<Blog>({
+      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,
+      handle = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Blog>> {
+    const response = await this.baseFind<Blog>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "since_id": since_id, "handle": handle, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Blog>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public admin_graphql_api_id: string | null;
+  public commentable: string | null;
+  public created_at: string | null;
+  public feedburner: string | null;
+  public feedburner_location: string | null;
+  public handle: string | null;
+  public id: string | null;
+  public metafields: Metafield[] | null | {[key: string]: any};
+  public tags: string | null;
+  public template_suffix: string | null;
+  public title: string | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,78 @@
+/***********************************************************************************************************************
+* 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 {ApiVersion} from '../../../lib/types';
+
+interface AcceptArgs {
+  [key: string]: unknown;
+  message?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface RejectArgs {
+  [key: string]: unknown;
+  message?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class CancellationRequest 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": "post", "operation": "accept", "ids": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/cancellation_request/accept.json"},
+    {"http_method": "post", "operation": "post", "ids": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/cancellation_request.json"},
+    {"http_method": "post", "operation": "reject", "ids": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/cancellation_request/reject.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "cancellation_request",
+      "plural": "cancellation_requests"
+    }
+  ];
+
+  public async accept(
+    {
+      message = null,
+      body = null,
+      ...otherArgs
+    }: AcceptArgs
+  ): Promise<unknown> {
+    const response = await this.request<CancellationRequest>({
+      http_method: "post",
+      operation: "accept",
+      session: this.session,
+      urlIds: {"fulfillment_order_id": this.fulfillment_order_id},
+      params: {"message": message, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async reject(
+    {
+      message = null,
+      body = null,
+      ...otherArgs
+    }: RejectArgs
+  ): Promise<unknown> {
+    const response = await this.request<CancellationRequest>({
+      http_method: "post",
+      operation: "reject",
+      session: this.session,
+      urlIds: {"fulfillment_order_id": this.fulfillment_order_id},
+      params: {"message": message, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public fulfillment_order_id: string | null;
+}