feat: added subscription schedules and jobs endpoints (#919)

Author: rostyk-kanafotskyy

src/endpoints/subscription-jobs.js

@@ -0,0 +1,18 @@
+import CRUDExtend from '../extends/crud'
+
+class SubscriptionJobsEndpoint extends CRUDExtend {
+  constructor(endpoint) {
+    super(endpoint)
+
+    this.endpoint = 'subscriptions/jobs'
+  }
+
+  Create(body) {
+    return this.request.send(this.endpoint, 'POST', {
+      ...body
+    })
+  }
+
+}
+
+export default SubscriptionJobsEndpoint

src/endpoints/subscription-schedules.js

@@ -0,0 +1,29 @@
+import CRUDExtend from '../extends/crud'
+
+class SubscriptionSchedulesEndpoint extends CRUDExtend {
+  constructor(endpoint) {
+    super(endpoint)
+
+    this.endpoint = 'subscriptions/schedules'
+  }
+
+  Create(body) {
+    return this.request.send(this.endpoint, 'POST', {
+      ...body
+    })
+  }
+
+  Update(id, body, token = null) {
+    return this.request.send(
+      `${this.endpoint}/${id}`,
+      'PUT',
+      {
+        ...body
+      },
+      token
+    )
+  }
+
+}
+
+export default SubscriptionSchedulesEndpoint

src/moltin.d.ts

@@ -62,6 +62,8 @@ import { OneTimePasswordTokenRequestEndpoint } from "./types/one-time-password-t
 import { SubscriptionsEndpoint } from './types/subscriptions'
 import { RulePromotionsEndpoint } from './types/rule-promotions'
 import { SubscriptionSubscribersEndpoint } from './types/subscription-subscribers'
+import { SubscriptionJobsEndpoint } from './types/subscription-jobs'
+import { SubscriptionSchedulesEndpoint } from './types/subscription-schedules'
 
 export * from './types/config'
 export * from './types/storage'
@@ -134,6 +136,8 @@ export * from './types/one-time-password-token-request'
 export * from './types/subscriptions'
 export * from './types/rule-promotions'
 export * from './types/subscription-subscribers'
+export * from './types/subscription-jobs'
+export * from './types/subscription-schedules'
 
 // UMD
 export as namespace moltin
@@ -197,6 +201,8 @@ export class Moltin {
   Subscriptions: SubscriptionsEndpoint
   RulePromotions : RulePromotionsEndpoint
   SubscriptionSubscribers : SubscriptionSubscribersEndpoint
+  SubscriptionJobs : SubscriptionJobsEndpoint
+  SubscriptionSchedules: SubscriptionSchedulesEndpoint
 
   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

@@ -54,6 +54,8 @@ import SubscriptionOfferingsEndpoint from './endpoints/subscription-offerings'
 import SubscriptionsEndpoint from './endpoints/subscriptions'
 import RulePromotionsEndpoint from './endpoints/rule-promotions'
 import SubscriptionSubscribersEndpoint from './endpoints/subscription-subscribers'
+import SubscriptionJobsEndpoint  from './endpoints/subscription-jobs'
+import SubscriptionSchedulesEndpoint from './endpoints/subscription-schedules'
 
 import {cartIdentifier, tokenInvalid, getCredentials, resolveCredentialsStorageKey} from './utils/helpers'
 import CatalogsEndpoint from './endpoints/catalogs'
@@ -126,6 +128,8 @@ export default class Moltin {
     this.Subscriptions = new SubscriptionsEndpoint(config)
     this.RulePromotions = new RulePromotionsEndpoint(config)
     this.SubscriptionSubscribers = new SubscriptionSubscribersEndpoint(config)
+    this.SubscriptionJobs = new SubscriptionJobsEndpoint(config)
+    this.SubscriptionSchedules = new SubscriptionSchedulesEndpoint(config)
   }
 
   // Expose `Cart` class on Moltin class

src/types/subscription-jobs.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Subscription Jobs
+ * Description: Subscription Jobs.
+ * DOCS: TODO: add docs when ready
+ */
+import {
+  Identifiable,
+  CrudQueryableResource
+} from './core'
+
+/**
+ * Core Subscription Job Base Interface
+ * For custom flows, extend this interface
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionJobBase {
+  type: "subscription_job",
+  attributes: {
+    external_ref: string,
+    job_type: "billing-run" | "payment-run" | "tax-run"
+    taxes?: {
+      invoice_id: string,
+      tax_items: [
+        {
+          type: "tax_item",
+          name?: string,
+          code?: string,
+          rate: number,
+          jurisdiction?: string
+        }
+      ]
+    }[]
+  }
+}
+
+export interface SubscriptionJob extends Identifiable, SubscriptionJobBase {
+  attributes: SubscriptionJobBase['attributes'] & {
+    status: 'pending' | 'started' | 'success' | 'failed'
+    updated_at: string
+    created_at: string
+  }
+  relationships: {
+    [key: string]: {
+      links: {
+        related: string,
+        self: string
+      },
+      data: {
+        type: string,
+        id: string
+      }
+    }
+  },
+  meta: {
+    owner: 'store' | 'organization',
+    timestamps: {
+      updated_at: string,
+      created_at: string,
+      started_at?: string,
+      finished_at?: string
+    }
+  }
+}
+
+export type SubscriptionJobCreate = SubscriptionJobBase
+
+/**
+ * Subscription Job Endpoints
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionJobsEndpoint
+  extends CrudQueryableResource<
+    SubscriptionJob,
+    SubscriptionJobCreate,
+    never,
+    never,
+    never,
+    never
+    > {
+  endpoint: 'jobs'
+}

src/types/subscription-schedules.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Subscription Schedules
+ * Description: Subscription Schedules.
+ * DOCS: TODO: add docs when ready
+ */
+import {
+  Identifiable,
+  CrudQueryableResource
+} from './core'
+import { SubscriptionJob } from './subscription-jobs'
+
+/**
+ * Core Subscription Schedule Base Interface
+ * For custom flows, extend this interface
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionScheduleBase {
+  type: 'subscription_schedule',
+  attributes: {
+    external_ref?: string,
+    name?: string,
+    specification: string,
+    location: string,
+    job: {
+      job_type: SubscriptionJob['attributes']['job_type']
+    }
+  }
+}
+
+export interface SubscriptionSchedule extends Identifiable, SubscriptionScheduleBase {
+  attributes: SubscriptionScheduleBase['attributes'] & {
+    updated_at: string
+    created_at: string
+  }
+  meta: {
+    scheduled_for: string,
+    owner: 'store' | 'organization',
+    timestamps: {
+      updated_at: string,
+      created_at: string,
+    }
+  }
+}
+
+export type SubscriptionScheduleCreate = SubscriptionScheduleBase
+export type SubscriptionScheduleUpdate = Omit<SubscriptionSchedule, 'attributes'> & {attributes: Partial<SubscriptionSchedule['attributes']>}
+
+/**
+ * Subscription Schedule Endpoints
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionSchedulesEndpoint
+  extends CrudQueryableResource<
+    SubscriptionSchedule,
+    SubscriptionScheduleCreate,
+    SubscriptionScheduleUpdate,
+    never,
+    never,
+    never
+    > {
+  endpoint: 'schedules'
+}