@apideck/unify 0.23.0 → 0.23.2

package/src/models/components/bankfeedstatement.ts

@@ -0,0 +1,535 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  CreditOrDebit,
+  CreditOrDebit$inboundSchema,
+  CreditOrDebit$outboundSchema,
+} from "./creditordebit.js";
+
+/**
+ * The current status of the bank feed statement.
+ */
+export const StatementStatus = {
+  Pending: "pending",
+  Rejected: "rejected",
+  Success: "success",
+} as const;
+/**
+ * The current status of the bank feed statement.
+ */
+export type StatementStatus = ClosedEnum<typeof StatementStatus>;
+
+/**
+ * Type of transaction.
+ */
+export const BankFeedStatementTransactionType = {
+  Credit: "credit",
+  Debit: "debit",
+  Deposit: "deposit",
+  Transfer: "transfer",
+  Payment: "payment",
+  Other: "other",
+} as const;
+/**
+ * Type of transaction.
+ */
+export type BankFeedStatementTransactionType = ClosedEnum<
+  typeof BankFeedStatementTransactionType
+>;
+
+export type Transactions = {
+  /**
+   * The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
+   */
+  postedDate: Date;
+  /**
+   * A description of the transaction.
+   */
+  description?: string | undefined;
+  /**
+   * The amount of the transaction.
+   */
+  amount: number;
+  /**
+   * Whether the amount is a credit or debit.
+   */
+  creditOrDebit: CreditOrDebit;
+  /**
+   * The ID of the source transaction.
+   */
+  sourceTransactionId: string;
+  /**
+   * The counterparty of the transaction.
+   */
+  counterparty?: string | undefined;
+  /**
+   * The reference of the transaction.
+   */
+  reference?: string | undefined;
+  /**
+   * Type of transaction.
+   */
+  transactionType?: BankFeedStatementTransactionType | undefined;
+};
+
+export type BankFeedStatement = {
+  /**
+   * A unique identifier for an object.
+   */
+  id: string;
+  /**
+   * The ID of the bank feed account this statement belongs to.
+   */
+  bankFeedAccountId?: string | undefined;
+  /**
+   * The current status of the bank feed statement.
+   */
+  status?: StatementStatus | undefined;
+  /**
+   * Start date of the bank feed statement.
+   */
+  startDate?: Date | undefined;
+  /**
+   * End date of the bank feed statement.
+   */
+  endDate?: Date | undefined;
+  /**
+   * Balance amount at the start of the period.
+   */
+  startBalance?: number | undefined;
+  /**
+   * Whether the amount is a credit or debit.
+   */
+  startBalanceCreditOrDebit?: CreditOrDebit | undefined;
+  /**
+   * Balance amount at the end of the period.
+   */
+  endBalance?: number | undefined;
+  /**
+   * Whether the amount is a credit or debit.
+   */
+  endBalanceCreditOrDebit?: CreditOrDebit | undefined;
+  /**
+   * List of transactions in the bank feed statement.
+   */
+  transactions?: Array<Transactions> | undefined;
+  /**
+   * The date and time when the object was created.
+   */
+  createdAt?: Date | null | undefined;
+  /**
+   * The user who created the object.
+   */
+  createdBy?: string | null | undefined;
+  /**
+   * The date and time when the object was last updated.
+   */
+  updatedAt?: Date | null | undefined;
+  /**
+   * The user who last updated the object.
+   */
+  updatedBy?: string | null | undefined;
+};
+
+export type BankFeedStatementInput = {
+  /**
+   * The ID of the bank feed account this statement belongs to.
+   */
+  bankFeedAccountId?: string | undefined;
+  /**
+   * The current status of the bank feed statement.
+   */
+  status?: StatementStatus | undefined;
+  /**
+   * Start date of the bank feed statement.
+   */
+  startDate?: Date | undefined;
+  /**
+   * End date of the bank feed statement.
+   */
+  endDate?: Date | undefined;
+  /**
+   * Balance amount at the start of the period.
+   */
+  startBalance?: number | undefined;
+  /**
+   * Whether the amount is a credit or debit.
+   */
+  startBalanceCreditOrDebit?: CreditOrDebit | undefined;
+  /**
+   * Balance amount at the end of the period.
+   */
+  endBalance?: number | undefined;
+  /**
+   * Whether the amount is a credit or debit.
+   */
+  endBalanceCreditOrDebit?: CreditOrDebit | undefined;
+  /**
+   * List of transactions in the bank feed statement.
+   */
+  transactions?: Array<Transactions> | undefined;
+};
+
+/** @internal */
+export const StatementStatus$inboundSchema: z.ZodNativeEnum<
+  typeof StatementStatus
+> = z.nativeEnum(StatementStatus);
+
+/** @internal */
+export const StatementStatus$outboundSchema: z.ZodNativeEnum<
+  typeof StatementStatus
+> = StatementStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StatementStatus$ {
+  /** @deprecated use `StatementStatus$inboundSchema` instead. */
+  export const inboundSchema = StatementStatus$inboundSchema;
+  /** @deprecated use `StatementStatus$outboundSchema` instead. */
+  export const outboundSchema = StatementStatus$outboundSchema;
+}
+
+/** @internal */
+export const BankFeedStatementTransactionType$inboundSchema: z.ZodNativeEnum<
+  typeof BankFeedStatementTransactionType
+> = z.nativeEnum(BankFeedStatementTransactionType);
+
+/** @internal */
+export const BankFeedStatementTransactionType$outboundSchema: z.ZodNativeEnum<
+  typeof BankFeedStatementTransactionType
+> = BankFeedStatementTransactionType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BankFeedStatementTransactionType$ {
+  /** @deprecated use `BankFeedStatementTransactionType$inboundSchema` instead. */
+  export const inboundSchema = BankFeedStatementTransactionType$inboundSchema;
+  /** @deprecated use `BankFeedStatementTransactionType$outboundSchema` instead. */
+  export const outboundSchema = BankFeedStatementTransactionType$outboundSchema;
+}
+
+/** @internal */
+export const Transactions$inboundSchema: z.ZodType<
+  Transactions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  posted_date: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  description: z.string().optional(),
+  amount: z.number(),
+  credit_or_debit: CreditOrDebit$inboundSchema,
+  source_transaction_id: z.string(),
+  counterparty: z.string().optional(),
+  reference: z.string().optional(),
+  transaction_type: BankFeedStatementTransactionType$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "posted_date": "postedDate",
+    "credit_or_debit": "creditOrDebit",
+    "source_transaction_id": "sourceTransactionId",
+    "transaction_type": "transactionType",
+  });
+});
+
+/** @internal */
+export type Transactions$Outbound = {
+  posted_date: string;
+  description?: string | undefined;
+  amount: number;
+  credit_or_debit: string;
+  source_transaction_id: string;
+  counterparty?: string | undefined;
+  reference?: string | undefined;
+  transaction_type?: string | undefined;
+};
+
+/** @internal */
+export const Transactions$outboundSchema: z.ZodType<
+  Transactions$Outbound,
+  z.ZodTypeDef,
+  Transactions
+> = z.object({
+  postedDate: z.date().transform(v => v.toISOString()),
+  description: z.string().optional(),
+  amount: z.number(),
+  creditOrDebit: CreditOrDebit$outboundSchema,
+  sourceTransactionId: z.string(),
+  counterparty: z.string().optional(),
+  reference: z.string().optional(),
+  transactionType: BankFeedStatementTransactionType$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    postedDate: "posted_date",
+    creditOrDebit: "credit_or_debit",
+    sourceTransactionId: "source_transaction_id",
+    transactionType: "transaction_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Transactions$ {
+  /** @deprecated use `Transactions$inboundSchema` instead. */
+  export const inboundSchema = Transactions$inboundSchema;
+  /** @deprecated use `Transactions$outboundSchema` instead. */
+  export const outboundSchema = Transactions$outboundSchema;
+  /** @deprecated use `Transactions$Outbound` instead. */
+  export type Outbound = Transactions$Outbound;
+}
+
+export function transactionsToJSON(transactions: Transactions): string {
+  return JSON.stringify(Transactions$outboundSchema.parse(transactions));
+}
+
+export function transactionsFromJSON(
+  jsonString: string,
+): SafeParseResult<Transactions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Transactions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Transactions' from JSON`,
+  );
+}
+
+/** @internal */
+export const BankFeedStatement$inboundSchema: z.ZodType<
+  BankFeedStatement,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  bank_feed_account_id: z.string().optional(),
+  status: StatementStatus$inboundSchema.optional(),
+  start_date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  end_date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  start_balance: z.number().optional(),
+  start_balance_credit_or_debit: CreditOrDebit$inboundSchema.optional(),
+  end_balance: z.number().optional(),
+  end_balance_credit_or_debit: CreditOrDebit$inboundSchema.optional(),
+  transactions: z.array(z.lazy(() => Transactions$inboundSchema)).optional(),
+  created_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  created_by: z.nullable(z.string()).optional(),
+  updated_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  updated_by: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "bank_feed_account_id": "bankFeedAccountId",
+    "start_date": "startDate",
+    "end_date": "endDate",
+    "start_balance": "startBalance",
+    "start_balance_credit_or_debit": "startBalanceCreditOrDebit",
+    "end_balance": "endBalance",
+    "end_balance_credit_or_debit": "endBalanceCreditOrDebit",
+    "created_at": "createdAt",
+    "created_by": "createdBy",
+    "updated_at": "updatedAt",
+    "updated_by": "updatedBy",
+  });
+});
+
+/** @internal */
+export type BankFeedStatement$Outbound = {
+  id: string;
+  bank_feed_account_id?: string | undefined;
+  status?: string | undefined;
+  start_date?: string | undefined;
+  end_date?: string | undefined;
+  start_balance?: number | undefined;
+  start_balance_credit_or_debit?: string | undefined;
+  end_balance?: number | undefined;
+  end_balance_credit_or_debit?: string | undefined;
+  transactions?: Array<Transactions$Outbound> | undefined;
+  created_at?: string | null | undefined;
+  created_by?: string | null | undefined;
+  updated_at?: string | null | undefined;
+  updated_by?: string | null | undefined;
+};
+
+/** @internal */
+export const BankFeedStatement$outboundSchema: z.ZodType<
+  BankFeedStatement$Outbound,
+  z.ZodTypeDef,
+  BankFeedStatement
+> = z.object({
+  id: z.string(),
+  bankFeedAccountId: z.string().optional(),
+  status: StatementStatus$outboundSchema.optional(),
+  startDate: z.date().transform(v => v.toISOString()).optional(),
+  endDate: z.date().transform(v => v.toISOString()).optional(),
+  startBalance: z.number().optional(),
+  startBalanceCreditOrDebit: CreditOrDebit$outboundSchema.optional(),
+  endBalance: z.number().optional(),
+  endBalanceCreditOrDebit: CreditOrDebit$outboundSchema.optional(),
+  transactions: z.array(z.lazy(() => Transactions$outboundSchema)).optional(),
+  createdAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  createdBy: z.nullable(z.string()).optional(),
+  updatedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  updatedBy: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    bankFeedAccountId: "bank_feed_account_id",
+    startDate: "start_date",
+    endDate: "end_date",
+    startBalance: "start_balance",
+    startBalanceCreditOrDebit: "start_balance_credit_or_debit",
+    endBalance: "end_balance",
+    endBalanceCreditOrDebit: "end_balance_credit_or_debit",
+    createdAt: "created_at",
+    createdBy: "created_by",
+    updatedAt: "updated_at",
+    updatedBy: "updated_by",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BankFeedStatement$ {
+  /** @deprecated use `BankFeedStatement$inboundSchema` instead. */
+  export const inboundSchema = BankFeedStatement$inboundSchema;
+  /** @deprecated use `BankFeedStatement$outboundSchema` instead. */
+  export const outboundSchema = BankFeedStatement$outboundSchema;
+  /** @deprecated use `BankFeedStatement$Outbound` instead. */
+  export type Outbound = BankFeedStatement$Outbound;
+}
+
+export function bankFeedStatementToJSON(
+  bankFeedStatement: BankFeedStatement,
+): string {
+  return JSON.stringify(
+    BankFeedStatement$outboundSchema.parse(bankFeedStatement),
+  );
+}
+
+export function bankFeedStatementFromJSON(
+  jsonString: string,
+): SafeParseResult<BankFeedStatement, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BankFeedStatement$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BankFeedStatement' from JSON`,
+  );
+}
+
+/** @internal */
+export const BankFeedStatementInput$inboundSchema: z.ZodType<
+  BankFeedStatementInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bank_feed_account_id: z.string().optional(),
+  status: StatementStatus$inboundSchema.optional(),
+  start_date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  end_date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  start_balance: z.number().optional(),
+  start_balance_credit_or_debit: CreditOrDebit$inboundSchema.optional(),
+  end_balance: z.number().optional(),
+  end_balance_credit_or_debit: CreditOrDebit$inboundSchema.optional(),
+  transactions: z.array(z.lazy(() => Transactions$inboundSchema)).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "bank_feed_account_id": "bankFeedAccountId",
+    "start_date": "startDate",
+    "end_date": "endDate",
+    "start_balance": "startBalance",
+    "start_balance_credit_or_debit": "startBalanceCreditOrDebit",
+    "end_balance": "endBalance",
+    "end_balance_credit_or_debit": "endBalanceCreditOrDebit",
+  });
+});
+
+/** @internal */
+export type BankFeedStatementInput$Outbound = {
+  bank_feed_account_id?: string | undefined;
+  status?: string | undefined;
+  start_date?: string | undefined;
+  end_date?: string | undefined;
+  start_balance?: number | undefined;
+  start_balance_credit_or_debit?: string | undefined;
+  end_balance?: number | undefined;
+  end_balance_credit_or_debit?: string | undefined;
+  transactions?: Array<Transactions$Outbound> | undefined;
+};
+
+/** @internal */
+export const BankFeedStatementInput$outboundSchema: z.ZodType<
+  BankFeedStatementInput$Outbound,
+  z.ZodTypeDef,
+  BankFeedStatementInput
+> = z.object({
+  bankFeedAccountId: z.string().optional(),
+  status: StatementStatus$outboundSchema.optional(),
+  startDate: z.date().transform(v => v.toISOString()).optional(),
+  endDate: z.date().transform(v => v.toISOString()).optional(),
+  startBalance: z.number().optional(),
+  startBalanceCreditOrDebit: CreditOrDebit$outboundSchema.optional(),
+  endBalance: z.number().optional(),
+  endBalanceCreditOrDebit: CreditOrDebit$outboundSchema.optional(),
+  transactions: z.array(z.lazy(() => Transactions$outboundSchema)).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    bankFeedAccountId: "bank_feed_account_id",
+    startDate: "start_date",
+    endDate: "end_date",
+    startBalance: "start_balance",
+    startBalanceCreditOrDebit: "start_balance_credit_or_debit",
+    endBalance: "end_balance",
+    endBalanceCreditOrDebit: "end_balance_credit_or_debit",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BankFeedStatementInput$ {
+  /** @deprecated use `BankFeedStatementInput$inboundSchema` instead. */
+  export const inboundSchema = BankFeedStatementInput$inboundSchema;
+  /** @deprecated use `BankFeedStatementInput$outboundSchema` instead. */
+  export const outboundSchema = BankFeedStatementInput$outboundSchema;
+  /** @deprecated use `BankFeedStatementInput$Outbound` instead. */
+  export type Outbound = BankFeedStatementInput$Outbound;
+}
+
+export function bankFeedStatementInputToJSON(
+  bankFeedStatementInput: BankFeedStatementInput,
+): string {
+  return JSON.stringify(
+    BankFeedStatementInput$outboundSchema.parse(bankFeedStatementInput),
+  );
+}
+
+export function bankFeedStatementInputFromJSON(
+  jsonString: string,
+): SafeParseResult<BankFeedStatementInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BankFeedStatementInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BankFeedStatementInput' from JSON`,
+  );
+}

package/src/models/components/createbankfeedaccountresponse.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  UnifiedId,
+  UnifiedId$inboundSchema,
+  UnifiedId$Outbound,
+  UnifiedId$outboundSchema,
+} from "./unifiedid.js";
+
+/**
+ * Bank Feed Accounts
+ */
+export type CreateBankFeedAccountResponse = {
+  /**
+   * HTTP Response Status Code
+   */
+  statusCode: number;
+  /**
+   * HTTP Response Status
+   */
+  status: string;
+  /**
+   * Apideck ID of service provider
+   */
+  service: string;
+  /**
+   * Unified API resource name
+   */
+  resource: string;
+  /**
+   * Operation performed
+   */
+  operation: string;
+  /**
+   * A object containing a unique identifier for the resource that was created, updated, or deleted.
+   */
+  data: UnifiedId;
+  /**
+   * Raw response from the integration when raw=true query param is provided
+   */
+  raw?: { [k: string]: any } | null | undefined;
+};
+
+/** @internal */
+export const CreateBankFeedAccountResponse$inboundSchema: z.ZodType<
+  CreateBankFeedAccountResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status_code: z.number().int(),
+  status: z.string(),
+  service: z.string(),
+  resource: z.string(),
+  operation: z.string(),
+  data: UnifiedId$inboundSchema,
+  _raw: z.nullable(z.record(z.any())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "status_code": "statusCode",
+    "_raw": "raw",
+  });
+});
+
+/** @internal */
+export type CreateBankFeedAccountResponse$Outbound = {
+  status_code: number;
+  status: string;
+  service: string;
+  resource: string;
+  operation: string;
+  data: UnifiedId$Outbound;
+  _raw?: { [k: string]: any } | null | undefined;
+};
+
+/** @internal */
+export const CreateBankFeedAccountResponse$outboundSchema: z.ZodType<
+  CreateBankFeedAccountResponse$Outbound,
+  z.ZodTypeDef,
+  CreateBankFeedAccountResponse
+> = z.object({
+  statusCode: z.number().int(),
+  status: z.string(),
+  service: z.string(),
+  resource: z.string(),
+  operation: z.string(),
+  data: UnifiedId$outboundSchema,
+  raw: z.nullable(z.record(z.any())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    statusCode: "status_code",
+    raw: "_raw",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateBankFeedAccountResponse$ {
+  /** @deprecated use `CreateBankFeedAccountResponse$inboundSchema` instead. */
+  export const inboundSchema = CreateBankFeedAccountResponse$inboundSchema;
+  /** @deprecated use `CreateBankFeedAccountResponse$outboundSchema` instead. */
+  export const outboundSchema = CreateBankFeedAccountResponse$outboundSchema;
+  /** @deprecated use `CreateBankFeedAccountResponse$Outbound` instead. */
+  export type Outbound = CreateBankFeedAccountResponse$Outbound;
+}
+
+export function createBankFeedAccountResponseToJSON(
+  createBankFeedAccountResponse: CreateBankFeedAccountResponse,
+): string {
+  return JSON.stringify(
+    CreateBankFeedAccountResponse$outboundSchema.parse(
+      createBankFeedAccountResponse,
+    ),
+  );
+}
+
+export function createBankFeedAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateBankFeedAccountResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateBankFeedAccountResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateBankFeedAccountResponse' from JSON`,
+  );
+}