@shopify/shopify-api 13.0.0 → 13.1.0

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

@@ -0,0 +1,80 @@
+/***********************************************************************************************************************
+* 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;
+  ids?: unknown;
+  limit?: unknown;
+}
+
+export class InventoryItem 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": "inventory_items.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "inventory_items/<id>.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "inventory_items/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "inventory_item",
+      "plural": "inventory_items"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<InventoryItem | null> {
+    const result = await this.baseFind<InventoryItem>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      ids = null,
+      limit = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<InventoryItem>> {
+    const response = await this.baseFind<InventoryItem>({
+      session: session,
+      urlIds: {},
+      params: {"ids": ids, "limit": limit, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public cost: string | null;
+  public country_code_of_origin: string | null;
+  public country_harmonized_system_codes: {[key: string]: unknown}[] | null;
+  public created_at: string | null;
+  public harmonized_system_code: number | null;
+  public id: string | null;
+  public province_code_of_origin: string | null;
+  public requires_shipping: boolean | null;
+  public sku: string | null;
+  public tracked: boolean | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,173 @@
+/***********************************************************************************************************************
+* 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;
+  inventory_item_id?: unknown;
+  location_id?: unknown;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  inventory_item_ids?: unknown;
+  location_ids?: unknown;
+  limit?: unknown;
+  updated_at_min?: unknown;
+}
+interface AdjustArgs {
+  [key: string]: unknown;
+  inventory_item_id?: unknown;
+  location_id?: unknown;
+  available_adjustment?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface ConnectArgs {
+  [key: string]: unknown;
+  inventory_item_id?: unknown;
+  location_id?: unknown;
+  relocate_if_necessary?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+interface SetArgs {
+  [key: string]: unknown;
+  inventory_item_id?: unknown;
+  location_id?: unknown;
+  available?: unknown;
+  disconnect_if_necessary?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class InventoryLevel 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": [], "path": "inventory_levels.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "inventory_levels.json"},
+    {"http_method": "post", "operation": "adjust", "ids": [], "path": "inventory_levels/adjust.json"},
+    {"http_method": "post", "operation": "connect", "ids": [], "path": "inventory_levels/connect.json"},
+    {"http_method": "post", "operation": "set", "ids": [], "path": "inventory_levels/set.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "inventory_level",
+      "plural": "inventory_levels"
+    }
+  ];
+
+  public static async delete(
+    {
+      session,
+      inventory_item_id = null,
+      location_id = null
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<InventoryLevel>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {},
+      params: {"inventory_item_id": inventory_item_id, "location_id": location_id},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      inventory_item_ids = null,
+      location_ids = null,
+      limit = null,
+      updated_at_min = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<InventoryLevel>> {
+    const response = await this.baseFind<InventoryLevel>({
+      session: session,
+      urlIds: {},
+      params: {"inventory_item_ids": inventory_item_ids, "location_ids": location_ids, "limit": limit, "updated_at_min": updated_at_min, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public async adjust(
+    {
+      inventory_item_id = null,
+      location_id = null,
+      available_adjustment = null,
+      body = null,
+      ...otherArgs
+    }: AdjustArgs
+  ): Promise<unknown> {
+    const response = await this.request<InventoryLevel>({
+      http_method: "post",
+      operation: "adjust",
+      session: this.session,
+      urlIds: {},
+      params: {"inventory_item_id": inventory_item_id, "location_id": location_id, "available_adjustment": available_adjustment, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async connect(
+    {
+      inventory_item_id = null,
+      location_id = null,
+      relocate_if_necessary = null,
+      body = null,
+      ...otherArgs
+    }: ConnectArgs
+  ): Promise<unknown> {
+    const response = await this.request<InventoryLevel>({
+      http_method: "post",
+      operation: "connect",
+      session: this.session,
+      urlIds: {},
+      params: {"inventory_item_id": inventory_item_id, "location_id": location_id, "relocate_if_necessary": relocate_if_necessary, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async set(
+    {
+      inventory_item_id = null,
+      location_id = null,
+      available = null,
+      disconnect_if_necessary = null,
+      body = null,
+      ...otherArgs
+    }: SetArgs
+  ): Promise<unknown> {
+    const response = await this.request<InventoryLevel>({
+      http_method: "post",
+      operation: "set",
+      session: this.session,
+      urlIds: {},
+      params: {"inventory_item_id": inventory_item_id, "location_id": location_id, "available": available, "disconnect_if_necessary": disconnect_if_necessary, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public available: number | null;
+  public inventory_item_id: string | null;
+  public location_id: string | null;
+  public updated_at: string | null;
+}

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

@@ -0,0 +1,133 @@
+/***********************************************************************************************************************
+* 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;
+  limit?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+interface InventoryLevelsArgs {
+  [key: string]: unknown;
+  session: Session;
+  id: number | string;
+}
+
+export class Location 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": "locations/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "locations.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "locations/<id>.json"},
+    {"http_method": "get", "operation": "inventory_levels", "ids": ["id"], "path": "locations/<id>/inventory_levels.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "location",
+      "plural": "locations"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<Location | null> {
+    const result = await this.baseFind<Location>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Location>> {
+    const response = await this.baseFind<Location>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Location>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async inventory_levels(
+    {
+      session,
+      id,
+      ...otherArgs
+    }: InventoryLevelsArgs
+  ): Promise<unknown> {
+    const response = await this.request<Location>({
+      http_method: "get",
+      operation: "inventory_levels",
+      session: session,
+      urlIds: {"id": id},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public active: boolean | null;
+  public address1: string | null;
+  public address2: string | null;
+  public city: string | null;
+  public country: string | null;
+  public country_code: string | null;
+  public created_at: string | null;
+  public id: string | null;
+  public legacy: boolean | null;
+  public localized_country_name: string | null;
+  public localized_province_name: string | null;
+  public name: string | null;
+  public phone: string | null;
+  public province: string | null;
+  public province_code: string | null;
+  public updated_at: string | null;
+  public zip: string | null;
+}

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

@@ -0,0 +1,48 @@
+/***********************************************************************************************************************
+* 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;
+  fulfillment_order_id?: number | string | null;
+}
+
+export class LocationsForMove 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": ["fulfillment_order_id"], "path": "fulfillment_orders/<fulfillment_order_id>/locations_for_move.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "locations_for_move",
+      "plural": "locations_for_moves"
+    }
+  ];
+
+  public static async all(
+    {
+      session,
+      fulfillment_order_id = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<LocationsForMove>> {
+    const response = await this.baseFind<LocationsForMove>({
+      session: session,
+      urlIds: {"fulfillment_order_id": fulfillment_order_id},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public locations_for_move: {[key: string]: unknown}[] | null;
+}

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

@@ -0,0 +1,175 @@
+/***********************************************************************************************************************
+* 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 DeleteArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  limit?: unknown;
+  offset?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+interface EngagementsArgs {
+  [key: string]: unknown;
+  occurred_on?: unknown;
+  impressions_count?: unknown;
+  views_count?: unknown;
+  clicks_count?: unknown;
+  shares_count?: unknown;
+  favorites_count?: unknown;
+  comments_count?: unknown;
+  ad_spend?: unknown;
+  is_cumulative?: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class MarketingEvent 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": ["id"], "path": "marketing_events/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": [], "path": "marketing_events/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "marketing_events.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "marketing_events/<id>.json"},
+    {"http_method": "post", "operation": "engagements", "ids": ["id"], "path": "marketing_events/<id>/engagements.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "marketing_events.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "marketing_events/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "marketing_event",
+      "plural": "marketing_events"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<MarketingEvent | null> {
+    const result = await this.baseFind<MarketingEvent>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<MarketingEvent>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      offset = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<MarketingEvent>> {
+    const response = await this.baseFind<MarketingEvent>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "offset": offset, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<MarketingEvent>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public async engagements(
+    {
+      occurred_on = null,
+      impressions_count = null,
+      views_count = null,
+      clicks_count = null,
+      shares_count = null,
+      favorites_count = null,
+      comments_count = null,
+      ad_spend = null,
+      is_cumulative = null,
+      body = null,
+      ...otherArgs
+    }: EngagementsArgs
+  ): Promise<unknown> {
+    const response = await this.request<MarketingEvent>({
+      http_method: "post",
+      operation: "engagements",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {"occurred_on": occurred_on, "impressions_count": impressions_count, "views_count": views_count, "clicks_count": clicks_count, "shares_count": shares_count, "favorites_count": favorites_count, "comments_count": comments_count, "ad_spend": ad_spend, "is_cumulative": is_cumulative, ...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public event_type: string | null;
+  public marketing_channel: string | null;
+  public paid: boolean | null;
+  public started_at: string | null;
+  public UTM_parameters: {[key: string]: unknown} | null;
+  public budget: string | null;
+  public budget_type: string | null;
+  public currency: string | null;
+  public description: string | null;
+  public ended_at: string | null;
+  public id: string | null;
+  public manage_url: string | null;
+  public marketed_resources: {[key: string]: unknown}[] | null;
+  public preview_url: string | null;
+  public referring_domain: string | null;
+  public remote_id: string | null;
+  public scheduled_to_end_at: string | null;
+}