@kanda-libs/ks-component-ts 0.2.240-qa3 → 0.2.241

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kanda-libs/ks-component-ts",
-  "version": "0.2.240-qa3",
+  "version": "0.2.241",
   "description": "Kanda form component library",
   "main": "dist/index.esm.js",
   "module": "dist/index.esm.js",
@@ -38,7 +38,7 @@
   "author": "rob@kanda.co.uk",
   "license": "MIT",
   "devDependencies": {
-    "@kanda-libs/ks-amplitude-provider": "0.0.17-qa2",
+    "@kanda-libs/ks-amplitude-provider": "0.0.17",
     "@kanda-libs/ks-design-library": "0.2.70",
     "@kanda-libs/ks-frontend-services": "0.2.140",
     "@types/browser-image-compression": "^1.0.9",

package/src/generated/components/schemas/Credit.ts

@@ -48,6 +48,7 @@ export const Credit = t.intersection([
     credit_documents: t.array(Document),
     signature: Signature,
     flow_type: FlowType,
+    quoted_to: t.string,
     metadata: Metadata,
   }),
 ]);
@@ -84,5 +85,6 @@ export interface Credit {
   credit_documents?: Array<Document>;
   signature?: Signature;
   flow_type?: FlowType;
+  quoted_to?: string;
   metadata?: Metadata;
 }

package/src/generated/components/schemas/FinanceRate.ts

@@ -13,6 +13,7 @@ export const FinanceRate = t.intersection([
     provider: FinanceProvider,
   }),
   t.partial({
+    credit_line: t.number,
     min_charge: t.number,
     apr_type: t.union([
       t.literal("INTEREST_FREE"),
@@ -34,6 +35,7 @@ export const FinanceRate = t.intersection([
 
 export interface FinanceRate {
   name: string;
+  credit_line?: number;
   fee: number;
   charge: number;
   min_charge?: number;

package/src/generated/components/schemas/Job.ts

@@ -54,6 +54,7 @@ export const Job = t.intersection([
     sat_note: SatNote,
     job_type: t.union([t.literal("standard"), t.literal("solar")]),
     flow_type: FlowType,
+    quoted_to: t.string,
     job_documents: t.array(Document),
     xid: t.string,
     xref: t.string,
@@ -87,6 +88,7 @@ export interface Job {
   sat_note?: SatNote;
   job_type?: "standard" | "solar";
   flow_type?: FlowType;
+  quoted_to?: string;
   job_documents?: Array<Document>;
   xid?: string;
   xref?: string;

package/src/generated/components/schemas/Lead.ts

@@ -0,0 +1,61 @@
+import * as t from "io-ts";
+import { DateFromISOString } from "io-ts-types/DateFromISOString";
+import { FinanceRate } from "./FinanceRate";
+import { FlowType } from "./FlowType";
+import { LeadApplicant } from "./LeadApplicant";
+import { LeadQuote } from "./LeadQuote";
+import { Metadata } from "./Metadata";
+import { Money } from "./Money";
+
+export const Lead = t.intersection([
+  t.type({
+    expired_at: DateFromISOString,
+    status: t.union([
+      t.literal("open"),
+      t.literal("credit_declined"),
+      t.literal("quote_declined"),
+      t.literal("trade_accepted"),
+      t.literal("trade_declined"),
+      t.literal("expired"),
+      t.literal("closed"),
+    ]),
+  }),
+  t.partial({
+    id: t.string,
+    cid: t.string,
+    oid: t.string,
+    aid: t.string,
+    lead_applicant: LeadApplicant,
+    lead_quote: LeadQuote,
+    finance_options: t.array(FinanceRate),
+    max_credit_amount: Money,
+    xid: t.string,
+    xref: t.string,
+    flow_type: FlowType,
+    metadata: Metadata,
+  }),
+]);
+
+export interface Lead {
+  id?: string;
+  cid?: string;
+  oid?: string;
+  aid?: string;
+  lead_applicant?: LeadApplicant;
+  lead_quote?: LeadQuote;
+  finance_options?: Array<FinanceRate>;
+  max_credit_amount?: Money;
+  expired_at: Date;
+  xid?: string;
+  xref?: string;
+  status:
+    | "open"
+    | "credit_declined"
+    | "quote_declined"
+    | "trade_accepted"
+    | "trade_declined"
+    | "expired"
+    | "closed";
+  flow_type?: FlowType;
+  metadata?: Metadata;
+}

package/src/generated/components/schemas/LeadApplicant.ts

@@ -0,0 +1,16 @@
+import * as t from "io-ts";
+import { CustomerDetails } from "./CustomerDetails";
+import { EmploymentDetails } from "./EmploymentDetails";
+import { FinanceDetails } from "./FinanceDetails";
+
+export const LeadApplicant = t.type({
+  customer_details: CustomerDetails,
+  employment_details: EmploymentDetails,
+  finance_details: FinanceDetails,
+});
+
+export interface LeadApplicant {
+  customer_details: CustomerDetails;
+  employment_details: EmploymentDetails;
+  finance_details: FinanceDetails;
+}

package/src/generated/components/schemas/LeadQuote.ts

@@ -0,0 +1,39 @@
+import * as t from "io-ts";
+import { FinanceRate } from "./FinanceRate";
+import { Money } from "./Money";
+import { WorkType } from "./WorkType";
+
+export const LeadQuote = t.intersection([
+  t.type({
+    finance_option: FinanceRate,
+    work_type: WorkType,
+    work_finished_by: t.union([
+      t.literal("as soon as possible"),
+      t.literal("within 1 month"),
+      t.literal("within 3 months"),
+      t.literal("within 6 months"),
+      t.literal("over 6 months"),
+    ]),
+    description: t.string,
+  }),
+  t.partial({
+    cash_amount: Money,
+    credit_amount: Money,
+    budget: Money,
+  }),
+]);
+
+export interface LeadQuote {
+  finance_option: FinanceRate;
+  work_type: WorkType;
+  cash_amount?: Money;
+  credit_amount?: Money;
+  budget?: Money;
+  work_finished_by:
+    | "as soon as possible"
+    | "within 1 month"
+    | "within 3 months"
+    | "within 6 months"
+    | "over 6 months";
+  description: string;
+}

package/src/generated/components/schemas/Payment.ts

@@ -25,6 +25,7 @@ export const Payment = t.intersection([
       t.literal("refunded"),
     ]),
     flow_type: FlowType,
+    quoted_to: t.string,
     metadata: Metadata,
   }),
 ]);
@@ -47,5 +48,6 @@ export interface Payment {
     | "cancelled"
     | "refunded";
   flow_type?: FlowType;
+  quoted_to?: string;
   metadata?: Metadata;
 }

package/src/generated/components/schemas/index.ts

@@ -56,6 +56,9 @@ export * from "./JobCompanyInfo";
 export * from "./JobCreditState";
 export * from "./JobItem";
 export * from "./JobOverride";
+export * from "./Lead";
+export * from "./LeadApplicant";
+export * from "./LeadQuote";
 export * from "./LimitedCompanyInfo";
 export * from "./Metadata";
 export * from "./Money";

package/src/generated/operations/deleteLead.ts

@@ -0,0 +1,29 @@
+import type { RequestFunction } from "@openapi-io-ts/runtime";
+import * as schemas from "../components/schemas";
+
+export type DeleteLeadRequestParameters = {
+  id: string;
+};
+
+export const deleteLeadOperation = {
+  path: "/api/lead/{id}",
+  method: "delete",
+  responses: {
+    "200": { _tag: "JsonResponse", decoder: schemas.Lead },
+    default: { _tag: "JsonResponse", decoder: schemas.Error },
+  },
+  parameters: [
+    {
+      _tag: "FormParameter",
+      explode: false,
+      in: "path",
+      name: "id",
+    },
+  ],
+  requestDefaultHeaders: { Accept: "application/json" },
+} as const;
+
+export type DeleteLeadRequestFunction = RequestFunction<
+  { params: DeleteLeadRequestParameters },
+  schemas.Lead
+>;

package/src/generated/operations/getLead.ts

@@ -0,0 +1,29 @@
+import type { RequestFunction } from "@openapi-io-ts/runtime";
+import * as schemas from "../components/schemas";
+
+export type GetLeadRequestParameters = {
+  id: string;
+};
+
+export const getLeadOperation = {
+  path: "/api/lead/{id}",
+  method: "get",
+  responses: {
+    "200": { _tag: "JsonResponse", decoder: schemas.Lead },
+    default: { _tag: "JsonResponse", decoder: schemas.Error },
+  },
+  parameters: [
+    {
+      _tag: "FormParameter",
+      explode: false,
+      in: "path",
+      name: "id",
+    },
+  ],
+  requestDefaultHeaders: { Accept: "application/json" },
+} as const;
+
+export type GetLeadRequestFunction = RequestFunction<
+  { params: GetLeadRequestParameters },
+  schemas.Lead
+>;

package/src/generated/operations/getLeads.ts

@@ -0,0 +1,25 @@
+import type { RequestFunction } from "@openapi-io-ts/runtime";
+import * as t from "io-ts";
+import * as parameters from "../components/parameters";
+import * as schemas from "../components/schemas";
+
+export type GetLeadsRequestParameters = {
+  format?: "reduced" | "full";
+  q?: string;
+};
+
+export const getLeadsOperation = {
+  path: "/api/lead",
+  method: "get",
+  responses: {
+    "200": { _tag: "JsonResponse", decoder: t.array(schemas.Lead) },
+    default: { _tag: "JsonResponse", decoder: schemas.Error },
+  },
+  parameters: [parameters.format, parameters.q],
+  requestDefaultHeaders: { Accept: "application/json" },
+} as const;
+
+export type GetLeadsRequestFunction = RequestFunction<
+  { params: GetLeadsRequestParameters },
+  Array<schemas.Lead>
+>;

package/src/generated/operations/index.ts

@@ -42,6 +42,7 @@ import {
   DeleteDocumentRequestFunction,
 } from "./deleteDocument";
 import { deleteJobOperation, DeleteJobRequestFunction } from "./deleteJob";
+import { deleteLeadOperation, DeleteLeadRequestFunction } from "./deleteLead";
 import {
   deleteMonitorOperation,
   DeleteMonitorRequestFunction,
@@ -92,6 +93,8 @@ import {
 } from "./getInfoEntity";
 import { getJobOperation, GetJobRequestFunction } from "./getJob";
 import { getJobsOperation, GetJobsRequestFunction } from "./getJobs";
+import { getLeadOperation, GetLeadRequestFunction } from "./getLead";
+import { getLeadsOperation, GetLeadsRequestFunction } from "./getLeads";
 import { getMonitorOperation, GetMonitorRequestFunction } from "./getMonitor";
 import {
   getMonitorsOperation,
@@ -228,6 +231,7 @@ import {
 } from "./postDocument";
 import { postEventOperation, PostEventRequestFunction } from "./postEvent";
 import { postJobOperation, PostJobRequestFunction } from "./postJob";
+import { postLeadOperation, PostLeadRequestFunction } from "./postLead";
 import { postMeOperation, PostMeRequestFunction } from "./postMe";
 import {
   postMonitorOperation,
@@ -277,6 +281,7 @@ import {
   PutDocumentRequestFunction,
 } from "./putDocument";
 import { putJobOperation, PutJobRequestFunction } from "./putJob";
+import { putLeadOperation, PutLeadRequestFunction } from "./putLead";
 import { putMeOperation, PutMeRequestFunction } from "./putMe";
 import { putMonitorOperation, PutMonitorRequestFunction } from "./putMonitor";
 import {
@@ -294,7 +299,9 @@ import {
   quoteCreditOperation,
   QuoteCreditRequestFunction,
 } from "./quoteCredit";
+import { quoteLeadOperation, QuoteLeadRequestFunction } from "./quoteLead";
 import { reapplyJobOperation, ReapplyJobRequestFunction } from "./reapplyJob";
+import { referLeadOperation, ReferLeadRequestFunction } from "./referLead";
 import { resendJobOperation, ResendJobRequestFunction } from "./resendJob";
 import { runnerOperation, RunnerRequestFunction } from "./runner";
 import { sendJobOperation, SendJobRequestFunction } from "./sendJob";
@@ -403,6 +410,13 @@ export const operations: Operations = {
   getDocument: getDocumentOperation,
   putDocument: putDocumentOperation,
   deleteDocument: deleteDocumentOperation,
+  getLeads: getLeadsOperation,
+  postLead: postLeadOperation,
+  getLead: getLeadOperation,
+  putLead: putLeadOperation,
+  deleteLead: deleteLeadOperation,
+  quoteLead: quoteLeadOperation,
+  referLead: referLeadOperation,
   getSubscriptions: getSubscriptionsOperation,
   postSubscription: postSubscriptionOperation,
   getSubscription: getSubscriptionOperation,
@@ -517,6 +531,13 @@ export interface OperationRequestFunctionMap {
   getDocument: GetDocumentRequestFunction;
   putDocument: PutDocumentRequestFunction;
   deleteDocument: DeleteDocumentRequestFunction;
+  getLeads: GetLeadsRequestFunction;
+  postLead: PostLeadRequestFunction;
+  getLead: GetLeadRequestFunction;
+  putLead: PutLeadRequestFunction;
+  deleteLead: DeleteLeadRequestFunction;
+  quoteLead: QuoteLeadRequestFunction;
+  referLead: ReferLeadRequestFunction;
   getSubscriptions: GetSubscriptionsRequestFunction;
   postSubscription: PostSubscriptionRequestFunction;
   getSubscription: GetSubscriptionRequestFunction;
@@ -720,6 +741,13 @@ export const requestFunctionsBuilder = (
     operations.deleteDocument,
     requestAdapter
   ),
+  getLeads: requestFunctionBuilder(operations.getLeads, requestAdapter),
+  postLead: requestFunctionBuilder(operations.postLead, requestAdapter),
+  getLead: requestFunctionBuilder(operations.getLead, requestAdapter),
+  putLead: requestFunctionBuilder(operations.putLead, requestAdapter),
+  deleteLead: requestFunctionBuilder(operations.deleteLead, requestAdapter),
+  quoteLead: requestFunctionBuilder(operations.quoteLead, requestAdapter),
+  referLead: requestFunctionBuilder(operations.referLead, requestAdapter),
   getSubscriptions: requestFunctionBuilder(
     operations.getSubscriptions,
     requestAdapter
@@ -985,6 +1013,18 @@ export const documentServiceBuilder = (
   deleteDocument: requestFunctions.deleteDocument,
 });
 
+export const leadServiceBuilder = (
+  requestFunctions: OperationRequestFunctionMap
+) => ({
+  getLeads: requestFunctions.getLeads,
+  postLead: requestFunctions.postLead,
+  getLead: requestFunctions.getLead,
+  putLead: requestFunctions.putLead,
+  deleteLead: requestFunctions.deleteLead,
+  quoteLead: requestFunctions.quoteLead,
+  referLead: requestFunctions.referLead,
+});
+
 export const subscriptionServiceBuilder = (
   requestFunctions: OperationRequestFunctionMap
 ) => ({
@@ -1117,6 +1157,13 @@ export interface Operations {
   getDocument: typeof getDocumentOperation;
   putDocument: typeof putDocumentOperation;
   deleteDocument: typeof deleteDocumentOperation;
+  getLeads: typeof getLeadsOperation;
+  postLead: typeof postLeadOperation;
+  getLead: typeof getLeadOperation;
+  putLead: typeof putLeadOperation;
+  deleteLead: typeof deleteLeadOperation;
+  quoteLead: typeof quoteLeadOperation;
+  referLead: typeof referLeadOperation;
   getSubscriptions: typeof getSubscriptionsOperation;
   postSubscription: typeof postSubscriptionOperation;
   getSubscription: typeof getSubscriptionOperation;

package/src/generated/operations/postLead.ts

@@ -0,0 +1,24 @@
+import type { RequestFunction } from "@openapi-io-ts/runtime";
+import * as schemas from "../components/schemas";
+
+export const postLeadOperation = {
+  path: "/api/lead",
+  method: "post",
+  responses: {
+    "200": { _tag: "JsonResponse", decoder: schemas.Lead },
+    default: { _tag: "JsonResponse", decoder: schemas.Error },
+  },
+  parameters: [],
+  requestDefaultHeaders: {
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  },
+  body: {
+    _tag: "JsonBody",
+  },
+} as const;
+
+export type PostLeadRequestFunction = RequestFunction<
+  { body: schemas.LeadApplicant },
+  schemas.Lead
+>;

package/src/generated/operations/putLead.ts

@@ -0,0 +1,35 @@
+import type { RequestFunction } from "@openapi-io-ts/runtime";
+import * as schemas from "../components/schemas";
+
+export type PutLeadRequestParameters = {
+  id: string;
+};
+
+export const putLeadOperation = {
+  path: "/api/lead/{id}",
+  method: "put",
+  responses: {
+    "200": { _tag: "JsonResponse", decoder: schemas.Lead },
+    default: { _tag: "JsonResponse", decoder: schemas.Error },
+  },
+  parameters: [
+    {
+      _tag: "FormParameter",
+      explode: false,
+      in: "path",
+      name: "id",
+    },
+  ],
+  requestDefaultHeaders: {
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  },
+  body: {
+    _tag: "JsonBody",
+  },
+} as const;
+
+export type PutLeadRequestFunction = RequestFunction<
+  { params: PutLeadRequestParameters; body: schemas.Lead },
+  schemas.Lead
+>;

package/src/generated/operations/quoteLead.ts

@@ -0,0 +1,35 @@
+import type { RequestFunction } from "@openapi-io-ts/runtime";
+import * as schemas from "../components/schemas";
+
+export type QuoteLeadRequestParameters = {
+  id: string;
+};
+
+export const quoteLeadOperation = {
+  path: "/api/lead/{id}/quote",
+  method: "post",
+  responses: {
+    "200": { _tag: "JsonResponse", decoder: schemas.Lead },
+    default: { _tag: "JsonResponse", decoder: schemas.Error },
+  },
+  parameters: [
+    {
+      _tag: "FormParameter",
+      explode: false,
+      in: "path",
+      name: "id",
+    },
+  ],
+  requestDefaultHeaders: {
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  },
+  body: {
+    _tag: "JsonBody",
+  },
+} as const;
+
+export type QuoteLeadRequestFunction = RequestFunction<
+  { params: QuoteLeadRequestParameters; body: schemas.LeadQuote },
+  schemas.Lead
+>;

package/src/generated/operations/referLead.ts

@@ -0,0 +1,44 @@
+import type { RequestFunction } from "@openapi-io-ts/runtime";
+import * as t from "io-ts";
+import * as schemas from "../components/schemas";
+
+export type ReferLeadRequestParameters = {
+  id: string;
+};
+
+export const ReferLeadRequestBodySchema = t.type({
+  cid: t.string,
+});
+
+export interface ReferLeadRequestBodySchema {
+  cid: string;
+}
+
+export const referLeadOperation = {
+  path: "/api/lead/{id}/refer",
+  method: "post",
+  responses: {
+    "200": { _tag: "JsonResponse", decoder: schemas.Lead },
+    default: { _tag: "JsonResponse", decoder: schemas.Error },
+  },
+  parameters: [
+    {
+      _tag: "FormParameter",
+      explode: false,
+      in: "path",
+      name: "id",
+    },
+  ],
+  requestDefaultHeaders: {
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  },
+  body: {
+    _tag: "JsonBody",
+  },
+} as const;
+
+export type ReferLeadRequestFunction = RequestFunction<
+  { params: ReferLeadRequestParameters; body: ReferLeadRequestBodySchema },
+  schemas.Lead
+>;