@maesn/typescript-sdk 0.2.1 → 0.2.2

package/src/models/operations/delete-vendor-credit.ts

@@ -3,13 +3,49 @@
  */
 
 import * as z from "zod/v4-mini";
+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/sdk-validation-error.js";
 
 export type DeleteVendorCreditRequest = {
   vendorCreditId: string;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
 };
 
+export type DeleteVendorCreditPagination = {
+  total: number;
+  perPage: number;
+  currentPage: number;
+  totalPages: number;
+};
+
+export type DeleteVendorCreditMeta = {
+  warnings?: Array<string> | null | undefined;
+  pagination?: DeleteVendorCreditPagination | null | undefined;
+};
+
+export type DeleteVendorCreditErrors = {};
+
+export type DeleteVendorCreditRawData = {};
+
+/**
+ * Operation completed successfully
+ */
+export type DeleteVendorCreditResponse = {
+  meta?: DeleteVendorCreditMeta | null | undefined;
+  data: string;
+  errors: DeleteVendorCreditErrors | null;
+  rawData: DeleteVendorCreditRawData | null;
+};
+
 /** @internal */
 export type DeleteVendorCreditRequest$Outbound = {
   vendorCreditId: string;
@@ -34,3 +70,102 @@ export function deleteVendorCreditRequestToJSON(
     DeleteVendorCreditRequest$outboundSchema.parse(deleteVendorCreditRequest),
   );
 }
+
+/** @internal */
+export const DeleteVendorCreditPagination$inboundSchema: z.ZodMiniType<
+  DeleteVendorCreditPagination,
+  unknown
+> = z.object({
+  total: types.number(),
+  perPage: types.number(),
+  currentPage: types.number(),
+  totalPages: types.number(),
+});
+
+export function deleteVendorCreditPaginationFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteVendorCreditPagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteVendorCreditPagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteVendorCreditPagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeleteVendorCreditMeta$inboundSchema: z.ZodMiniType<
+  DeleteVendorCreditMeta,
+  unknown
+> = z.object({
+  warnings: z.optional(z.nullable(z.array(types.string()))),
+  pagination: z.optional(
+    z.nullable(z.lazy(() => DeleteVendorCreditPagination$inboundSchema)),
+  ),
+});
+
+export function deleteVendorCreditMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteVendorCreditMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteVendorCreditMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteVendorCreditMeta' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeleteVendorCreditErrors$inboundSchema: z.ZodMiniType<
+  DeleteVendorCreditErrors,
+  unknown
+> = z.object({});
+
+export function deleteVendorCreditErrorsFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteVendorCreditErrors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteVendorCreditErrors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteVendorCreditErrors' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeleteVendorCreditRawData$inboundSchema: z.ZodMiniType<
+  DeleteVendorCreditRawData,
+  unknown
+> = z.object({});
+
+export function deleteVendorCreditRawDataFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteVendorCreditRawData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteVendorCreditRawData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteVendorCreditRawData' from JSON`,
+  );
+}
+
+/** @internal */
+export const DeleteVendorCreditResponse$inboundSchema: z.ZodMiniType<
+  DeleteVendorCreditResponse,
+  unknown
+> = z.object({
+  meta: z.optional(
+    z.nullable(z.lazy(() => DeleteVendorCreditMeta$inboundSchema)),
+  ),
+  data: types.string(),
+  errors: types.nullable(z.lazy(() => DeleteVendorCreditErrors$inboundSchema)),
+  rawData: types.nullable(
+    z.lazy(() => DeleteVendorCreditRawData$inboundSchema),
+  ),
+});
+
+export function deleteVendorCreditResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteVendorCreditResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteVendorCreditResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteVendorCreditResponse' from JSON`,
+  );
+}

package/src/models/operations/delete-webhook-end-user.ts

@@ -3,13 +3,27 @@
  */
 
 import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
 
 export type DeleteWebhookEndUserRequest = {
   webhookId: string;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
 };
 
+/**
+ * Operation completed successfully
+ */
+export type DeleteWebhookEndUserResponse = {};
+
 /** @internal */
 export type DeleteWebhookEndUserRequest$Outbound = {
   webhookId: string;
@@ -36,3 +50,19 @@ export function deleteWebhookEndUserRequestToJSON(
     ),
   );
 }
+
+/** @internal */
+export const DeleteWebhookEndUserResponse$inboundSchema: z.ZodMiniType<
+  DeleteWebhookEndUserResponse,
+  unknown
+> = z.object({});
+
+export function deleteWebhookEndUserResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteWebhookEndUserResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteWebhookEndUserResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteWebhookEndUserResponse' from JSON`,
+  );
+}

package/src/models/operations/delete-webhook.ts

@@ -3,13 +3,27 @@
  */
 
 import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
 
 export type DeleteWebhookRequest = {
   webhookId: string;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
 };
 
+/**
+ * Operation completed successfully
+ */
+export type DeleteWebhookResponse = {};
+
 /** @internal */
 export type DeleteWebhookRequest$Outbound = {
   webhookId: string;
@@ -34,3 +48,19 @@ export function deleteWebhookRequestToJSON(
     DeleteWebhookRequest$outboundSchema.parse(deleteWebhookRequest),
   );
 }
+
+/** @internal */
+export const DeleteWebhookResponse$inboundSchema: z.ZodMiniType<
+  DeleteWebhookResponse,
+  unknown
+> = z.object({});
+
+export function deleteWebhookResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteWebhookResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteWebhookResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteWebhookResponse' from JSON`,
+  );
+}

package/src/models/operations/details.ts

@@ -23,6 +23,11 @@ export type Details = {
   [additionalProperties: string]: unknown;
 };
 
+/**
+ * Detailed health status including database connectivity.
+ */
+export type DetailsResponse = {};
+
 /** @internal */
 export const Info$inboundSchema: z.ZodMiniType<Info, unknown> = z.catchall(
   z.object({
@@ -77,3 +82,19 @@ export function detailsFromJSON(
     `Failed to parse 'Details' from JSON`,
   );
 }
+
+/** @internal */
+export const DetailsResponse$inboundSchema: z.ZodMiniType<
+  DetailsResponse,
+  unknown
+> = z.object({});
+
+export function detailsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DetailsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DetailsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DetailsResponse' from JSON`,
+  );
+}

package/src/models/operations/get-account.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetAccountRequest = {
   accountId: string;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -32,6 +41,9 @@ export type GetAccountErrors = {};
 
 export type GetAccountRawData = {};
 
+/**
+ * Account record matching the provided ID
+ */
 export type GetAccountResponse = {
   meta?: GetAccountMeta | null | undefined;
   data: models.AccountResponseDto;

package/src/models/operations/get-accounts.ts

@@ -10,24 +10,60 @@ import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
+/**
+ * Filter accounts by debit/credit indicator
+ */
 export const DebitCreditIndicator = {
   Debit: "DEBIT",
   Credit: "CREDIT",
 } as const;
+/**
+ * Filter accounts by debit/credit indicator
+ */
 export type DebitCreditIndicator = ClosedEnum<typeof DebitCreditIndicator>;
 
 export type GetAccountsRequest = {
   page?: number | undefined;
   limit?: number | undefined;
+  /**
+   * ISO 8601 timestamp; only records modified after this date are returned
+   */
   lastModifiedAt?: string | undefined;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
+  /**
+   * Filter accounts by debit/credit indicator
+   */
   debitCreditIndicator?: DebitCreditIndicator | undefined;
+  /**
+   * Fiscal year to scope the account balances (e.g. 2024)
+   */
   fiscalYear?: number | undefined;
+  /**
+   * Comma-separated list of account types to filter by
+   */
   types?: string | undefined;
+  /**
+   * ISO 8601 start date of the fiscal year used for balance calculation
+   */
   fiscalYearStartDate?: string | undefined;
+  /**
+   * Filter accounts by account class (e.g. asset, liability, equity)
+   */
   classFilter?: string | undefined;
+  /**
+   * When true, returns only active accounts; when false, returns only inactive accounts
+   */
   isActive?: boolean | undefined;
 };
 
@@ -47,6 +83,9 @@ export type GetAccountsErrors = {};
 
 export type GetAccountsRawData = {};
 
+/**
+ * List of accounts for the authenticated end user's connected target system
+ */
 export type GetAccountsResponse = {
   meta?: GetAccountsMeta | null | undefined;
   data: Array<models.AccountResponseDto>;

package/src/models/operations/get-all-active-end-users.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+/**
+ * List of all active end users across all tenants
+ */
+export type GetAllActiveEndUsersResponse = {};
+
+/** @internal */
+export const GetAllActiveEndUsersResponse$inboundSchema: z.ZodMiniType<
+  GetAllActiveEndUsersResponse,
+  unknown
+> = z.object({});
+
+export function getAllActiveEndUsersResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAllActiveEndUsersResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAllActiveEndUsersResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAllActiveEndUsersResponse' from JSON`,
+  );
+}

package/src/models/operations/get-async-task-info.ts

@@ -11,6 +11,9 @@ import * as models from "../index.js";
 
 export type GetAsyncTaskInfoRequest = {
   taskId: string;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
   page?: number | undefined;
   limit?: number | undefined;
@@ -32,6 +35,9 @@ export type GetAsyncTaskInfoErrors = {};
 
 export type GetAsyncTaskInfoRawData = {};
 
+/**
+ * Async task status and result matching the provided task ID
+ */
 export type GetAsyncTaskInfoResponse = {
   meta?: GetAsyncTaskInfoMeta | null | undefined;
   data: models.AsyncTaskResponseDto;

package/src/models/operations/get-bank-account.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetBankAccountRequest = {
   bankAccountId: string;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -32,6 +41,9 @@ export type GetBankAccountErrors = {};
 
 export type GetBankAccountRawData = {};
 
+/**
+ * Bank account record matching the provided ID
+ */
 export type GetBankAccountResponse = {
   meta?: GetBankAccountMeta | null | undefined;
   data: models.BankAccountResponseDto;

package/src/models/operations/get-bank-accounts.ts

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetBankAccountsRequest = {
   page?: number | undefined;
   limit?: number | undefined;
+  /**
+   * ISO 8601 timestamp; only records modified after this date are returned
+   */
   lastModifiedAt?: string | undefined;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -34,6 +46,9 @@ export type GetBankAccountsErrors = {};
 
 export type GetBankAccountsRawData = {};
 
+/**
+ * List of bank accounts for the authenticated end user's connected target system
+ */
 export type GetBankAccountsResponse = {
   meta?: GetBankAccountsMeta | null | undefined;
   data: Array<models.BankAccountResponseDto>;

package/src/models/operations/get-bill-document.ts

@@ -29,6 +29,9 @@ export type GetBillDocumentErrors = {};
 
 export type GetBillDocumentRawData = {};
 
+/**
+ * Document associated with the specified bill
+ */
 export type GetBillDocumentResponse = {
   meta?: GetBillDocumentMeta | null | undefined;
   data: models.DocumentResponseDto;

package/src/models/operations/get-bill-line-items.ts

@@ -11,7 +11,13 @@ import * as models from "../index.js";
 
 export type GetBillLineItemsRequest = {
   billId: string;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -31,6 +37,9 @@ export type GetBillLineItemsErrors = {};
 
 export type GetBillLineItemsRawData = {};
 
+/**
+ * List of line items for the authenticated end user's connected target system
+ */
 export type GetBillLineItemsResponse = {
   meta?: GetBillLineItemsMeta | null | undefined;
   data: Array<models.BillLineItemResponseDto>;

package/src/models/operations/get-bill.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetBillRequest = {
   billId: string;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -32,6 +41,9 @@ export type GetBillErrors = {};
 
 export type GetBillRawData = {};
 
+/**
+ * Bill record matching the provided ID
+ */
 export type GetBillResponse = {
   meta?: GetBillMeta | null | undefined;
   data: models.BillResponseDto;

package/src/models/operations/get-bills.ts

@@ -10,6 +10,9 @@ import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
+/**
+ * Filter bills by unified status
+ */
 export const GetBillsStatus = {
   Draft: "DRAFT",
   Corrective: "CORRECTIVE",
@@ -22,8 +25,14 @@ export const GetBillsStatus = {
   Overdue: "OVERDUE",
   Voided: "VOIDED",
 } as const;
+/**
+ * Filter bills by unified status
+ */
 export type GetBillsStatus = ClosedEnum<typeof GetBillsStatus>;
 
+/**
+ * Filter bills by payment status
+ */
 export const GetBillsPaymentStatus = {
   NoOpenItem: "NO_OPEN_ITEM",
   Pending: "PENDING",
@@ -37,32 +46,71 @@ export const GetBillsPaymentStatus = {
   Canceled: "CANCELED",
   Unknown: "UNKNOWN",
 } as const;
+/**
+ * Filter bills by payment status
+ */
 export type GetBillsPaymentStatus = ClosedEnum<typeof GetBillsPaymentStatus>;
 
+/**
+ * Field to sort the results by
+ */
 export const GetBillsOrderField = {
   BillDate: "billDate",
   BillNumber: "billNumber",
   CreatedDate: "createdDate",
   UpdatedDate: "updatedDate",
 } as const;
+/**
+ * Field to sort the results by
+ */
 export type GetBillsOrderField = ClosedEnum<typeof GetBillsOrderField>;
 
+/**
+ * Sort direction for the ordered results
+ */
 export const GetBillsOrderDir = {
   Asc: "ASC",
   Desc: "DESC",
 } as const;
+/**
+ * Sort direction for the ordered results
+ */
 export type GetBillsOrderDir = ClosedEnum<typeof GetBillsOrderDir>;
 
 export type GetBillsRequest = {
   page?: number | undefined;
   limit?: number | undefined;
+  /**
+   * ISO 8601 timestamp; only records modified after this date are returned
+   */
   lastModifiedAt?: string | undefined;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * Filter bills by unified status
+   */
   status?: GetBillsStatus | undefined;
+  /**
+   * Filter bills by payment status
+   */
   paymentStatus?: GetBillsPaymentStatus | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
+  /**
+   * Field to sort the results by
+   */
   orderField?: GetBillsOrderField | undefined;
+  /**
+   * Sort direction for the ordered results
+   */
   orderDir?: GetBillsOrderDir | undefined;
 };
 
@@ -82,6 +130,9 @@ export type GetBillsErrors = {};
 
 export type GetBillsRawData = {};
 
+/**
+ * List of bills for the authenticated end user's connected target system
+ */
 export type GetBillsResponse = {
   meta?: GetBillsMeta | null | undefined;
   data: Array<models.BillResponseDto>;

package/src/models/operations/get-booking-proposal-document.ts

@@ -29,6 +29,9 @@ export type GetBookingProposalDocumentErrors = {};
 
 export type GetBookingProposalDocumentRawData = {};
 
+/**
+ * Document associated with the specified booking proposal
+ */
 export type GetBookingProposalDocumentResponse = {
   meta?: GetBookingProposalDocumentMeta | null | undefined;
   data: models.DocumentResponseDto;

package/src/models/operations/get-booking-proposal.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetBookingProposalRequest = {
   bookingProposalId: string;
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -32,6 +41,9 @@ export type GetBookingProposalErrors = {};
 
 export type GetBookingProposalRawData = {};
 
+/**
+ * Booking proposal record matching the provided ID
+ */
 export type GetBookingProposalResponse = {
   meta?: GetBookingProposalMeta | null | undefined;
   data: models.BookingProposalResponseDto;