@oatfi/oatfi-sdk-ts 0.12.5 → 0.12.7

package/src/models/operations/purchasescontrollercreateoffer.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type PurchasesControllerCreateOfferRequest = {
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  /**
+   * Purchase offer creation data
+   */
+  createPurchaseOfferDto: models.CreatePurchaseOfferDto;
+};
+
+/** @internal */
+export type PurchasesControllerCreateOfferRequest$Outbound = {
+  "Idempotency-Key": string;
+  CreatePurchaseOfferDto: models.CreatePurchaseOfferDto$Outbound;
+};
+
+/** @internal */
+export const PurchasesControllerCreateOfferRequest$outboundSchema: z.ZodType<
+  PurchasesControllerCreateOfferRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerCreateOfferRequest
+> = z.object({
+  idempotencyKey: z.string(),
+  createPurchaseOfferDto: models.CreatePurchaseOfferDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+    createPurchaseOfferDto: "CreatePurchaseOfferDto",
+  });
+});
+
+export function purchasesControllerCreateOfferRequestToJSON(
+  purchasesControllerCreateOfferRequest: PurchasesControllerCreateOfferRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerCreateOfferRequest$outboundSchema.parse(
+      purchasesControllerCreateOfferRequest,
+    ),
+  );
+}

package/src/models/operations/purchasescontrollerfindone.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PurchasesControllerFindOneRequest = {
+  /**
+   * The ID of the purchase to retrieve
+   */
+  id: string;
+};
+
+/** @internal */
+export type PurchasesControllerFindOneRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const PurchasesControllerFindOneRequest$outboundSchema: z.ZodType<
+  PurchasesControllerFindOneRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerFindOneRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function purchasesControllerFindOneRequestToJSON(
+  purchasesControllerFindOneRequest: PurchasesControllerFindOneRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerFindOneRequest$outboundSchema.parse(
+      purchasesControllerFindOneRequest,
+    ),
+  );
+}

package/src/models/operations/purchasescontrollerretry.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type PurchasesControllerRetryRequest = {
+  /**
+   * The ID of the purchase to retry
+   */
+  purchaseId: string;
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  /**
+   * Retry reason
+   */
+  retryPurchaseDto: models.RetryPurchaseDto;
+};
+
+/** @internal */
+export type PurchasesControllerRetryRequest$Outbound = {
+  purchaseId: string;
+  "Idempotency-Key": string;
+  RetryPurchaseDto: models.RetryPurchaseDto$Outbound;
+};
+
+/** @internal */
+export const PurchasesControllerRetryRequest$outboundSchema: z.ZodType<
+  PurchasesControllerRetryRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerRetryRequest
+> = z.object({
+  purchaseId: z.string(),
+  idempotencyKey: z.string(),
+  retryPurchaseDto: models.RetryPurchaseDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+    retryPurchaseDto: "RetryPurchaseDto",
+  });
+});
+
+export function purchasesControllerRetryRequestToJSON(
+  purchasesControllerRetryRequest: PurchasesControllerRetryRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerRetryRequest$outboundSchema.parse(
+      purchasesControllerRetryRequest,
+    ),
+  );
+}

package/src/models/operations/purchasescontrollerreverse.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type PurchasesControllerReverseRequest = {
+  /**
+   * The ID of the purchase to reverse
+   */
+  purchaseId: string;
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  /**
+   * Reversal reason
+   */
+  reversePurchaseDto: models.ReversePurchaseDto;
+};
+
+/** @internal */
+export type PurchasesControllerReverseRequest$Outbound = {
+  purchaseId: string;
+  "Idempotency-Key": string;
+  ReversePurchaseDto: models.ReversePurchaseDto$Outbound;
+};
+
+/** @internal */
+export const PurchasesControllerReverseRequest$outboundSchema: z.ZodType<
+  PurchasesControllerReverseRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerReverseRequest
+> = z.object({
+  purchaseId: z.string(),
+  idempotencyKey: z.string(),
+  reversePurchaseDto: models.ReversePurchaseDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+    reversePurchaseDto: "ReversePurchaseDto",
+  });
+});
+
+export function purchasesControllerReverseRequestToJSON(
+  purchasesControllerReverseRequest: PurchasesControllerReverseRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerReverseRequest$outboundSchema.parse(
+      purchasesControllerReverseRequest,
+    ),
+  );
+}

package/src/models/operations/purchasescontrollerupdate.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type PurchasesControllerUpdateRequest = {
+  id: string;
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  /**
+   * Purchase update data
+   */
+  updatePurchaseDto: models.UpdatePurchaseDto;
+};
+
+/** @internal */
+export type PurchasesControllerUpdateRequest$Outbound = {
+  id: string;
+  "Idempotency-Key": string;
+  UpdatePurchaseDto: models.UpdatePurchaseDto$Outbound;
+};
+
+/** @internal */
+export const PurchasesControllerUpdateRequest$outboundSchema: z.ZodType<
+  PurchasesControllerUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerUpdateRequest
+> = z.object({
+  id: z.string(),
+  idempotencyKey: z.string(),
+  updatePurchaseDto: models.UpdatePurchaseDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+    updatePurchaseDto: "UpdatePurchaseDto",
+  });
+});
+
+export function purchasesControllerUpdateRequestToJSON(
+  purchasesControllerUpdateRequest: PurchasesControllerUpdateRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerUpdateRequest$outboundSchema.parse(
+      purchasesControllerUpdateRequest,
+    ),
+  );
+}

package/src/models/operations/transactionscontrollerupdate.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type TransactionsControllerUpdateRequest = {
+  /**
+   * The stored transaction id
+   */
+  transactionId: string;
+  updateTransactionDto: models.UpdateTransactionDto;
+};
+
+/** @internal */
+export type TransactionsControllerUpdateRequest$Outbound = {
+  transactionId: string;
+  UpdateTransactionDto: models.UpdateTransactionDto$Outbound;
+};
+
+/** @internal */
+export const TransactionsControllerUpdateRequest$outboundSchema: z.ZodType<
+  TransactionsControllerUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  TransactionsControllerUpdateRequest
+> = z.object({
+  transactionId: z.string(),
+  updateTransactionDto: models.UpdateTransactionDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    updateTransactionDto: "UpdateTransactionDto",
+  });
+});
+
+export function transactionsControllerUpdateRequestToJSON(
+  transactionsControllerUpdateRequest: TransactionsControllerUpdateRequest,
+): string {
+  return JSON.stringify(
+    TransactionsControllerUpdateRequest$outboundSchema.parse(
+      transactionsControllerUpdateRequest,
+    ),
+  );
+}

package/src/models/paymentraildatadto.ts

@@ -34,10 +34,6 @@ export type PaymentRailDataDto = {
    * Direct Debit Authorization
    */
   directDebitAuthorization?: string | undefined;
-  /**
-   * Dwolla Funding Source Id
-   */
-  fundingSourceId?: string | undefined;
   /**
    * Moov Payment Method Id
    */
@@ -92,7 +88,6 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
   account_number: types.optional(types.string()),
   routing_number: types.optional(types.string()),
   direct_debit_authorization: types.optional(types.string()),
-  funding_source_id: types.optional(types.string()),
   moov_payment_method_id: types.optional(types.string()),
   unit_account_id: types.optional(types.string()),
   swift_code: types.optional(types.string()),
@@ -111,7 +106,6 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
     "account_number": "accountNumber",
     "routing_number": "routingNumber",
     "direct_debit_authorization": "directDebitAuthorization",
-    "funding_source_id": "fundingSourceId",
     "moov_payment_method_id": "moovPaymentMethodId",
     "unit_account_id": "unitAccountId",
     "swift_code": "swiftCode",
@@ -131,7 +125,6 @@ export type PaymentRailDataDto$Outbound = {
   account_number?: string | undefined;
   routing_number?: string | undefined;
   direct_debit_authorization?: string | undefined;
-  funding_source_id?: string | undefined;
   moov_payment_method_id?: string | undefined;
   unit_account_id?: string | undefined;
   swift_code?: string | undefined;
@@ -156,7 +149,6 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
   accountNumber: z.string().optional(),
   routingNumber: z.string().optional(),
   directDebitAuthorization: z.string().optional(),
-  fundingSourceId: z.string().optional(),
   moovPaymentMethodId: z.string().optional(),
   unitAccountId: z.string().optional(),
   swiftCode: z.string().optional(),
@@ -175,7 +167,6 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
     accountNumber: "account_number",
     routingNumber: "routing_number",
     directDebitAuthorization: "direct_debit_authorization",
-    fundingSourceId: "funding_source_id",
     moovPaymentMethodId: "moov_payment_method_id",
     unitAccountId: "unit_account_id",
     swiftCode: "swift_code",

package/src/models/platformsettingsdto.ts

@@ -70,14 +70,6 @@ export type PlatformSettingsDto = {
    * Plaid client ID
    */
   plaidClientId?: string | undefined;
-  /**
-   * Dwolla client ID
-   */
-  dwollaClientId?: string | undefined;
-  /**
-   * Dwolla client secret
-   */
-  dwollaClientSecret?: string | undefined;
   /**
    * MOOV payment method ID
    */
@@ -166,14 +158,6 @@ export type PlatformSettingsDto = {
    * Codat API key for accounting integration
    */
   codatApiKey?: string | undefined;
-  /**
-   * OatFi Dwolla funding source
-   */
-  oatfiDwollaFundingSource?: string | undefined;
-  /**
-   * OatFi SPV Dwolla funding source
-   */
-  oatfiSpvDwollaFundingSource?: string | undefined;
   /**
    * Enable AAN (Account and Network)
    */
@@ -235,8 +219,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
   stripe_repayment_enabled: types.optional(types.boolean()),
   plaid_api_key: types.optional(types.string()),
   plaid_client_id: types.optional(types.string()),
-  dwolla_client_id: types.optional(types.string()),
-  dwolla_client_secret: types.optional(types.string()),
   moov_payment_method_id: types.optional(types.string()),
   account_number: types.optional(types.string()),
   routing_number: types.optional(types.string()),
@@ -263,8 +245,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
   credit_facility: types.optional(types.string()),
   portfolio: types.optional(types.string()),
   codat_api_key: types.optional(types.string()),
-  oatfi_dwolla_funding_source: types.optional(types.string()),
-  oatfi_spv_dwolla_funding_source: types.optional(types.string()),
   aan_enable: types.optional(types.boolean()),
   aan_configuration: types.optional(AANConfigPartnerSettingsDto$inboundSchema),
   branding_configuration: types.optional(
@@ -290,8 +270,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
     "stripe_repayment_enabled": "stripeRepaymentEnabled",
     "plaid_api_key": "plaidApiKey",
     "plaid_client_id": "plaidClientId",
-    "dwolla_client_id": "dwollaClientId",
-    "dwolla_client_secret": "dwollaClientSecret",
     "moov_payment_method_id": "moovPaymentMethodId",
     "account_number": "accountNumber",
     "routing_number": "routingNumber",
@@ -313,8 +291,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
     "operating_account": "operatingAccount",
     "credit_facility": "creditFacility",
     "codat_api_key": "codatApiKey",
-    "oatfi_dwolla_funding_source": "oatfiDwollaFundingSource",
-    "oatfi_spv_dwolla_funding_source": "oatfiSpvDwollaFundingSource",
     "aan_enable": "aanEnable",
     "aan_configuration": "aanConfiguration",
     "branding_configuration": "brandingConfiguration",

package/src/models/preferreddisbursementtime.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Category of the fee range
+ */
+export const PreferredDisbursementTime = {
+  OnTime: "ON_TIME",
+  EarlyPay: "EARLY_PAY",
+  Custom: "CUSTOM",
+} as const;
+/**
+ * Category of the fee range
+ */
+export type PreferredDisbursementTime = ClosedEnum<
+  typeof PreferredDisbursementTime
+>;
+
+/** @internal */
+export const PreferredDisbursementTime$inboundSchema: z.ZodNativeEnum<
+  typeof PreferredDisbursementTime
+> = z.nativeEnum(PreferredDisbursementTime);
+/** @internal */
+export const PreferredDisbursementTime$outboundSchema: z.ZodNativeEnum<
+  typeof PreferredDisbursementTime
+> = PreferredDisbursementTime$inboundSchema;

package/src/models/purchasecancelresponsedto.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  PurchaseStatus,
+  PurchaseStatus$inboundSchema,
+} from "./purchasestatus.js";
+
+export type PurchaseCancelResponseDto = {
+  /**
+   * Unique purchase identifier.
+   */
+  id: string;
+  /**
+   * String identifier of the object.
+   */
+  object: string;
+  status: PurchaseStatus;
+  /**
+   * Reason recorded at cancel time.
+   */
+  cancelReason?: string | undefined;
+};
+
+/** @internal */
+export const PurchaseCancelResponseDto$inboundSchema: z.ZodType<
+  PurchaseCancelResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  status: PurchaseStatus$inboundSchema,
+  cancel_reason: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "cancel_reason": "cancelReason",
+  });
+});
+
+export function purchaseCancelResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseCancelResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseCancelResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseCancelResponseDto' from JSON`,
+  );
+}

package/src/models/purchaseexecutionrequestdto.ts

@@ -7,9 +7,9 @@ import { remap as remap$ } from "../lib/primitives.js";
 
 export type PurchaseExecutionRequestDto = {
   /**
-   * lms_program_id.
+   * lms_program_id (OatFi program id, Mongo ObjectId).
    */
-  programId: string;
+  programExternalId: string;
   originalAmount: number;
   discountAmount: number;
   /**
@@ -33,7 +33,7 @@ export type PurchaseExecutionRequestDto = {
 
 /** @internal */
 export type PurchaseExecutionRequestDto$Outbound = {
-  program_id: string;
+  program_external_id: string;
   original_amount: number;
   discount_amount: number;
   purchase_amount: number;
@@ -49,7 +49,7 @@ export const PurchaseExecutionRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PurchaseExecutionRequestDto
 > = z.object({
-  programId: z.string(),
+  programExternalId: z.string(),
   originalAmount: z.number(),
   discountAmount: z.number(),
   purchaseAmount: z.number(),
@@ -59,7 +59,7 @@ export const PurchaseExecutionRequestDto$outboundSchema: z.ZodType<
   ippOfferId: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    programId: "program_id",
+    programExternalId: "program_external_id",
     originalAmount: "original_amount",
     discountAmount: "discount_amount",
     purchaseAmount: "purchase_amount",

package/src/models/purchasefeebreakdowndto.ts

@@ -0,0 +1,64 @@
+/*
+ * 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 types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type PurchaseFeeBreakdownDto = {
+  /**
+   * Prorated fee amount in cents.
+   */
+  proratedFeeAmount: number;
+  /**
+   * Origination fee amount in cents.
+   */
+  originationFeeAmount: number;
+  /**
+   * Program-configured minimum fee amount in cents.
+   */
+  minFeeAmount: number;
+  /**
+   * True if the minimum fee was substituted in place of the computed fee.
+   */
+  minFeeApplied: boolean;
+  /**
+   * Actual fee amount charged in cents.
+   */
+  totalFeeAmount: number;
+};
+
+/** @internal */
+export const PurchaseFeeBreakdownDto$inboundSchema: z.ZodType<
+  PurchaseFeeBreakdownDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  prorated_fee_amount: types.number(),
+  origination_fee_amount: types.number(),
+  min_fee_amount: types.number(),
+  min_fee_applied: types.boolean(),
+  total_fee_amount: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "prorated_fee_amount": "proratedFeeAmount",
+    "origination_fee_amount": "originationFeeAmount",
+    "min_fee_amount": "minFeeAmount",
+    "min_fee_applied": "minFeeApplied",
+    "total_fee_amount": "totalFeeAmount",
+  });
+});
+
+export function purchaseFeeBreakdownDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseFeeBreakdownDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseFeeBreakdownDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseFeeBreakdownDto' from JSON`,
+  );
+}

package/src/models/purchasenotconfirmeddto.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type PurchaseNotConfirmedDto = {
+  /**
+   * Not confirmed.
+   */
+  confirmed: boolean;
+};
+
+/** @internal */
+export const PurchaseNotConfirmedDto$inboundSchema: z.ZodType<
+  PurchaseNotConfirmedDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confirmed: types.boolean(),
+});
+
+export function purchaseNotConfirmedDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseNotConfirmedDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseNotConfirmedDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseNotConfirmedDto' from JSON`,
+  );
+}