@financeable/aggregation 0.11.0 → 0.12.0

package/src/models/operations/index.ts

@@ -3,4 +3,6 @@
  */
 
 export * from "./createapplication.js";
+export * from "./getapplication.js";
+export * from "./listapplications.js";
 export * from "./supportingdocumentscreate.js";

package/src/models/operations/listapplications.ts

@@ -0,0 +1,364 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListApplicationsRequest = {
+  pageNumber?: number | undefined;
+  pageSize?: number | undefined;
+};
+
+/**
+ * The server cannot find the requested resource.
+ */
+export type ListApplicationsApplicationsResponseResponseBody = {
+  errors: Array<components.ResourceNotFound>;
+};
+
+/**
+ * Access is forbidden.
+ */
+export type ListApplicationsApplicationsResponseBody = {
+  errors: Array<components.ForbiddenError>;
+};
+
+/**
+ * The request has succeeded.
+ */
+export type ListApplicationsResponseBody = {
+  data: Array<components.ApplicationResource>;
+  links?: components.PaginationLinks | undefined;
+  meta?: components.PaginationMeta | undefined;
+};
+
+export type ListApplicationsResponse =
+  | ListApplicationsResponseBody
+  | ListApplicationsApplicationsResponseBody
+  | ListApplicationsApplicationsResponseResponseBody;
+
+/** @internal */
+export const ListApplicationsRequest$inboundSchema: z.ZodType<
+  ListApplicationsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "page[number]": z.number().int().optional(),
+  "page[size]": z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page[number]": "pageNumber",
+    "page[size]": "pageSize",
+  });
+});
+
+/** @internal */
+export type ListApplicationsRequest$Outbound = {
+  "page[number]"?: number | undefined;
+  "page[size]"?: number | undefined;
+};
+
+/** @internal */
+export const ListApplicationsRequest$outboundSchema: z.ZodType<
+  ListApplicationsRequest$Outbound,
+  z.ZodTypeDef,
+  ListApplicationsRequest
+> = z.object({
+  pageNumber: z.number().int().optional(),
+  pageSize: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageNumber: "page[number]",
+    pageSize: "page[size]",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListApplicationsRequest$ {
+  /** @deprecated use `ListApplicationsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListApplicationsRequest$inboundSchema;
+  /** @deprecated use `ListApplicationsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListApplicationsRequest$outboundSchema;
+  /** @deprecated use `ListApplicationsRequest$Outbound` instead. */
+  export type Outbound = ListApplicationsRequest$Outbound;
+}
+
+export function listApplicationsRequestToJSON(
+  listApplicationsRequest: ListApplicationsRequest,
+): string {
+  return JSON.stringify(
+    ListApplicationsRequest$outboundSchema.parse(listApplicationsRequest),
+  );
+}
+
+export function listApplicationsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListApplicationsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListApplicationsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListApplicationsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListApplicationsApplicationsResponseResponseBody$inboundSchema:
+  z.ZodType<
+    ListApplicationsApplicationsResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    errors: z.array(components.ResourceNotFound$inboundSchema),
+  });
+
+/** @internal */
+export type ListApplicationsApplicationsResponseResponseBody$Outbound = {
+  errors: Array<components.ResourceNotFound$Outbound>;
+};
+
+/** @internal */
+export const ListApplicationsApplicationsResponseResponseBody$outboundSchema:
+  z.ZodType<
+    ListApplicationsApplicationsResponseResponseBody$Outbound,
+    z.ZodTypeDef,
+    ListApplicationsApplicationsResponseResponseBody
+  > = z.object({
+    errors: z.array(components.ResourceNotFound$outboundSchema),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListApplicationsApplicationsResponseResponseBody$ {
+  /** @deprecated use `ListApplicationsApplicationsResponseResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    ListApplicationsApplicationsResponseResponseBody$inboundSchema;
+  /** @deprecated use `ListApplicationsApplicationsResponseResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    ListApplicationsApplicationsResponseResponseBody$outboundSchema;
+  /** @deprecated use `ListApplicationsApplicationsResponseResponseBody$Outbound` instead. */
+  export type Outbound =
+    ListApplicationsApplicationsResponseResponseBody$Outbound;
+}
+
+export function listApplicationsApplicationsResponseResponseBodyToJSON(
+  listApplicationsApplicationsResponseResponseBody:
+    ListApplicationsApplicationsResponseResponseBody,
+): string {
+  return JSON.stringify(
+    ListApplicationsApplicationsResponseResponseBody$outboundSchema.parse(
+      listApplicationsApplicationsResponseResponseBody,
+    ),
+  );
+}
+
+export function listApplicationsApplicationsResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListApplicationsApplicationsResponseResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListApplicationsApplicationsResponseResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListApplicationsApplicationsResponseResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListApplicationsApplicationsResponseBody$inboundSchema: z.ZodType<
+  ListApplicationsApplicationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  errors: z.array(components.ForbiddenError$inboundSchema),
+});
+
+/** @internal */
+export type ListApplicationsApplicationsResponseBody$Outbound = {
+  errors: Array<components.ForbiddenError$Outbound>;
+};
+
+/** @internal */
+export const ListApplicationsApplicationsResponseBody$outboundSchema: z.ZodType<
+  ListApplicationsApplicationsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListApplicationsApplicationsResponseBody
+> = z.object({
+  errors: z.array(components.ForbiddenError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListApplicationsApplicationsResponseBody$ {
+  /** @deprecated use `ListApplicationsApplicationsResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    ListApplicationsApplicationsResponseBody$inboundSchema;
+  /** @deprecated use `ListApplicationsApplicationsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    ListApplicationsApplicationsResponseBody$outboundSchema;
+  /** @deprecated use `ListApplicationsApplicationsResponseBody$Outbound` instead. */
+  export type Outbound = ListApplicationsApplicationsResponseBody$Outbound;
+}
+
+export function listApplicationsApplicationsResponseBodyToJSON(
+  listApplicationsApplicationsResponseBody:
+    ListApplicationsApplicationsResponseBody,
+): string {
+  return JSON.stringify(
+    ListApplicationsApplicationsResponseBody$outboundSchema.parse(
+      listApplicationsApplicationsResponseBody,
+    ),
+  );
+}
+
+export function listApplicationsApplicationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListApplicationsApplicationsResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListApplicationsApplicationsResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListApplicationsApplicationsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListApplicationsResponseBody$inboundSchema: z.ZodType<
+  ListApplicationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(components.ApplicationResource$inboundSchema),
+  links: components.PaginationLinks$inboundSchema.optional(),
+  meta: components.PaginationMeta$inboundSchema.optional(),
+});
+
+/** @internal */
+export type ListApplicationsResponseBody$Outbound = {
+  data: Array<components.ApplicationResource$Outbound>;
+  links?: components.PaginationLinks$Outbound | undefined;
+  meta?: components.PaginationMeta$Outbound | undefined;
+};
+
+/** @internal */
+export const ListApplicationsResponseBody$outboundSchema: z.ZodType<
+  ListApplicationsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListApplicationsResponseBody
+> = z.object({
+  data: z.array(components.ApplicationResource$outboundSchema),
+  links: components.PaginationLinks$outboundSchema.optional(),
+  meta: components.PaginationMeta$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListApplicationsResponseBody$ {
+  /** @deprecated use `ListApplicationsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListApplicationsResponseBody$inboundSchema;
+  /** @deprecated use `ListApplicationsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListApplicationsResponseBody$outboundSchema;
+  /** @deprecated use `ListApplicationsResponseBody$Outbound` instead. */
+  export type Outbound = ListApplicationsResponseBody$Outbound;
+}
+
+export function listApplicationsResponseBodyToJSON(
+  listApplicationsResponseBody: ListApplicationsResponseBody,
+): string {
+  return JSON.stringify(
+    ListApplicationsResponseBody$outboundSchema.parse(
+      listApplicationsResponseBody,
+    ),
+  );
+}
+
+export function listApplicationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListApplicationsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListApplicationsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListApplicationsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListApplicationsResponse$inboundSchema: z.ZodType<
+  ListApplicationsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => ListApplicationsResponseBody$inboundSchema),
+  z.lazy(() => ListApplicationsApplicationsResponseBody$inboundSchema),
+  z.lazy(() => ListApplicationsApplicationsResponseResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type ListApplicationsResponse$Outbound =
+  | ListApplicationsResponseBody$Outbound
+  | ListApplicationsApplicationsResponseBody$Outbound
+  | ListApplicationsApplicationsResponseResponseBody$Outbound;
+
+/** @internal */
+export const ListApplicationsResponse$outboundSchema: z.ZodType<
+  ListApplicationsResponse$Outbound,
+  z.ZodTypeDef,
+  ListApplicationsResponse
+> = z.union([
+  z.lazy(() => ListApplicationsResponseBody$outboundSchema),
+  z.lazy(() => ListApplicationsApplicationsResponseBody$outboundSchema),
+  z.lazy(() => ListApplicationsApplicationsResponseResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListApplicationsResponse$ {
+  /** @deprecated use `ListApplicationsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListApplicationsResponse$inboundSchema;
+  /** @deprecated use `ListApplicationsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListApplicationsResponse$outboundSchema;
+  /** @deprecated use `ListApplicationsResponse$Outbound` instead. */
+  export type Outbound = ListApplicationsResponse$Outbound;
+}
+
+export function listApplicationsResponseToJSON(
+  listApplicationsResponse: ListApplicationsResponse,
+): string {
+  return JSON.stringify(
+    ListApplicationsResponse$outboundSchema.parse(listApplicationsResponse),
+  );
+}
+
+export function listApplicationsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListApplicationsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListApplicationsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListApplicationsResponse' from JSON`,
+  );
+}

package/src/sdk/applications.ts

@@ -3,6 +3,8 @@
  */
 
 import { applicationsCreate } from "../funcs/applicationsCreate.js";
+import { applicationsGet } from "../funcs/applicationsGet.js";
+import { applicationsList } from "../funcs/applicationsList.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
@@ -21,4 +23,32 @@ export class Applications extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List all applications from the tenant. This endpoint does not support the 'include' query parameter; relationships must be fetched via the 'Get Application' endpoint.
+   */
+  async list(
+    request: operations.ListApplicationsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListApplicationsResponse> {
+    return unwrapAsync(applicationsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a specific application from the Financeable platform.
+   */
+  async get(
+    request: operations.GetApplicationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetApplicationResponse> {
+    return unwrapAsync(applicationsGet(
+      this,
+      request,
+      options,
+    ));
+  }
 }