New base headers x-accept-version and relationships update for Create Application Form (#471)

* feat: new base headers x-accept-version and relationships update for Create Application Form

* feat: test to verify that providing version header changes the response

Author: YegorZh

resources/baseResource.ts

@@ -22,8 +22,10 @@ export class BaseResource {
         this.headers = {
             "Authorization": `Bearer ${token}`,
             "Content-Type": "application/vnd.api+json",
-            "X-UNIT-SDK": `unit-node-sdk@v${version}`
+            "X-UNIT-SDK": `unit-node-sdk@v${version}`,
         }
+         
+        if(config?.apiVersion) this.headers["X-Accept-Version"] = config?.apiVersion
 
         this.axios = config?.axios ?? axiosStatic
     }

tests/applicationForms.spec.ts

@@ -1,10 +1,11 @@
 
 
-import { ApplicationFormPrefill, Unit } from "../unit"
+import { ApiVersion, ApplicationFormPrefill, CreateApplicationForm, Unit } from "../unit"
 
 import dotenv from "dotenv"
 dotenv.config()
 const unit = new Unit(process.env.UNIT_TOKEN || "test", process.env.UNIT_API_URL || "test")
+const unitWithVersion = new Unit(process.env.UNIT_TOKEN || "test", process.env.UNIT_API_URL || "test", {apiVersion: ApiVersion.V2024_06})
 
 
 describe("ApplicationForms", () => {
@@ -25,6 +26,26 @@ describe("ApplicationForms", () => {
         })
     })
 
+    test("Create Application Form", async () => {
+      const req: CreateApplicationForm = {
+        type: "applicationForm",
+        attributes: {},
+        relationships: {}
+      }
+      const res = await unit.applicationForms.create(req)
+      expect(res.data.type === "applicationForm")
+    })
+
+    test("Create White-Label Application Form", async () => {
+      const req: CreateApplicationForm = {
+        type: "applicationForm",
+        attributes: {},
+        relationships: {}
+      }
+      const res = await unitWithVersion.applicationForms.create(req)
+      expect(res.data.type === "applicationFormV2")
+    })
+
     test("Test ApplicationFormPrefill Interface", () => {
         const applicationFormPrefill: ApplicationFormPrefill = {
             "applicationType": "Business",

tests/applications.spec.ts

@@ -1,14 +1,12 @@
 
 
 import { createAddress, createFullName, createPhone } from "../helpers"
-import { Agent, BusinessApplication, CancelApplicationRequest, CreateBusinessApplicationRequest, CreateIndividualApplicationRequest, CreateSoleProprietorApplicationRequest, CreateTrustApplicationRequest, IndividualApplication, PatchApplicationRequest, PatchBusinessApplicationAttributes, PatchBusinessApplicationBeneficialOwner, RelationshipsArrayData, TrustApplication, Unit, VerifyDocumentRequest } from "../unit"
+import { Agent, BusinessApplication, CancelApplicationRequest, CreateBusinessApplicationRequest, CreateIndividualApplicationRequest, CreateSoleProprietorApplicationRequest, CreateTrustApplicationRequest, IndividualApplication, PatchApplicationRequest, PatchBusinessApplicationAttributes, PatchBusinessApplicationBeneficialOwner, RelationshipsArrayData, TrustApplication, Unit } from "../unit"
 import {
     createIndividualApplication,
     createBusinessApplication,
     createTrustApplication,
-    createIndividualApplicationWithRequiredDocument,
-    createVerifyDocumentRequest,
-    createIndividualApplicationWithSelfieVerification
+    createIndividualApplicationWithRequiredDocument
 } from "./testHelpers"
 import dotenv from "dotenv"
 import * as fs from "fs"

types/applicationForm.ts

@@ -15,9 +15,9 @@ export type ApplicationFormStage =
     "SoleProprietorshipPhoneVerification" |
     "SoleProprietorshipApplicationCreated"
 
-export interface CreateApplicationFormRequest {
-    "type": "applicationForm"
-    "attributes": {
+export interface CreateApplicationForm {
+    type: "applicationForm"
+    attributes: {
         /**
          * See [Tags](https://developers.unit.co/#tags). Tags that will be copied to the customer that this application creates(see [Tag Inheritance](https://developers.unit.co/#tag-inheritance)).
          */
@@ -37,19 +37,45 @@ export interface CreateApplicationFormRequest {
     }
     relationships?: {
         /**
-         * See [Create an Application Form from an existing Application](https://developers.unit.co/application-forms/#create-an-application-form-from-an-existing-application)
+         * Optional. The ID of the white-label theme to be used for this application form. See [White-Labeling and Customization](https://www.unit.co/docs/white-label-uis/white-label-application-form/#white-labeling-and-customization).
+         */
+        whiteLabelTheme?: {
+            data: {
+                type: "whiteLabelTheme"
+                id: string
+            }
+        }
+         /**
+         * Optional. The ID of the lending program to be used for this application form. See [Create Application Form with Credit Application](https://www.unit.co/docs/white-label-uis/white-label-application-form/#create-application-form-with-credit-application) for more information.
          */
-        application?: {
+        lendingProgram?: {
             data: {
-                type: "application"
+                type: "lendingProgram"
                 id: string
             }
         }
     }
 }
 
-export interface CreateApplicationFormResponse {
-    "type": "applicationForm"
+export interface CreateApplicationFormFromAnExistingApplication {
+    type: "applicationForm"
+    attributes: Record<string, never>
+    relationships?: {
+    /**
+     * See [Create an Application Form from an existing Application](https://developers.unit.co/application-forms/#create-an-application-form-from-an-existing-application)
+     */
+    application?: {
+        data: {
+            type: "application"
+            id: string
+        }
+    }}
+}
+
+export type CreateApplicationFormRequest = CreateApplicationForm | CreateApplicationFormFromAnExistingApplication 
+
+export type CreateApplicationFormResponseDefault = {
+    type: "applicationForm"
     "id": string
     "attributes": {
         /**
@@ -84,6 +110,10 @@ export interface CreateApplicationFormResponse {
     }
 }
 
+export type CreateApplicationFormResponseV2 = { type: "applicationFormV2"; }
+
+export type CreateApplicationFormResponse = CreateApplicationFormResponseDefault | CreateApplicationFormResponseV2
+
 export interface ApplicationFormPrefill {
     /**
      * Optional. One of "Individual", "Business" or "SoleProprietorship".

types/common.ts

@@ -484,10 +484,15 @@ export interface BaseCreateRequestAttributes {
     idempotencyKey?: string
 }
 
+export enum ApiVersion {
+    V2024_06 = "V2024_06"
+}
+
 export interface UnitConfig {
     axios?: AxiosInstance
     sdkUserAgent?: boolean
     securePath?: string
+    apiVersion?: ApiVersion | string
 }
 
 export class UnitError extends Error {