@tailor-platform/shopify

interface AdminApiClientConfig { storeDomain: string; apiVersion: string; accessToken: string; } interface GraphQLError { message: string; extensions?: Record<string, unknown>; path?: (string | number)[]; locations?: { line: number; column: number; }[]; } interface GraphQLResponse<TData = unknown> { data?: TData; errors?: GraphQLError[]; extensions?: { cost?: { requestedQueryCost: number; actualQueryCost: number; throttleStatus: { maximumAvailable: number; currentlyAvailable: number; restoreRate: number; }; }; [key: string]: unknown; }; } interface AdminApiClientRequestOptions<TVariables = Record<string, unknown>> { variables?: TVariables; headers?: Record<string, string>; } interface AdminApiClient { request: <TData = unknown, TVariables = Record<string, unknown>>(operation: string | TypedGraphQLDocument<TData, TVariables>, options?: AdminApiClientRequestOptions<TVariables>) => Promise<GraphQLResponse<TData>>; } /** * Type-safe GraphQL document type * @template TData - The expected response data type * @template TVariables - The expected variables type */ interface TypedGraphQLDocument<TData = unknown, TVariables = Record<string, unknown>> { readonly query: string; readonly __types?: { data: TData; variables: TVariables; }; } /** * Type helper for GraphQL operations with typed variables and responses. * * @template TData - The expected response data type * @template TVariables - The expected variables type * * @example * const query = gql<ProductData, ProductVariables>` * query GetProduct($id: ID!) { * product(id: $id) { * id * title * } * } * `; * * // Then use with client.request: * const { data } = await client.request(query, { variables }); * // TypeScript will infer ProductData and ProductVariables from the query */ declare function gql<TData = unknown, TVariables = Record<string, unknown>>(strings: TemplateStringsArray, ...values: unknown[]): TypedGraphQLDocument<TData, TVariables>; declare function createAdminApiClient(config: AdminApiClientConfig): AdminApiClient; declare class ShopifyApiError extends Error { errors: unknown[] | undefined; extensions: unknown; constructor(message: string, errors?: unknown[], extensions?: unknown); } declare class NetworkError extends Error { statusCode: number | undefined; response: Response | undefined; constructor(message: string, statusCode?: number, response?: Response); } declare class ConfigurationError extends Error { constructor(message: string); } /** * Available Shopify API versions * @see https://shopify.dev/docs/api/usage/versioning * * Note: Shopify releases new API versions quarterly (January, April, July, October) * Each stable version is supported for a minimum of 12 months. * Versions older than 2023-10 may no longer be supported. */ declare const ApiVersion: { readonly October25: "2025-10"; readonly July25: "2025-07"; readonly April25: "2025-04"; readonly January25: "2025-01"; readonly October24: "2024-10"; readonly July24: "2024-07"; readonly April24: "2024-04"; readonly January24: "2024-01"; readonly October23: "2023-10"; readonly Unstable: "unstable"; }; type ApiVersionValue = (typeof ApiVersion)[keyof typeof ApiVersion]; /** * Latest stable API version */ declare const LATEST_API_VERSION: "2025-10"; /** * API version aliases for convenience */ declare const API_VERSION_ALIASES: { readonly October25: "2025-10"; readonly July25: "2025-07"; readonly April25: "2025-04"; readonly January25: "2025-01"; readonly October24: "2024-10"; readonly July24: "2024-07"; readonly April24: "2024-04"; readonly January24: "2024-01"; readonly October23: "2023-10"; readonly Unstable: "unstable"; readonly latest: "2025-10"; }; type ApiVersionAlias = (typeof API_VERSION_ALIASES)[keyof typeof API_VERSION_ALIASES]; declare const API_VERSIONS: { readonly October25: "2025-10"; readonly July25: "2025-07"; readonly April25: "2025-04"; readonly January25: "2025-01"; readonly October24: "2024-10"; readonly July24: "2024-07"; readonly April24: "2024-04"; readonly January24: "2024-01"; readonly October23: "2023-10"; readonly Unstable: "unstable"; }; /** * Webhook topic constants mapping GraphQL enum values to event names * Generated from Shopify WebhookSubscriptionTopic enum (2025-10 API version) * @see https://shopify.dev/docs/api/admin-graphql/2025-10/enums/WebhookSubscriptionTopic */ declare const WebhookTopic: { readonly APP_PURCHASES_ONE_TIME_UPDATE: "app_purchases_one_time/update"; readonly APP_SCOPES_UPDATE: "app/scopes_update"; readonly APP_SUBSCRIPTIONS_APPROACHING_CAPPED_AMOUNT: "app_subscriptions/approaching_capped_amount"; readonly APP_SUBSCRIPTIONS_UPDATE: "app_subscriptions/update"; readonly APP_UNINSTALLED: "app/uninstalled"; readonly AUDIT_EVENTS_ADMIN_API_ACTIVITY: "audit_events/admin_api_activity"; readonly BULK_OPERATIONS_FINISH: "bulk_operations/finish"; readonly CARTS_CREATE: "carts/create"; readonly CARTS_UPDATE: "carts/update"; readonly CHANNELS_DELETE: "channels/delete"; readonly CHECKOUTS_CREATE: "checkouts/create"; readonly CHECKOUTS_DELETE: "checkouts/delete"; readonly CHECKOUTS_UPDATE: "checkouts/update"; readonly COLLECTION_LISTINGS_ADD: "collection_listings/add"; readonly COLLECTION_LISTINGS_REMOVE: "collection_listings/remove"; readonly COLLECTION_LISTINGS_UPDATE: "collection_listings/update"; readonly COLLECTION_PUBLICATIONS_CREATE: "collection_publications/create"; readonly COLLECTION_PUBLICATIONS_DELETE: "collection_publications/delete"; readonly COLLECTION_PUBLICATIONS_UPDATE: "collection_publications/update"; readonly COLLECTIONS_CREATE: "collections/create"; readonly COLLECTIONS_DELETE: "collections/delete"; readonly COLLECTIONS_UPDATE: "collections/update"; readonly COMPANIES_CREATE: "companies/create"; readonly COMPANIES_DELETE: "companies/delete"; readonly COMPANIES_UPDATE: "companies/update"; readonly COMPANY_CONTACT_ROLES_ASSIGN: "company_contact_roles/assign"; readonly COMPANY_CONTACT_ROLES_REVOKE: "company_contact_roles/revoke"; readonly COMPANY_CONTACTS_CREATE: "company_contacts/create"; readonly COMPANY_CONTACTS_DELETE: "company_contacts/delete"; readonly COMPANY_CONTACTS_UPDATE: "company_contacts/update"; readonly COMPANY_LOCATIONS_CREATE: "company_locations/create"; readonly COMPANY_LOCATIONS_DELETE: "company_locations/delete"; readonly COMPANY_LOCATIONS_UPDATE: "company_locations/update"; readonly CUSTOMER_ACCOUNT_SETTINGS_UPDATE: "customer_account_settings/update"; readonly CUSTOMER_GROUPS_CREATE: "customer_groups/create"; readonly CUSTOMER_GROUPS_DELETE: "customer_groups/delete"; readonly CUSTOMER_GROUPS_UPDATE: "customer_groups/update"; readonly CUSTOMER_PAYMENT_METHODS_CREATE: "customer_payment_methods/create"; readonly CUSTOMER_PAYMENT_METHODS_REVOKE: "customer_payment_methods/revoke"; readonly CUSTOMER_PAYMENT_METHODS_UPDATE: "customer_payment_methods/update"; readonly CUSTOMER_JOINED_SEGMENT: "customer.joined_segment"; readonly CUSTOMER_LEFT_SEGMENT: "customer.left_segment"; readonly CUSTOMER_TAGS_ADDED: "customer.tags_added"; readonly CUSTOMER_TAGS_REMOVED: "customer.tags_removed"; readonly CUSTOMERS_CREATE: "customers/create"; readonly CUSTOMERS_DATA_REQUEST: "customers/data_request"; readonly CUSTOMERS_DELETE: "customers/delete"; readonly CUSTOMERS_DISABLE: "customers/disable"; readonly CUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATE: "customers_email_marketing_consent/update"; readonly CUSTOMERS_ENABLE: "customers/enable"; readonly CUSTOMERS_MARKETING_CONSENT_UPDATE: "customers_marketing_consent/update"; readonly CUSTOMERS_MERGE: "customers/merge"; readonly CUSTOMERS_PURCHASING_SUMMARY: "customers/purchasing_summary"; readonly CUSTOMERS_REDACT: "customers/redact"; readonly CUSTOMERS_UPDATE: "customers/update"; readonly DELIVERY_PROMISE_SETTINGS_UPDATE: "delivery_promise_settings/update"; readonly DISCOUNTS_CREATE: "discounts/create"; readonly DISCOUNTS_DELETE: "discounts/delete"; readonly DISCOUNTS_REDEEMCODE_ADDED: "discounts/redeemcode_added"; readonly DISCOUNTS_REDEEMCODE_REMOVED: "discounts/redeemcode_removed"; readonly DISCOUNTS_UPDATE: "discounts/update"; readonly DISPUTES_CREATE: "disputes/create"; readonly DISPUTES_UPDATE: "disputes/update"; readonly DOMAINS_CREATE: "domains/create"; readonly DOMAINS_DESTROY: "domains/destroy"; readonly DOMAINS_UPDATE: "domains/update"; readonly DRAFT_ORDERS_CREATE: "draft_orders/create"; readonly DRAFT_ORDERS_DELETE: "draft_orders/delete"; readonly DRAFT_ORDERS_UPDATE: "draft_orders/update"; readonly FINANCE_APP_STAFF_MEMBER_DELETE: "finance_app_staff_member/delete"; readonly FINANCE_APP_STAFF_MEMBER_GRANT: "finance_app_staff_member/grant"; readonly FINANCE_APP_STAFF_MEMBER_REVOKE: "finance_app_staff_member/revoke"; readonly FINANCE_APP_STAFF_MEMBER_UPDATE: "finance_app_staff_member/update"; readonly FINANCE_KYC_INFORMATION_UPDATE: "finance_kyc_information/update"; readonly FULFILLMENT_EVENTS_CREATE: "fulfillment_events/create"; readonly FULFILLMENT_EVENTS_DELETE: "fulfillment_events/delete"; readonly FULFILLMENT_HOLDS_ADDED: "fulfillment_holds/added"; readonly FULFILLMENT_HOLDS_RELEASED: "fulfillment_holds/released"; readonly FULFILLMENT_ORDERS_CANCELLATION_REQUEST_ACCEPTED: "fulfillment_orders/cancellation_request_accepted"; readonly FULFILLMENT_ORDERS_CANCELLATION_REQUEST_REJECTED: "fulfillment_orders/cancellation_request_rejected"; readonly FULFILLMENT_ORDERS_CANCELLATION_REQUEST_SUBMITTED: "fulfillment_orders/cancellation_request_submitted"; readonly FULFILLMENT_ORDERS_CANCELLED: "fulfillment_orders/cancelled"; readonly FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_ACCEPTED: "fulfillment_orders/fulfillment_request_accepted"; readonly FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_REJECTED: "fulfillment_orders/fulfillment_request_rejected"; readonly FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_SUBMITTED: "fulfillment_orders/fulfillment_request_submitted"; readonly FULFILLMENT_ORDERS_FULFILLMENT_SERVICE_FAILED_TO_COMPLETE: "fulfillment_orders/fulfillment_service_failed_to_complete"; readonly FULFILLMENT_ORDERS_HOLD_RELEASED: "fulfillment_orders/hold_released"; readonly FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_LOCAL_DELIVERY: "fulfillment_orders/line_items_prepared_for_local_delivery"; readonly FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_PICKUP: "fulfillment_orders/line_items_prepared_for_pickup"; readonly FULFILLMENT_ORDERS_MERGED: "fulfillment_orders/merged"; readonly FULFILLMENT_ORDERS_MOVED: "fulfillment_orders/moved"; readonly FULFILLMENT_ORDERS_ORDER_ROUTING_COMPLETE: "fulfillment_orders/order_routing_complete"; readonly FULFILLMENT_ORDERS_PLACED_ON_HOLD: "fulfillment_orders/placed_on_hold"; readonly FULFILLMENT_ORDERS_RESCHEDULED: "fulfillment_orders/rescheduled"; readonly FULFILLMENT_ORDERS_SCHEDULED_FULFILLMENT_ORDER_READY: "fulfillment_orders/scheduled_fulfillment_order_ready"; readonly FULFILLMENT_ORDERS_SPLIT: "fulfillment_orders/split"; readonly FULFILLMENTS_CREATE: "fulfillments/create"; readonly FULFILLMENTS_UPDATE: "fulfillments/update"; readonly INVENTORY_ITEMS_CREATE: "inventory_items/create"; readonly INVENTORY_ITEMS_DELETE: "inventory_items/delete"; readonly INVENTORY_ITEMS_UPDATE: "inventory_items/update"; readonly INVENTORY_LEVELS_CONNECT: "inventory_levels/connect"; readonly INVENTORY_LEVELS_DISCONNECT: "inventory_levels/disconnect"; readonly INVENTORY_LEVELS_UPDATE: "inventory_levels/update"; readonly INVENTORY_SHIPMENTS_ADD_ITEMS: "inventory_shipments/add_items"; readonly INVENTORY_SHIPMENTS_CREATE: "inventory_shipments/create"; readonly INVENTORY_SHIPMENTS_DELETE: "inventory_shipments/delete"; readonly INVENTORY_SHIPMENTS_MARK_IN_TRANSIT: "inventory_shipments/mark_in_transit"; readonly INVENTORY_SHIPMENTS_RECEIVE_ITEMS: "inventory_shipments/receive_items"; readonly INVENTORY_SHIPMENTS_REMOVE_ITEMS: "inventory_shipments/remove_items"; readonly INVENTORY_SHIPMENTS_UPDATE_ITEM_QUANTITIES: "inventory_shipments/update_item_quantities"; readonly INVENTORY_SHIPMENTS_UPDATE_TRACKING: "inventory_shipments/update_tracking"; readonly INVENTORY_TRANSFERS_ADD_ITEMS: "inventory_transfers/add_items"; readonly INVENTORY_TRANSFERS_CANCEL: "inventory_transfers/cancel"; readonly INVENTORY_TRANSFERS_COMPLETE: "inventory_transfers/complete"; readonly INVENTORY_TRANSFERS_READY_TO_SHIP: "inventory_transfers/ready_to_ship"; readonly INVENTORY_TRANSFERS_REMOVE_ITEMS: "inventory_transfers/remove_items"; readonly INVENTORY_TRANSFERS_UPDATE_ITEM_QUANTITIES: "inventory_transfers/update_item_quantities"; readonly LOCALES_CREATE: "locales/create"; readonly LOCALES_DESTROY: "locales/destroy"; readonly LOCALES_UPDATE: "locales/update"; readonly LOCATIONS_ACTIVATE: "locations/activate"; readonly LOCATIONS_CREATE: "locations/create"; readonly LOCATIONS_DEACTIVATE: "locations/deactivate"; readonly LOCATIONS_DELETE: "locations/delete"; readonly LOCATIONS_UPDATE: "locations/update"; readonly MARKETS_BACKUP_REGION_UPDATE: "markets_backup_region/update"; readonly MARKETS_CREATE: "markets/create"; readonly MARKETS_DELETE: "markets/delete"; readonly MARKETS_UPDATE: "markets/update"; readonly METAFIELD_DEFINITIONS_CREATE: "metafield_definitions/create"; readonly METAFIELD_DEFINITIONS_DELETE: "metafield_definitions/delete"; readonly METAFIELD_DEFINITIONS_UPDATE: "metafield_definitions/update"; readonly METAOBJECTS_CREATE: "metaobjects/create"; readonly METAOBJECTS_DELETE: "metaobjects/delete"; readonly METAOBJECTS_UPDATE: "metaobjects/update"; readonly ORDER_TRANSACTIONS_CREATE: "order_transactions/create"; readonly ORDERS_CANCELLED: "orders/cancelled"; readonly ORDERS_CREATE: "orders/create"; readonly ORDERS_DELETE: "orders/delete"; readonly ORDERS_EDITED: "orders/edited"; readonly ORDERS_FULFILLED: "orders/fulfilled"; readonly ORDERS_PAID: "orders/paid"; readonly ORDERS_PARTIALLY_FULFILLED: "orders/partially_fulfilled"; readonly ORDERS_RISK_ASSESSMENT_CHANGED: "orders/risk_assessment_changed"; readonly ORDERS_SHOPIFY_PROTECT_ELIGIBILITY_CHANGED: "orders/shopify_protect_eligibility_changed"; readonly ORDERS_UPDATED: "orders/updated"; readonly PAYMENT_SCHEDULES_DUE: "payment_schedules/due"; readonly PAYMENT_TERMS_CREATE: "payment_terms/create"; readonly PAYMENT_TERMS_DELETE: "payment_terms/delete"; readonly PAYMENT_TERMS_UPDATE: "payment_terms/update"; readonly PRODUCT_FEEDS_CREATE: "product_feeds/create"; readonly PRODUCT_FEEDS_FULL_SYNC: "product_feeds/full_sync"; readonly PRODUCT_FEEDS_FULL_SYNC_FINISH: "product_feeds/full_sync_finish"; readonly PRODUCT_FEEDS_INCREMENTAL_SYNC: "product_feeds/incremental_sync"; readonly PRODUCT_FEEDS_UPDATE: "product_feeds/update"; readonly PRODUCT_LISTINGS_ADD: "product_listings/add"; readonly PRODUCT_LISTINGS_REMOVE: "product_listings/remove"; readonly PRODUCT_LISTINGS_UPDATE: "product_listings/update"; readonly PRODUCT_PUBLICATIONS_CREATE: "product_publications/create"; readonly PRODUCT_PUBLICATIONS_DELETE: "product_publications/delete"; readonly PRODUCT_PUBLICATIONS_UPDATE: "product_publications/update"; readonly PRODUCTS_CREATE: "products/create"; readonly PRODUCTS_DELETE: "products/delete"; readonly PRODUCTS_UPDATE: "products/update"; readonly PROFILES_CREATE: "profiles/create"; readonly PROFILES_DELETE: "profiles/delete"; readonly PROFILES_UPDATE: "profiles/update"; readonly REFUNDS_CREATE: "refunds/create"; readonly RETURNS_APPROVE: "returns/approve"; readonly RETURNS_CANCEL: "returns/cancel"; readonly RETURNS_CLOSE: "returns/close"; readonly RETURNS_DECLINE: "returns/decline"; readonly RETURNS_PROCESS: "returns/process"; readonly RETURNS_REOPEN: "returns/reopen"; readonly RETURNS_REQUEST: "returns/request"; readonly RETURNS_UPDATE: "returns/update"; readonly REVERSE_DELIVERIES_ATTACH_DELIVERABLE: "reverse_deliveries/attach_deliverable"; readonly REVERSE_FULFILLMENT_ORDERS_DISPOSE: "reverse_fulfillment_orders/dispose"; readonly SCHEDULED_PRODUCT_LISTINGS_ADD: "scheduled_product_listings/add"; readonly SCHEDULED_PRODUCT_LISTINGS_REMOVE: "scheduled_product_listings/remove"; readonly SCHEDULED_PRODUCT_LISTINGS_UPDATE: "scheduled_product_listings/update"; readonly SEGMENTS_CREATE: "segments/create"; readonly SEGMENTS_DELETE: "segments/delete"; readonly SEGMENTS_UPDATE: "segments/update"; readonly SELLING_PLAN_GROUPS_CREATE: "selling_plan_groups/create"; readonly SELLING_PLAN_GROUPS_DELETE: "selling_plan_groups/delete"; readonly SELLING_PLAN_GROUPS_UPDATE: "selling_plan_groups/update"; readonly SHIPPING_ADDRESSES_CREATE: "shipping_addresses/create"; readonly SHIPPING_ADDRESSES_UPDATE: "shipping_addresses/update"; readonly SHOP_REDACT: "shop/redact"; readonly SHOP_UPDATE: "shop/update"; readonly SUBSCRIPTION_BILLING_ATTEMPTS_CHALLENGED: "subscription_billing_attempts/challenged"; readonly SUBSCRIPTION_BILLING_ATTEMPTS_FAILURE: "subscription_billing_attempts/failure"; readonly SUBSCRIPTION_BILLING_ATTEMPTS_SUCCESS: "subscription_billing_attempts/success"; readonly SUBSCRIPTION_BILLING_CYCLE_EDITS_CREATE: "subscription_billing_cycle_edits/create"; readonly SUBSCRIPTION_BILLING_CYCLE_EDITS_DELETE: "subscription_billing_cycle_edits/delete"; readonly SUBSCRIPTION_BILLING_CYCLE_EDITS_UPDATE: "subscription_billing_cycle_edits/update"; readonly SUBSCRIPTION_BILLING_CYCLES_SKIP: "subscription_billing_cycles/skip"; readonly SUBSCRIPTION_BILLING_CYCLES_UNSKIP: "subscription_billing_cycles/unskip"; readonly SUBSCRIPTION_CONTRACTS_ACTIVATE: "subscription_contracts/activate"; readonly SUBSCRIPTION_CONTRACTS_CANCEL: "subscription_contracts/cancel"; readonly SUBSCRIPTION_CONTRACTS_CREATE: "subscription_contracts/create"; readonly SUBSCRIPTION_CONTRACTS_EXPIRE: "subscription_contracts/expire"; readonly SUBSCRIPTION_CONTRACTS_FAIL: "subscription_contracts/fail"; readonly SUBSCRIPTION_CONTRACTS_PAUSE: "subscription_contracts/pause"; readonly SUBSCRIPTION_CONTRACTS_UPDATE: "subscription_contracts/update"; readonly TAX_SERVICES_CREATE: "tax_services/create"; readonly TAX_SERVICES_UPDATE: "tax_services/update"; readonly TENDER_TRANSACTIONS_CREATE: "tender_transactions/create"; readonly THEMES_CREATE: "themes/create"; readonly THEMES_DELETE: "themes/delete"; readonly THEMES_PUBLISH: "themes/publish"; readonly THEMES_UPDATE: "themes/update"; readonly VARIANTS_IN_STOCK: "variants/in_stock"; readonly VARIANTS_OUT_OF_STOCK: "variants/out_of_stock"; }; type WebhookTopicKey = keyof typeof WebhookTopic; type WebhookTopicValue = (typeof WebhookTopic)[WebhookTopicKey]; /** * Reverse mapping from event name to GraphQL enum */ declare const WebhookTopicReverse: Record<WebhookTopicValue, "APP_PURCHASES_ONE_TIME_UPDATE" | "APP_SCOPES_UPDATE" | "APP_SUBSCRIPTIONS_APPROACHING_CAPPED_AMOUNT" | "APP_SUBSCRIPTIONS_UPDATE" | "APP_UNINSTALLED" | "AUDIT_EVENTS_ADMIN_API_ACTIVITY" | "BULK_OPERATIONS_FINISH" | "CARTS_CREATE" | "CARTS_UPDATE" | "CHANNELS_DELETE" | "CHECKOUTS_CREATE" | "CHECKOUTS_DELETE" | "CHECKOUTS_UPDATE" | "COLLECTION_LISTINGS_ADD" | "COLLECTION_LISTINGS_REMOVE" | "COLLECTION_LISTINGS_UPDATE" | "COLLECTION_PUBLICATIONS_CREATE" | "COLLECTION_PUBLICATIONS_DELETE" | "COLLECTION_PUBLICATIONS_UPDATE" | "COLLECTIONS_CREATE" | "COLLECTIONS_DELETE" | "COLLECTIONS_UPDATE" | "COMPANIES_CREATE" | "COMPANIES_DELETE" | "COMPANIES_UPDATE" | "COMPANY_CONTACT_ROLES_ASSIGN" | "COMPANY_CONTACT_ROLES_REVOKE" | "COMPANY_CONTACTS_CREATE" | "COMPANY_CONTACTS_DELETE" | "COMPANY_CONTACTS_UPDATE" | "COMPANY_LOCATIONS_CREATE" | "COMPANY_LOCATIONS_DELETE" | "COMPANY_LOCATIONS_UPDATE" | "CUSTOMER_ACCOUNT_SETTINGS_UPDATE" | "CUSTOMER_GROUPS_CREATE" | "CUSTOMER_GROUPS_DELETE" | "CUSTOMER_GROUPS_UPDATE" | "CUSTOMER_PAYMENT_METHODS_CREATE" | "CUSTOMER_PAYMENT_METHODS_REVOKE" | "CUSTOMER_PAYMENT_METHODS_UPDATE" | "CUSTOMER_JOINED_SEGMENT" | "CUSTOMER_LEFT_SEGMENT" | "CUSTOMER_TAGS_ADDED" | "CUSTOMER_TAGS_REMOVED" | "CUSTOMERS_CREATE" | "CUSTOMERS_DATA_REQUEST" | "CUSTOMERS_DELETE" | "CUSTOMERS_DISABLE" | "CUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATE" | "CUSTOMERS_ENABLE" | "CUSTOMERS_MARKETING_CONSENT_UPDATE" | "CUSTOMERS_MERGE" | "CUSTOMERS_PURCHASING_SUMMARY" | "CUSTOMERS_REDACT" | "CUSTOMERS_UPDATE" | "DELIVERY_PROMISE_SETTINGS_UPDATE" | "DISCOUNTS_CREATE" | "DISCOUNTS_DELETE" | "DISCOUNTS_REDEEMCODE_ADDED" | "DISCOUNTS_REDEEMCODE_REMOVED" | "DISCOUNTS_UPDATE" | "DISPUTES_CREATE" | "DISPUTES_UPDATE" | "DOMAINS_CREATE" | "DOMAINS_DESTROY" | "DOMAINS_UPDATE" | "DRAFT_ORDERS_CREATE" | "DRAFT_ORDERS_DELETE" | "DRAFT_ORDERS_UPDATE" | "FINANCE_APP_STAFF_MEMBER_DELETE" | "FINANCE_APP_STAFF_MEMBER_GRANT" | "FINANCE_APP_STAFF_MEMBER_REVOKE" | "FINANCE_APP_STAFF_MEMBER_UPDATE" | "FINANCE_KYC_INFORMATION_UPDATE" | "FULFILLMENT_EVENTS_CREATE" | "FULFILLMENT_EVENTS_DELETE" | "FULFILLMENT_HOLDS_ADDED" | "FULFILLMENT_HOLDS_RELEASED" | "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_ACCEPTED" | "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_REJECTED" | "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_SUBMITTED" | "FULFILLMENT_ORDERS_CANCELLED" | "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_ACCEPTED" | "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_REJECTED" | "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_SUBMITTED" | "FULFILLMENT_ORDERS_FULFILLMENT_SERVICE_FAILED_TO_COMPLETE" | "FULFILLMENT_ORDERS_HOLD_RELEASED" | "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_LOCAL_DELIVERY" | "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_PICKUP" | "FULFILLMENT_ORDERS_MERGED" | "FULFILLMENT_ORDERS_MOVED" | "FULFILLMENT_ORDERS_ORDER_ROUTING_COMPLETE" | "FULFILLMENT_ORDERS_PLACED_ON_HOLD" | "FULFILLMENT_ORDERS_RESCHEDULED" | "FULFILLMENT_ORDERS_SCHEDULED_FULFILLMENT_ORDER_READY" | "FULFILLMENT_ORDERS_SPLIT" | "FULFILLMENTS_CREATE" | "FULFILLMENTS_UPDATE" | "INVENTORY_ITEMS_CREATE" | "INVENTORY_ITEMS_DELETE" | "INVENTORY_ITEMS_UPDATE" | "INVENTORY_LEVELS_CONNECT" | "INVENTORY_LEVELS_DISCONNECT" | "INVENTORY_LEVELS_UPDATE" | "INVENTORY_SHIPMENTS_ADD_ITEMS" | "INVENTORY_SHIPMENTS_CREATE" | "INVENTORY_SHIPMENTS_DELETE" | "INVENTORY_SHIPMENTS_MARK_IN_TRANSIT" | "INVENTORY_SHIPMENTS_RECEIVE_ITEMS" | "INVENTORY_SHIPMENTS_REMOVE_ITEMS" | "INVENTORY_SHIPMENTS_UPDATE_ITEM_QUANTITIES" | "INVENTORY_SHIPMENTS_UPDATE_TRACKING" | "INVENTORY_TRANSFERS_ADD_ITEMS" | "INVENTORY_TRANSFERS_CANCEL" | "INVENTORY_TRANSFERS_COMPLETE" | "INVENTORY_TRANSFERS_READY_TO_SHIP" | "INVENTORY_TRANSFERS_REMOVE_ITEMS" | "INVENTORY_TRANSFERS_UPDATE_ITEM_QUANTITIES" | "LOCALES_CREATE" | "LOCALES_DESTROY" | "LOCALES_UPDATE" | "LOCATIONS_ACTIVATE" | "LOCATIONS_CREATE" | "LOCATIONS_DEACTIVATE" | "LOCATIONS_DELETE" | "LOCATIONS_UPDATE" | "MARKETS_BACKUP_REGION_UPDATE" | "MARKETS_CREATE" | "MARKETS_DELETE" | "MARKETS_UPDATE" | "METAFIELD_DEFINITIONS_CREATE" | "METAFIELD_DEFINITIONS_DELETE" | "METAFIELD_DEFINITIONS_UPDATE" | "METAOBJECTS_CREATE" | "METAOBJECTS_DELETE" | "METAOBJECTS_UPDATE" | "ORDER_TRANSACTIONS_CREATE" | "ORDERS_CANCELLED" | "ORDERS_CREATE" | "ORDERS_DELETE" | "ORDERS_EDITED" | "ORDERS_FULFILLED" | "ORDERS_PAID" | "ORDERS_PARTIALLY_FULFILLED" | "ORDERS_RISK_ASSESSMENT_CHANGED" | "ORDERS_SHOPIFY_PROTECT_ELIGIBILITY_CHANGED" | "ORDERS_UPDATED" | "PAYMENT_SCHEDULES_DUE" | "PAYMENT_TERMS_CREATE" | "PAYMENT_TERMS_DELETE" | "PAYMENT_TERMS_UPDATE" | "PRODUCT_FEEDS_CREATE" | "PRODUCT_FEEDS_FULL_SYNC" | "PRODUCT_FEEDS_FULL_SYNC_FINISH" | "PRODUCT_FEEDS_INCREMENTAL_SYNC" | "PRODUCT_FEEDS_UPDATE" | "PRODUCT_LISTINGS_ADD" | "PRODUCT_LISTINGS_REMOVE" | "PRODUCT_LISTINGS_UPDATE" | "PRODUCT_PUBLICATIONS_CREATE" | "PRODUCT_PUBLICATIONS_DELETE" | "PRODUCT_PUBLICATIONS_UPDATE" | "PRODUCTS_CREATE" | "PRODUCTS_DELETE" | "PRODUCTS_UPDATE" | "PROFILES_CREATE" | "PROFILES_DELETE" | "PROFILES_UPDATE" | "REFUNDS_CREATE" | "RETURNS_APPROVE" | "RETURNS_CANCEL" | "RETURNS_CLOSE" | "RETURNS_DECLINE" | "RETURNS_PROCESS" | "RETURNS_REOPEN" | "RETURNS_REQUEST" | "RETURNS_UPDATE" | "REVERSE_DELIVERIES_ATTACH_DELIVERABLE" | "REVERSE_FULFILLMENT_ORDERS_DISPOSE" | "SCHEDULED_PRODUCT_LISTINGS_ADD" | "SCHEDULED_PRODUCT_LISTINGS_REMOVE" | "SCHEDULED_PRODUCT_LISTINGS_UPDATE" | "SEGMENTS_CREATE" | "SEGMENTS_DELETE" | "SEGMENTS_UPDATE" | "SELLING_PLAN_GROUPS_CREATE" | "SELLING_PLAN_GROUPS_DELETE" | "SELLING_PLAN_GROUPS_UPDATE" | "SHIPPING_ADDRESSES_CREATE" | "SHIPPING_ADDRESSES_UPDATE" | "SHOP_REDACT" | "SHOP_UPDATE" | "SUBSCRIPTION_BILLING_ATTEMPTS_CHALLENGED" | "SUBSCRIPTION_BILLING_ATTEMPTS_FAILURE" | "SUBSCRIPTION_BILLING_ATTEMPTS_SUCCESS" | "SUBSCRIPTION_BILLING_CYCLE_EDITS_CREATE" | "SUBSCRIPTION_BILLING_CYCLE_EDITS_DELETE" | "SUBSCRIPTION_BILLING_CYCLE_EDITS_UPDATE" | "SUBSCRIPTION_BILLING_CYCLES_SKIP" | "SUBSCRIPTION_BILLING_CYCLES_UNSKIP" | "SUBSCRIPTION_CONTRACTS_ACTIVATE" | "SUBSCRIPTION_CONTRACTS_CANCEL" | "SUBSCRIPTION_CONTRACTS_CREATE" | "SUBSCRIPTION_CONTRACTS_EXPIRE" | "SUBSCRIPTION_CONTRACTS_FAIL" | "SUBSCRIPTION_CONTRACTS_PAUSE" | "SUBSCRIPTION_CONTRACTS_UPDATE" | "TAX_SERVICES_CREATE" | "TAX_SERVICES_UPDATE" | "TENDER_TRANSACTIONS_CREATE" | "THEMES_CREATE" | "THEMES_DELETE" | "THEMES_PUBLISH" | "THEMES_UPDATE" | "VARIANTS_IN_STOCK" | "VARIANTS_OUT_OF_STOCK">; /** * Helper function to convert GraphQL topic enum to event name * @example * getWebhookEventName('ORDERS_CREATE') // returns 'orders/create' */ declare function getWebhookEventName(topic: WebhookTopicKey): WebhookTopicValue; /** * Helper function to convert event name to GraphQL topic enum * @example * getWebhookTopicEnum('orders/create') // returns 'ORDERS_CREATE' */ declare function getWebhookTopicEnum(eventName: WebhookTopicValue): WebhookTopicKey; export { API_VERSIONS, API_VERSION_ALIASES, type AdminApiClient, type AdminApiClientConfig, type AdminApiClientRequestOptions, ApiVersion, type ApiVersionAlias, type ApiVersionValue, ConfigurationError, type GraphQLError, type GraphQLResponse, LATEST_API_VERSION, NetworkError, ShopifyApiError, type TypedGraphQLDocument, WebhookTopic, type WebhookTopicKey, WebhookTopicReverse, type WebhookTopicValue, createAdminApiClient, getWebhookEventName, getWebhookTopicEnum, gql };