feat: added GetAttachedPlans and GetAttachedProducts to subs (#927)

BREAKING CHANGE

src/endpoints/subscriptions.js

@@ -17,6 +17,13 @@ class SubscriptionsEndpoint extends CRUDExtend {
     return this.request.send(`${this.endpoint}/${id}/invoices`, 'GET')
   }
 
+  GetAttachedProducts(id) {
+    return this.request.send(`${this.endpoint}/${id}/products`, 'GET')
+  }
+
+  GetAttachedPlans(id) {
+    return this.request.send(`${this.endpoint}/${id}/plans`, 'GET')
+  }
 }
 
 export default SubscriptionsEndpoint

src/types/subscription-offerings.d.ts

@@ -97,7 +97,18 @@ export interface SubscriptionOfferingFilter {
   }
 }
 
-export type SubscriptionOfferingPlan = SubscriptionPlan & SubscriptionOfferingAttachmentsRelationships
+type SubscriptionOfferingPlanMeta = {
+  meta: {
+    active_plan?: boolean
+    owner: string
+    timestamps: {
+      created_at: string
+      updated_at: string
+    }
+  }
+}
+
+export type SubscriptionOfferingPlan = Omit<SubscriptionPlan, 'meta'> & SubscriptionOfferingAttachmentsRelationships & SubscriptionOfferingPlanMeta
 export type SubscriptionOfferingProduct = SubscriptionProduct & SubscriptionOfferingAttachmentsRelationships
 /**
  * Subscription Offering Endpoints

src/types/subscriptions.d.ts

@@ -6,8 +6,10 @@
 import {
   Identifiable,
   CrudQueryableResource,
-  Resource
+  Resource,
+  ResourcePage
 } from './core'
+import { SubscriptionOfferingPlan, SubscriptionOfferingProduct } from './subscription-offerings'
 
 /**
  * Core Subscription Base Interface
@@ -109,6 +111,12 @@ export interface Subscription extends Identifiable, SubscriptionBase {
   }
 }
 
+export type SubscriptionsInclude = 'plans'
+
+export interface SubscriptionsIncluded {
+  plans: SubscriptionOfferingPlan[]
+}
+
 /**
  * Subscription Endpoints
  * DOCS: TODO: add docs when ready
@@ -120,9 +128,15 @@ export interface SubscriptionsEndpoint
     never,
     SubscriptionFilter,
     never,
-    never
-    >, "Limit" | "Offset" | "Sort" | "With" | "Attributes" | "Update" | "Link" > {
+    SubscriptionsInclude
+    >, "All" | "Limit" | "Offset" | "Sort" | "Attributes" | "Update" | "Link" > {
   endpoint: 'subscriptions'
 
+  All(token?: string): Promise<ResourcePage<Subscription, SubscriptionsIncluded>>
+
   GetInvoices(id: string): Promise<Resource<SubscriptionInvoice[]>>
+
+  GetAttachedProducts(id: string) : Promise<Resource<SubscriptionOfferingProduct[]>>
+
+  GetAttachedPlans(id: string) : Promise<Resource<SubscriptionOfferingPlan[]>>
 }