@maesn/typescript-sdk 0.2.1 → 0.2.3

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

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetContactsRequest = {
   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 GetContactsErrors = {};
 
 export type GetContactsRawData = {};
 
+/**
+ * List of contacts for the authenticated end user's connected target system
+ */
 export type GetContactsResponse = {
   meta?: GetContactsMeta | null | undefined;
   data: Array<models.ContactResponseDtoV2>;

package/src/models/operations/get-credit-note.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetCreditNoteRequest = {
   creditNoteId: 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 GetCreditNoteErrors = {};
 
 export type GetCreditNoteRawData = {};
 
+/**
+ * Credit note record matching the provided ID
+ */
 export type GetCreditNoteResponse = {
   meta?: GetCreditNoteMeta | null | undefined;
   data: models.CreditNoteResponseDto;

package/src/models/operations/get-credit-notes.ts

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetCreditNotesRequest = {
   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 GetCreditNotesErrors = {};
 
 export type GetCreditNotesRawData = {};
 
+/**
+ * List of credit notes for the authenticated end user's connected target system
+ */
 export type GetCreditNotesResponse = {
   meta?: GetCreditNotesMeta | null | undefined;
   data: Array<models.CreditNoteResponseDto>;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetCustomerRequest = {
   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 GetCustomerErrors = {};
 
 export type GetCustomerRawData = {};
 
+/**
+ * Customer record matching the provided ID
+ */
 export type GetCustomerResponse = {
   meta?: GetCustomerMeta | null | undefined;
   data: models.ContactResponseDto;

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

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

package/src/models/operations/get-dimensions-by-dimension.ts

@@ -13,9 +13,21 @@ export type GetDimensionsByDimensionRequest = {
   dimension: 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 GetDimensionsByDimensionErrors = {};
 
 export type GetDimensionsByDimensionRawData = {};
 
+/**
+ * List of dimension values for the authenticated end user's connected target system
+ */
 export type GetDimensionsByDimensionResponse = {
   meta?: GetDimensionsByDimensionMeta | null | undefined;
   data: Array<models.DimensionMetaResponseDto>;

package/src/models/operations/get-dimensions-v2.ts

@@ -10,9 +10,21 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type GetDimensionsV2Request = {
+  /**
+   * 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;
 };
 
@@ -32,6 +44,9 @@ export type GetDimensionsV2Errors = {};
 
 export type GetDimensionsV2RawData = {};
 
+/**
+ * List of dimension categories for the authenticated end user's connected target system
+ */
 export type GetDimensionsV2Response = {
   meta?: GetDimensionsV2Meta | null | undefined;
   data: Array<models.DimensionMetaResponseDto>;

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

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetDimensionsRequest = {
   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 GetDimensionsErrors = {};
 
 export type GetDimensionsRawData = {};
 
+/**
+ * List of dimensions for the authenticated end user's connected target system
+ */
 export type GetDimensionsResponse = {
   meta?: GetDimensionsMeta | null | undefined;
   data: Array<models.DimensionResponseDto>;

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

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type GetDocumentExtensionsRequest = {
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
 };
 
@@ -29,6 +32,9 @@ export type GetDocumentExtensionsErrors = {};
 
 export type GetDocumentExtensionsRawData = {};
 
+/**
+ * List of permitted file extensions for the authenticated end user's connected target system
+ */
 export type GetDocumentExtensionsResponse = {
   meta?: GetDocumentExtensionsMeta | null | undefined;
   data: models.DocumentExtensionsResponseDto;

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

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type GetDocumentTypesRequest = {
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
 };
 
@@ -29,6 +32,9 @@ export type GetDocumentTypesErrors = {};
 
 export type GetDocumentTypesRawData = {};
 
+/**
+ * List of document types supported by the authenticated end user's connected target system
+ */
 export type GetDocumentTypesResponse = {
   meta?: GetDocumentTypesMeta | null | undefined;
   data: Array<models.DocumentTypesResponseDto>;

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

@@ -3,12 +3,26 @@
  */
 
 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 GetEnvironmentPageRequest = {
+  /**
+   * Encoded state value containing tenant and user context, returned from the OAuth redirect
+   */
   state: string;
+  /**
+   * Identifier of the target system (e.g. exact, sevdesk, xero)
+   */
   targetSystem: string;
 };
 
+/**
+ * Environment or company selection page rendered successfully
+ */
+export type GetEnvironmentPageResponse = {};
+
 /** @internal */
 export type GetEnvironmentPageRequest$Outbound = {
   state: string;
@@ -31,3 +45,19 @@ export function getEnvironmentPageRequestToJSON(
     GetEnvironmentPageRequest$outboundSchema.parse(getEnvironmentPageRequest),
   );
 }
+
+/** @internal */
+export const GetEnvironmentPageResponse$inboundSchema: z.ZodMiniType<
+  GetEnvironmentPageResponse,
+  unknown
+> = z.object({});
+
+export function getEnvironmentPageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEnvironmentPageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEnvironmentPageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEnvironmentPageResponse' from JSON`,
+  );
+}

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

@@ -25,6 +25,9 @@ export type GetEnvironmentsErrors = {};
 
 export type GetEnvironmentsRawData = {};
 
+/**
+ * List of environments for the authenticated end user's connected target system
+ */
 export type GetEnvironmentsResponse = {
   meta?: GetEnvironmentsMeta | null | undefined;
   data: Array<models.EnvironmentResponseDto>;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetExpenseRequest = {
   expenseId: string;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
+  /**
+   * Journal code used to scope the expense lookup on systems that require it
+   */
   journalCode?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -32,6 +41,9 @@ export type GetExpenseErrors = {};
 
 export type GetExpenseRawData = {};
 
+/**
+ * Expense record matching the provided ID
+ */
 export type GetExpenseResponse = {
   meta?: GetExpenseMeta | null | undefined;
   data: models.ExpenseResponseDto;

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

@@ -12,8 +12,17 @@ import * as models from "../index.js";
 export type GetExpensesRequest = {
   page?: number | undefined;
   limit?: number | undefined;
+  /**
+   * ISO 8601 timestamp; only records modified after this date are returned
+   */
   lastModifiedAt?: 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 GetExpensesErrors = {};
 
 export type GetExpensesRawData = {};
 
+/**
+ * List of expenses for the authenticated end user's connected target system
+ */
 export type GetExpensesResponse = {
   meta?: GetExpensesMeta | null | undefined;
   data: Array<models.ExpenseResponseDto>;

package/src/models/operations/get-fiscal-year.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetFiscalYearRequest = {
   fiscalYearId: 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 GetFiscalYearErrors = {};
 
 export type GetFiscalYearRawData = {};
 
+/**
+ * Fiscal year record matching the provided ID
+ */
 export type GetFiscalYearResponse = {
   meta?: GetFiscalYearMeta | null | undefined;
   data: Array<models.FiscalYearResponseDto>;

package/src/models/operations/get-fiscal-years.ts

@@ -10,8 +10,17 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type GetFiscalYearsRequest = {
+  /**
+   * 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;
 };
 
@@ -31,6 +40,9 @@ export type GetFiscalYearsErrors = {};
 
 export type GetFiscalYearsRawData = {};
 
+/**
+ * List of fiscal years for the authenticated end user's connected target system
+ */
 export type GetFiscalYearsResponse = {
   meta?: GetFiscalYearsMeta | null | undefined;
   data: Array<models.FiscalYearResponseDto>;

package/src/models/operations/get-goods-receipt-line-item.ts

@@ -12,8 +12,17 @@ import * as models from "../index.js";
 export type GetGoodsReceiptLineItemRequest = {
   goodsReceiptId: 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 GetGoodsReceiptLineItemErrors = {};
 
 export type GetGoodsReceiptLineItemRawData = {};
 
+/**
+ * Goods receipt line item record matching the provided ID
+ */
 export type GetGoodsReceiptLineItemResponse = {
   meta?: GetGoodsReceiptLineItemMeta | null | undefined;
   data: models.GoodsReceiptLineItemResponse;

package/src/models/operations/get-goods-receipt-line-items.ts

@@ -11,9 +11,21 @@ import * as models from "../index.js";
 
 export type GetGoodsReceiptLineItemsRequest = {
   goodsReceiptId: 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 GetGoodsReceiptLineItemsErrors = {};
 
 export type GetGoodsReceiptLineItemsRawData = {};
 
+/**
+ * List of line items for the authenticated end user's connected target system
+ */
 export type GetGoodsReceiptLineItemsResponse = {
   meta?: GetGoodsReceiptLineItemsMeta | null | undefined;
   data: Array<models.GoodsReceiptLineItemResponse>;

package/src/models/operations/get-goods-receipt.ts

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetGoodsReceiptRequest = {
   goodsReceiptId: 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 GetGoodsReceiptErrors = {};
 
 export type GetGoodsReceiptRawData = {};
 
+/**
+ * Goods receipt record matching the provided ID
+ */
 export type GetGoodsReceiptResponse = {
   meta?: GetGoodsReceiptMeta | null | undefined;
   data: models.GoodsReceiptResponseDto;

package/src/models/operations/get-goods-receipts.ts

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetGoodsReceiptsRequest = {
   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 GetGoodsReceiptsErrors = {};
 
 export type GetGoodsReceiptsRawData = {};
 
+/**
+ * List of goods receipts for the authenticated end user's connected target system
+ */
 export type GetGoodsReceiptsResponse = {
   meta?: GetGoodsReceiptsMeta | null | undefined;
   data: Array<models.GoodsReceiptResponseDto>;

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

@@ -11,7 +11,13 @@ import * as models from "../index.js";
 
 export type GetInvoiceDocumentRequest = {
   invoiceId: 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;
 };
 
@@ -31,6 +37,9 @@ export type GetInvoiceDocumentErrors = {};
 
 export type GetInvoiceDocumentRawData = {};
 
+/**
+ * Document attached to the invoice matching the provided ID
+ */
 export type GetInvoiceDocumentResponse = {
   meta?: GetInvoiceDocumentMeta | null | undefined;
   data: models.DocumentResponseDto;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetInvoiceRequest = {
   invoiceId: 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 GetInvoiceErrors = {};
 
 export type GetInvoiceRawData = {};
 
+/**
+ * Invoice record matching the provided ID
+ */
 export type GetInvoiceResponse = {
   meta?: GetInvoiceMeta | null | undefined;
   data: models.InvoiceResponseDto;