@oatfi/oatfi-sdk-ts 0.12.6 → 0.12.7

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/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/purchaseofferresponsedto.ts

@@ -0,0 +1,165 @@
+/*
+ * 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 {
+  PreferredDisbursementTime,
+  PreferredDisbursementTime$inboundSchema,
+} from "./preferreddisbursementtime.js";
+import {
+  PurchaseFeeBreakdownDto,
+  PurchaseFeeBreakdownDto$inboundSchema,
+} from "./purchasefeebreakdowndto.js";
+import {
+  PurchaseOfferStatus,
+  PurchaseOfferStatus$inboundSchema,
+} from "./purchaseofferstatus.js";
+
+export type PurchaseOfferResponseDto = {
+  /**
+   * Unique purchase offer identifier.
+   */
+  id: string;
+  /**
+   * String identifier of the object.
+   */
+  object: string;
+  /**
+   * Public-facing offer ID used to identify this offer attempt.
+   */
+  offer: string;
+  status: PurchaseOfferStatus;
+  /**
+   * Identifier of the payment intent the offer is reserved against.
+   */
+  paymentIntent: string;
+  /**
+   * Payment intent amount in cents.
+   */
+  paymentIntentAmount: number;
+  /**
+   * Invoice due date (ISO 8601).
+   */
+  paymentIntentDueDate: string;
+  /**
+   * Purchase amount in cents.
+   */
+  purchaseAmount: number;
+  /**
+   * Resolved preferred disbursement time (fee-range alias selector on the program configuration).
+   */
+  preferredDisbursementTime: PreferredDisbursementTime;
+  /**
+   * Resolved disbursement date (ISO 8601).
+   */
+  disbursementDate: string;
+  /**
+   * Effective disbursement date (ISO 8601).
+   */
+  effectiveDisbursementDate: string;
+  /**
+   * Supplier identifier.
+   */
+  supplier: string;
+  /**
+   * Loan program identifier.
+   */
+  program: string;
+  feeBreakdown: PurchaseFeeBreakdownDto;
+  /**
+   * Sum of all fees, excluding reward_amount, in cents.
+   */
+  discountAmount: number;
+  /**
+   * Buyer reward amount in cents.
+   */
+  rewardAmount: number;
+  /**
+   * Identifier of the hold reserving credit for this offer.
+   */
+  hold?: string | undefined;
+  /**
+   * Offer expiration timestamp — equals the invoice due date (ISO 8601).
+   */
+  expirationDate: string;
+  /**
+   * Timestamp the offer was accepted (ISO 8601).
+   */
+  acceptedAt?: string | undefined;
+  /**
+   * Identifier of the Purchase created from this offer once accepted.
+   */
+  acceptedPurchase?: string | undefined;
+  /**
+   * Creation timestamp (ISO 8601).
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp (ISO 8601).
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const PurchaseOfferResponseDto$inboundSchema: z.ZodType<
+  PurchaseOfferResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  offer: types.string(),
+  status: PurchaseOfferStatus$inboundSchema,
+  payment_intent: types.string(),
+  payment_intent_amount: types.number(),
+  payment_intent_due_date: types.string(),
+  purchase_amount: types.number(),
+  preferred_disbursement_time: PreferredDisbursementTime$inboundSchema,
+  disbursement_date: types.string(),
+  effective_disbursement_date: types.string(),
+  supplier: types.string(),
+  program: types.string(),
+  fee_breakdown: PurchaseFeeBreakdownDto$inboundSchema,
+  discount_amount: types.number(),
+  reward_amount: types.number(),
+  hold: types.optional(types.string()),
+  expiration_date: types.string(),
+  accepted_at: types.optional(types.string()),
+  accepted_purchase: types.optional(types.string()),
+  created_at: types.string(),
+  updated_at: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "payment_intent": "paymentIntent",
+    "payment_intent_amount": "paymentIntentAmount",
+    "payment_intent_due_date": "paymentIntentDueDate",
+    "purchase_amount": "purchaseAmount",
+    "preferred_disbursement_time": "preferredDisbursementTime",
+    "disbursement_date": "disbursementDate",
+    "effective_disbursement_date": "effectiveDisbursementDate",
+    "fee_breakdown": "feeBreakdown",
+    "discount_amount": "discountAmount",
+    "reward_amount": "rewardAmount",
+    "expiration_date": "expirationDate",
+    "accepted_at": "acceptedAt",
+    "accepted_purchase": "acceptedPurchase",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function purchaseOfferResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseOfferResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseOfferResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseOfferResponseDto' from JSON`,
+  );
+}

package/src/models/purchaseofferstatus.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const PurchaseOfferStatus = {
+  Active: "ACTIVE",
+  Accepted: "ACCEPTED",
+  Expired: "EXPIRED",
+} as const;
+export type PurchaseOfferStatus = ClosedEnum<typeof PurchaseOfferStatus>;
+
+/** @internal */
+export const PurchaseOfferStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PurchaseOfferStatus
+> = z.nativeEnum(PurchaseOfferStatus);