@shopify/shopify-api 13.0.0 → 13.1.0

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

@@ -0,0 +1,59 @@
+/***********************************************************************************************************************
+* 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';
+
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+  dispute_id?: number | string | null;
+}
+
+export class DisputeFileUpload 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": ["dispute_id", "id"], "path": "shopify_payments/disputes/<dispute_id>/dispute_file_uploads/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": ["dispute_id"], "path": "shopify_payments/disputes/<dispute_id>/dispute_file_uploads.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "dispute_file_upload",
+      "plural": "dispute_file_uploads"
+    }
+  ];
+
+  public static async delete(
+    {
+      session,
+      id,
+      dispute_id = null
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<DisputeFileUpload>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id, "dispute_id": dispute_id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public dispute_evidence_id: string | null;
+  public dispute_evidence_type: string | null;
+  public file_size: number | null;
+  public file_type: string | null;
+  public filename: string | null;
+  public id: string | null;
+  public original_filename: string | null;
+  public shop_id: string | null;
+  public url: string | null;
+}

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

@@ -0,0 +1,221 @@
+/***********************************************************************************************************************
+* 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 {Customer} from './customer';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  fields?: unknown;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  fields?: unknown;
+  limit?: unknown;
+  since_id?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  ids?: unknown;
+  status?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  since_id?: unknown;
+  status?: unknown;
+  updated_at_max?: unknown;
+  updated_at_min?: unknown;
+}
+interface SendInvoiceArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface CompleteArgs {
+  [key: string]: unknown;
+  payment_gateway_id?: unknown;
+  payment_pending?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class DraftOrder extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "customer": Customer
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["id"], "path": "draft_orders/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "draft_orders/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "draft_orders.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "draft_orders/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "draft_orders.json"},
+    {"http_method": "post", "operation": "send_invoice", "ids": ["id"], "path": "draft_orders/<id>/send_invoice.json"},
+    {"http_method": "put", "operation": "complete", "ids": ["id"], "path": "draft_orders/<id>/complete.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "draft_orders/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "draft_order",
+      "plural": "draft_orders"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<DraftOrder | null> {
+    const result = await this.baseFind<DraftOrder>({
+      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<DraftOrder>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      fields = null,
+      limit = null,
+      since_id = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      ids = null,
+      status = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<DraftOrder>> {
+    const response = await this.baseFind<DraftOrder>({
+      session: session,
+      urlIds: {},
+      params: {"fields": fields, "limit": limit, "since_id": since_id, "updated_at_min": updated_at_min, "updated_at_max": updated_at_max, "ids": ids, "status": status, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      since_id = null,
+      status = null,
+      updated_at_max = null,
+      updated_at_min = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<DraftOrder>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"since_id": since_id, "status": status, "updated_at_max": updated_at_max, "updated_at_min": updated_at_min, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async send_invoice(
+    {
+      body = null,
+      ...otherArgs
+    }: SendInvoiceArgs
+  ): Promise<unknown> {
+    const response = await this.request<DraftOrder>({
+      http_method: "post",
+      operation: "send_invoice",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async complete(
+    {
+      payment_gateway_id = null,
+      payment_pending = null,
+      body = null,
+      ...otherArgs
+    }: CompleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<DraftOrder>({
+      http_method: "put",
+      operation: "complete",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"payment_gateway_id": payment_gateway_id, "payment_pending": payment_pending, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public applied_discount: {[key: string]: unknown} | null;
+  public billing_address: {[key: string]: unknown} | null;
+  public completed_at: string | null;
+  public created_at: string | null;
+  public currency: string | null;
+  public customer: Customer | null | {[key: string]: any};
+  public email: string | null;
+  public id: string | null;
+  public invoice_sent_at: string | null;
+  public invoice_url: string | null;
+  public line_items: {[key: string]: unknown}[] | null;
+  public name: string | null;
+  public note: string | null;
+  public note_attributes: {[key: string]: unknown}[] | null;
+  public order_id: string | null;
+  public payment_terms: {[key: string]: unknown} | null;
+  public shipping_address: {[key: string]: unknown} | null;
+  public shipping_line: {[key: string]: unknown} | null;
+  public source_name: string | null;
+  public status: string | null;
+  public subtotal_price: string | null;
+  public tags: string | null;
+  public tax_exempt: boolean | null;
+  public tax_exemptions: string[] | null;
+  public tax_lines: {[key: string]: unknown}[] | null;
+  public taxes_included: boolean | null;
+  public total_price: string | null;
+  public total_tax: string | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,124 @@
+/***********************************************************************************************************************
+* 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;
+  order_id?: number | string | null;
+  product_id?: number | string | null;
+  limit?: unknown;
+  since_id?: unknown;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  filter?: unknown;
+  verb?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+}
+
+export class Event 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": [], "path": "events/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "events.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "events/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id"], "path": "orders/<order_id>/events.json"},
+    {"http_method": "get", "operation": "get", "ids": ["product_id"], "path": "products/<product_id>/events.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "event",
+      "plural": "events"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Event | null> {
+    const result = await this.baseFind<Event>({
+      session: session,
+      urlIds: {"id": id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      order_id = null,
+      product_id = null,
+      limit = null,
+      since_id = null,
+      created_at_min = null,
+      created_at_max = null,
+      filter = null,
+      verb = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Event>> {
+    const response = await this.baseFind<Event>({
+      session: session,
+      urlIds: {"order_id": order_id, "product_id": product_id},
+      params: {"limit": limit, "since_id": since_id, "created_at_min": created_at_min, "created_at_max": created_at_max, "filter": filter, "verb": verb, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      created_at_min = null,
+      created_at_max = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Event>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"created_at_min": created_at_min, "created_at_max": created_at_max, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public arguments: string[] | null;
+  public body: string | null;
+  public created_at: string | null;
+  public description: string | null;
+  public id: string | null;
+  public message: string | null;
+  public path: string | null;
+  public subject_id: string | null;
+  public subject_type: string | null;
+  public verb: string | null;
+}

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

@@ -0,0 +1,193 @@
+/***********************************************************************************************************************
+* 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;
+  order_id?: number | string | null;
+  fields?: unknown;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  fulfillment_order_id?: number | string | null;
+  order_id?: number | string | null;
+  created_at_max?: unknown;
+  created_at_min?: unknown;
+  fields?: unknown;
+  limit?: unknown;
+  since_id?: unknown;
+  updated_at_max?: unknown;
+  updated_at_min?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  order_id?: number | string | null;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+}
+interface CancelArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface UpdateTrackingArgs {
+  [key: string]: unknown;
+  notify_customer?: unknown;
+  tracking_info?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class Fulfillment 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": ["order_id"], "path": "orders/<order_id>/fulfillments/count.json"},
+    {"http_method": "get", "operation": "get", "ids": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/fulfillments.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id"], "path": "orders/<order_id>/fulfillments.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id", "id"], "path": "orders/<order_id>/fulfillments/<id>.json"},
+    {"http_method": "post", "operation": "cancel", "ids": ["id"], "path": "fulfillments/<id>/cancel.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "fulfillments.json"},
+    {"http_method": "post", "operation": "update_tracking", "ids": ["id"], "path": "fulfillments/<id>/update_tracking.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "fulfillment",
+      "plural": "fulfillments"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      order_id = null,
+      fields = null
+    }: FindArgs
+  ): Promise<Fulfillment | null> {
+    const result = await this.baseFind<Fulfillment>({
+      session: session,
+      urlIds: {"id": id, "order_id": order_id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      fulfillment_order_id = null,
+      order_id = null,
+      created_at_max = null,
+      created_at_min = null,
+      fields = null,
+      limit = null,
+      since_id = null,
+      updated_at_max = null,
+      updated_at_min = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Fulfillment>> {
+    const response = await this.baseFind<Fulfillment>({
+      session: session,
+      urlIds: {"fulfillment_order_id": fulfillment_order_id, "order_id": order_id},
+      params: {"created_at_max": created_at_max, "created_at_min": created_at_min, "fields": fields, "limit": limit, "since_id": since_id, "updated_at_max": updated_at_max, "updated_at_min": updated_at_min, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      order_id = null,
+      created_at_min = null,
+      created_at_max = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Fulfillment>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {"order_id": order_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, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async cancel(
+    {
+      body = null,
+      ...otherArgs
+    }: CancelArgs
+  ): Promise<unknown> {
+    const response = await this.request<Fulfillment>({
+      http_method: "post",
+      operation: "cancel",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async update_tracking(
+    {
+      notify_customer = null,
+      tracking_info = null,
+      body = null,
+      ...otherArgs
+    }: UpdateTrackingArgs
+  ): Promise<unknown> {
+    const response = await this.request<Fulfillment>({
+      http_method: "post",
+      operation: "update_tracking",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"notify_customer": notify_customer, "tracking_info": tracking_info, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public created_at: string | null;
+  public id: string | null;
+  public line_items: {[key: string]: unknown}[] | null;
+  public location_id: string | null;
+  public name: string | null;
+  public notify_customer: boolean | null;
+  public order_id: string | null;
+  public origin_address: {[key: string]: unknown}[] | null;
+  public receipt: {[key: string]: unknown} | null;
+  public service: string | null;
+  public shipment_status: string | null;
+  public status: string | null;
+  public tracking_company: string | null;
+  public tracking_number: string | null;
+  public tracking_numbers: string[] | null;
+  public tracking_url: string | null;
+  public tracking_urls: string[] | null;
+  public updated_at: string | null;
+  public variant_inventory_management: string | null;
+}