@maesn/typescript-sdk 0.2.1 → 0.2.3

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

@@ -11,7 +11,13 @@ import * as models from "../index.js";
 
 export type GetPaymentRequest = {
   paymentId: 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 GetPaymentErrors = {};
 
 export type GetPaymentRawData = {};
 
+/**
+ * Payment record matching the provided ID
+ */
 export type GetPaymentResponse = {
   meta?: GetPaymentMeta | null | undefined;
   data: models.PaymentResponseDto;

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

@@ -12,10 +12,25 @@ import * as models from "../index.js";
 export type GetPaymentsRequest = {
   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;
+  /**
+   * ISO 8601 timestamp; only records modified after this date are returned
+   */
   lastModifiedAt?: string | undefined;
+  /**
+   * ID of the invoice to filter payments by
+   */
   invoiceId?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -35,6 +50,9 @@ export type GetPaymentsErrors = {};
 
 export type GetPaymentsRawData = {};
 
+/**
+ * List of payments for the authenticated end user's connected target system
+ */
 export type GetPaymentsResponse = {
   meta?: GetPaymentsMeta | null | undefined;
   data: Array<models.PaymentResponseDto>;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetProjectRequest = {
   projectId: 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 GetProjectErrors = {};
 
 export type GetProjectRawData = {};
 
+/**
+ * Project record matching the provided ID
+ */
 export type GetProjectResponse = {
   meta?: GetProjectMeta | null | undefined;
   data: models.ProjectResponseDto;

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

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetProjectsRequest = {
   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 GetProjectsErrors = {};
 
 export type GetProjectsRawData = {};
 
+/**
+ * List of projects for the authenticated end user's connected target system
+ */
 export type GetProjectsResponse = {
   meta?: GetProjectsMeta | null | undefined;
   data: Array<models.ProjectResponseDto>;

package/src/models/operations/get-purchase-order-line-item.ts

@@ -12,8 +12,17 @@ import * as models from "../index.js";
 export type GetPurchaseOrderLineItemRequest = {
   purchaseOrderId: string;
   lineItemId: 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;
 };
 
@@ -33,6 +42,9 @@ export type GetPurchaseOrderLineItemErrors = {};
 
 export type GetPurchaseOrderLineItemRawData = {};
 
+/**
+ * Purchase order line item record matching the provided ID
+ */
 export type GetPurchaseOrderLineItemResponse = {
   meta?: GetPurchaseOrderLineItemMeta | null | undefined;
   data: models.PurchaseOrderLineItemResponseDto;

package/src/models/operations/get-purchase-order-line-items.ts

@@ -11,9 +11,21 @@ import * as models from "../index.js";
 
 export type GetPurchaseOrderLineItemsRequest = {
   purchaseOrderId: string;
+  /**
+   * 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;
 };
 
@@ -33,6 +45,9 @@ export type GetPurchaseOrderLineItemsErrors = {};
 
 export type GetPurchaseOrderLineItemsRawData = {};
 
+/**
+ * List of line items for the authenticated end user's connected target system
+ */
 export type GetPurchaseOrderLineItemsResponse = {
   meta?: GetPurchaseOrderLineItemsMeta | null | undefined;
   data: Array<models.PurchaseOrderLineItemResponseDto>;

package/src/models/operations/get-purchase-order.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetPurchaseOrderRequest = {
   purchaseOrderId: 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 GetPurchaseOrderErrors = {};
 
 export type GetPurchaseOrderRawData = {};
 
+/**
+ * Purchase order record matching the provided ID
+ */
 export type GetPurchaseOrderResponse = {
   meta?: GetPurchaseOrderMeta | null | undefined;
   data: models.PurchaseOrderResponseDto;

package/src/models/operations/get-purchase-orders.ts

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetPurchaseOrdersRequest = {
   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 GetPurchaseOrdersErrors = {};
 
 export type GetPurchaseOrdersRawData = {};
 
+/**
+ * List of purchase orders for the authenticated end user's connected target system
+ */
 export type GetPurchaseOrdersResponse = {
   meta?: GetPurchaseOrdersMeta | null | undefined;
   data: Array<models.PurchaseOrderResponseDto>;

package/src/models/operations/get-sales-order-lines.ts

@@ -13,9 +13,21 @@ export type GetSalesOrderLinesRequest = {
   salesOrderId: string;
   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;
 };
 
@@ -35,6 +47,9 @@ export type GetSalesOrderLinesErrors = {};
 
 export type GetSalesOrderLinesRawData = {};
 
+/**
+ * List of line items for the authenticated end user's connected target system
+ */
 export type GetSalesOrderLinesResponse = {
   meta?: GetSalesOrderLinesMeta | null | undefined;
   data: Array<models.SalesOrderLineItemResponseDto>;

package/src/models/operations/get-sales-order.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetSalesOrderRequest = {
   salesOrderId: 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 GetSalesOrderErrors = {};
 
 export type GetSalesOrderRawData = {};
 
+/**
+ * Sales order record matching the provided ID
+ */
 export type GetSalesOrderResponse = {
   meta?: GetSalesOrderMeta | null | undefined;
   data: models.SalesOrderResponseDto;

package/src/models/operations/get-sales-orders.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 sales orders by status
+ */
 export const GetSalesOrdersStatus = {
   Draft: "DRAFT",
   InReview: "IN_REVIEW",
@@ -17,15 +20,33 @@ export const GetSalesOrdersStatus = {
   Closed: "CLOSED",
   Voided: "VOIDED",
 } as const;
+/**
+ * Filter sales orders by status
+ */
 export type GetSalesOrdersStatus = ClosedEnum<typeof GetSalesOrdersStatus>;
 
 export type GetSalesOrdersRequest = {
   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 sales orders by status
+   */
   status?: GetSalesOrdersStatus | undefined;
 };
 
@@ -45,6 +66,9 @@ export type GetSalesOrdersErrors = {};
 
 export type GetSalesOrdersRawData = {};
 
+/**
+ * List of sales orders for the authenticated end user's connected target system
+ */
 export type GetSalesOrdersResponse = {
   meta?: GetSalesOrdersMeta | null | undefined;
   data: Array<models.SalesOrderResponseDto>;

package/src/models/operations/get-submission-page-style-by-key.ts

@@ -0,0 +1,30 @@
+/*
+ * 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";
+
+/**
+ * Submission page style configuration for the authenticated tenant
+ */
+export type GetSubmissionPageStyleByKeyResponse = {};
+
+/** @internal */
+export const GetSubmissionPageStyleByKeyResponse$inboundSchema: z.ZodMiniType<
+  GetSubmissionPageStyleByKeyResponse,
+  unknown
+> = z.object({});
+
+export function getSubmissionPageStyleByKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubmissionPageStyleByKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubmissionPageStyleByKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubmissionPageStyleByKeyResponse' from JSON`,
+  );
+}

package/src/models/operations/get-submission-page-style.ts

@@ -3,11 +3,22 @@
  */
 
 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 GetSubmissionPageStyleRequest = {
+  /**
+   * Unique tenant code used to look up the submission page style
+   */
   code: string;
 };
 
+/**
+ * Submission page style configuration for the given tenant code
+ */
+export type GetSubmissionPageStyleResponse = {};
+
 /** @internal */
 export type GetSubmissionPageStyleRequest$Outbound = {
   code: string;
@@ -30,3 +41,19 @@ export function getSubmissionPageStyleRequestToJSON(
     ),
   );
 }
+
+/** @internal */
+export const GetSubmissionPageStyleResponse$inboundSchema: z.ZodMiniType<
+  GetSubmissionPageStyleResponse,
+  unknown
+> = z.object({});
+
+export function getSubmissionPageStyleResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubmissionPageStyleResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubmissionPageStyleResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubmissionPageStyleResponse' from JSON`,
+  );
+}

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>;