@shopify/shopify-api 13.1.0 → 14.0.0

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

@@ -0,0 +1,163 @@
+/***********************************************************************************************************************
+* 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;
+  ids?: unknown;
+  since_id?: unknown;
+  title?: unknown;
+  product_id?: unknown;
+  handle?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  published_at_min?: unknown;
+  published_at_max?: unknown;
+  published_status?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  title?: unknown;
+  product_id?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  published_at_min?: unknown;
+  published_at_max?: unknown;
+  published_status?: unknown;
+}
+
+export class CustomCollection 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": "custom_collections/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "custom_collections/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "custom_collections.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "custom_collections/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "custom_collections.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "custom_collections/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "custom_collection",
+      "plural": "custom_collections"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<CustomCollection | null> {
+    const result = await this.baseFind<CustomCollection>({
+      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<CustomCollection>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      ids = null,
+      since_id = null,
+      title = null,
+      product_id = null,
+      handle = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      published_at_min = null,
+      published_at_max = null,
+      published_status = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<CustomCollection>> {
+    const response = await this.baseFind<CustomCollection>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "ids": ids, "since_id": since_id, "title": title, "product_id": product_id, "handle": handle, "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, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      title = null,
+      product_id = 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<CustomCollection>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {"title": title, "product_id": product_id, "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 title: string | null;
+  public body_html: string | null;
+  public handle: string | null;
+  public id: string | null;
+  public image: string | {[key: string]: unknown} | null;
+  public published: boolean | null;
+  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/customer.ts

@@ -0,0 +1,277 @@
+/***********************************************************************************************************************
+* 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;
+  ids?: unknown;
+  since_id?: unknown;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+  limit?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+}
+interface OrdersArgs {
+  [key: string]: unknown;
+  session: Session;
+  id: number | string;
+  status?: unknown;
+}
+interface SearchArgs {
+  [key: string]: unknown;
+  session: Session;
+  order?: unknown;
+  query?: unknown;
+  limit?: unknown;
+  fields?: unknown;
+}
+interface AccountActivationUrlArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface SendInviteArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class Customer extends Base {
+  public static apiVersion = ApiVersion.July26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "metafield": Metafield
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "delete", "operation": "delete", "ids": ["id"], "path": "customers/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "customers/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "customers.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "customers/<id>.json"},
+    {"http_method": "get", "operation": "orders", "ids": ["id"], "path": "customers/<id>/orders.json"},
+    {"http_method": "get", "operation": "search", "ids": [], "path": "customers/search.json"},
+    {"http_method": "post", "operation": "account_activation_url", "ids": ["id"], "path": "customers/<id>/account_activation_url.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "customers.json"},
+    {"http_method": "post", "operation": "send_invite", "ids": ["id"], "path": "customers/<id>/send_invite.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "customers/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "customer",
+      "plural": "customers"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Customer | null> {
+    const result = await this.baseFind<Customer>({
+      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<Customer>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      ids = null,
+      since_id = null,
+      created_at_min = null,
+      created_at_max = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      limit = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Customer>> {
+    const response = await this.baseFind<Customer>({
+      session: session,
+      urlIds: {},
+      params: {"ids": ids, "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, "limit": limit, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      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<Customer>({
+      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, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async orders(
+    {
+      session,
+      id,
+      status = null,
+      ...otherArgs
+    }: OrdersArgs
+  ): Promise<unknown> {
+    const response = await this.request<Customer>({
+      http_method: "get",
+      operation: "orders",
+      session: session,
+      urlIds: {"id": id},
+      params: {"status": status, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async search(
+    {
+      session,
+      order = null,
+      query = null,
+      limit = null,
+      fields = null,
+      ...otherArgs
+    }: SearchArgs
+  ): Promise<unknown> {
+    const response = await this.request<Customer>({
+      http_method: "get",
+      operation: "search",
+      session: session,
+      urlIds: {},
+      params: {"order": order, "query": query, "limit": limit, "fields": fields, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async account_activation_url(
+    {
+      body = null,
+      ...otherArgs
+    }: AccountActivationUrlArgs
+  ): Promise<unknown> {
+    const response = await this.request<Customer>({
+      http_method: "post",
+      operation: "account_activation_url",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async send_invite(
+    {
+      body = null,
+      ...otherArgs
+    }: SendInviteArgs
+  ): Promise<unknown> {
+    const response = await this.request<Customer>({
+      http_method: "post",
+      operation: "send_invite",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public addresses: {[key: string]: unknown}[] | null;
+  public created_at: string | null;
+  public currency: string | null;
+  public default_address: {[key: string]: unknown} | null;
+  public email: string | null;
+  public email_marketing_consent: {[key: string]: unknown} | null;
+  public first_name: string | null;
+  public id: string | null;
+  public last_name: string | null;
+  public last_order_id: string | null;
+  public last_order_name: string | null;
+  public marketing_opt_in_level: string | null;
+  public metafield: Metafield | null | {[key: string]: any};
+  public multipass_identifier: string | null;
+  public note: string | null;
+  public orders_count: number | null;
+  public password: string | null;
+  public password_confirmation: string | null;
+  public phone: string | null;
+  public sms_marketing_consent: {[key: string]: unknown} | null;
+  public state: string | null;
+  public tags: string | null;
+  public tax_exempt: boolean | null;
+  public tax_exemptions: string[] | null;
+  public total_spent: string | null;
+  public updated_at: string | null;
+  public verified_email: boolean | null;
+}

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

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

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;
+}