@shopify/shopify-api 13.0.0 → 13.1.0

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

@@ -0,0 +1,187 @@
+/***********************************************************************************************************************
+* 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 {Balance} from './balance';
+import {Currency} from './currency';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  status?: unknown;
+  limit?: unknown;
+  since_id?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  status?: unknown;
+}
+interface SearchArgs {
+  [key: string]: unknown;
+  session: Session;
+  order?: unknown;
+  query?: unknown;
+  limit?: unknown;
+  fields?: unknown;
+  created_at_min?: unknown;
+  created_at_max?: unknown;
+  updated_at_min?: unknown;
+  updated_at_max?: unknown;
+}
+interface DisableArgs {
+  [key: string]: unknown;
+  body?: {[key: string]: unknown} | null;
+}
+
+export class GiftCard extends Base {
+  public static apiVersion = ApiVersion.April26;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "balance": Balance,
+    "currency": Currency
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "count", "ids": [], "path": "gift_cards/count.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "gift_cards.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "gift_cards/<id>.json"},
+    {"http_method": "get", "operation": "search", "ids": [], "path": "gift_cards/search.json"},
+    {"http_method": "post", "operation": "disable", "ids": ["id"], "path": "gift_cards/<id>/disable.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "gift_cards.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "gift_cards/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "gift_card",
+      "plural": "gift_cards"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<GiftCard | null> {
+    const result = await this.baseFind<GiftCard>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      status = null,
+      limit = null,
+      since_id = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<GiftCard>> {
+    const response = await this.baseFind<GiftCard>({
+      session: session,
+      urlIds: {},
+      params: {"status": status, "limit": limit, "since_id": since_id, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      status = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<GiftCard>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {},
+      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,
+      created_at_min = null,
+      created_at_max = null,
+      updated_at_min = null,
+      updated_at_max = null,
+      ...otherArgs
+    }: SearchArgs
+  ): Promise<unknown> {
+    const response = await this.request<GiftCard>({
+      http_method: "get",
+      operation: "search",
+      session: session,
+      urlIds: {},
+      params: {"order": order, "query": query, "limit": limit, "fields": fields, "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 disable(
+    {
+      body = null,
+      ...otherArgs
+    }: DisableArgs
+  ): Promise<unknown> {
+    const response = await this.request<GiftCard>({
+      http_method: "post",
+      operation: "disable",
+      session: this.session,
+      urlIds: {"id": this.id},
+      params: {...otherArgs},
+      body: body,
+      entity: this,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public api_client_id: string | null;
+  public balance: Balance | null | {[key: string]: any};
+  public code: string | null;
+  public created_at: string | null;
+  public currency: Currency | null | {[key: string]: any};
+  public customer_id: string | null;
+  public disabled_at: string | null;
+  public expires_on: string | null;
+  public id: string | null;
+  public initial_value: string | null;
+  public last_characters: string | null;
+  public line_item_id: string | null;
+  public note: string | null;
+  public order_id: string | null;
+  public template_suffix: string | null;
+  public updated_at: string | null;
+  public user_id: string | null;
+}

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

@@ -0,0 +1,86 @@
+/***********************************************************************************************************************
+* 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;
+  gift_card_id?: number | string | null;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  gift_card_id?: number | string | null;
+}
+
+export class GiftCardAdjustment 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": ["gift_card_id"], "path": "gift_cards/<gift_card_id>/adjustments.json"},
+    {"http_method": "get", "operation": "get", "ids": ["gift_card_id", "id"], "path": "gift_cards/<gift_card_id>/adjustments/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": ["gift_card_id"], "path": "gift_cards/<gift_card_id>/adjustments.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "gift_card_adjustment",
+      "plural": "gift_card_adjustments"
+    }
+  ];
+
+  protected static getJsonBodyName(): string
+  {
+    return "adjustment";
+  }
+
+  public static async find(
+    {
+      session,
+      id,
+      gift_card_id = null
+    }: FindArgs
+  ): Promise<GiftCardAdjustment | null> {
+    const result = await this.baseFind<GiftCardAdjustment>({
+      session: session,
+      urlIds: {"id": id, "gift_card_id": gift_card_id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      gift_card_id = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<GiftCardAdjustment>> {
+    const response = await this.baseFind<GiftCardAdjustment>({
+      session: session,
+      urlIds: {"gift_card_id": gift_card_id},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public amount: number | null;
+  public api_client_id: string | null;
+  public created_at: string | null;
+  public gift_card_id: string | null;
+  public id: string | null;
+  public note: string | null;
+  public number: number | null;
+  public order_transaction_id: string | null;
+  public processed_at: string | null;
+  public remote_transaction_ref: string | null;
+  public remote_transaction_url: string | null;
+  public user_id: string | null;
+}

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

@@ -0,0 +1,137 @@
+/***********************************************************************************************************************
+* 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;
+  product_id?: number | string | null;
+  fields?: unknown;
+}
+interface DeleteArgs {
+  session: Session;
+  id: number | string;
+  product_id?: number | string | null;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  product_id?: number | string | null;
+  since_id?: unknown;
+  fields?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  product_id?: number | string | null;
+  since_id?: unknown;
+}
+
+export class Image 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": ["product_id", "id"], "path": "products/<product_id>/images/<id>.json"},
+    {"http_method": "get", "operation": "count", "ids": ["product_id"], "path": "products/<product_id>/images/count.json"},
+    {"http_method": "get", "operation": "get", "ids": ["product_id"], "path": "products/<product_id>/images.json"},
+    {"http_method": "get", "operation": "get", "ids": ["product_id", "id"], "path": "products/<product_id>/images/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": ["product_id"], "path": "products/<product_id>/images.json"},
+    {"http_method": "put", "operation": "put", "ids": ["product_id", "id"], "path": "products/<product_id>/images/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "image",
+      "plural": "images"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      product_id = null,
+      fields = null
+    }: FindArgs
+  ): Promise<Image | null> {
+    const result = await this.baseFind<Image>({
+      session: session,
+      urlIds: {"id": id, "product_id": product_id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async delete(
+    {
+      session,
+      id,
+      product_id = null
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<Image>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id, "product_id": product_id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      product_id = null,
+      since_id = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Image>> {
+    const response = await this.baseFind<Image>({
+      session: session,
+      urlIds: {"product_id": product_id},
+      params: {"since_id": since_id, "fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      product_id = null,
+      since_id = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Image>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {"product_id": product_id},
+      params: {"since_id": since_id, ...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public created_at: string | null;
+  public height: number | null;
+  public id: string | null;
+  public position: number | null;
+  public product_id: string | null;
+  public src: string | null;
+  public updated_at: string | null;
+  public variant_ids: string[] | null;
+  public width: number | null;
+}

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

@@ -0,0 +1,228 @@
+/***********************************************************************************************************************
+* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *
+***********************************************************************************************************************/
+
+import {ShopifyRestResources} from '../../types';
+
+import {AbandonedCheckout} from './abandoned_checkout';
+import {AccessScope} from './access_scope';
+import {ApplePayCertificate} from './apple_pay_certificate';
+import {ApplicationCharge} from './application_charge';
+import {ApplicationCredit} from './application_credit';
+import {Article} from './article';
+import {Asset} from './asset';
+import {AssignedFulfillmentOrder} from './assigned_fulfillment_order';
+import {Balance} from './balance';
+import {Blog} from './blog';
+import {CancellationRequest} from './cancellation_request';
+import {CarrierService} from './carrier_service';
+import {Checkout} from './checkout';
+import {Collect} from './collect';
+import {Collection} from './collection';
+import {CollectionListing} from './collection_listing';
+import {Comment} from './comment';
+import {Country} from './country';
+import {Currency} from './currency';
+import {CustomCollection} from './custom_collection';
+import {Customer} from './customer';
+import {DeprecatedApiCall} from './deprecated_api_call';
+import {DiscountCode} from './discount_code';
+import {Dispute} from './dispute';
+import {DisputeEvidence} from './dispute_evidence';
+import {DisputeFileUpload} from './dispute_file_upload';
+import {DraftOrder} from './draft_order';
+import {Event} from './event';
+import {Fulfillment} from './fulfillment';
+import {FulfillmentEvent} from './fulfillment_event';
+import {FulfillmentOrder} from './fulfillment_order';
+import {FulfillmentRequest} from './fulfillment_request';
+import {FulfillmentService} from './fulfillment_service';
+import {GiftCard} from './gift_card';
+import {GiftCardAdjustment} from './gift_card_adjustment';
+import {Image} from './image';
+import {InventoryItem} from './inventory_item';
+import {InventoryLevel} from './inventory_level';
+import {Location} from './location';
+import {LocationsForMove} from './locations_for_move';
+import {MarketingEvent} from './marketing_event';
+import {Metafield} from './metafield';
+import {MobilePlatformApplication} from './mobile_platform_application';
+import {Order} from './order';
+import {OrderRisk} from './order_risk';
+import {Page} from './page';
+import {Payment} from './payment';
+import {PaymentGateway} from './payment_gateway';
+import {PaymentTransaction} from './payment_transaction';
+import {Payout} from './payout';
+import {Policy} from './policy';
+import {PriceRule} from './price_rule';
+import {Product} from './product';
+import {ProductListing} from './product_listing';
+import {ProductResourceFeedback} from './product_resource_feedback';
+import {Province} from './province';
+import {RecurringApplicationCharge} from './recurring_application_charge';
+import {Redirect} from './redirect';
+import {Refund} from './refund';
+import {ResourceFeedback} from './resource_feedback';
+import {ScriptTag} from './script_tag';
+import {ShippingZone} from './shipping_zone';
+import {Shop} from './shop';
+import {SmartCollection} from './smart_collection';
+import {StorefrontAccessToken} from './storefront_access_token';
+import {TenderTransaction} from './tender_transaction';
+import {Theme} from './theme';
+import {Transaction} from './transaction';
+import {UsageCharge} from './usage_charge';
+import {User} from './user';
+import {Variant} from './variant';
+import {Webhook} from './webhook';
+
+export interface RestResources extends ShopifyRestResources {
+  AbandonedCheckout: typeof AbandonedCheckout;
+  AccessScope: typeof AccessScope;
+  ApplePayCertificate: typeof ApplePayCertificate;
+  ApplicationCharge: typeof ApplicationCharge;
+  ApplicationCredit: typeof ApplicationCredit;
+  Article: typeof Article;
+  Asset: typeof Asset;
+  AssignedFulfillmentOrder: typeof AssignedFulfillmentOrder;
+  Balance: typeof Balance;
+  Blog: typeof Blog;
+  CancellationRequest: typeof CancellationRequest;
+  CarrierService: typeof CarrierService;
+  Checkout: typeof Checkout;
+  Collect: typeof Collect;
+  Collection: typeof Collection;
+  CollectionListing: typeof CollectionListing;
+  Comment: typeof Comment;
+  Country: typeof Country;
+  Currency: typeof Currency;
+  CustomCollection: typeof CustomCollection;
+  Customer: typeof Customer;
+  DeprecatedApiCall: typeof DeprecatedApiCall;
+  DiscountCode: typeof DiscountCode;
+  Dispute: typeof Dispute;
+  DisputeEvidence: typeof DisputeEvidence;
+  DisputeFileUpload: typeof DisputeFileUpload;
+  DraftOrder: typeof DraftOrder;
+  Event: typeof Event;
+  Fulfillment: typeof Fulfillment;
+  FulfillmentEvent: typeof FulfillmentEvent;
+  FulfillmentOrder: typeof FulfillmentOrder;
+  FulfillmentRequest: typeof FulfillmentRequest;
+  FulfillmentService: typeof FulfillmentService;
+  GiftCard: typeof GiftCard;
+  GiftCardAdjustment: typeof GiftCardAdjustment;
+  Image: typeof Image;
+  InventoryItem: typeof InventoryItem;
+  InventoryLevel: typeof InventoryLevel;
+  Location: typeof Location;
+  LocationsForMove: typeof LocationsForMove;
+  MarketingEvent: typeof MarketingEvent;
+  Metafield: typeof Metafield;
+  MobilePlatformApplication: typeof MobilePlatformApplication;
+  Order: typeof Order;
+  OrderRisk: typeof OrderRisk;
+  Page: typeof Page;
+  Payment: typeof Payment;
+  PaymentGateway: typeof PaymentGateway;
+  PaymentTransaction: typeof PaymentTransaction;
+  Payout: typeof Payout;
+  Policy: typeof Policy;
+  PriceRule: typeof PriceRule;
+  Product: typeof Product;
+  ProductListing: typeof ProductListing;
+  ProductResourceFeedback: typeof ProductResourceFeedback;
+  Province: typeof Province;
+  RecurringApplicationCharge: typeof RecurringApplicationCharge;
+  Redirect: typeof Redirect;
+  Refund: typeof Refund;
+  ResourceFeedback: typeof ResourceFeedback;
+  ScriptTag: typeof ScriptTag;
+  ShippingZone: typeof ShippingZone;
+  Shop: typeof Shop;
+  SmartCollection: typeof SmartCollection;
+  StorefrontAccessToken: typeof StorefrontAccessToken;
+  TenderTransaction: typeof TenderTransaction;
+  Theme: typeof Theme;
+  Transaction: typeof Transaction;
+  UsageCharge: typeof UsageCharge;
+  User: typeof User;
+  Variant: typeof Variant;
+  Webhook: typeof Webhook;
+}
+
+export const restResources: RestResources = {
+  AbandonedCheckout,
+  AccessScope,
+  ApplePayCertificate,
+  ApplicationCharge,
+  ApplicationCredit,
+  Article,
+  Asset,
+  AssignedFulfillmentOrder,
+  Balance,
+  Blog,
+  CancellationRequest,
+  CarrierService,
+  Checkout,
+  Collect,
+  Collection,
+  CollectionListing,
+  Comment,
+  Country,
+  Currency,
+  CustomCollection,
+  Customer,
+  DeprecatedApiCall,
+  DiscountCode,
+  Dispute,
+  DisputeEvidence,
+  DisputeFileUpload,
+  DraftOrder,
+  Event,
+  Fulfillment,
+  FulfillmentEvent,
+  FulfillmentOrder,
+  FulfillmentRequest,
+  FulfillmentService,
+  GiftCard,
+  GiftCardAdjustment,
+  Image,
+  InventoryItem,
+  InventoryLevel,
+  Location,
+  LocationsForMove,
+  MarketingEvent,
+  Metafield,
+  MobilePlatformApplication,
+  Order,
+  OrderRisk,
+  Page,
+  Payment,
+  PaymentGateway,
+  PaymentTransaction,
+  Payout,
+  Policy,
+  PriceRule,
+  Product,
+  ProductListing,
+  ProductResourceFeedback,
+  Province,
+  RecurringApplicationCharge,
+  Redirect,
+  Refund,
+  ResourceFeedback,
+  ScriptTag,
+  ShippingZone,
+  Shop,
+  SmartCollection,
+  StorefrontAccessToken,
+  TenderTransaction,
+  Theme,
+  Transaction,
+  UsageCharge,
+  User,
+  Variant,
+  Webhook,
+};