@shopify/shopify-api 12.3.0 → 13.0.0

package/rest/admin/2025-04/storefront_access_token.ts

@@ -0,0 +1,73 @@
+/***********************************************************************************************************************
+* 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;
+  id: number | string;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+
+export class StorefrontAccessToken extends Base {
+  public static apiVersion = ApiVersion.April25;
+
+  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": "storefront_access_tokens/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "storefront_access_tokens.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "storefront_access_tokens.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "storefront_access_token",
+      "plural": "storefront_access_tokens"
+    }
+  ];
+
+  public static async delete(
+    {
+      session,
+      id
+    }: DeleteArgs
+  ): Promise<unknown> {
+    const response = await this.request<StorefrontAccessToken>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<StorefrontAccessToken>> {
+    const response = await this.baseFind<StorefrontAccessToken>({
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+    });
+
+    return response;
+  }
+
+  public title: string | null;
+  public access_scope: string | null;
+  public access_token: string | null;
+  public created_at: string | null;
+  public id: string | null;
+}

package/rest/admin/2025-04/tender_transaction.ts

@@ -0,0 +1,67 @@
+/***********************************************************************************************************************
+* 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;
+  limit?: unknown;
+  since_id?: unknown;
+  processed_at_min?: unknown;
+  processed_at_max?: unknown;
+  processed_at?: unknown;
+  order?: unknown;
+}
+
+export class TenderTransaction extends Base {
+  public static apiVersion = ApiVersion.April25;
+
+  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": "tender_transactions.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "tender_transaction",
+      "plural": "tender_transactions"
+    }
+  ];
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      since_id = null,
+      processed_at_min = null,
+      processed_at_max = null,
+      processed_at = null,
+      order = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<TenderTransaction>> {
+    const response = await this.baseFind<TenderTransaction>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "since_id": since_id, "processed_at_min": processed_at_min, "processed_at_max": processed_at_max, "processed_at": processed_at, "order": order, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public amount: string | null;
+  public currency: string | null;
+  public id: string | null;
+  public order_id: string | null;
+  public payment_details: {[key: string]: unknown} | null;
+  public payment_method: string | null;
+  public processed_at: string | null;
+  public remote_reference: string | null;
+  public test: boolean | null;
+  public user_id: string | null;
+}

package/rest/admin/2025-04/theme.ts

@@ -0,0 +1,101 @@
+/***********************************************************************************************************************
+* 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;
+  fields?: unknown;
+}
+
+export class Theme extends Base {
+  public static apiVersion = ApiVersion.April25;
+
+  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": "themes/<id>.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "themes.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "themes/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": [], "path": "themes.json"},
+    {"http_method": "put", "operation": "put", "ids": ["id"], "path": "themes/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "theme",
+      "plural": "themes"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      fields = null
+    }: FindArgs
+  ): Promise<Theme | null> {
+    const result = await this.baseFind<Theme>({
+      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<Theme>({
+      http_method: "delete",
+      operation: "delete",
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+
+    return response ? response.body : null;
+  }
+
+  public static async all(
+    {
+      session,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Theme>> {
+    const response = await this.baseFind<Theme>({
+      session: session,
+      urlIds: {},
+      params: {"fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public created_at: string | null;
+  public id: string | null;
+  public name: string | null;
+  public previewable: boolean | null;
+  public processing: boolean | null;
+  public role: string | null;
+  public src: string | null;
+  public theme_store_id: string | null;
+  public updated_at: string | null;
+}

package/rest/admin/2025-04/transaction.ts

@@ -0,0 +1,132 @@
+/***********************************************************************************************************************
+* 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;
+  in_shop_currency?: unknown;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  order_id?: number | string | null;
+  since_id?: unknown;
+  fields?: unknown;
+  in_shop_currency?: unknown;
+}
+interface CountArgs {
+  [key: string]: unknown;
+  session: Session;
+  order_id?: number | string | null;
+}
+
+export class Transaction extends Base {
+  public static apiVersion = ApiVersion.April25;
+
+  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>/transactions/count.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id"], "path": "orders/<order_id>/transactions.json"},
+    {"http_method": "get", "operation": "get", "ids": ["order_id", "id"], "path": "orders/<order_id>/transactions/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": ["order_id"], "path": "orders/<order_id>/transactions.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "transaction",
+      "plural": "transactions"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      order_id = null,
+      fields = null,
+      in_shop_currency = null
+    }: FindArgs
+  ): Promise<Transaction | null> {
+    const result = await this.baseFind<Transaction>({
+      session: session,
+      urlIds: {"id": id, "order_id": order_id},
+      params: {"fields": fields, "in_shop_currency": in_shop_currency},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      order_id = null,
+      since_id = null,
+      fields = null,
+      in_shop_currency = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<Transaction>> {
+    const response = await this.baseFind<Transaction>({
+      session: session,
+      urlIds: {"order_id": order_id},
+      params: {"since_id": since_id, "fields": fields, "in_shop_currency": in_shop_currency, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async count(
+    {
+      session,
+      order_id = null,
+      ...otherArgs
+    }: CountArgs
+  ): Promise<unknown> {
+    const response = await this.request<Transaction>({
+      http_method: "get",
+      operation: "count",
+      session: session,
+      urlIds: {"order_id": order_id},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public kind: string | null;
+  public amount: string | null;
+  public amount_rounding: string | null;
+  public authorization: string | null;
+  public authorization_expires_at: string | null;
+  public created_at: string | null;
+  public currency: string | null;
+  public currency_exchange_adjustment: {[key: string]: unknown} | null;
+  public device_id: string | null;
+  public error_code: string | null;
+  public extended_authorization_attributes: {[key: string]: unknown} | null;
+  public gateway: string | null;
+  public id: string | null;
+  public location_id: string | null;
+  public manual_payment_gateway: boolean | null;
+  public message: string | null;
+  public order_id: string | null;
+  public parent_id: string | null;
+  public payment_details: {[key: string]: unknown} | null;
+  public payments_refund_attributes: {[key: string]: unknown} | null;
+  public processed_at: string | null;
+  public receipt: {[key: string]: unknown} | null;
+  public source_name: string | null;
+  public status: string | null;
+  public test: boolean | null;
+  public total_unsettled_set: {[key: string]: unknown} | null;
+  public user_id: string | null;
+}

package/rest/admin/2025-04/usage_charge.ts

@@ -0,0 +1,84 @@
+/***********************************************************************************************************************
+* 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 {Currency} from './currency';
+
+interface FindArgs {
+  session: Session;
+  id: number | string;
+  recurring_application_charge_id?: number | string | null;
+  fields?: unknown;
+}
+interface AllArgs {
+  [key: string]: unknown;
+  session: Session;
+  recurring_application_charge_id?: number | string | null;
+  fields?: unknown;
+}
+
+export class UsageCharge extends Base {
+  public static apiVersion = ApiVersion.April25;
+
+  protected static hasOne: {[key: string]: typeof Base} = {
+    "currency": Currency
+  };
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "get", "ids": ["recurring_application_charge_id"], "path": "recurring_application_charges/<recurring_application_charge_id>/usage_charges.json"},
+    {"http_method": "get", "operation": "get", "ids": ["recurring_application_charge_id", "id"], "path": "recurring_application_charges/<recurring_application_charge_id>/usage_charges/<id>.json"},
+    {"http_method": "post", "operation": "post", "ids": ["recurring_application_charge_id"], "path": "recurring_application_charges/<recurring_application_charge_id>/usage_charges.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "usage_charge",
+      "plural": "usage_charges"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id,
+      recurring_application_charge_id = null,
+      fields = null
+    }: FindArgs
+  ): Promise<UsageCharge | null> {
+    const result = await this.baseFind<UsageCharge>({
+      session: session,
+      urlIds: {"id": id, "recurring_application_charge_id": recurring_application_charge_id},
+      params: {"fields": fields},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      recurring_application_charge_id = null,
+      fields = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<UsageCharge>> {
+    const response = await this.baseFind<UsageCharge>({
+      session: session,
+      urlIds: {"recurring_application_charge_id": recurring_application_charge_id},
+      params: {"fields": fields, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public created_at: string | null;
+  public currency: Currency | null | {[key: string]: any};
+  public description: string | null;
+  public id: string | null;
+  public price: string | null;
+  public recurring_application_charge_id: string | null;
+  public updated_at: string | null;
+}

package/rest/admin/2025-04/user.ts

@@ -0,0 +1,106 @@
+/***********************************************************************************************************************
+* 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;
+  page_info?: unknown;
+}
+interface CurrentArgs {
+  [key: string]: unknown;
+  session: Session;
+}
+
+export class User extends Base {
+  public static apiVersion = ApiVersion.April25;
+
+  protected static hasOne: {[key: string]: typeof Base} = {};
+  protected static hasMany: {[key: string]: typeof Base} = {};
+  protected static paths: ResourcePath[] = [
+    {"http_method": "get", "operation": "current", "ids": [], "path": "users/current.json"},
+    {"http_method": "get", "operation": "get", "ids": [], "path": "users.json"},
+    {"http_method": "get", "operation": "get", "ids": ["id"], "path": "users/<id>.json"}
+  ];
+  protected static resourceNames: ResourceNames[] = [
+    {
+      "singular": "user",
+      "plural": "users"
+    }
+  ];
+
+  public static async find(
+    {
+      session,
+      id
+    }: FindArgs
+  ): Promise<User | null> {
+    const result = await this.baseFind<User>({
+      session: session,
+      urlIds: {"id": id},
+      params: {},
+    });
+    return result.data ? result.data[0] : null;
+  }
+
+  public static async all(
+    {
+      session,
+      limit = null,
+      page_info = null,
+      ...otherArgs
+    }: AllArgs
+  ): Promise<FindAllResponse<User>> {
+    const response = await this.baseFind<User>({
+      session: session,
+      urlIds: {},
+      params: {"limit": limit, "page_info": page_info, ...otherArgs},
+    });
+
+    return response;
+  }
+
+  public static async current(
+    {
+      session,
+      ...otherArgs
+    }: CurrentArgs
+  ): Promise<unknown> {
+    const response = await this.request<User>({
+      http_method: "get",
+      operation: "current",
+      session: session,
+      urlIds: {},
+      params: {...otherArgs},
+      body: {},
+      entity: null,
+    });
+
+    return response ? response.body : null;
+  }
+
+  public account_owner: boolean | null;
+  public bio: string | null;
+  public email: string | null;
+  public first_name: string | null;
+  public id: string | null;
+  public im: string | null;
+  public last_name: string | null;
+  public locale: string | null;
+  public permissions: string[] | null;
+  public phone: string | null;
+  public receive_announcements: number | null;
+  public screen_name: string | null;
+  public url: string | null;
+  public user_type: string | null;
+}