@shopify/shopify-api 13.1.0 → 14.0.1

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

@@ -0,0 +1,212 @@
+/***********************************************************************************************************************
+* 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;
+  price_rule_id?: number | string | null;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+  price_rule_id?: number | string | null;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  price_rule_id?: number | string | null;
+  batch_id?: number | string | null;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  times_used?: unknown;
+  times_used_min?: unknown;
+  times_used_max?: unknown;
+}
+interface GetAllArgs {
+  [key: string]: unknown;
+  session: Session;
+  price_rule_id?: number | string | null;
+  batch_id?: number | string | null;
+}
+interface LookupArgs {
+  [key: string]: unknown;
+  session: Session;
+  code?: unknown;
+}
+interface BatchArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class DiscountCode 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": ["price_rule_id", "id"], "path": "price_rules/<price_rule_id>/discount_codes/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "discount_codes/count.json"},
+    {"http_method": "get", "operation": "get", "ids": ["price_rule_id", "batch_id"], "path": "price_rules/<price_rule_id>/batch/<batch_id>/discount_codes.json"},
+    {"http_method": "get", "operation": "get", "ids": ["price_rule_id"], "path": "price_rules/<price_rule_id>/discount_codes.json"},
+    {"http_method": "get", "operation": "get", "ids": ["price_rule_id", "id"], "path": "price_rules/<price_rule_id>/discount_codes/<id>.json"},
+    {"http_method": "get", "operation": "get_all", "ids": ["price_rule_id", "batch_id"], "path": "price_rules/<price_rule_id>/batch/<batch_id>.json"},
+    {"http_method": "get", "operation": "lookup", "ids": [], "path": "discount_codes/lookup.json"},
+    {"http_method": "post", "operation": "batch", "ids": ["price_rule_id"], "path": "price_rules/<price_rule_id>/batch.json"},
+    {"http_method": "post", "operation": "post", "ids": ["price_rule_id"], "path": "price_rules/<price_rule_id>/discount_codes.json"},
+    {"http_method": "put", "operation": "put", "ids": ["price_rule_id", "id"], "path": "price_rules/<price_rule_id>/discount_codes/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "discount_code",
+      "plural": "discount_codes"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      price_rule_id = null
+    }: FindArgs
+  ): Promise<DiscountCode | null> {
+    const result = await this.baseFind<DiscountCode>({
+      session: session,
+      urlIds: {"id": id, "price_rule_id": price_rule_id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id,
+      price_rule_id = null
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<DiscountCode>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id, "price_rule_id": price_rule_id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      price_rule_id = null,
+      batch_id = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<DiscountCode>> {
+    const response = await this.baseFind<DiscountCode>({
+      session: session,
+      urlIds: {"price_rule_id": price_rule_id, "batch_id": batch_id},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      times_used = null,
+      times_used_min = null,
+      times_used_max = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<DiscountCode>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"times_used": times_used, "times_used_min": times_used_min, "times_used_max": times_used_max, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async get_all(
+    {
+      session,
+      price_rule_id = null,
+      batch_id = null,
+      ...otherArgs
+    }: GetAllArgs
+  ): Promise<unknown> {
+    const response = await this.request<DiscountCode>({
+      http_method: "get",
+      operation: "get_all",
+      session: session,
+      urlIds: {"price_rule_id": price_rule_id, "batch_id": batch_id},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async lookup(
+    {
+      session,
+      code = null,
+      ...otherArgs
+    }: LookupArgs
+  ): Promise<unknown> {
+    const response = await this.request<DiscountCode>({
+      http_method: "get",
+      operation: "lookup",
+      session: session,
+      urlIds: {},
+      params: {"code": code, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async batch(
+    {
+      body = null,
+      ...otherArgs
+    }: BatchArgs
+  ): Promise<unknown> {
+    const response = await this.request<DiscountCode>({
+      http_method: "post",
+      operation: "batch",
+      session: this.session,
+      urlIds: {"price_rule_id": this.price_rule_id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public code: string | null;
+  public created_at: string | null;
+  public errors: {[key: string]: unknown} | null;
+  public id: string | null;
+  public price_rule_id: string | null;
+  public updated_at: string | null;
+  public usage_count: number | null;
+}

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

@@ -0,0 +1,83 @@
+/***********************************************************************************************************************
+* 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;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  since_id?: unknown;
+  last_id?: unknown;
+  status?: unknown;
+  initiated_at?: unknown;
+}
+
+export class Dispute 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": "shopify_payments/disputes.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "shopify_payments/disputes/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "dispute",
+      "plural": "disputes"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<Dispute | null> {
+    const result = await this.baseFind<Dispute>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      since_id = null,
+      last_id = null,
+      status = null,
+      initiated_at = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Dispute>> {
+    const response = await this.baseFind<Dispute>({
+      session: session,
+      urlIds: {},
+      params: {"since_id": since_id, "last_id": last_id, "status": status, "initiated_at": initiated_at, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public amount: string | null;
+  public currency: string | null;
+  public evidence_due_by: string | null;
+  public evidence_sent_on: string | null;
+  public finalized_on: string | null;
+  public id: string | null;
+  public network_reason_code: string | null;
+  public order_id: string | null;
+  public reason: string | null;
+  public status: string | null;
+  public type: string | null;
+}

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

@@ -0,0 +1,69 @@
+/***********************************************************************************************************************
+* 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 {Fulfillment} from './fulfillment';
+
+interface FindArgs {
+  session: Session;
+  dispute_id: number | string;
+}
+
+export class DisputeEvidence extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {
+    "fulfillments": Fulfillment
+  };
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": ["dispute_id"], "path": "shopify_payments/disputes/<dispute_id>/dispute_evidences.json"},
+    {"http_method": "put", "operation": "put", "ids": ["dispute_id"], "path": "shopify_payments/disputes/<dispute_id>/dispute_evidences.json"}
+  ];
+  protected static primaryKey: string = "dispute_id";
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "dispute_evidence",
+      "plural": "dispute_evidences"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      dispute_id
+    }: FindArgs
+  ): Promise<DisputeEvidence | null> {
+    const result = await this.baseFind<DisputeEvidence>({
+      session: session,
+      urlIds: {"dispute_id": dispute_id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public access_activity_log: string | null;
+  public billing_address: {[key: string]: unknown} | null;
+  public cancellation_policy_disclosure: string | null;
+  public cancellation_rebuttal: string | null;
+  public created_at: string | null;
+  public customer_email_address: string | null;
+  public customer_first_name: string | null;
+  public customer_last_name: string | null;
+  public dispute_evidence_files: {[key: string]: unknown} | null;
+  public fulfillments: Fulfillment[] | null | {[key: string]: any};
+  public id: string | null;
+  public payments_dispute_id: string | null;
+  public product_description: {[key: string]: unknown} | null;
+  public refund_policy_disclosure: string | null;
+  public refund_refusal_explanation: string | null;
+  public shipping_address: {[key: string]: unknown} | null;
+  public submitted: boolean | null;
+  public uncategorized_text: string | null;
+  public updated_on: string | null;
+}

package/rest/admin/2026-07/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.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": ["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-07/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.July26;
+
+  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;
+}