@crevio/sdk 0.4.16 → 0.4.17

package/src/funcs/formsSubmit.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CrevioCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { CrevioError } from "../models/errors/crevioerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Create form submission
+ *
+ * @remarks
+ * Submits an answer set to a specific Form. Customer is upserted by email; lead-magnet purpose forms also trigger delivery.
+ */
+export function formsSubmit(
+  client: CrevioCore,
+  request: operations.CreateFormSubmissionForFormRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.FormSubmission,
+    | errors.ErrorT
+    | CrevioError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CrevioCore,
+  request: operations.CreateFormSubmissionForFormRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.FormSubmission,
+      | errors.ErrorT
+      | CrevioError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.CreateFormSubmissionForFormRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    form_id: encodeSimple("form_id", payload.form_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/forms/{form_id}/submissions")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "createFormSubmissionForForm",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.FormSubmission,
+    | errors.ErrorT
+    | CrevioError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, models.FormSubmission$inboundSchema),
+    M.jsonErr([400, 401, 403, 404, 422], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.4.16",
+  sdkVersion: "0.4.17",
   genVersion: "2.882.0",
-  userAgent: "speakeasy-sdk/typescript 0.4.16 2.882.0 1.0.0 @crevio/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.4.17 2.882.0 1.0.0 @crevio/sdk",
 } as const;

package/src/models/form.ts

@@ -10,24 +10,24 @@ import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import { FormField, FormField$inboundSchema } from "./formfield.js";
 
-export const Purpose = {
+export const FormPurpose = {
   Newsletter: "newsletter",
   Contact: "contact",
   LeadMagnet: "lead_magnet",
   Custom: "custom",
 } as const;
-export type Purpose = ClosedEnum<typeof Purpose>;
+export type FormPurpose = ClosedEnum<typeof FormPurpose>;
 
-export type Settings = {};
+export type FormSettings = {};
 
 export type Form = {
   id: string;
   object: string;
-  purpose: Purpose;
+  purpose: FormPurpose;
   name: string;
   isPrimary: boolean;
   confirmationRequired: boolean;
-  settings: Settings;
+  settings: FormSettings;
   tagIds: Array<number>;
   archivedAt: Date | null;
   createdAt: Date;
@@ -36,23 +36,23 @@ export type Form = {
 };
 
 /** @internal */
-export const Purpose$inboundSchema: z.ZodNativeEnum<typeof Purpose> = z
-  .nativeEnum(Purpose);
+export const FormPurpose$inboundSchema: z.ZodNativeEnum<typeof FormPurpose> = z
+  .nativeEnum(FormPurpose);
 
 /** @internal */
-export const Settings$inboundSchema: z.ZodType<
-  Settings,
+export const FormSettings$inboundSchema: z.ZodType<
+  FormSettings,
   z.ZodTypeDef,
   unknown
 > = z.object({});
 
-export function settingsFromJSON(
+export function formSettingsFromJSON(
   jsonString: string,
-): SafeParseResult<Settings, SDKValidationError> {
+): SafeParseResult<FormSettings, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Settings$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Settings' from JSON`,
+    (x) => FormSettings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FormSettings' from JSON`,
   );
 }
 
@@ -61,11 +61,11 @@ export const Form$inboundSchema: z.ZodType<Form, z.ZodTypeDef, unknown> = z
   .object({
     id: z.string(),
     object: z.string(),
-    purpose: Purpose$inboundSchema,
+    purpose: FormPurpose$inboundSchema,
     name: z.string(),
     is_primary: z.boolean(),
     confirmation_required: z.boolean(),
-    settings: z.lazy(() => Settings$inboundSchema),
+    settings: z.lazy(() => FormSettings$inboundSchema),
     tag_ids: z.array(z.number().int()),
     archived_at: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),

package/src/models/formfield.ts

@@ -5,19 +5,36 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
+export const FormFieldFieldType = {
+  Email: "email",
+  Text: "text",
+  Phone: "phone",
+  Textarea: "textarea",
+  Radio: "radio",
+  Select: "select",
+  Checkbox: "checkbox",
+} as const;
+export type FormFieldFieldType = ClosedEnum<typeof FormFieldFieldType>;
+
 export type FormField = {
   id: string;
   object: string;
   name: string;
-  fieldType: string;
+  fieldType: FormFieldFieldType;
   required: boolean | null;
   position: number | null;
   options: Array<string>;
 };
 
+/** @internal */
+export const FormFieldFieldType$inboundSchema: z.ZodNativeEnum<
+  typeof FormFieldFieldType
+> = z.nativeEnum(FormFieldFieldType);
+
 /** @internal */
 export const FormField$inboundSchema: z.ZodType<
   FormField,
@@ -27,7 +44,7 @@ export const FormField$inboundSchema: z.ZodType<
   id: z.string(),
   object: z.string(),
   name: z.string(),
-  field_type: z.string(),
+  field_type: FormFieldFieldType$inboundSchema,
   required: z.nullable(z.boolean()),
   position: z.nullable(z.number().int()),
   options: z.array(z.string()),

package/src/models/formrequest.ts

@@ -4,22 +4,154 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * newsletter and contact have account-wide defaults; lead_magnet wraps a Blocks::LeadMagnet; custom is anything else.
+ */
+export const FormRequestPurpose = {
+  Newsletter: "newsletter",
+  Contact: "contact",
+  LeadMagnet: "lead_magnet",
+  Custom: "custom",
+} as const;
+/**
+ * newsletter and contact have account-wide defaults; lead_magnet wraps a Blocks::LeadMagnet; custom is anything else.
+ */
+export type FormRequestPurpose = ClosedEnum<typeof FormRequestPurpose>;
+
+export const FormRequestFieldType = {
+  Email: "email",
+  Text: "text",
+  Phone: "phone",
+  Textarea: "textarea",
+  Radio: "radio",
+  Select: "select",
+  Checkbox: "checkbox",
+} as const;
+export type FormRequestFieldType = ClosedEnum<typeof FormRequestFieldType>;
+
+export type FormFieldsAttribute = {
+  /**
+   * FormField id (omit when creating)
+   */
+  id?: number | null | undefined;
+  /**
+   * User-facing label
+   */
+  name: string;
+  fieldType: FormRequestFieldType;
+  required?: boolean | undefined;
+  /**
+   * Zero-based ordinal
+   */
+  position?: number | undefined;
+  /**
+   * Required when field_type is radio/select/checkbox
+   */
+  options?: Array<string> | undefined;
+  /**
+   * Set true to remove this field
+   */
+  destroy?: boolean | undefined;
+};
+
+export type FormRequestSettings = {};
 
 export type FormRequest = {
   name?: string | undefined;
+  /**
+   * newsletter and contact have account-wide defaults; lead_magnet wraps a Blocks::LeadMagnet; custom is anything else.
+   */
+  purpose?: FormRequestPurpose | undefined;
   isPrimary?: boolean | undefined;
   confirmationRequired?: boolean | undefined;
   archivedAt?: Date | null | undefined;
   tagIds?: Array<string> | undefined;
+  /**
+   * Nested-attributes payload for creating, updating, or destroying fields in one round-trip. Pass `id` to update an existing field; pass `_destroy: true` to remove one.
+   */
+  formFieldsAttributes?: Array<FormFieldsAttribute> | undefined;
+  settings?: FormRequestSettings | undefined;
+};
+
+/** @internal */
+export const FormRequestPurpose$outboundSchema: z.ZodNativeEnum<
+  typeof FormRequestPurpose
+> = z.nativeEnum(FormRequestPurpose);
+
+/** @internal */
+export const FormRequestFieldType$outboundSchema: z.ZodNativeEnum<
+  typeof FormRequestFieldType
+> = z.nativeEnum(FormRequestFieldType);
+
+/** @internal */
+export type FormFieldsAttribute$Outbound = {
+  id?: number | null | undefined;
+  name: string;
+  field_type: string;
+  required?: boolean | undefined;
+  position?: number | undefined;
+  options?: Array<string> | undefined;
+  _destroy?: boolean | undefined;
 };
 
+/** @internal */
+export const FormFieldsAttribute$outboundSchema: z.ZodType<
+  FormFieldsAttribute$Outbound,
+  z.ZodTypeDef,
+  FormFieldsAttribute
+> = z.object({
+  id: z.nullable(z.number().int()).optional(),
+  name: z.string(),
+  fieldType: FormRequestFieldType$outboundSchema,
+  required: z.boolean().optional(),
+  position: z.number().int().optional(),
+  options: z.array(z.string()).optional(),
+  destroy: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    fieldType: "field_type",
+    destroy: "_destroy",
+  });
+});
+
+export function formFieldsAttributeToJSON(
+  formFieldsAttribute: FormFieldsAttribute,
+): string {
+  return JSON.stringify(
+    FormFieldsAttribute$outboundSchema.parse(formFieldsAttribute),
+  );
+}
+
+/** @internal */
+export type FormRequestSettings$Outbound = {};
+
+/** @internal */
+export const FormRequestSettings$outboundSchema: z.ZodType<
+  FormRequestSettings$Outbound,
+  z.ZodTypeDef,
+  FormRequestSettings
+> = z.object({});
+
+export function formRequestSettingsToJSON(
+  formRequestSettings: FormRequestSettings,
+): string {
+  return JSON.stringify(
+    FormRequestSettings$outboundSchema.parse(formRequestSettings),
+  );
+}
+
 /** @internal */
 export type FormRequest$Outbound = {
   name?: string | undefined;
+  purpose?: string | undefined;
   is_primary?: boolean | undefined;
   confirmation_required?: boolean | undefined;
   archived_at?: string | null | undefined;
   tag_ids?: Array<string> | undefined;
+  form_fields_attributes?: Array<FormFieldsAttribute$Outbound> | undefined;
+  settings?: FormRequestSettings$Outbound | undefined;
 };
 
 /** @internal */
@@ -29,16 +161,22 @@ export const FormRequest$outboundSchema: z.ZodType<
   FormRequest
 > = z.object({
   name: z.string().optional(),
+  purpose: FormRequestPurpose$outboundSchema.optional(),
   isPrimary: z.boolean().optional(),
   confirmationRequired: z.boolean().optional(),
   archivedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
   tagIds: z.array(z.string()).optional(),
+  formFieldsAttributes: z.array(
+    z.lazy(() => FormFieldsAttribute$outboundSchema),
+  ).optional(),
+  settings: z.lazy(() => FormRequestSettings$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     isPrimary: "is_primary",
     confirmationRequired: "confirmation_required",
     archivedAt: "archived_at",
     tagIds: "tag_ids",
+    formFieldsAttributes: "form_fields_attributes",
   });
 });
 

package/src/models/formsubmissionrequest.ts

@@ -5,50 +5,31 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
 
-/**
- * Map of form question IDs to answer values
- */
-export type Answers = {};
-
 export type FormSubmissionRequest = {
   /**
-   * ID of the lead magnet block being submitted
+   * Form prefix_id being submitted
    */
-  leadMagnetId: string;
+  formId: string;
   /**
    * Respondent email address
    */
   email: string;
   /**
-   * Respondent name (defaults to 'Lead' if omitted)
+   * Respondent name (defaults to email local-part if omitted)
    */
   name?: string | null | undefined;
   /**
-   * Map of form question IDs to answer values
+   * Map of form_field id → answer value
    */
-  answers?: Answers | undefined;
+  answers: { [k: string]: any };
 };
 
-/** @internal */
-export type Answers$Outbound = {};
-
-/** @internal */
-export const Answers$outboundSchema: z.ZodType<
-  Answers$Outbound,
-  z.ZodTypeDef,
-  Answers
-> = z.object({});
-
-export function answersToJSON(answers: Answers): string {
-  return JSON.stringify(Answers$outboundSchema.parse(answers));
-}
-
 /** @internal */
 export type FormSubmissionRequest$Outbound = {
-  lead_magnet_id: string;
+  form_id: string;
   email: string;
   name?: string | null | undefined;
-  answers?: Answers$Outbound | undefined;
+  answers: { [k: string]: any };
 };
 
 /** @internal */
@@ -57,13 +38,13 @@ export const FormSubmissionRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   FormSubmissionRequest
 > = z.object({
-  leadMagnetId: z.string(),
+  formId: z.string(),
   email: z.string(),
   name: z.nullable(z.string()).optional(),
-  answers: z.lazy(() => Answers$outboundSchema).optional(),
+  answers: z.record(z.any()),
 }).transform((v) => {
   return remap$(v, {
-    leadMagnetId: "lead_magnet_id",
+    formId: "form_id",
   });
 });
 

package/src/sdk/forms.ts

@@ -5,6 +5,7 @@
 import { formsCreate } from "../funcs/formsCreate.js";
 import { formsGet } from "../funcs/formsGet.js";
 import { formsList } from "../funcs/formsList.js";
+import { formsSubmit } from "../funcs/formsSubmit.js";
 import { formsUpdate } from "../funcs/formsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
@@ -29,17 +30,34 @@ export class Forms extends ClientSDK {
     ));
   }
 
+  /**
+   * Create form
+   *
+   * @remarks
+   * Creates a new Form, optionally with fields nested via form_fields_attributes. Use this to provision newsletter, contact, lead-magnet, or custom-purpose forms programmatically.
+   */
+  async create(
+    request: models.FormRequest,
+    options?: RequestOptions,
+  ): Promise<models.Form> {
+    return unwrapAsync(formsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create form submission
    *
    * @remarks
    * Submits an answer set to a specific Form. Customer is upserted by email; lead-magnet purpose forms also trigger delivery.
    */
-  async create(
+  async submit(
     request: operations.CreateFormSubmissionForFormRequest,
     options?: RequestOptions,
   ): Promise<models.FormSubmission> {
-    return unwrapAsync(formsCreate(
+    return unwrapAsync(formsSubmit(
       this,
       request,
       options,