@maesn/typescript-sdk 0.2.1 → 0.2.2

package/src/models/operations/get-booking-proposals.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 booking proposals by booking type
+ */
 export const BookingType = {
   Invoice: "INVOICE",
   Bill: "BILL",
@@ -21,8 +24,14 @@ export const BookingType = {
   DownPayment: "DOWN_PAYMENT",
   Other: "OTHER",
 } as const;
+/**
+ * Filter booking proposals by booking type
+ */
 export type BookingType = ClosedEnum<typeof BookingType>;
 
+/**
+ * Filter booking proposals by status
+ */
 export const GetBookingProposalsStatus = {
   Draft: "DRAFT",
   Submitted: "SUBMITTED",
@@ -34,24 +43,39 @@ export const GetBookingProposalsStatus = {
   Disputed: "DISPUTED",
   Cancelled: "CANCELLED",
 } as const;
+/**
+ * Filter booking proposals by status
+ */
 export type GetBookingProposalsStatus = ClosedEnum<
   typeof GetBookingProposalsStatus
 >;
 
+/**
+ * Field to sort the results by
+ */
 export const GetBookingProposalsOrderField = {
   BookingProposalDate: "bookingProposalDate",
   Number: "number",
   CreatedDate: "createdDate",
   UpdatedDate: "updatedDate",
 } as const;
+/**
+ * Field to sort the results by
+ */
 export type GetBookingProposalsOrderField = ClosedEnum<
   typeof GetBookingProposalsOrderField
 >;
 
+/**
+ * Sort direction for the ordered results
+ */
 export const GetBookingProposalsOrderDir = {
   Asc: "ASC",
   Desc: "DESC",
 } as const;
+/**
+ * Sort direction for the ordered results
+ */
 export type GetBookingProposalsOrderDir = ClosedEnum<
   typeof GetBookingProposalsOrderDir
 >;
@@ -59,13 +83,37 @@ export type GetBookingProposalsOrderDir = ClosedEnum<
 export type GetBookingProposalsRequest = {
   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 booking proposals by booking type
+   */
   bookingType?: BookingType | undefined;
+  /**
+   * Filter booking proposals by status
+   */
   status?: GetBookingProposalsStatus | undefined;
+  /**
+   * When true, returns the unprocessed response from the upstream target system
+   */
   rawData?: boolean | undefined;
+  /**
+   * Field to sort the results by
+   */
   orderField?: GetBookingProposalsOrderField | undefined;
+  /**
+   * Sort direction for the ordered results
+   */
   orderDir?: GetBookingProposalsOrderDir | undefined;
 };
 
@@ -85,6 +133,9 @@ export type GetBookingProposalsErrors = {};
 
 export type GetBookingProposalsRawData = {};
 
+/**
+ * List of booking proposals for the authenticated end user's connected target system
+ */
 export type GetBookingProposalsResponse = {
   meta?: GetBookingProposalsMeta | null | undefined;
   data: Array<models.BookingProposalResponseDto>;

package/src/models/operations/get-code.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 GetCodeRequest = {
   code: string;
 };
 
+/**
+ * Authorization code saved successfully
+ */
+export type GetCodeResponse = {};
+
 /** @internal */
 export type GetCodeRequest$Outbound = {
   code: string;
@@ -24,3 +32,19 @@ export const GetCodeRequest$outboundSchema: z.ZodMiniType<
 export function getCodeRequestToJSON(getCodeRequest: GetCodeRequest): string {
   return JSON.stringify(GetCodeRequest$outboundSchema.parse(getCodeRequest));
 }
+
+/** @internal */
+export const GetCodeResponse$inboundSchema: z.ZodMiniType<
+  GetCodeResponse,
+  unknown
+> = z.object({});
+
+export function getCodeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCodeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCodeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCodeResponse' from JSON`,
+  );
+}

package/src/models/operations/get-companies-flow.ts

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type GetCompaniesFlowRequest = {
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
 };
 
@@ -29,6 +32,9 @@ export type GetCompaniesFlowErrors = {};
 
 export type GetCompaniesFlowRawData = {};
 
+/**
+ * List of companies for the authenticated end user's connected target system
+ */
 export type GetCompaniesFlowResponse = {
   meta?: GetCompaniesFlowMeta | null | undefined;
   data: Array<models.CompanyResponseDto>;

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

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type GetCompaniesRequest = {
+  /**
+   * Environment name (required for multi-environment systems such as Business Central)
+   */
   environmentName?: string | undefined;
 };
 
@@ -29,6 +32,9 @@ export type GetCompaniesErrors = {};
 
 export type GetCompaniesRawData = {};
 
+/**
+ * List of companies for the authenticated end user's connected target system
+ */
 export type GetCompaniesResponse = {
   meta?: GetCompaniesMeta | null | undefined;
   data: Array<models.CompanyResponseDto>;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetContactV2Request = {
   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 GetContactV2Errors = {};
 
 export type GetContactV2RawData = {};
 
+/**
+ * Contact record matching the provided ID
+ */
 export type GetContactV2Response = {
   meta?: GetContactV2Meta | null | undefined;
   data: models.ContactResponseDtoV2;

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

@@ -11,8 +11,17 @@ import * as models from "../index.js";
 
 export type GetContactRequest = {
   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 GetContactErrors = {};
 
 export type GetContactRawData = {};
 
+/**
+ * Contact record matching the provided ID
+ */
 export type GetContactResponse = {
   meta?: GetContactMeta | null | undefined;
   data: models.ContactResponseDtoV2;

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

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

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;