@financeable/aggregation 0.4.5 → 0.5.0

package/src/models/components/australianstatesandterritories.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const AustralianStatesAndTerritories = {
+  Sa: "SA",
+  Nsw: "NSW",
+  Vic: "VIC",
+  Qld: "QLD",
+  Wa: "WA",
+  Tas: "TAS",
+  Act: "ACT",
+  Nt: "NT",
+} as const;
+export type AustralianStatesAndTerritories = ClosedEnum<
+  typeof AustralianStatesAndTerritories
+>;
+
+/** @internal */
+export const AustralianStatesAndTerritories$inboundSchema: z.ZodNativeEnum<
+  typeof AustralianStatesAndTerritories
+> = z.nativeEnum(AustralianStatesAndTerritories);
+
+/** @internal */
+export const AustralianStatesAndTerritories$outboundSchema: z.ZodNativeEnum<
+  typeof AustralianStatesAndTerritories
+> = AustralianStatesAndTerritories$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AustralianStatesAndTerritories$ {
+  /** @deprecated use `AustralianStatesAndTerritories$inboundSchema` instead. */
+  export const inboundSchema = AustralianStatesAndTerritories$inboundSchema;
+  /** @deprecated use `AustralianStatesAndTerritories$outboundSchema` instead. */
+  export const outboundSchema = AustralianStatesAndTerritories$outboundSchema;
+}

package/src/models/components/entityattributes.ts

@@ -0,0 +1,130 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AustralianStatesAndTerritories,
+  AustralianStatesAndTerritories$inboundSchema,
+  AustralianStatesAndTerritories$outboundSchema,
+} from "./australianstatesandterritories.js";
+
+export type EntityAttributes = {
+  businessNames: Array<string>;
+  entityName: string;
+  abn: string;
+  acn: string;
+  state: AustralianStatesAndTerritories;
+  entityType?: string | undefined;
+  gst?: string | undefined;
+  abnStatus?: string | undefined;
+  /**
+   * in format YYYY-MM-DD
+   */
+  abnStatusEffectiveFrom?: string | undefined;
+  monthsInBusiness?: number | undefined;
+  turnover?: number | undefined;
+  industryType?: string | undefined;
+  ppsr?: string | undefined;
+  emails?: Array<string> | undefined;
+  phoneNumbers?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EntityAttributes$inboundSchema: z.ZodType<
+  EntityAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  businessNames: z.array(z.string()),
+  entityName: z.string(),
+  abn: z.string(),
+  acn: z.string(),
+  state: AustralianStatesAndTerritories$inboundSchema,
+  entityType: z.string().optional(),
+  gst: z.string().optional(),
+  abnStatus: z.string().optional(),
+  abnStatusEffectiveFrom: z.string().optional(),
+  monthsInBusiness: z.number().int().optional(),
+  turnover: z.number().int().optional(),
+  industryType: z.string().optional(),
+  ppsr: z.string().optional(),
+  emails: z.array(z.string()).optional(),
+  phoneNumbers: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type EntityAttributes$Outbound = {
+  businessNames: Array<string>;
+  entityName: string;
+  abn: string;
+  acn: string;
+  state: string;
+  entityType?: string | undefined;
+  gst?: string | undefined;
+  abnStatus?: string | undefined;
+  abnStatusEffectiveFrom?: string | undefined;
+  monthsInBusiness?: number | undefined;
+  turnover?: number | undefined;
+  industryType?: string | undefined;
+  ppsr?: string | undefined;
+  emails?: Array<string> | undefined;
+  phoneNumbers?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EntityAttributes$outboundSchema: z.ZodType<
+  EntityAttributes$Outbound,
+  z.ZodTypeDef,
+  EntityAttributes
+> = z.object({
+  businessNames: z.array(z.string()),
+  entityName: z.string(),
+  abn: z.string(),
+  acn: z.string(),
+  state: AustralianStatesAndTerritories$outboundSchema,
+  entityType: z.string().optional(),
+  gst: z.string().optional(),
+  abnStatus: z.string().optional(),
+  abnStatusEffectiveFrom: z.string().optional(),
+  monthsInBusiness: z.number().int().optional(),
+  turnover: z.number().int().optional(),
+  industryType: z.string().optional(),
+  ppsr: z.string().optional(),
+  emails: z.array(z.string()).optional(),
+  phoneNumbers: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EntityAttributes$ {
+  /** @deprecated use `EntityAttributes$inboundSchema` instead. */
+  export const inboundSchema = EntityAttributes$inboundSchema;
+  /** @deprecated use `EntityAttributes$outboundSchema` instead. */
+  export const outboundSchema = EntityAttributes$outboundSchema;
+  /** @deprecated use `EntityAttributes$Outbound` instead. */
+  export type Outbound = EntityAttributes$Outbound;
+}
+
+export function entityAttributesToJSON(
+  entityAttributes: EntityAttributes,
+): string {
+  return JSON.stringify(
+    EntityAttributes$outboundSchema.parse(entityAttributes),
+  );
+}
+
+export function entityAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityAttributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityAttributes' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -10,11 +10,13 @@ export * from "./applicationresourcebulksubmission.js";
 export * from "./applicationstatus.js";
 export * from "./applicationtype.js";
 export * from "./assetattributes.js";
+export * from "./australianstatesandterritories.js";
 export * from "./commercialassettype.js";
 export * from "./consumerassettype.js";
 export * from "./customerattributes.js";
 export * from "./customeridtype.js";
 export * from "./customertitle.js";
+export * from "./entityattributes.js";
 export * from "./errorsource.js";
 export * from "./forbiddenerror.js";
 export * from "./frequencytype.js";

package/src/models/components/tokenrequest.ts

@@ -29,11 +29,11 @@ export type TokenRequest = {
    */
   grantType: GrantType;
   /**
-   * The client ID
+   * The client ID issued to you, by Financeable, for service integration.
    */
   clientId: string;
   /**
-   * The client secret
+   * The client secret issued to you, by Financeable, for service integration.
    */
   clientSecret: string;
   /**