Restructure files

index.ts

@@ -1,19 +1,35 @@
 // Exported definitions should never contain triple-slash references: 
 // https://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html
 
+// Import and export models/infrastructure
 import * as Enums from "./enums";
+import * as Models from "./models";
 import * as Options from "./options";
 import * as Infrastructure from "./infrastructure";
 
-export {Enums};
-export {Options};
-export {Infrastructure};
-export {Shops, Shop} from "./modules/shops";
-export {Charges, Charge} from "./modules/charges";
-export {Webhooks, Webhook} from "./modules/webhooks";
-export {ScriptTags, ScriptTag} from "./modules/script_tags";
-export {UsageCharges, UsageCharge} from "./modules/usage_charges";
-export {RecurringCharges, RecurringCharge} from "./modules/recurring_charges";
+export {
+ Enums, 
+ Models, 
+ Options, 
+ Infrastructure,
+};
+
+// Import and export services
+import Shops from "./services/shops";
+import Charges from "./services/charges";
+import Webhooks from "./services/webhooks";
+import ScriptTags from "./services/script_tags";
+import UsageCharges from "./services/usage_charges";
+import RecurringCharges from "./services/recurring_charges";
+
+export {
+ Shops,
+ Charges,
+ Webhooks,
+ ScriptTags,
+ UsageCharges,
+ RecurringCharges,
+};
 
 // Export auth functions at the top level
 export {
@@ -23,4 +39,4 @@ export {
  isAuthenticRequest,
  isAuthenticWebhook,
  isValidShopifyDomain
-} from "./modules/auth";
+} from "./services/auth";

models/charge.ts

@@ -0,0 +1,46 @@
+import {ShopifyObject} from "../infrastructure";
+
+/**
+ * Represents a one-time application charge.
+ */
+export interface Charge extends ShopifyObject {
+ /**
+ * The URL that the customer should be sent to, to accept or decline the application charge.
+ */
+ confirmation_url?: string;
+
+ /**
+ * The date and time when the application charge was created.
+ */
+ created_at?: string;
+
+ /**
+ * The name of the application charge, e.g. "Super Expensive One-time Charge".
+ */
+ name: string;
+
+ /**
+ * The price of the application charge. Note: Shopify returns this value as a string.
+ */
+ price: string | number;
+
+ /**
+ * The URL the customer is sent to once they accept/decline a charge.
+ */
+ return_url?: string;
+
+ /**
+ * The status of the charge.
+ */
+ status?: "pending" | "accepted" | "active" | "cancelled" | "declined" | "expired";
+
+ /**
+ * Whether or not the application charge is a test transaction.
+ */
+ test?: boolean;
+
+ /**
+ * The date and time when the recurring application charge was last updated.
+ */
+ updated_at?: string;
+}

models/index.ts

@@ -0,0 +1,6 @@
+export {Shop} from "./shop";
+export {Order} from "./order";
+export {Charge} from "./charge";
+export {Webhook} from "./webhook";
+export {ScriptTag} from "./script_tag";
+export {UsageCharge} from "./usage_charge";

models/order.ts

@@ -0,0 +1,139 @@
+import {ShopifyObject} from "../infrastructure";
+
+export interface Order extends ShopifyObject {
+ /// The mailing address associated with the payment method. This address is an optional field that will not be available on orders that do not require one. 
+ billing_address?: Address;
+
+ /// The IP address of the browser used by the customer when placing the order.
+ browser_ip?: string;
+
+ /// Indicates whether or not the person who placed the order would like to receive email updates from the shop. 
+ /// This is set when checking the "I want to receive occasional emails about new products, promotions and other news" checkbox during checkout. 
+ buyer_accepts_marketing?: boolean;
+
+ /// The reason why the order was cancelled. If the order was not cancelled, this value is null. Known values are "customer", "fraud", "inventory" and "other".
+ cancel_reason?: string;
+
+ /// The date and time when the order was cancelled. If the order was not cancelled, this value is null. 
+ cancelled_at?: string;
+
+ /// Unique identifier for a particular cart that is attached to a particular order. 
+ cart_token?: string;
+
+ /// A <see cref="ShopifyClientDetails"/> object containing information about the client.
+ client_details?: ClientDetails;
+
+ /// The date and time when the order was closed. If the order was not clsoed, this value is null.
+ closed_at?: string;
+
+ /// The customer's contact email address.
+ contact_email?: string;
+
+ /// The date and time when the order was created in Shopify. 
+ created_at?: string;
+
+ /// The three letter code (ISO 4217) for the currency used for the payment. 
+ currency?: string;
+
+ /// A <see cref="ShopifyCustomer"/> object containing information about the customer. This value may be null if the order was created through Shopify POS. 
+ customer?: Customer;
+
+ /// Applicable discount codes that can be applied to the order. 
+ discount_codes?: DiscountCode[];
+
+ /// The order's email address. Note?: On and after 2015-11-03, you should be using <see cref="ContactEmail"/> to refer to the customer's email address. 
+ /// Between 2015-11-03 and 2015-12-03, updates to an order's email will also update the customer's email. This is temporary so apps can be migrated over to 
+ /// doing customer updates rather than order updates to change the contact email. After 2015-12-03, updating updating an order's email will no longer update 
+ /// the customer's email and apps will have to use the customer update endpoint to do so.
+ email?: string;
+
+ /// The financial status of an order. Known values are "authorized", "paid", "pending", "partially_paid", "partially_refunded", "refunded" and "voided". 
+ financial_status?: FinancialStatus;
+
+ /// An array of <see cref="ShopifyFulfillment"/> objects for this order.
+ fulfillments?: Fulfillment[];
+
+ /// The fulfillment status for this order. Known values are 'fulfilled', 'null' and 'partial'.
+ fulfillment_status?: FulfillmentStatus;
+
+ /// Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values. 
+ tags?: string;
+
+ /// The URL for the page where the buyer landed when entering the shop. 
+ landing_site?: string;
+
+ /// An array of <see cref="ShopifyLineItem"/> objects, each one containing information about an item in the order. 
+ line_items?: LineItem[];
+
+ /// The customer's order name as represented by a number, e.g. '#1001'.
+ name?: string;
+
+ /// The text of an optional note that a shop owner can attach to the order. 
+ note?: string;
+
+ /// Extra information that is added to the order. 
+ note_attributes?: NoteAttribute;
+
+ /// Numerical identifier unique to the shop. A number is sequential and starts at 1000. 
+ number?: number;
+
+ /// A unique numeric identifier for the order. This one is used by the shop owner and customer. 
+ /// This is different from the id property, which is also a unique numeric identifier for the order, but used for API purposes.
+ order_number?: number;
+
+ /// Payment details for this order. May be null if the order was created via API without payment details.
+ payment_details?: PaymentDetails;
+
+ /// The date that the order was processed at.
+ processed_at?: string;
+
+ /// The type of payment processing method. Known values are 'checkout', 'direct', 'manual', 'offsite', 'express', 'free' and 'none'. 
+ processing_method?: string;
+
+ /// The website that the customer clicked on to come to the shop. 
+ referring_site?: string;
+
+ /// The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require one. 
+ shipping_address?: Address;
+
+ /// An array of <see cref="ShopifyShippingLine"/> objects, each of which details the shipping methods used. 
+ shipping_lines?: ShippingLine[];
+
+ /// Where the order originated. May only be set during creation, and is not writeable thereafter.
+ /// Orders created via the API may be assigned any string of your choice except for "web", "pos", "iphone", and "android". 
+ /// Default is "api". 
+ source_name?: string;
+
+ /// Price of the order before shipping and taxes 
+ subtotal_price?: number;
+
+ /// An array of <see cref="ShopifyTaxLine"/> objects, each of which details the total taxes applicable to the order. 
+ tax_lines?: TaxLine[];
+
+ /// States whether or not taxes are included in the order subtotal. 
+ taxes_included?: boolean;
+
+ /// Unique identifier for a particular order. 
+ token?: string;
+
+ /// The total amount of the discounts applied to the price of the order.
+ total_discounts?: number;
+
+ /// The sum of all the prices of all the items in the order. 
+ total_line_items_price?: number;
+
+ /// The sum of all the prices of all the items in the order, with taxes and discounts included (must be positive). 
+ total_price?: number;
+
+ /// The sum of all the prices of all the items in the order, in USD, with taxes and discounts included (must be positive). 
+ total_price_usd?: number;
+
+ /// The sum of all the taxes applied to the order (must be positive). 
+ total_tax?: number;
+
+ /// The sum of all the weights of the line items in the order, in grams.
+ total_weight?: number;
+
+ /// The date and time when the order was last modified. 
+ updated_at?: string;
+}

models/script_tag.ts

@@ -0,0 +1,26 @@
+import {ShopifyObject} from "../infrastructure";
+
+/**
+ * An entity representing a Shopify script tag.
+ */
+export interface ScriptTag extends ShopifyObject {
+ /**
+ * The date and time the script tag was created.
+ */
+ created_at?: string;
+
+ /**
+ * DOM event which triggers the loading of the script. Currently, 'onload' is the only accepted value.
+ */
+ event?: "onload";
+
+ /**
+ * Specifies the src of the script tag, i.e. which URL to load it from.
+ */
+ src: string;
+
+ /**
+ * The date and time the script tag was updated.
+ */
+ updated_at?: string;
+}

modules/shops.ts → models/shop.ts

@@ -1,41 +1,9 @@
-/// <reference path="./../typings/index.d.ts" />
-
-import {FieldOptions, ListOptions} from "../options";
-import {ShopifyObject, BaseService} from "../infrastructure";
-
-/**
- * A service for manipulating Shopify shops.
- */
-export class Shops extends BaseService
-{
- constructor(shopDomain: string, accessToken: string)
- {
- super(shopDomain, accessToken, "");
- }
-
- /**
- * Returns shop data for the shop.
- * @param options Options for filtering the result.
- */
- public get(options?: FieldOptions)
- {
- return this.createRequest<Shop>("GET", "shop.json", "shop", options);
- }
-
- /**
- * Forces the shop to uninstall your Shopify app. Uninstalling an application is an irreversible operation. Be entirely sure that you no longer need to make API calls for the shop in which the application has been installed.
- */
- public forceUninstallApp()
- {
- return this.createRequest<void>("DELETE", "api_permissions/current.json");
- }
-}
+import {ShopifyObject} from "../infrastructure";
 
 /**
  * Represents a Shopify shop.
  */
-export interface Shop extends ShopifyObject
-{
+export interface Shop extends ShopifyObject {
  /**
  * The shop's street address. 
  */

models/usage_charge.ts

@@ -0,0 +1,31 @@
+import {ShopifyObject} from "../infrastructure";
+
+/**
+ * Represents a usage charge, a variable monthly fee for an app or a service.
+ */
+export interface UsageCharge extends ShopifyObject {
+ /**
+ * The date and time when the usage charge was created. 
+ */
+ created_at?: string;
+
+ /**
+ * The name or description of the usage charge.
+ */
+ description?: string;
+
+ /**
+ * The price of the usage charge.
+ */
+ price?: number;
+
+ /**
+ * The recurring application charge the usage charge belongs to.
+ */
+ recurring_application_charge_id?: number;
+
+ /**
+ * The date and time when the usage charge was last updated.
+ */
+ updated_at?: string;
+}

models/webhook.ts

@@ -0,0 +1,43 @@
+import {WebhookTopic} from "../enums";
+import {ShopifyObject} from "../infrastructure";
+
+/**
+ * An entity representing a Shopify webhook.
+ */
+export interface Webhook extends ShopifyObject
+{
+ /**
+ * The URL where the webhook should send the POST request when the event occurs.
+ */
+ address: string;
+
+ /**
+ * The date and time when the webhook was created.
+ */
+ created_at?: string;
+
+ /**
+ * An optional array of fields which should be included in webhooks.
+ */
+ fields?: string[];
+
+ /**
+ * The format in which the webhook should send the data. Valid values are json and xml.
+ */
+ format?: "json" | "xml";
+
+ /**
+ * An optional array of namespaces for metafields that should be included in webhooks.
+ */
+ metafield_namespaces?: string[];
+
+ /**
+ * The event that will trigger the webhook.
+ */
+ topic: WebhookTopic;
+
+ /**
+ * The date and time when the webhook was updated.
+ */
+ updated_at?: string;
+}