@steuerboard/mcp 0.3.0 → 0.3.4

package/src/models/collectfilesubmission.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CollectFileSubmission = {
+  id: string;
+  status: string;
+  fileName: string | null;
+  fileSize: number | null;
+  fileMimeType: string | null;
+  collectItemId: string;
+  createdAt: string;
+};
+
+export const CollectFileSubmission$zodSchema: z.ZodType<
+  CollectFileSubmission,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collectItemId: z.string(),
+  createdAt: z.string().datetime({ offset: true }),
+  fileMimeType: z.string().nullable(),
+  fileName: z.string().nullable(),
+  fileSize: z.number().nullable(),
+  id: z.string(),
+  status: z.string(),
+});

package/src/models/collectfilesubmitform.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CollectFileSubmitFormFile = {
+  fileName: string;
+  content: Uint8Array | string;
+};
+
+export const CollectFileSubmitFormFile$zodSchema: z.ZodType<
+  CollectFileSubmitFormFile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  content: z.string().base64(),
+  fileName: z.string(),
+});
+
+export type CollectFileSubmitForm = {
+  file: CollectFileSubmitFormFile | Blob;
+  collectItemId: string;
+};
+
+export const CollectFileSubmitForm$zodSchema: z.ZodType<
+  CollectFileSubmitForm,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collectItemId: z.string(),
+  file: z.lazy(() => CollectFileSubmitFormFile$zodSchema),
+});

package/src/models/collectformdatasubmission.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CollectFormDataSubmission = {
+  id: string;
+  status: string;
+  value: string | null;
+  collectItemId: string;
+  createdAt: string;
+};
+
+export const CollectFormDataSubmission$zodSchema: z.ZodType<
+  CollectFormDataSubmission,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collectItemId: z.string(),
+  createdAt: z.string().datetime({ offset: true }),
+  id: z.string(),
+  status: z.string(),
+  value: z.string().nullable(),
+});

package/src/models/collectformdatasubmit.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CollectFormDataSubmit = { collectItemId: string; value: string };
+
+export const CollectFormDataSubmit$zodSchema: z.ZodType<
+  CollectFormDataSubmit,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collectItemId: z.string(),
+  value: z.string(),
+});

package/src/models/collectsessionbytoken.ts

@@ -0,0 +1,431 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const CollectSessionByTokenStatus$zodSchema = z.enum([
+  "created",
+  "active",
+  "pending_review",
+  "completed",
+  "cancelled",
+]);
+
+export type CollectSessionByTokenStatus = z.infer<
+  typeof CollectSessionByTokenStatus$zodSchema
+>;
+
+export const Channel$zodSchema = z.enum([
+  "collectUi",
+]);
+
+export type Channel = z.infer<typeof Channel$zodSchema>;
+
+export type ChannelConfig = {
+  channel: Channel;
+  brandingColor?: string | undefined;
+  logoUrl?: string | undefined;
+  pinProtected?: boolean | undefined;
+  submitButtonLabel?: string | undefined;
+  locale?: string | undefined;
+};
+
+export const ChannelConfig$zodSchema: z.ZodType<
+  ChannelConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  brandingColor: z.string().optional(),
+  channel: Channel$zodSchema,
+  locale: z.string().default("de"),
+  logoUrl: z.string().optional(),
+  pinProtected: z.boolean().default(false),
+  submitButtonLabel: z.string().default("Submit"),
+});
+
+export const EvaluationMode$zodSchema = z.enum([
+  "individual",
+  "batch",
+  "bulk_match",
+]);
+
+export type EvaluationMode = z.infer<typeof EvaluationMode$zodSchema>;
+
+export const CollectSessionByTokenType$zodSchema = z.enum([
+  "file_upload",
+  "form_field",
+  "signature",
+  "confirmation",
+]);
+
+export type CollectSessionByTokenType = z.infer<
+  typeof CollectSessionByTokenType$zodSchema
+>;
+
+export const ItemStatus$zodSchema = z.enum([
+  "pending",
+  "submitted",
+  "fulfilled",
+  "rejected",
+]);
+
+export type ItemStatus = z.infer<typeof ItemStatus$zodSchema>;
+
+export const TypeConfirmation$zodSchema = z.enum([
+  "confirmation",
+]);
+
+export type TypeConfirmation = z.infer<typeof TypeConfirmation$zodSchema>;
+
+export type ConfigConfirmation = {
+  type: TypeConfirmation;
+  confirmationText: string;
+  requiresExplicitConsent?: boolean | undefined;
+};
+
+export const ConfigConfirmation$zodSchema: z.ZodType<
+  ConfigConfirmation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confirmationText: z.string(),
+  requiresExplicitConsent: z.boolean().default(true),
+  type: TypeConfirmation$zodSchema,
+});
+
+export const TypeSignature$zodSchema = z.enum([
+  "signature",
+]);
+
+export type TypeSignature = z.infer<typeof TypeSignature$zodSchema>;
+
+export type ConfigSignature = {
+  type: TypeSignature;
+  signerName: string;
+  signerEmail?: string | undefined;
+  documentRef?: string | undefined;
+};
+
+export const ConfigSignature$zodSchema: z.ZodType<
+  ConfigSignature,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  documentRef: z.string().optional(),
+  signerEmail: z.string().optional(),
+  signerName: z.string(),
+  type: TypeSignature$zodSchema,
+});
+
+export const TypeFileUpload$zodSchema = z.enum([
+  "fileUpload",
+]);
+
+export type TypeFileUpload = z.infer<typeof TypeFileUpload$zodSchema>;
+
+export type FileCount = { min?: number | undefined; max?: number | undefined };
+
+export const FileCount$zodSchema: z.ZodType<FileCount, z.ZodTypeDef, unknown> =
+  z.object({
+    max: z.number().int().optional(),
+    min: z.number().int().default(1),
+  });
+
+export type MatchingHints = string | number;
+
+export const MatchingHints$zodSchema: z.ZodType<
+  MatchingHints,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.string(),
+  z.number(),
+]);
+
+export type ConfigFileUpload = {
+  type: TypeFileUpload;
+  acceptedFileTypes?: Array<string> | undefined;
+  maxFileSizeMb?: number | undefined;
+  fileCount?: FileCount | undefined;
+  matchingHints?: { [k: string]: string | number } | undefined;
+};
+
+export const ConfigFileUpload$zodSchema: z.ZodType<
+  ConfigFileUpload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  acceptedFileTypes: z.array(z.string()).optional(),
+  fileCount: z.lazy(() => FileCount$zodSchema).optional(),
+  matchingHints: z.record(z.union([
+    z.string(),
+    z.number(),
+  ])).optional(),
+  maxFileSizeMb: z.number().default(25),
+  type: TypeFileUpload$zodSchema,
+});
+
+export const TypeFormField$zodSchema = z.enum([
+  "formField",
+]);
+
+export type TypeFormField = z.infer<typeof TypeFormField$zodSchema>;
+
+export const FieldType$zodSchema = z.enum([
+  "text",
+  "number",
+  "date",
+  "select",
+  "multiSelect",
+  "address",
+  "phone",
+  "email",
+  "taxId",
+  "iban",
+]);
+
+export type FieldType = z.infer<typeof FieldType$zodSchema>;
+
+export const FieldValidationType$zodSchema = z.enum([
+  "regex",
+  "min",
+  "max",
+  "minLength",
+  "maxLength",
+  "custom",
+]);
+
+export type FieldValidationType = z.infer<typeof FieldValidationType$zodSchema>;
+
+export type Value = string | number;
+
+export const Value$zodSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z.union(
+  [
+    z.string(),
+    z.number(),
+  ],
+);
+
+export type FieldValidation = {
+  type: FieldValidationType;
+  value: string | number;
+  message?: string | undefined;
+};
+
+export const FieldValidation$zodSchema: z.ZodType<
+  FieldValidation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string().optional(),
+  type: FieldValidationType$zodSchema,
+  value: z.union([
+    z.string(),
+    z.number(),
+  ]),
+});
+
+export const Condition$zodSchema = z.enum([
+  "equals",
+  "notEmpty",
+  "notEquals",
+]);
+
+export type Condition = z.infer<typeof Condition$zodSchema>;
+
+export type FieldDependsOn = {
+  collectItemId: string;
+  condition: Condition;
+  value?: string | undefined;
+};
+
+export const FieldDependsOn$zodSchema: z.ZodType<
+  FieldDependsOn,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collectItemId: z.string(),
+  condition: Condition$zodSchema,
+  value: z.string().optional(),
+});
+
+export type ConfigFormField = {
+  type: TypeFormField;
+  fieldType: FieldType;
+  fieldRequired?: boolean | undefined;
+  fieldPlaceholder?: string | undefined;
+  fieldOptions?: Array<string> | undefined;
+  fieldValidation?: Array<FieldValidation> | undefined;
+  fieldDependsOn?: FieldDependsOn | undefined;
+};
+
+export const ConfigFormField$zodSchema: z.ZodType<
+  ConfigFormField,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fieldDependsOn: z.lazy(() => FieldDependsOn$zodSchema).optional(),
+  fieldOptions: z.array(z.string()).optional(),
+  fieldPlaceholder: z.string().optional(),
+  fieldRequired: z.boolean().default(true),
+  fieldType: FieldType$zodSchema,
+  fieldValidation: z.array(z.lazy(() => FieldValidation$zodSchema)).optional(),
+  type: TypeFormField$zodSchema,
+});
+
+export type Config =
+  | ConfigFormField
+  | ConfigSignature
+  | ConfigConfirmation
+  | ConfigFileUpload;
+
+export const Config$zodSchema: z.ZodType<Config, z.ZodTypeDef, unknown> = z
+  .union([
+    z.lazy(() => ConfigFormField$zodSchema),
+    z.lazy(() => ConfigSignature$zodSchema),
+    z.lazy(() => ConfigConfirmation$zodSchema),
+    z.lazy(() => ConfigFileUpload$zodSchema),
+  ]);
+
+export type ItemSubmission = {
+  id: string;
+  status: string;
+  fileName: string | null;
+  fileSize: number | null;
+  rejectionReason: string | null;
+};
+
+export const ItemSubmission$zodSchema: z.ZodType<
+  ItemSubmission,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fileName: z.string().nullable(),
+  fileSize: z.number().nullable(),
+  id: z.string(),
+  rejectionReason: z.string().nullable(),
+  status: z.string(),
+});
+
+export type Item = {
+  id: string;
+  type: CollectSessionByTokenType;
+  description: string;
+  status: ItemStatus;
+  sortOrder: number;
+  config:
+    | ConfigFormField
+    | ConfigSignature
+    | ConfigConfirmation
+    | ConfigFileUpload;
+  groupId: string | null;
+  submissions: Array<ItemSubmission>;
+};
+
+export const Item$zodSchema: z.ZodType<Item, z.ZodTypeDef, unknown> = z.object({
+  config: z.union([
+    z.lazy(() => ConfigFormField$zodSchema),
+    z.lazy(() => ConfigSignature$zodSchema),
+    z.lazy(() => ConfigConfirmation$zodSchema),
+    z.lazy(() => ConfigFileUpload$zodSchema),
+  ]),
+  description: z.string(),
+  groupId: z.string().nullable(),
+  id: z.string(),
+  sortOrder: z.number().int(),
+  status: ItemStatus$zodSchema,
+  submissions: z.array(z.lazy(() => ItemSubmission$zodSchema)),
+  type: CollectSessionByTokenType$zodSchema,
+});
+
+export type CollectSessionByTokenSubmission = {
+  id: string;
+  status: string;
+  fileName: string | null;
+  fileSize: number | null;
+  rejectionReason: string | null;
+};
+
+export const CollectSessionByTokenSubmission$zodSchema: z.ZodType<
+  CollectSessionByTokenSubmission,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fileName: z.string().nullable(),
+  fileSize: z.number().nullable(),
+  id: z.string(),
+  rejectionReason: z.string().nullable(),
+  status: z.string(),
+});
+
+export type SubmissionSummary = {
+  total: number;
+  pending: number;
+  processing: number;
+  matched: number;
+  proposed: number;
+};
+
+export const SubmissionSummary$zodSchema: z.ZodType<
+  SubmissionSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  matched: z.number().int(),
+  pending: z.number().int(),
+  processing: z.number().int(),
+  proposed: z.number().int(),
+  total: z.number().int(),
+});
+
+export type Group = {
+  id: string;
+  label: string;
+  description: string | null;
+  sortOrder: number;
+  evaluationMode: EvaluationMode;
+  repeatable: boolean;
+  minInstances: number;
+  maxInstances: number | null;
+  items: Array<Item>;
+  submissions?: Array<CollectSessionByTokenSubmission> | undefined;
+  submissionSummary?: SubmissionSummary | undefined;
+};
+
+export const Group$zodSchema: z.ZodType<Group, z.ZodTypeDef, unknown> = z
+  .object({
+    description: z.string().nullable(),
+    evaluationMode: EvaluationMode$zodSchema,
+    id: z.string(),
+    items: z.array(z.lazy(() => Item$zodSchema)),
+    label: z.string(),
+    maxInstances: z.number().int().nullable(),
+    minInstances: z.number().int(),
+    repeatable: z.boolean(),
+    sortOrder: z.number().int(),
+    submissionSummary: z.lazy(() => SubmissionSummary$zodSchema).optional(),
+    submissions: z.array(
+      z.lazy(() => CollectSessionByTokenSubmission$zodSchema),
+    ).optional(),
+  });
+
+export type CollectSessionByToken = {
+  id: string;
+  description: string;
+  status: CollectSessionByTokenStatus;
+  channelConfig: ChannelConfig;
+  groups: Array<Group>;
+};
+
+export const CollectSessionByToken$zodSchema: z.ZodType<
+  CollectSessionByToken,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  channelConfig: z.lazy(() => ChannelConfig$zodSchema),
+  description: z.string(),
+  groups: z.array(z.lazy(() => Group$zodSchema)),
+  id: z.string(),
+  status: CollectSessionByTokenStatus$zodSchema,
+});

package/src/models/completecollectsessionop.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { BadRequest, BadRequest$zodSchema } from "./badrequest.js";
+import {
+  CompleteSessionBody,
+  CompleteSessionBody$zodSchema,
+} from "./completesessionbody.js";
+import {
+  CompleteSessionResponse,
+  CompleteSessionResponse$zodSchema,
+} from "./completesessionresponse.js";
+import { RateLimit, RateLimit$zodSchema } from "./ratelimit.js";
+
+export type CompleteCollectSessionRequest = {
+  token: string;
+  CompleteSessionBody?: CompleteSessionBody | undefined;
+};
+
+export const CompleteCollectSessionRequest$zodSchema: z.ZodType<
+  CompleteCollectSessionRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  CompleteSessionBody: CompleteSessionBody$zodSchema.optional(),
+  token: z.string(),
+});
+
+export const CompleteCollectSessionStatusCode$zodSchema = z.literal(404);
+
+export type CompleteCollectSessionStatusCode = z.infer<
+  typeof CompleteCollectSessionStatusCode$zodSchema
+>;
+
+export const CompleteCollectSessionType$zodSchema = z.enum([
+  "not_found",
+]);
+
+export type CompleteCollectSessionType = z.infer<
+  typeof CompleteCollectSessionType$zodSchema
+>;
+
+export const CompleteCollectSessionCode$zodSchema = z.enum([
+  "collect_token_not_found",
+]);
+
+export type CompleteCollectSessionCode = z.infer<
+  typeof CompleteCollectSessionCode$zodSchema
+>;
+
+/**
+ * Collect session not found. The token may be invalid or revoked.
+ */
+export type CompleteCollectSessionResponseBody = {
+  status_code: CompleteCollectSessionStatusCode;
+  type: CompleteCollectSessionType;
+  code: CompleteCollectSessionCode;
+  message: string;
+};
+
+export const CompleteCollectSessionResponseBody$zodSchema: z.ZodType<
+  CompleteCollectSessionResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: CompleteCollectSessionCode$zodSchema,
+  message: z.string(),
+  status_code: CompleteCollectSessionStatusCode$zodSchema,
+  type: CompleteCollectSessionType$zodSchema,
+}).describe("Collect session not found. The token may be invalid or revoked.");
+
+export type CompleteCollectSessionResponse =
+  | CompleteCollectSessionResponseBody
+  | BadRequest
+  | RateLimit
+  | CompleteSessionResponse;
+
+export const CompleteCollectSessionResponse$zodSchema: z.ZodType<
+  CompleteCollectSessionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => CompleteCollectSessionResponseBody$zodSchema),
+  BadRequest$zodSchema,
+  RateLimit$zodSchema,
+  CompleteSessionResponse$zodSchema,
+]);

package/src/models/completesessionbody.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * Explicit completion outcome picked by the client: 'complete' (everything provided), 'incomplete' (will provide the rest later), 'incomplete_finished' (cannot provide the rest; clientNote explains).
+ */
+export const Outcome$zodSchema = z.enum([
+  "complete",
+  "incomplete",
+  "incomplete_finished",
+]).describe(
+  "Explicit completion outcome picked by the client: 'complete' (everything provided), 'incomplete' (will provide the rest later), 'incomplete_finished' (cannot provide the rest; clientNote explains).",
+);
+
+export type Outcome = z.infer<typeof Outcome$zodSchema>;
+
+export type CompleteSessionBody = {
+  clientNote?: string | undefined;
+  outcome?: Outcome | undefined;
+};
+
+export const CompleteSessionBody$zodSchema: z.ZodType<
+  CompleteSessionBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  clientNote: z.string().optional(),
+  outcome: Outcome$zodSchema.optional(),
+});

package/src/models/completesessionresponse.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CompleteSessionResponse = { success: boolean };
+
+export const CompleteSessionResponse$zodSchema: z.ZodType<
+  CompleteSessionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean(),
+});