feat: subscriptions endpoint (#848)

Author: rostyk-kanafotskyy

src/endpoints/subscriptions.js

@@ -0,0 +1,22 @@
+import CRUDExtend from '../extends/crud'
+
+class SubscriptionsEndpoint extends CRUDExtend {
+  constructor(endpoint) {
+    super(endpoint)
+
+    this.endpoint = 'subscriptions/subscriptions'
+  }
+
+  Create(body) {
+    return this.request.send(this.endpoint, 'POST', {
+      ...body
+    })
+  }
+
+  GetInvoices(id) {
+    return this.request.send(`${this.endpoint}/${id}/invoices`, 'GET')
+  }
+
+}
+
+export default SubscriptionsEndpoint

src/moltin.d.ts

@@ -57,6 +57,7 @@ import { ApplicationKeysEndpoint } from './types/application-keys'
 import { SubscriptionProductsEndpoint } from './types/subscription-products'
 import { SubscriptionPlansEndpoint } from './types/subscription-plans'
 import { SubscriptionOfferingsEndpoint } from './types/subscription-offerings'
+import { SubscriptionsEndpoint } from './types/subscriptions'
 
 export * from './types/config'
 export * from './types/storage'
@@ -124,6 +125,7 @@ export * from './types/application-keys'
 export * from './types/subscription-products'
 export * from './types/subscription-plans'
 export * from './types/subscription-offerings'
+export * from './types/subscriptions'
 
 // UMD
 export as namespace moltin
@@ -183,6 +185,7 @@ export class Moltin {
   SubscriptionProducts: SubscriptionProductsEndpoint
   SubscriptionPlans: SubscriptionPlansEndpoint
   SubscriptionOfferings: SubscriptionOfferingsEndpoint
+  Subscriptions: SubscriptionsEndpoint
 
   Cart(id?: string): CartEndpoint // This optional cart id is super worrying when using the SDK in a node server :/
   constructor(config: Config)

src/moltin.js

@@ -50,6 +50,7 @@ import ApplicationKeysEndpoint from './endpoints/application-keys'
 import SubscriptionProductsEndpoint from './endpoints/subscription-products'
 import SubscriptionPlansEndpoint from './endpoints/subscription-plan'
 import SubscriptionOfferingsEndpoint from './endpoints/subscription-offerings'
+import SubscriptionsEndpoint from './endpoints/subscriptions'
 
 import {cartIdentifier, tokenInvalid, getCredentials, resolveCredentialsStorageKey} from './utils/helpers'
 import CatalogsEndpoint from './endpoints/catalogs'
@@ -118,6 +119,7 @@ export default class Moltin {
     this.SubscriptionProducts = new SubscriptionProductsEndpoint(config)
     this.SubscriptionPlans = new SubscriptionPlansEndpoint(config)
     this.SubscriptionOfferings = new SubscriptionOfferingsEndpoint(config)
+    this.Subscriptions = new SubscriptionsEndpoint(config)
   }
 
   // Expose `Cart` class on Moltin class

src/types/subscriptions.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Subscriptions
+ * Description: Subscriptions.
+ * DOCS: TODO: add docs when ready
+ */
+import {
+  Identifiable,
+  CrudQueryableResource,
+  Resource
+} from './core'
+
+/**
+ * Core Subscription Base Interface
+ * For custom flows, extend this interface
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionBase {
+  type: "subscription",
+  attributes: {
+    account_id: string,
+    offering: {
+      id: string
+      type: "subscription-offering",
+      attributes: {
+        name: string,
+        description: string,
+        updated_at: string,
+        created_at: string
+      },
+      relationships: {
+        plans: {
+          links: {
+            related: string,
+            self: string
+          },
+          data: {
+            type: "offering-plan",
+            id: string
+          }
+        }
+      },
+      meta: {
+        owner: string
+      }
+    },
+    plan_id: string,
+    currency: string,
+    updated_at: string,
+    created_at: string
+  },
+  meta: {
+    owner: string
+  }
+}
+
+export interface SubscriptionCreate {
+  account_id: string,
+  offering_id: string,
+  plan_id: string,
+  currency: string,
+  meta?: {
+    owner?: string
+  }
+}
+
+export interface SubscriptionInvoice extends Identifiable {
+  type: "subscription-invoice",
+  attributes: {
+    billing_period: {
+      start: string,
+      end: string
+    },
+    invoice_items:       {
+      description: string,
+      price: {
+        currency: string,
+        amount: number,
+        includes_tax: boolean
+      }
+    }[],
+    outstanding: boolean,
+    updated_at: string,
+    created_at: string
+  },
+  meta: {
+    owner: string,
+    subscription_id: string,
+    price: {
+      currency: string,
+      amount: number,
+      includes_tax: boolean
+    }
+  }
+}
+
+
+export interface Subscription extends Identifiable, SubscriptionBase {
+
+}
+
+/**
+ * Subscription Endpoints
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionsEndpoint
+  extends Omit<CrudQueryableResource<
+    Subscription,
+    SubscriptionCreate,
+    never,
+    never,
+    never,
+    never
+    >, "Filter" | "Limit" | "Offset" | "Sort" | "With" | "Attributes" | "Update" | "Link" > {
+  endpoint: 'subscriptions'
+
+  GetInvoices(id: string): Promise<Resource<SubscriptionInvoice[]>>
+}