@financeable/aggregation 0.2.1 → 0.3.1

package/src/funcs/applicationsGet.ts

@@ -8,6 +8,7 @@ import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import { APIError } from "../models/errors/apierror.js";
 import {
@@ -20,16 +21,17 @@ import {
 import * as errors from "../models/errors/index.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
  * Retrieve an application by its ID
  */
-export async function applicationsGet(
+export function applicationsGet(
   client: FinanceableCore,
   request: operations.GetApplicationRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.GetApplicationResponseBody,
     | errors.GetApplicationResponseBody
@@ -41,6 +43,33 @@ export async function applicationsGet(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FinanceableCore,
+  request: operations.GetApplicationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetApplicationResponseBody,
+      | errors.GetApplicationResponseBody
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -48,7 +77,7 @@ export async function applicationsGet(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -66,14 +95,20 @@ export async function applicationsGet(
     Accept: "application/json",
   }));
 
+  const secConfig = await extractSecurity(client._options.clientCredentials);
+  const securityInput = secConfig == null
+    ? {}
+    : { clientCredentials: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
   const context = {
     baseURL: options?.serverURL ?? "",
     operationID: "getApplication",
     oAuth2Scopes: [],
 
-    resolvedSecurity: null,
+    resolvedSecurity: requestSecurity,
 
-    securitySource: null,
+    securitySource: client._options.clientCredentials,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -81,6 +116,7 @@ export async function applicationsGet(
   };
 
   const requestRes = client._createRequest(context, {
+    security: requestSecurity,
     method: "GET",
     baseURL: options?.serverURL,
     path: path,
@@ -89,7 +125,7 @@ export async function applicationsGet(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -100,7 +136,7 @@ export async function applicationsGet(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -125,8 +161,8 @@ export async function applicationsGet(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/applicationsList.ts

@@ -8,6 +8,7 @@ import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import { APIError } from "../models/errors/apierror.js";
 import {
@@ -20,16 +21,17 @@ import {
 import * as errors from "../models/errors/index.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
  * Retrieve a list of applications
  */
-export async function applicationsList(
+export function applicationsList(
   client: FinanceableCore,
   request: operations.GetApplicationsRequest,
   options?: RequestOptions,
-): Promise<
+): APIPromise<
   Result<
     operations.GetApplicationsResponseBody,
     | errors.GetApplicationsResponseBody
@@ -41,6 +43,33 @@ export async function applicationsList(
     | RequestTimeoutError
     | ConnectionError
   >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FinanceableCore,
+  request: operations.GetApplicationsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetApplicationsResponseBody,
+      | errors.GetApplicationsResponseBody
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
 > {
   const parsed = safeParse(
     request,
@@ -48,7 +77,7 @@ export async function applicationsList(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return parsed;
+    return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -63,14 +92,20 @@ export async function applicationsList(
     Accept: "application/json",
   }));
 
+  const secConfig = await extractSecurity(client._options.clientCredentials);
+  const securityInput = secConfig == null
+    ? {}
+    : { clientCredentials: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
   const context = {
     baseURL: options?.serverURL ?? "",
     operationID: "getApplications",
     oAuth2Scopes: [],
 
-    resolvedSecurity: null,
+    resolvedSecurity: requestSecurity,
 
-    securitySource: null,
+    securitySource: client._options.clientCredentials,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -78,6 +113,7 @@ export async function applicationsList(
   };
 
   const requestRes = client._createRequest(context, {
+    security: requestSecurity,
     method: "GET",
     baseURL: options?.serverURL,
     path: path,
@@ -87,7 +123,7 @@ export async function applicationsList(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return requestRes;
+    return [requestRes, { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -98,7 +134,7 @@ export async function applicationsList(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return doResult;
+    return [doResult, { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -123,8 +159,8 @@ export async function applicationsList(
     M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
-    return result;
+    return [result, { status: "complete", request: req, response }];
   }
 
-  return result;
+  return [result, { status: "complete", request: req, response }];
 }

package/src/funcs/getToken.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { FinanceableCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Obtain an OAuth client_credentials token
+ */
+export function getToken(
+  client: FinanceableCore,
+  request: components.TokenRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.TokenResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FinanceableCore,
+  request: components.TokenRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.TokenResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.TokenRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/oauth/token")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.clientCredentials);
+  const securityInput = secConfig == null
+    ? {}
+    : { clientCredentials: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? "",
+    operationID: "getToken",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.clientCredentials,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.TokenResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(201, components.TokenResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -11,10 +11,15 @@ import { Params, pathToFunc } from "./url.js";
  * Contains the list of servers available to the SDK
  */
 export const ServerList = [
+  /**
+   * Production Server
+   */
   "https://api.financeable.com.au",
 ] as const;
 
 export type SDKOptions = {
+  clientCredentials?: string | (() => Promise<string>);
+
   httpClient?: HTTPClient;
   /**
    * Allows overriding the default server used by the SDK
@@ -51,9 +56,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "0.2.0",
-  sdkVersion: "0.2.1",
-  genVersion: "2.512.0",
+  openapiDocVersion: "0.3.0",
+  sdkVersion: "0.3.1",
+  genVersion: "2.515.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.2.1 2.512.0 0.2.0 @financeable/aggregation",
+    "speakeasy-sdk/typescript 0.3.1 2.515.0 0.3.0 @financeable/aggregation",
 } as const;

package/src/lib/env.ts

@@ -7,10 +7,14 @@ import { dlv } from "./dlv.js";
 import * as z from "zod";
 
 export interface Env {
+  FINANCEABLE_CLIENT_CREDENTIALS?: string | undefined;
+
   FINANCEABLE_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
+  FINANCEABLE_CLIENT_CREDENTIALS: z.string().optional(),
+
   FINANCEABLE_DEBUG: z.coerce.boolean().optional(),
 });
 

package/src/lib/security.ts

@@ -2,6 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as components from "../models/components/index.js";
+import { env } from "./env.js";
 type OAuth2PasswordFlow = {
   username: string;
   password?: string | undefined;
@@ -225,3 +227,28 @@ function applyBearer(
 
   state.headers[spec.fieldName] = value;
 }
+
+export function resolveGlobalSecurity(
+  security: Partial<components.Security> | null | undefined,
+): SecurityState | null {
+  return resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "oauth2",
+        value: security?.clientCredentials
+          ?? env().FINANCEABLE_CLIENT_CREDENTIALS,
+      },
+    ],
+  );
+}
+
+export async function extractSecurity<
+  T extends string | Record<string, unknown>,
+>(sec: T | (() => Promise<T>) | undefined): Promise<T | undefined> {
+  if (sec == null) {
+    return;
+  }
+
+  return typeof sec === "function" ? sec() : sec;
+}

package/src/models/components/customerattributes.ts

@@ -3,29 +3,20 @@
  */
 
 import * as z from "zod";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomerIDType,
+  CustomerIDType$inboundSchema,
+  CustomerIDType$outboundSchema,
+} from "./customeridtype.js";
 import {
   CustomerTitle,
   CustomerTitle$inboundSchema,
   CustomerTitle$outboundSchema,
 } from "./customertitle.js";
 
-/**
- * Type of ID, either drivers' license or passport
- */
-export const IDType = {
-  Licence: "licence",
-  Passport: "passport",
-} as const;
-/**
- * Type of ID, either drivers' license or passport
- */
-export type IDType = ClosedEnum<typeof IDType>;
-
 /**
  * A customer of the proposed financing
  */
@@ -57,32 +48,13 @@ export type CustomerAttributes = {
   /**
    * Type of ID, either drivers' license or passport
    */
-  idType?: IDType | undefined;
+  idType?: CustomerIDType | undefined;
   /**
    * Number of the ID
    */
   idNumber?: string | undefined;
 };
 
-/** @internal */
-export const IDType$inboundSchema: z.ZodNativeEnum<typeof IDType> = z
-  .nativeEnum(IDType);
-
-/** @internal */
-export const IDType$outboundSchema: z.ZodNativeEnum<typeof IDType> =
-  IDType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace IDType$ {
-  /** @deprecated use `IDType$inboundSchema` instead. */
-  export const inboundSchema = IDType$inboundSchema;
-  /** @deprecated use `IDType$outboundSchema` instead. */
-  export const outboundSchema = IDType$outboundSchema;
-}
-
 /** @internal */
 export const CustomerAttributes$inboundSchema: z.ZodType<
   CustomerAttributes,
@@ -94,15 +66,9 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
   middleNames: z.string().optional(),
   lastName: z.string(),
   dateOfBirth: z.string(),
-  IDExpiryDate: z.string(),
-  IDType: IDType$inboundSchema.optional(),
-  IDNumber: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "IDExpiryDate": "idExpiryDate",
-    "IDType": "idType",
-    "IDNumber": "idNumber",
-  });
+  idExpiryDate: z.string(),
+  idType: CustomerIDType$inboundSchema.optional(),
+  idNumber: z.string().optional(),
 });
 
 /** @internal */
@@ -112,9 +78,9 @@ export type CustomerAttributes$Outbound = {
   middleNames?: string | undefined;
   lastName: string;
   dateOfBirth: string;
-  IDExpiryDate: string;
-  IDType?: string | undefined;
-  IDNumber?: string | undefined;
+  idExpiryDate: string;
+  idType?: string | undefined;
+  idNumber?: string | undefined;
 };
 
 /** @internal */
@@ -129,14 +95,8 @@ export const CustomerAttributes$outboundSchema: z.ZodType<
   lastName: z.string(),
   dateOfBirth: z.string(),
   idExpiryDate: z.string(),
-  idType: IDType$outboundSchema.optional(),
+  idType: CustomerIDType$outboundSchema.optional(),
   idNumber: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    idExpiryDate: "IDExpiryDate",
-    idType: "IDType",
-    idNumber: "IDNumber",
-  });
 });
 
 /**

package/src/models/components/customeridtype.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const CustomerIDType = {
+  Passport: "passport",
+  Licence: "licence",
+} as const;
+export type CustomerIDType = ClosedEnum<typeof CustomerIDType>;
+
+/** @internal */
+export const CustomerIDType$inboundSchema: z.ZodNativeEnum<
+  typeof CustomerIDType
+> = z.nativeEnum(CustomerIDType);
+
+/** @internal */
+export const CustomerIDType$outboundSchema: z.ZodNativeEnum<
+  typeof CustomerIDType
+> = CustomerIDType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerIDType$ {
+  /** @deprecated use `CustomerIDType$inboundSchema` instead. */
+  export const inboundSchema = CustomerIDType$inboundSchema;
+  /** @deprecated use `CustomerIDType$outboundSchema` instead. */
+  export const outboundSchema = CustomerIDType$outboundSchema;
+}

package/src/models/components/index.ts

@@ -11,6 +11,7 @@ export * from "./applicationstatus.js";
 export * from "./applicationtype.js";
 export * from "./assetattributes.js";
 export * from "./customerattributes.js";
+export * from "./customeridtype.js";
 export * from "./customertitle.js";
 export * from "./errorsource.js";
 export * from "./forbiddenerror.js";
@@ -18,3 +19,6 @@ export * from "./frequencytype.js";
 export * from "./links.js";
 export * from "./loandetailsattributes.js";
 export * from "./repaymentstructure.js";
+export * from "./security.js";
+export * from "./tokenrequest.js";
+export * from "./tokenresponse.js";