@maesn/typescript-sdk 0.2.1 → 0.2.2

package/src/models/operations/get-submit-page.ts

@@ -3,11 +3,25 @@
  */
 
 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 GetSubmitPageRequest = {
+  /**
+   * Unique code identifying the tenant submission session
+   */
   code: string;
 };
 
+/**
+ * Submission page rendered successfully
+ */
+export type GetSubmitPageResponse = {
+  code?: string | undefined;
+};
+
 /** @internal */
 export type GetSubmitPageRequest$Outbound = {
   code: string;
@@ -28,3 +42,21 @@ export function getSubmitPageRequestToJSON(
     GetSubmitPageRequest$outboundSchema.parse(getSubmitPageRequest),
   );
 }
+
+/** @internal */
+export const GetSubmitPageResponse$inboundSchema: z.ZodMiniType<
+  GetSubmitPageResponse,
+  unknown
+> = z.object({
+  code: types.optional(types.string()),
+});
+
+export function getSubmitPageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubmitPageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubmitPageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubmitPageResponse' from JSON`,
+  );
+}

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetSupplierRequest = {
   contactId: 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 GetSupplierErrors = {};
 
 export type GetSupplierRawData = {};
 
+/**
+ * Supplier record matching the provided ID
+ */
 export type GetSupplierResponse = {
   meta?: GetSupplierMeta | null | undefined;
   data: models.ContactResponseDto;

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

@@ -12,12 +12,33 @@ import * as models from "../index.js";
 export type GetSuppliersRequest = {
   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 suppliers by email address
+   */
   email?: string | undefined;
+  /**
+   * Filter suppliers by name
+   */
   name?: string | undefined;
+  /**
+   * Filter suppliers by supplier number
+   */
   number?: string | undefined;
 };
 
@@ -37,6 +58,9 @@ export type GetSuppliersErrors = {};
 
 export type GetSuppliersRawData = {};
 
+/**
+ * List of suppliers for the authenticated end user's connected target system
+ */
 export type GetSuppliersResponse = {
   meta?: GetSuppliersMeta | null | undefined;
   data: Array<models.ContactResponseDto>;

package/src/models/operations/get-tax-rate.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetTaxRateRequest = {
   taxRateId: 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 GetTaxRateErrors = {};
 
 export type GetTaxRateRawData = {};
 
+/**
+ * Tax rate record matching the provided ID
+ */
 export type GetTaxRateResponse = {
   meta?: GetTaxRateMeta | null | undefined;
   data: models.TaxRateResponseDto;

package/src/models/operations/get-tax-rates.ts

@@ -12,10 +12,25 @@ import * as models from "../index.js";
 export type GetTaxRatesRequest = {
   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;
+  /**
+   * When true, returns only active tax rates; when false, returns only inactive tax rates
+   */
   isActive?: boolean | undefined;
 };
 
@@ -35,6 +50,9 @@ export type GetTaxRatesErrors = {};
 
 export type GetTaxRatesRawData = {};
 
+/**
+ * List of tax rates for the authenticated end user's connected target system
+ */
 export type GetTaxRatesResponse = {
   meta?: GetTaxRatesMeta | null | undefined;
   data: Array<models.TaxRateResponseDto>;

package/src/models/operations/get-trial-balance.ts

@@ -12,13 +12,37 @@ import * as models from "../index.js";
 export type GetTrialBalanceRequest = {
   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;
+  /**
+   * Fiscal year to scope the trial balance results (e.g. 2024)
+   */
   fiscalYear?: number | undefined;
+  /**
+   * Filter the trial balance by account number
+   */
   accountNumber?: string | undefined;
+  /**
+   * Filter the trial balance by account code
+   */
   accountCode?: string | undefined;
+  /**
+   * ISO 8601 start date of the fiscal year used for balance calculation
+   */
   fiscalYearStartDate?: string | undefined;
 };
 
@@ -38,6 +62,9 @@ export type GetTrialBalanceErrors = {};
 
 export type GetTrialBalanceRawData = {};
 
+/**
+ * Trial balance for the authenticated end user's connected target system
+ */
 export type GetTrialBalanceResponse = {
   meta?: GetTrialBalanceMeta | null | undefined;
   data: Array<models.TrialBalanceResponseDto>;

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

@@ -12,8 +12,17 @@ import * as models from "../index.js";
 export type GetUnitsRequest = {
   page?: number | undefined;
   limit?: number | 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;
 };
 
@@ -33,6 +42,9 @@ export type GetUnitsErrors = {};
 
 export type GetUnitsRawData = {};
 
+/**
+ * List of units for the authenticated end user's connected target system
+ */
 export type GetUnitsResponse = {
   meta?: GetUnitsMeta | null | undefined;
   data: Array<models.UnitResponseDto>;

package/src/models/operations/get-vendor-credits.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 vendor credits by unified status
+ */
 export const GetVendorCreditsStatus = {
   Draft: "DRAFT",
   Corrective: "CORRECTIVE",
@@ -22,8 +25,14 @@ export const GetVendorCreditsStatus = {
   Overdue: "OVERDUE",
   Voided: "VOIDED",
 } as const;
+/**
+ * Filter vendor credits by unified status
+ */
 export type GetVendorCreditsStatus = ClosedEnum<typeof GetVendorCreditsStatus>;
 
+/**
+ * Filter vendor credits by payment status
+ */
 export const GetVendorCreditsPaymentStatus = {
   NoOpenItem: "NO_OPEN_ITEM",
   Pending: "PENDING",
@@ -37,6 +46,9 @@ export const GetVendorCreditsPaymentStatus = {
   Canceled: "CANCELED",
   Unknown: "UNKNOWN",
 } as const;
+/**
+ * Filter vendor credits by payment status
+ */
 export type GetVendorCreditsPaymentStatus = ClosedEnum<
   typeof GetVendorCreditsPaymentStatus
 >;
@@ -44,11 +56,29 @@ export type GetVendorCreditsPaymentStatus = ClosedEnum<
 export type GetVendorCreditsRequest = {
   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 vendor credits by unified status
+   */
   status?: GetVendorCreditsStatus | undefined;
+  /**
+   * Filter vendor credits by payment status
+   */
   paymentStatus?: GetVendorCreditsPaymentStatus | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -68,6 +98,9 @@ export type GetVendorCreditsErrors = {};
 
 export type GetVendorCreditsRawData = {};
 
+/**
+ * List of vendor credits for the authenticated end user's connected target system
+ */
 export type GetVendorCreditsResponse = {
   meta?: GetVendorCreditsMeta | null | undefined;
   data: Array<models.VendorCreditResponseDto>;

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

@@ -3,13 +3,53 @@
  */
 
 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";
+import * as models from "../index.js";
 
 export type GetWebhooksRequest = {
+  /**
+   * 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;
 };
 
+export type GetWebhooksPagination = {
+  total: number;
+  perPage: number;
+  currentPage: number;
+  totalPages: number;
+};
+
+export type GetWebhooksMeta = {
+  warnings?: Array<string> | null | undefined;
+  pagination?: GetWebhooksPagination | null | undefined;
+};
+
+export type GetWebhooksErrors = {};
+
+export type GetWebhooksRawData = {};
+
+/**
+ * List of webhooks for the authenticated end user's connected target system
+ */
+export type GetWebhooksResponse = {
+  meta?: GetWebhooksMeta | null | undefined;
+  data: Array<models.WebhookResponseDto>;
+  errors: GetWebhooksErrors | null;
+  rawData: GetWebhooksRawData | null;
+};
+
 /** @internal */
 export type GetWebhooksRequest$Outbound = {
   environmentName?: string | undefined;
@@ -34,3 +74,98 @@ export function getWebhooksRequestToJSON(
     GetWebhooksRequest$outboundSchema.parse(getWebhooksRequest),
   );
 }
+
+/** @internal */
+export const GetWebhooksPagination$inboundSchema: z.ZodMiniType<
+  GetWebhooksPagination,
+  unknown
+> = z.object({
+  total: types.number(),
+  perPage: types.number(),
+  currentPage: types.number(),
+  totalPages: types.number(),
+});
+
+export function getWebhooksPaginationFromJSON(
+  jsonString: string,
+): SafeParseResult<GetWebhooksPagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetWebhooksPagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetWebhooksPagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetWebhooksMeta$inboundSchema: z.ZodMiniType<
+  GetWebhooksMeta,
+  unknown
+> = z.object({
+  warnings: z.optional(z.nullable(z.array(types.string()))),
+  pagination: z.optional(
+    z.nullable(z.lazy(() => GetWebhooksPagination$inboundSchema)),
+  ),
+});
+
+export function getWebhooksMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<GetWebhooksMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetWebhooksMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetWebhooksMeta' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetWebhooksErrors$inboundSchema: z.ZodMiniType<
+  GetWebhooksErrors,
+  unknown
+> = z.object({});
+
+export function getWebhooksErrorsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetWebhooksErrors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetWebhooksErrors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetWebhooksErrors' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetWebhooksRawData$inboundSchema: z.ZodMiniType<
+  GetWebhooksRawData,
+  unknown
+> = z.object({});
+
+export function getWebhooksRawDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetWebhooksRawData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetWebhooksRawData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetWebhooksRawData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetWebhooksResponse$inboundSchema: z.ZodMiniType<
+  GetWebhooksResponse,
+  unknown
+> = z.object({
+  meta: z.optional(z.nullable(z.lazy(() => GetWebhooksMeta$inboundSchema))),
+  data: z.array(models.WebhookResponseDto$inboundSchema),
+  errors: types.nullable(z.lazy(() => GetWebhooksErrors$inboundSchema)),
+  rawData: types.nullable(z.lazy(() => GetWebhooksRawData$inboundSchema)),
+});
+
+export function getWebhooksResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetWebhooksResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetWebhooksResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetWebhooksResponse' from JSON`,
+  );
+}

package/src/models/operations/handle-callback.ts

@@ -3,11 +3,19 @@
  */
 
 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 HandleCallbackRequest = {
   code: string;
 };
 
+/**
+ * Webhook event received and queued for processing
+ */
+export type HandleCallbackResponse = {};
+
 /** @internal */
 export type HandleCallbackRequest$Outbound = {
   code: string;
@@ -28,3 +36,19 @@ export function handleCallbackRequestToJSON(
     HandleCallbackRequest$outboundSchema.parse(handleCallbackRequest),
   );
 }
+
+/** @internal */
+export const HandleCallbackResponse$inboundSchema: z.ZodMiniType<
+  HandleCallbackResponse,
+  unknown
+> = z.object({});
+
+export function handleCallbackResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<HandleCallbackResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HandleCallbackResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HandleCallbackResponse' from JSON`,
+  );
+}

package/src/models/operations/handle-configuration-callback.ts

@@ -3,11 +3,19 @@
  */
 
 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 HandleConfigurationCallbackRequest = {
   code: string;
 };
 
+/**
+ * Configuration webhook event received and queued for processing
+ */
+export type HandleConfigurationCallbackResponse = {};
+
 /** @internal */
 export type HandleConfigurationCallbackRequest$Outbound = {
   code: string;
@@ -30,3 +38,20 @@ export function handleConfigurationCallbackRequestToJSON(
     ),
   );
 }
+
+/** @internal */
+export const HandleConfigurationCallbackResponse$inboundSchema: z.ZodMiniType<
+  HandleConfigurationCallbackResponse,
+  unknown
+> = z.object({});
+
+export function handleConfigurationCallbackResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<HandleConfigurationCallbackResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      HandleConfigurationCallbackResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HandleConfigurationCallbackResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -2,7 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./api-key-confirmation.js";
 export * from "./callback.js";
+export * from "./cancel.js";
+export * from "./check.js";
 export * from "./create-account.js";
 export * from "./create-bank-account.js";
 export * from "./create-bill-line-item.js";
@@ -33,9 +36,12 @@ export * from "./create-sales-order.js";
 export * from "./create-supplier.js";
 export * from "./create-transaction.js";
 export * from "./create-vendor-credit.js";
+export * from "./create-web-hook-tenant.js";
+export * from "./create-webhook-config.js";
 export * from "./create-webhook-end-user.js";
 export * from "./create-webhook.js";
 export * from "./delete-bill.js";
+export * from "./delete-end-user.js";
 export * from "./delete-event-subscriptions.js";
 export * from "./delete-payment.js";
 export * from "./delete-registered-system.js";
@@ -46,6 +52,7 @@ export * from "./delete-webhook.js";
 export * from "./details.js";
 export * from "./get-account.js";
 export * from "./get-accounts.js";
+export * from "./get-all-active-end-users.js";
 export * from "./get-async-task-info.js";
 export * from "./get-bank-account.js";
 export * from "./get-bank-accounts.js";
@@ -113,6 +120,7 @@ export * from "./get-purchase-orders.js";
 export * from "./get-sales-order-lines.js";
 export * from "./get-sales-order.js";
 export * from "./get-sales-orders.js";
+export * from "./get-submission-page-style-by-key.js";
 export * from "./get-submission-page-style.js";
 export * from "./get-submit-page.js";
 export * from "./get-supplier.js";
@@ -143,5 +151,6 @@ export * from "./test.js";
 export * from "./update-bill-line-item.js";
 export * from "./update-bill.js";
 export * from "./update-customer.js";
+export * from "./update-submission-page-style.js";
 export * from "./update-supplier.js";
 export * from "./update-vendor-credit.js";

package/src/models/operations/long-token.ts

@@ -5,15 +5,24 @@
 import * as z from "zod/v4-mini";
 
 export type LongTokenRequest = {
-  targetSystem?: string | undefined;
-  companyId?: string | undefined;
+  /**
+   * Identifier of the target system (e.g. exact, sevdesk, xero)
+   */
+  targetSystem: string;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
+  companyId: string;
+  /**
+   * URL to redirect to after successful authentication
+   */
   callbackUrl?: string | undefined;
 };
 
 /** @internal */
 export type LongTokenRequest$Outbound = {
-  targetSystem?: string | undefined;
-  companyId?: string | undefined;
+  targetSystem: string;
+  companyId: string;
   callbackUrl?: string | undefined;
 };
 
@@ -22,8 +31,8 @@ export const LongTokenRequest$outboundSchema: z.ZodMiniType<
   LongTokenRequest$Outbound,
   LongTokenRequest
 > = z.object({
-  targetSystem: z.optional(z.string()),
-  companyId: z.optional(z.string()),
+  targetSystem: z.string(),
+  companyId: z.string(),
   callbackUrl: z.optional(z.string()),
 });
 

package/src/models/operations/patch-contact-v2.ts

@@ -11,7 +11,13 @@ import * as models from "../index.js";
 
 export type PatchContactV2Request = {
   contactId: 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;
   body: models.CreateContactRequestDtoV2;
 };
@@ -32,6 +38,9 @@ export type PatchContactV2Errors = {};
 
 export type PatchContactV2RawData = {};
 
+/**
+ * Contact updated successfully
+ */
 export type PatchContactV2Response = {
   meta?: PatchContactV2Meta | null | undefined;
   data: models.ContactResponseDtoV2;