feat: added subscription dunning rules endpoint (#935)

Author: rostyk-kanafotskyy

src/endpoints/subscription-dunning-rules.js

@@ -0,0 +1,29 @@
+import CRUDExtend from '../extends/crud'
+
+class SubscriptionDunningRulesEndpoint extends CRUDExtend {
+  constructor(endpoint) {
+    super(endpoint)
+
+    this.endpoint = 'subscriptions/dunning-rules'
+  }
+
+  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 SubscriptionDunningRulesEndpoint

src/moltin.d.ts

@@ -65,6 +65,7 @@ import { SubscriptionSubscribersEndpoint } from './types/subscription-subscriber
 import { SubscriptionJobsEndpoint } from './types/subscription-jobs'
 import { SubscriptionSchedulesEndpoint } from './types/subscription-schedules'
 import { CustomApisEndpoint } from './types/custom-apis'
+import { SubscriptionDunningRulesEndpoint } from './types/subscription-dunning-rules'
 
 export * from './types/config'
 export * from './types/storage'
@@ -140,6 +141,7 @@ export * from './types/subscription-subscribers'
 export * from './types/subscription-jobs'
 export * from './types/subscription-schedules'
 export * from './types/custom-apis'
+export * from './types/subscription-dunning-rules'
 
 // UMD
 export as namespace moltin
@@ -206,6 +208,7 @@ export class Moltin {
   SubscriptionJobs : SubscriptionJobsEndpoint
   SubscriptionSchedules: SubscriptionSchedulesEndpoint
   CustomApis: CustomApisEndpoint
+  SubscriptionDunningRules: SubscriptionDunningRulesEndpoint
 
   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

@@ -56,6 +56,7 @@ 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 SubscriptionDunningRulesEndpoint from './endpoints/subscription-dunning-rules'
 
 import {cartIdentifier, tokenInvalid, getCredentials, resolveCredentialsStorageKey} from './utils/helpers'
 import CatalogsEndpoint from './endpoints/catalogs'
@@ -132,6 +133,7 @@ export default class Moltin {
     this.SubscriptionJobs = new SubscriptionJobsEndpoint(config)
     this.SubscriptionSchedules = new SubscriptionSchedulesEndpoint(config)
     this.CustomApis = new CustomApisEndpoint(config)
+    this.SubscriptionDunningRules = new SubscriptionDunningRulesEndpoint(config)
   }
 
   // Expose `Cart` class on Moltin class

src/types/subscription-dunning-rules.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Subscription Dunning Rules
+ * Description: Subscription Dunning Rules.
+ * DOCS: TODO: add docs when ready
+ */
+import {
+  Identifiable,
+  CrudQueryableResource
+} from './core'
+
+/**
+ * Core Subscription Dunning Rules Base Interface
+ * For custom flows, extend this interface
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionDunningRulesBase {
+  type: 'subscription_dunning_rule'
+  attributes: {
+    payment_retry_type:  'fixed' | 'backoff' | 'tiered'
+    payment_retry_interval?: number
+    payment_retry_unit?: 'day' | 'week'
+    payment_retry_multiplier?: number
+    payment_retries_limit: number
+    action: 'none' | 'pause' | 'close'
+    default?: boolean
+  }
+}
+
+export interface SubscriptionDunningRules extends Identifiable, SubscriptionDunningRulesBase {
+  meta: {
+    owner: 'store' | 'organization'
+    timestamps: {
+      updated_at: string
+      created_at: string
+    }
+  }
+}
+
+export type SubscriptionDunningRulesCreate = SubscriptionDunningRulesBase
+export type SubscriptionDunningRulesUpdate = Identifiable & Omit<SubscriptionDunningRulesBase, 'attributes'> & {attributes: Partial<SubscriptionDunningRules['attributes']>}
+
+/**
+ * Subscription Dunning Rules Endpoints
+ * DOCS: TODO: add docs when ready
+ */
+export interface SubscriptionDunningRulesEndpoint
+  extends CrudQueryableResource<
+    SubscriptionDunningRules,
+    SubscriptionDunningRulesCreate,
+    SubscriptionDunningRulesUpdate,
+    never,
+    never,
+    never
+    > {
+  endpoint: 'dunning-rules'
+}