shopify-api-node-interface
v2.0.0
Published
Typescript interface declarations for the official shopify-api-node module
Downloads
46
Maintainers
Readme
A Typescript Interface for the Shopify API Node Module
Shopify's official documentation
Typescript type definitions for the Shopify API Node module.
npm i shopify-api-node-interface --save-dev
import {Shopify} from 'shopify-api-node-interface';
const Shopify: Shopify = require('shopify-api-node');
... bingo
Incomplete. All contributions appreciated :)
Though incomplete, all the listed actions are at least plugged by an "any" type, so there is top-level intellisense.
Progress:
| Action | Complete | Started | Not started | |--------------------|--------------------|--------------------|--------------------| | Product| |:heavy_check_mark:| | | Order| |:heavy_check_mark:| | |ScriptTag| |:heavy_check_mark:| | |AbandonedCheckouts| | |:heavy_check_mark:| |ApplicationCharge| | |:heavy_check_mark:| |ApplicationCredit| | |:heavy_check_mark:| |Article| | |:heavy_check_mark:| |Asset| | |:heavy_check_mark:| |Blog| | |:heavy_check_mark:| |CarrierService| | |:heavy_check_mark:| |Checkout| | |:heavy_check_mark:| |Collect| | |:heavy_check_mark:| |CollectionListing| | |:heavy_check_mark:| |Comment| | |:heavy_check_mark:| |Country| | |:heavy_check_mark:| |CustomCollection| | |:heavy_check_mark:| |Customer| | |:heavy_check_mark:| |CustomerAddress| | |:heavy_check_mark:| |DiscountCode| | |:heavy_check_mark:| |DraftOrder| | |:heavy_check_mark:| |Event| | |:heavy_check_mark:| |Fulfillment| | |:heavy_check_mark:| |FulfillmentEvent| | |:heavy_check_mark:| |FulfillmentService| | |:heavy_check_mark:| |Gift Card| | |:heavy_check_mark:| |Location| | |:heavy_check_mark:| |Marketing Event| | |:heavy_check_mark:| |Metafield| | |:heavy_check_mark:| |Multipass| | |:heavy_check_mark:| |Order Risks| | |:heavy_check_mark:| |Page| | |:heavy_check_mark:| |Policy| | |:heavy_check_mark:| |PriceRule| | |:heavy_check_mark:| |Product Image| | |:heavy_check_mark:| |Product Variant| | |:heavy_check_mark:| |ProductListing| | |:heavy_check_mark:| |Province| | |:heavy_check_mark:| |RecurringApplicationCharge| | |:heavy_check_mark:| |Redirect| | |:heavy_check_mark:| |Refund| | |:heavy_check_mark:| |Report| | |:heavy_check_mark:| |ResourceFeedback| | |:heavy_check_mark:| |ShippingZone| | |:heavy_check_mark:| |Shop| | |:heavy_check_mark:| |SmartCollection| | |:heavy_check_mark:| |Storefront Access Token| | |:heavy_check_mark:| |Theme| | |:heavy_check_mark:| |Transaction| | |:heavy_check_mark:| |UsageCharge| | |:heavy_check_mark:| |User (shopify plus)| | |:heavy_check_mark:| |Webhook| | |:heavy_check_mark:| |ShopifyQL| | |:heavy_check_mark:|