@maesn/typescript-sdk 0.2.1 → 0.2.2

package/src/models/base-response-dto.ts

@@ -0,0 +1,133 @@
+/*
+ * 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 * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type Pagination = {
+  total: number;
+  perPage: number;
+  currentPage: number;
+  totalPages: number;
+};
+
+export type Meta = {
+  warnings?: Array<string> | null | undefined;
+  pagination?: Pagination | null | undefined;
+};
+
+export type Data = {};
+
+export type Errors = {};
+
+export type RawData = {};
+
+export type BaseResponseDto = {
+  meta?: Meta | null | undefined;
+  data: Data;
+  errors: Errors | null;
+  rawData: RawData | null;
+};
+
+/** @internal */
+export const Pagination$inboundSchema: z.ZodMiniType<Pagination, unknown> = z
+  .object({
+    total: types.number(),
+    perPage: types.number(),
+    currentPage: types.number(),
+    totalPages: types.number(),
+  });
+
+export function paginationFromJSON(
+  jsonString: string,
+): SafeParseResult<Pagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Pagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Pagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const Meta$inboundSchema: z.ZodMiniType<Meta, unknown> = z.object({
+  warnings: z.optional(z.nullable(z.array(types.string()))),
+  pagination: z.optional(z.nullable(z.lazy(() => Pagination$inboundSchema))),
+});
+
+export function metaFromJSON(
+  jsonString: string,
+): SafeParseResult<Meta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Meta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Meta' from JSON`,
+  );
+}
+
+/** @internal */
+export const Data$inboundSchema: z.ZodMiniType<Data, unknown> = z.object({});
+
+export function dataFromJSON(
+  jsonString: string,
+): SafeParseResult<Data, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Data$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Data' from JSON`,
+  );
+}
+
+/** @internal */
+export const Errors$inboundSchema: z.ZodMiniType<Errors, unknown> = z.object(
+  {},
+);
+
+export function errorsFromJSON(
+  jsonString: string,
+): SafeParseResult<Errors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Errors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Errors' from JSON`,
+  );
+}
+
+/** @internal */
+export const RawData$inboundSchema: z.ZodMiniType<RawData, unknown> = z.object(
+  {},
+);
+
+export function rawDataFromJSON(
+  jsonString: string,
+): SafeParseResult<RawData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RawData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RawData' from JSON`,
+  );
+}
+
+/** @internal */
+export const BaseResponseDto$inboundSchema: z.ZodMiniType<
+  BaseResponseDto,
+  unknown
+> = z.object({
+  meta: z.optional(z.nullable(z.lazy(() => Meta$inboundSchema))),
+  data: z.lazy(() => Data$inboundSchema),
+  errors: types.nullable(z.lazy(() => Errors$inboundSchema)),
+  rawData: types.nullable(z.lazy(() => RawData$inboundSchema)),
+});
+
+export function baseResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BaseResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BaseResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BaseResponseDto' from JSON`,
+  );
+}

package/src/models/company-response-dto.ts

@@ -8,13 +8,7 @@ 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 Subscription = {
-  id: string | null;
-  name?: string | null | undefined;
-  status?: string | null | undefined;
-  active?: boolean | null | undefined;
-};
+import { Subscription, Subscription$inboundSchema } from "./subscription.js";
 
 export type CompanyResponseDto = {
   id: string | null;
@@ -22,28 +16,9 @@ export type CompanyResponseDto = {
   environmentId?: string | null | undefined;
   clientNumber?: number | null | undefined;
   consultantNumber?: number | null | undefined;
-  subscription?: Subscription | null | undefined;
+  subscription?: Array<Subscription> | null | undefined;
 };
 
-/** @internal */
-export const Subscription$inboundSchema: z.ZodMiniType<Subscription, unknown> =
-  z.object({
-    id: types.nullable(types.string()),
-    name: z.optional(z.nullable(types.string())),
-    status: z.optional(z.nullable(types.string())),
-    active: z.optional(z.nullable(types.boolean())),
-  });
-
-export function subscriptionFromJSON(
-  jsonString: string,
-): SafeParseResult<Subscription, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Subscription$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Subscription' from JSON`,
-  );
-}
-
 /** @internal */
 export const CompanyResponseDto$inboundSchema: z.ZodMiniType<
   CompanyResponseDto,
@@ -55,9 +30,7 @@ export const CompanyResponseDto$inboundSchema: z.ZodMiniType<
     environmentId: z.optional(z.nullable(types.string())),
     client_number: z.optional(z.nullable(types.number())),
     consultant_number: z.optional(z.nullable(types.number())),
-    subscription: z.optional(
-      z.nullable(z.lazy(() => Subscription$inboundSchema)),
-    ),
+    subscription: z.optional(z.nullable(z.array(Subscription$inboundSchema))),
   }),
   z.transform((v) => {
     return remap$(v, {

package/src/models/index.ts

@@ -11,6 +11,7 @@ export * from "./bank-account-request-common-dto-v2.js";
 export * from "./bank-account-response-dto.js";
 export * from "./bank-account-response.js";
 export * from "./bank-account.js";
+export * from "./base-response-dto.js";
 export * from "./bill-dimension-request-dto.js";
 export * from "./bill-dimension-response-dto.js";
 export * from "./bill-line-item-response-dto.js";
@@ -135,6 +136,7 @@ export * from "./sales-order-line-item-response-dto.js";
 export * from "./sales-order-response-dto.js";
 export * from "./security.js";
 export * from "./submission-page-style-dto.js";
+export * from "./subscription.js";
 export * from "./system-registration-dto.js";
 export * from "./tax-rate-input.js";
 export * from "./tax-rate-response-dto.js";
@@ -146,3 +148,4 @@ export * from "./vedor-credit-dimension-request-dto.js";
 export * from "./vendor-credit-dimension-response-dto.js";
 export * from "./vendor-credit-line-item-response-dto.js";
 export * from "./vendor-credit-response-dto.js";
+export * from "./webhook-response-dto.js";

package/src/models/operations/api-key-confirmation.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+/**
+ * API key confirmed and redirect URL returned successfully
+ */
+export type ApiKeyConfirmationResponse = {
+  url?: string | undefined;
+};
+
+/** @internal */
+export const ApiKeyConfirmationResponse$inboundSchema: z.ZodMiniType<
+  ApiKeyConfirmationResponse,
+  unknown
+> = z.object({
+  url: types.optional(types.string()),
+});
+
+export function apiKeyConfirmationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ApiKeyConfirmationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApiKeyConfirmationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApiKeyConfirmationResponse' from JSON`,
+  );
+}

package/src/models/operations/callback.ts

@@ -4,20 +4,43 @@
 
 import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
+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 CallbackRequest = {
   targetSystem: string;
-  code?: string | undefined;
+  /**
+   * OAuth state parameter returned by the target system, encoding tenant and user context
+   */
   state: string;
+  /**
+   * Authorization code returned by the target system after successful OAuth consent
+   */
+  code?: string | undefined;
+  /**
+   * Realm ID returned by QuickBooks Online after OAuth consent
+   */
   realmId?: string | undefined;
+  /**
+   * Access token returned directly by some target systems that do not use an authorization code flow
+   */
   token?: string | undefined;
 };
 
+/**
+ * OAuth callback processed and redirect URL returned successfully
+ */
+export type CallbackResponse = {
+  url?: string | undefined;
+};
+
 /** @internal */
 export type CallbackRequest$Outbound = {
   TARGET_SYSTEM: string;
-  code?: string | undefined;
   state: string;
+  code?: string | undefined;
   realmId?: string | undefined;
   token?: string | undefined;
 };
@@ -29,8 +52,8 @@ export const CallbackRequest$outboundSchema: z.ZodMiniType<
 > = z.pipe(
   z.object({
     targetSystem: z.string(),
-    code: z.optional(z.string()),
     state: z.string(),
+    code: z.optional(z.string()),
     realmId: z.optional(z.string()),
     token: z.optional(z.string()),
   }),
@@ -46,3 +69,21 @@ export function callbackRequestToJSON(
 ): string {
   return JSON.stringify(CallbackRequest$outboundSchema.parse(callbackRequest));
 }
+
+/** @internal */
+export const CallbackResponse$inboundSchema: z.ZodMiniType<
+  CallbackResponse,
+  unknown
+> = z.object({
+  url: types.optional(types.string()),
+});
+
+export function callbackResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CallbackResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CallbackResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CallbackResponse' from JSON`,
+  );
+}

package/src/models/operations/cancel.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+/**
+ * Cancellation redirect URL returned successfully
+ */
+export type CancelResponse = {
+  url?: string | undefined;
+};
+
+/** @internal */
+export const CancelResponse$inboundSchema: z.ZodMiniType<
+  CancelResponse,
+  unknown
+> = z.object({
+  url: types.optional(types.string()),
+});
+
+export function cancelResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CancelResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CancelResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CancelResponse' from JSON`,
+  );
+}

package/src/models/operations/check.ts

@@ -0,0 +1,29 @@
+/*
+ * 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";
+
+/**
+ * Service is healthy.
+ */
+export type CheckResponse = {};
+
+/** @internal */
+export const CheckResponse$inboundSchema: z.ZodMiniType<
+  CheckResponse,
+  unknown
+> = z.object({});
+
+export function checkResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CheckResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckResponse' from JSON`,
+  );
+}

package/src/models/operations/create-account.ts

@@ -10,7 +10,13 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateAccountRequest = {
+  /**
+   * 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.CreateAccountRequestDto;
 };
@@ -31,6 +37,9 @@ export type CreateAccountErrors = {};
 
 export type CreateAccountRawData = {};
 
+/**
+ * Account created successfully
+ */
 export type CreateAccountResponse = {
   meta?: CreateAccountMeta | null | undefined;
   data: models.AccountResponseDto;

package/src/models/operations/create-bank-account.ts

@@ -10,7 +10,13 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateBankAccountRequest = {
+  /**
+   * 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.CreateBankAccountRequestDto;
 };
@@ -31,6 +37,9 @@ export type CreateBankAccountErrors = {};
 
 export type CreateBankAccountRawData = {};
 
+/**
+ * Bank account created successfully
+ */
 export type CreateBankAccountResponse = {
   meta?: CreateBankAccountMeta | null | undefined;
   data: models.BankAccountResponseDto;

package/src/models/operations/create-bill-line-item.ts

@@ -11,6 +11,9 @@ import * as models from "../index.js";
 
 export type CreateBillLineItemRequest = {
   billId: string;
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
   body: models.CreateBillLineItemRequestDto;
 };
@@ -31,6 +34,9 @@ export type CreateBillLineItemErrors = {};
 
 export type CreateBillLineItemRawData = {};
 
+/**
+ * Bill line item created successfully
+ */
 export type CreateBillLineItemResponse = {
   meta?: CreateBillLineItemMeta | null | undefined;
   data: Array<models.BillLineItemResponseDto>;

package/src/models/operations/create-bill.ts

@@ -10,7 +10,13 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateBillRequest = {
+  /**
+   * 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.CreateBillRequestDto;
 };
@@ -31,6 +37,9 @@ export type CreateBillErrors = {};
 
 export type CreateBillRawData = {};
 
+/**
+ * Bill created successfully
+ */
 export type CreateBillResponse = {
   meta?: CreateBillMeta | null | undefined;
   data: models.BillResponseDto;

package/src/models/operations/create-booking-proposal-v2.ts

@@ -28,6 +28,9 @@ export type CreateBookingProposalV2RequestBody = {
 };
 
 export type CreateBookingProposalV2Request = {
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
   body: CreateBookingProposalV2RequestBody;
 };
@@ -48,6 +51,9 @@ export type CreateBookingProposalV2Errors = {};
 
 export type CreateBookingProposalV2RawData = {};
 
+/**
+ * Booking proposal created successfully. Returns 202 with taskId if processed asynchronously.
+ */
 export type CreateBookingProposalV2Response = {
   meta?: CreateBookingProposalV2Meta | null | undefined;
   data: models.BookingProposalResponseDtoV2;

package/src/models/operations/create-booking-proposal.ts

@@ -28,6 +28,9 @@ export type CreateBookingProposalRequestBody = {
 };
 
 export type CreateBookingProposalRequest = {
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
   body: CreateBookingProposalRequestBody;
 };
@@ -48,6 +51,9 @@ export type CreateBookingProposalErrors = {};
 
 export type CreateBookingProposalRawData = {};
 
+/**
+ * Booking proposal created successfully
+ */
 export type CreateBookingProposalResponse = {
   meta?: CreateBookingProposalMeta | null | undefined;
   data: models.BookingProposalResponseDto;

package/src/models/operations/create-bookings.ts

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateBookingsRequest = {
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
   body: models.CreateBookingsRequestDto;
 };
@@ -30,6 +33,9 @@ export type CreateBookingsErrors = {};
 
 export type CreateBookingsRawData = {};
 
+/**
+ * Booking created successfully
+ */
 export type CreateBookingsResponse = {
   meta?: CreateBookingsMeta | null | undefined;
   data: models.BookingsResponseDto;

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

@@ -10,7 +10,13 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateContactV2Request = {
+  /**
+   * 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;
 };
@@ -31,6 +37,9 @@ export type CreateContactV2Errors = {};
 
 export type CreateContactV2RawData = {};
 
+/**
+ * Contact created successfully
+ */
 export type CreateContactV2Response = {
   meta?: CreateContactV2Meta | null | undefined;
   data: models.ContactResponseDtoV2;

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

@@ -10,7 +10,13 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateContactRequest = {
+  /**
+   * 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;
 };
@@ -31,6 +37,9 @@ export type CreateContactErrors = {};
 
 export type CreateContactRawData = {};
 
+/**
+ * Contact created successfully. Returns 202 with taskId if processed asynchronously.
+ */
 export type CreateContactResponse = {
   meta?: CreateContactMeta | null | undefined;
   data: models.ContactResponseDtoV2;

package/src/models/operations/create-contacts-v1.ts

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateContactsV1Request = {
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
   body: models.CreateContactByBatchMetaDataDto;
 };
@@ -30,6 +33,9 @@ export type CreateContactsV1Errors = {};
 
 export type CreateContactsV1RawData = {};
 
+/**
+ * Contacts created successfully in bulk
+ */
 export type CreateContactsV1Response = {
   meta?: CreateContactsV1Meta | null | undefined;
   data: models.ContactByBatchMetaDataResponseDto;

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

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateContactsRequest = {
+  /**
+   * ID of the company (required for multi-company target systems)
+   */
   companyId?: string | undefined;
   body: models.CreateContactByBatchMetaDataDto;
 };
@@ -30,6 +33,9 @@ export type CreateContactsErrors = {};
 
 export type CreateContactsRawData = {};
 
+/**
+ * Contacts created successfully in bulk
+ */
 export type CreateContactsResponse = {
   meta?: CreateContactsMeta | null | undefined;
   data: models.ContactByBatchMetaDataResponseDto;

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

@@ -10,7 +10,13 @@ import { SDKValidationError } from "../errors/sdk-validation-error.js";
 import * as models from "../index.js";
 
 export type CreateCustomerRequest = {
+  /**
+   * 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.CreateContactRequestDto;
 };
@@ -31,6 +37,9 @@ export type CreateCustomerErrors = {};
 
 export type CreateCustomerRawData = {};
 
+/**
+ * Customer created successfully
+ */
 export type CreateCustomerResponse = {
   meta?: CreateCustomerMeta | null | undefined;
   data: models.ContactResponseDto;