@maesn/typescript-sdk 0.2.1 → 0.2.3

package/src/models/operations/get-invoices.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 invoices by unified status
+ */
 export const GetInvoicesStatus = {
   Draft: "DRAFT",
   Corrective: "CORRECTIVE",
@@ -22,8 +25,14 @@ export const GetInvoicesStatus = {
   Overdue: "OVERDUE",
   Voided: "VOIDED",
 } as const;
+/**
+ * Filter invoices by unified status
+ */
 export type GetInvoicesStatus = ClosedEnum<typeof GetInvoicesStatus>;
 
+/**
+ * Filter invoices by payment status
+ */
 export const GetInvoicesPaymentStatus = {
   NoOpenItem: "NO_OPEN_ITEM",
   Pending: "PENDING",
@@ -37,35 +46,77 @@ export const GetInvoicesPaymentStatus = {
   Canceled: "CANCELED",
   Unknown: "UNKNOWN",
 } as const;
+/**
+ * Filter invoices by payment status
+ */
 export type GetInvoicesPaymentStatus = ClosedEnum<
   typeof GetInvoicesPaymentStatus
 >;
 
+/**
+ * Field to sort the results by
+ */
 export const GetInvoicesOrderField = {
   InvoiceDate: "invoiceDate",
   InvoiceNumber: "invoiceNumber",
   CreatedDate: "createdDate",
   UpdatedDate: "updatedDate",
 } as const;
+/**
+ * Field to sort the results by
+ */
 export type GetInvoicesOrderField = ClosedEnum<typeof GetInvoicesOrderField>;
 
+/**
+ * Sort direction for the ordered results
+ */
 export const GetInvoicesOrderDir = {
   Asc: "ASC",
   Desc: "DESC",
 } as const;
+/**
+ * Sort direction for the ordered results
+ */
 export type GetInvoicesOrderDir = ClosedEnum<typeof GetInvoicesOrderDir>;
 
 export type GetInvoicesRequest = {
   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 invoices by unified status
+   */
   status?: GetInvoicesStatus | undefined;
+  /**
+   * Filter invoices by payment status
+   */
   paymentStatus?: GetInvoicesPaymentStatus | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
+  /**
+   * Field to sort the results by
+   */
   orderField?: GetInvoicesOrderField | undefined;
+  /**
+   * Sort direction for the ordered results
+   */
   orderDir?: GetInvoicesOrderDir | undefined;
+  /**
+   * ISO 8601 date; only invoices with a due date on or after this date are returned
+   */
   dueDateFrom?: string | undefined;
 };
 
@@ -85,6 +136,9 @@ export type GetInvoicesErrors = {};
 
 export type GetInvoicesRawData = {};
 
+/**
+ * List of invoices for the authenticated end user's connected target system
+ */
 export type GetInvoicesResponse = {
   meta?: GetInvoicesMeta | null | undefined;
   data: Array<models.InvoiceResponseDto>;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetItemRequest = {
   itemId: 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 GetItemErrors = {};
 
 export type GetItemRawData = {};
 
+/**
+ * Item record matching the provided ID
+ */
 export type GetItemResponse = {
   meta?: GetItemMeta | null | undefined;
   data: Array<models.ItemResponseDto>;

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

@@ -12,11 +12,29 @@ import * as models from "../index.js";
 export type GetItemsRequest = {
   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 items by type
+   */
   type?: string | undefined;
+  /**
+   * Filter items by item number
+   */
   itemNumber?: string | undefined;
 };
 
@@ -36,6 +54,9 @@ export type GetItemsErrors = {};
 
 export type GetItemsRawData = {};
 
+/**
+ * List of items for the authenticated end user's connected target system
+ */
 export type GetItemsResponse = {
   meta?: GetItemsMeta | null | undefined;
   data: Array<models.ItemResponseDto>;

package/src/models/operations/get-journal-entries.ts

@@ -12,11 +12,29 @@ import * as models from "../index.js";
 export type GetJournalEntriesRequest = {
   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 journal entries (e.g. 2024)
+   */
   fiscalYear?: number | undefined;
+  /**
+   * ISO 8601 start date of the fiscal year used for scoping results
+   */
   fiscalYearStartDate?: string | undefined;
 };
 
@@ -36,6 +54,9 @@ export type GetJournalEntriesErrors = {};
 
 export type GetJournalEntriesRawData = {};
 
+/**
+ * List of journal entries for the authenticated end user's connected target system
+ */
 export type GetJournalEntriesResponse = {
   meta?: GetJournalEntriesMeta | null | undefined;
   data: Array<models.JournalEntryResponseDto>;

package/src/models/operations/get-journal-entry-attachment-by-id.ts

@@ -12,7 +12,13 @@ import * as models from "../index.js";
 export type GetJournalEntryAttachmentByIdRequest = {
   journalEntryId: string;
   attachmentId: 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;
 };
 
@@ -32,6 +38,9 @@ export type GetJournalEntryAttachmentByIdErrors = {};
 
 export type GetJournalEntryAttachmentByIdRawData = {};
 
+/**
+ * Journal entry attachment record matching the provided ID
+ */
 export type GetJournalEntryAttachmentByIdResponse = {
   meta?: GetJournalEntryAttachmentByIdMeta | null | undefined;
   data: models.JournalEntryResponseDto;

package/src/models/operations/get-journal-entry-attachments.ts

@@ -11,7 +11,13 @@ import * as models from "../index.js";
 
 export type GetJournalEntryAttachmentsRequest = {
   journalEntryId: 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 GetJournalEntryAttachmentsErrors = {};
 
 export type GetJournalEntryAttachmentsRawData = {};
 
+/**
+ * List of attachments for the journal entry matching the provided ID
+ */
 export type GetJournalEntryAttachmentsResponse = {
   meta?: GetJournalEntryAttachmentsMeta | null | undefined;
   data: Array<models.JournalEntryResponseDto>;

package/src/models/operations/get-journal-entry.ts

@@ -11,9 +11,21 @@ import * as models from "../index.js";
 
 export type GetJournalEntryRequest = {
   journalEntryId: 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;
+  /**
+   * Journal code used to scope the journal entry lookup on systems that require it
+   */
   journalCode?: string | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -33,6 +45,9 @@ export type GetJournalEntryErrors = {};
 
 export type GetJournalEntryRawData = {};
 
+/**
+ * Journal entry record matching the provided ID
+ */
 export type GetJournalEntryResponse = {
   meta?: GetJournalEntryMeta | null | undefined;
   data: models.JournalEntryResponseDto;

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

@@ -12,9 +12,21 @@ import * as models from "../index.js";
 export type GetJournalsRequest = {
   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 GetJournalsErrors = {};
 
 export type GetJournalsRawData = {};
 
+/**
+ * List of journals for the authenticated end user's connected target system
+ */
 export type GetJournalsResponse = {
   meta?: GetJournalsMeta | null | undefined;
   data: Array<models.JournalResponseDto>;

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

@@ -12,8 +12,17 @@ import * as models from "../index.js";
 export type GetLineItemRequest = {
   invoiceId: 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 GetLineItemErrors = {};
 
 export type GetLineItemRawData = {};
 
+/**
+ * Line item record matching the provided ID
+ */
 export type GetLineItemResponse = {
   meta?: GetLineItemMeta | null | undefined;
   data: models.LineItemResponseDto;

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

@@ -13,9 +13,21 @@ export type GetLineItemsRequest = {
   invoiceId: 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 GetLineItemsErrors = {};
 
 export type GetLineItemsRawData = {};
 
+/**
+ * List of line items for the authenticated end user's connected target system
+ */
 export type GetLineItemsResponse = {
   meta?: GetLineItemsMeta | null | undefined;
   data: Array<models.LineItemResponseDto>;

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

@@ -11,7 +11,13 @@ import * as models from "../index.js";
 
 export type GetOfferDocumentRequest = {
   offerId: 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 GetOfferDocumentErrors = {};
 
 export type GetOfferDocumentRawData = {};
 
+/**
+ * Document attached to the offer matching the provided ID
+ */
 export type GetOfferDocumentResponse = {
   meta?: GetOfferDocumentMeta | null | undefined;
   data: models.DocumentResponseDto;

package/src/models/operations/get-offer-line-item.ts

@@ -12,8 +12,17 @@ import * as models from "../index.js";
 export type GetOfferLineItemRequest = {
   offerId: 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 GetOfferLineItemErrors = {};
 
 export type GetOfferLineItemRawData = {};
 
+/**
+ * Offer line item record matching the provided ID
+ */
 export type GetOfferLineItemResponse = {
   meta?: GetOfferLineItemMeta | null | undefined;
   data: models.OfferLineItemResponseDto;

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

@@ -13,9 +13,21 @@ export type GetOfferLineItemsRequest = {
   offerId: 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 GetOfferLineItemsErrors = {};
 
 export type GetOfferLineItemsRawData = {};
 
+/**
+ * List of line items for the authenticated end user's connected target system
+ */
 export type GetOfferLineItemsResponse = {
   meta?: GetOfferLineItemsMeta | null | undefined;
   data: Array<models.OfferLineItemResponseDto>;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetOfferRequest = {
   offerId: 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 GetOfferErrors = {};
 
 export type GetOfferRawData = {};
 
+/**
+ * Offer record matching the provided ID
+ */
 export type GetOfferResponse = {
   meta?: GetOfferMeta | null | undefined;
   data: models.OfferResponseDto;

package/src/models/operations/get-offers.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 offers by unified status
+ */
 export const GetOffersStatus = {
   Draft: "DRAFT",
   Sent: "SENT",
@@ -18,15 +21,33 @@ export const GetOffersStatus = {
   Voided: "VOIDED",
   Declined: "DECLINED",
 } as const;
+/**
+ * Filter offers by unified status
+ */
 export type GetOffersStatus = ClosedEnum<typeof GetOffersStatus>;
 
 export type GetOffersRequest = {
   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 offers by unified status
+   */
   status?: GetOffersStatus | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
 };
 
@@ -46,6 +67,9 @@ export type GetOffersErrors = {};
 
 export type GetOffersRawData = {};
 
+/**
+ * List of offers for the authenticated end user's connected target system
+ */
 export type GetOffersResponse = {
   meta?: GetOffersMeta | null | undefined;
   data: Array<models.OfferResponseDto>;

package/src/models/operations/get-open-items.ts

@@ -12,13 +12,37 @@ import * as models from "../index.js";
 export type GetOpenItemsRequest = {
   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 open items results (e.g. 2024)
+   */
   fiscalYear?: number | undefined;
+  /**
+   * Filter open items by account number
+   */
   accountNumber?: string | undefined;
+  /**
+   * Filter open items by document number
+   */
   documentNumber?: string | undefined;
+  /**
+   * Filter open items by type (e.g. receivable, payable)
+   */
   type?: string | undefined;
 };
 
@@ -38,6 +62,9 @@ export type GetOpenItemsErrors = {};
 
 export type GetOpenItemsRawData = {};
 
+/**
+ * List of open items for the authenticated end user's connected target system
+ */
 export type GetOpenItemsResponse = {
   meta?: GetOpenItemsMeta | null | undefined;
   data: Array<models.OpenItemResponseDto>;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetPaymentTermRequest = {
   paymentTermId: 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 GetPaymentTermErrors = {};
 
 export type GetPaymentTermRawData = {};
 
+/**
+ * Payment term record matching the provided ID
+ */
 export type GetPaymentTermResponse = {
   meta?: GetPaymentTermMeta | null | undefined;
   data: models.PaymentTermResponseDto;

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

@@ -12,11 +12,29 @@ import * as models from "../index.js";
 export type GetPaymentTermsRequest = {
   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 payment terms results (e.g. 2024)
+   */
   fiscalYear?: number | undefined;
+  /**
+   * ISO 8601 start date of the fiscal year used for scoping results
+   */
   fiscalYearStartDate?: string | undefined;
 };
 
@@ -36,6 +54,9 @@ export type GetPaymentTermsErrors = {};
 
 export type GetPaymentTermsRawData = {};
 
+/**
+ * List of payment terms for the authenticated end user's connected target system
+ */
 export type GetPaymentTermsResponse = {
   meta?: GetPaymentTermsMeta | null | undefined;
   data: Array<models.PaymentTermResponseDto>;