Added Order service

services/charges.ts

@@ -1,6 +1,6 @@
 import { Charge } from "../typings/models";
 import BaseService from "../infrastructure/base_service";
-import { FieldOptions, ListOptions } from "../typings/options";
+import { FieldOptions, ListOptions, DateOptions } from "../typings/options";
 
 /**
  * A service for manipulating Shopify's ApplicationCharge API.
@@ -30,7 +30,7 @@ export default class Charges extends BaseService {
  * Retrieves a list of all past and present charges.
  * @param options Options for filtering the result.
  */
- public list(options?: ListOptions) {
+ public list(options?: ListOptions & DateOptions & FieldOptions) {
  return this.createRequest<Charge[]>("GET", ".json", "application_charges", options);
  }
 

services/orders.ts

@@ -1,9 +1,85 @@
 import { Order } from "../typings/models";
 import BaseService from "../infrastructure/base_service";
-import { FieldOptions, ListOptions, WebhookOptions } from "../typings/options";
+import { OrderCountOptions, OrderListOptions, FieldOptions, OrderCreateOptions } from "../typings/options";
 
 export default class Orders extends BaseService {
  constructor(shopDomain: string, accessToken: string) {
  super(shopDomain, accessToken, "orders");
  }
+
+ /**
+ * Gets a count of all of the shop's orders.
+ * @param options Options for filtering the results.
+ */
+ public count(options?: OrderCountOptions) {
+ return this.createRequest<number>("GET", "count.json", "count", options);
+ }
+
+ /**
+ * Gets a list of up to 250 of the shop's orders.
+ * @param options Options for filtering the results.
+ */
+ public list(options?: OrderListOptions) {
+ return this.createRequest<Order[]>("GET", ".json", "orders", options);
+ }
+
+ /**
+ * Gets a list of up to 250 orders from the given customer.
+ * @param customerId The customer's id.
+ * @param options Options for filtering the results.
+ */
+ public listForCustomer(customerId: number, options?: OrderListOptions) {
+ return this.createRequest<Order[]>("GET", ".json", "orders", Object.assign({ customer_id: customerId }, options));
+ }
+
+ /**
+ * Gets the order with the given id.
+ * @param orderId The order's id.
+ * @param options Options for filtering the results.
+ */
+ public get(orderId: number, options?: FieldOptions) {
+ return this.createRequest<Order>("GET", `${orderId}.json`, "order", options);
+ }
+
+ /**
+ * Creates an order.
+ * @param order The order being created.
+ * @param options Options for creating the order.
+ */
+ public create(order: Order, options?: OrderCreateOptions) {
+ return this.createRequest<Order>("POST", ".json", "order", { order: Object.assign({}, order, options) });
+ }
+
+ /**
+ * Updates an order with the given id.
+ * @param id The order's id.
+ * @param order The updated order.
+ */
+ public update(id: number, order: Order) {
+ return this.createRequest<Order>("PUT", `${id}.json`, "order", {order});
+ }
+
+ /**
+ * Deletes an order with the given id.
+ * @param id The order's id.
+ */
+ public delete(id: number) {
+ return this.createRequest<void>("DELETE", `${id}.json`);
+ }
+
+ /**
+ * Closes an order with the given id.
+ * @param id The order's id.
+ */
+ public close(id: number) {
+ return this.createRequest<Order>("POST", `${id}/close.json`, "order");
+ }
+
+ /**
+ * Opens an order with the given id.
+ * @param id The order's id.
+ */
+ public open(id: number) {
+ return this.createRequest<Order>("POST", `${id}/open.json`, "order");
+ }
 }

services/recurring_charges.ts

@@ -1,6 +1,6 @@
 import { Charge } from "../typings/models";
 import BaseService from "../infrastructure/base_service";
-import { FieldOptions, ListOptions } from "../typings/options";
+import { FieldOptions, ListOptions, DateOptions } from "../typings/options";
 
 /**
  * A service for manipulating Shopify's RecurringCharge API.
@@ -30,7 +30,7 @@ export default class RecurringCharges extends BaseService {
  * Retrieves a list of all past and present charges.
  * @param options Options for filtering the result.
  */
- public list(options?: ListOptions) {
+ public list(options?: ListOptions & DateOptions & FieldOptions) {
  return this.createRequest<RecurringCharge[]>("GET", ".json", "recurring_application_charges", options);
  }
 

services/script_tags.ts

@@ -1,6 +1,6 @@
 import { ScriptTag } from "../typings/models";
 import BaseService from "../infrastructure/base_service";
-import { FieldOptions, ListOptions, ScriptTagOptions } from "../typings/options";
+import { FieldOptions, ListOptions, DateOptions, ScriptTagOptions } from "../typings/options";
 
 /**
  * A service for manipulating Shopify script tags.
@@ -22,7 +22,7 @@ export default class ScriptTags extends BaseService {
  * Gets a list of up to 250 of the shop's script tags.
  * @param options Options for filtering the results.
  */
- public list(options?: ScriptTagOptions & ListOptions) {
+ public list(options?: ScriptTagOptions & ListOptions & DateOptions & FieldOptions) {
  return this.createRequest<ScriptTag[]>("GET", ".json", "script_tags", options);
  }
 

services/webhooks.ts

@@ -1,6 +1,6 @@
 import { Webhook } from "../typings/models";
 import BaseService from "../infrastructure/base_service";
-import { FieldOptions, ListOptions, WebhookOptions } from "../typings/options";
+import { FieldOptions, ListOptions, DateOptions, WebhookOptions } from "../typings/options";
 
 /**
  * A service for manipulating Shopify webhooks.
@@ -22,7 +22,7 @@ export default class Webhooks extends BaseService {
  * Gets a list of up to 250 of the shop's webhooks.
  * @param options Options for filtering the results.
  */
- public list(options?: WebhookOptions & ListOptions) {
+ public list(options?: WebhookOptions & ListOptions & DateOptions) {
  return this.createRequest<Webhook[]>("GET", ".json", "webhooks", options);
  }
 

typings/enums/auth_scope.d.ts

@@ -17,5 +17,6 @@ export type AuthScope = (
  "write_shipping" |
  "read_analytics" |
  "read_users" |
- "write_users"
+ "write_users" |
+ string
 );

typings/enums/financial_status.d.ts

@@ -1,3 +1,12 @@
 export type FinancialStatus = (
- ""
+ "authorized" |
+ "pending" |
+ "paid" |
+ "partially_paid" |
+ "refunded" |
+ "voided" |
+ "partially_refunded" |
+ "unpaid" |
+ "any" |
+ string
 );

typings/enums/fulfillment_status.d.ts

@@ -1,3 +1,7 @@
 export type FulfillmentStatus = (
- ""
+ "shipped" |
+ "partial" |
+ "unshipped" |
+ "any" |
+ string
 );

typings/enums/index.d.ts

@@ -1,4 +1,6 @@
 export { AuthScope } from "./auth_scope";
+export { OrderStatus } from "./order_status";
 export { WebhookTopic } from "./webhook_topic";
 export { FinancialStatus } from "./financial_status";
+export { InventoryBehavior } from "./inventory_behavior";
 export { FulfillmentStatus } from "./fulfillment_status";

typings/enums/inventory_behavior.d.ts

@@ -0,0 +1,6 @@
+export type InventoryBehavior = (
+ "bypass" |
+ "decrement_ignoring_policy" |
+ "decrement_obeying_policy" |
+ string
+);

typings/enums/order_status.d.ts

@@ -0,0 +1,7 @@
+export type OrderStatus = (
+ "open" |
+ "closed" |
+ "cancelled" |
+ "any" |
+ string
+);

typings/enums/webhook_topic.d.ts

@@ -33,5 +33,6 @@ export type WebhookTopic = (
  "disputes/create" |
  "disputes/update" |
  "app/uninstalled" |
- "themes/publish"
+ "themes/publish" |
+ string
 )

typings/models/order.d.ts

@@ -65,8 +65,8 @@ export interface Order extends ShopifyObject {
  /// 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;
+ /// The fulfillment status for this order. Known values are 'fulfilled', 'partial' or null.
+ fulfillment_status?: "fulfilled" | "partial" | string;
 
  /// Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values. 
  tags?: string;

typings/options/index.d.ts

@@ -1,4 +1,61 @@
 export { WebhookOptions } from "./webhooks";
-export { ListOptions } from "./list_options";
-export { FieldOptions } from "./field_options";
-export { ScriptTagOptions } from "./script_tags";
+export { ScriptTagOptions } from "./script_tags";
+export { OrderCountOptions, OrderListOptions, OrderCreateOptions } from "./orders";
+
+export interface FieldOptions {
+ /**
+ * Restricts the result to only the fields specified.
+ */
+ fields?: string[];
+}
+
+export interface DateOptions {
+ /**
+ * Retrieve only objects that were created after the given date and time (format: 2014-04-25T16:15:47-04:00).
+ */
+ created_at_min?: string;
+
+ /**
+ * Retrieve only objects that were created before the given date and time (format: 2014-04-25T16:15:47-04:00).
+ */
+ created_at_max?: string;
+
+ /**
+ * Retrieve only objects that were created after the given date and time (format: 2014-04-25T16:15:47-04:00).
+ */
+ updated_at_min?: string;
+
+ /**
+ * Retrieve only objects that were created before the given date and time (format: 2014-04-25T16:15:47-04:00).
+ */
+ updated_at_max?: string;
+}
+
+export interface ProcessedOptions {
+ /**
+ * Show objects imported or processed after date (format: 2014-04-25T16:15:47-04:00).
+ */
+ processed_at_min?: string;
+
+ /**
+ * Show objects imported or processed before date (format: 2014-04-25T16:15:47-04:00).
+ */
+ processed_at_max?: string;
+}
+
+export interface ListOptions {
+ /**
+ * The maximum number of objects that should be returned, up to 250. Setting this parameter above 250 will result in an error.
+ */
+ limit?: number;
+
+ /**
+ * The page number of the result list to retrieve. Use this in tandem with limit to page through the webhooks in a shop.
+ */
+ page?: number;
+
+ /**
+ * Restricts results to those created after the given id.
+ */
+ since_id?: number;
+}

typings/options/orders.d.ts

@@ -0,0 +1,25 @@
+import { FieldOptions, ListOptions, DateOptions, ProcessedOptions } from "./";
+import { OrderStatus, FinancialStatus, FulfillmentStatus, InventoryBehavior } from "../enums";
+
+export interface OrderCountOptions extends DateOptions {
+ status?: OrderStatus;
+
+ financial_status?: FinancialStatus;
+
+ fulfillment_status?: FulfillmentStatus;
+}
+
+export interface OrderListOptions extends FieldOptions, DateOptions, ProcessedOptions, ListOptions, OrderCountOptions {
+ /**
+ * A comma-separated list of order ids.
+ */
+ ids?: string;
+}
+
+export interface OrderCreateOptions {
+ send_receipt?: boolean;
+
+ send_fulfillment_receipt?: boolean;
+
+ inventory_behavior?: InventoryBehavior;
+}