@unified-api/typescript-sdk 2.85.40 → 2.85.41

package/src/lib/encodings.ts

@@ -12,10 +12,41 @@ export class EncodingError extends Error {
   }
 }
 
+export type CharEncoding = "percent" | "percentExceptReserved" | "none";
+
+const reservedEscapes = /%(2[346bcf]|3[abdf]|40|5[bd])/gi;
+
+function encodeKeyChars(
+  v: string,
+  charEncoding: CharEncoding | undefined,
+): string {
+  return encodeChars(
+    v,
+    charEncoding === "percentExceptReserved" ? "percent" : charEncoding,
+  );
+}
+
+function encodeChars(
+  v: string,
+  charEncoding: CharEncoding | undefined,
+): string {
+  switch (charEncoding) {
+    case "percent":
+      return encodeURIComponent(v);
+    case "percentExceptReserved":
+      return encodeURIComponent(v).replace(
+        reservedEscapes,
+        (m) => decodeURIComponent(m),
+      );
+    default:
+      return v;
+  }
+}
+
 export function encodeMatrix(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -27,7 +58,7 @@ export function encodeMatrix(
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
@@ -52,7 +83,7 @@ export function encodeMatrix(
       return;
     }
 
-    const keyPrefix = encodeString(pk);
+    const keyPrefix = encodeKeyChars(pk, options?.charEncoding);
     tmp = `${keyPrefix}=${encValue}`;
     // trim trailing '=' if value was empty
     if (tmp === `${keyPrefix}=`) {
@@ -73,7 +104,7 @@ export function encodeMatrix(
 export function encodeLabel(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -85,7 +116,7 @@ export function encodeLabel(
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
@@ -103,7 +134,7 @@ export function encodeLabel(
       encValue = mapped?.join("").slice(1);
     } else {
       const k = options?.explode && isPlainObject(value)
-        ? `${encodeString(pk)}=`
+        ? `${encodeKeyChars(pk, options?.charEncoding)}=`
         : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
@@ -117,14 +148,14 @@ export function encodeLabel(
 type FormEncoder = (
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ) => string | undefined;
 
 function formEncoder(sep: string): FormEncoder {
   return (
     key: string,
     value: unknown,
-    options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+    options?: { explode?: boolean; charEncoding?: CharEncoding },
   ) => {
     let out = "";
     const pairs: [string, unknown][] = options?.explode
@@ -136,7 +167,7 @@ function formEncoder(sep: string): FormEncoder {
     }
 
     const encodeString = (v: string) => {
-      return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+      return encodeChars(v, options?.charEncoding);
     };
 
     const encodeValue = (v: unknown) => encodeString(serializeValue(v));
@@ -163,7 +194,7 @@ function formEncoder(sep: string): FormEncoder {
         return;
       }
 
-      tmp = `${encodeString(pk)}=${encValue}`;
+      tmp = `${encodeKeyChars(pk, options?.charEncoding)}=${encValue}`;
 
       // If we end up with the nothing then skip forward
       if (!tmp || tmp === "=") {
@@ -184,7 +215,7 @@ export const encodePipeDelimited = formEncoder("|");
 export function encodeBodyForm(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -192,7 +223,7 @@ export function encodeBodyForm(
     : [[key, value]];
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
 
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
@@ -211,7 +242,7 @@ export function encodeBodyForm(
       encValue = `${encodeValue(pv)}`;
     }
 
-    tmp = `${encodeString(pk)}=${encValue}`;
+    tmp = `${encodeKeyChars(pk, options?.charEncoding)}=${encValue}`;
 
     // If we end up with the nothing then skip forward
     if (!tmp || tmp === "=") {
@@ -227,7 +258,7 @@ export function encodeBodyForm(
 export function encodeDeepObject(
   key: string,
   value: unknown,
-  options?: { charEncoding?: "percent" | "none" },
+  options?: { charEncoding?: CharEncoding },
 ): string | undefined {
   if (value == null) {
     return;
@@ -245,7 +276,7 @@ export function encodeDeepObject(
 export function encodeDeepObjectObject(
   key: string,
   value: unknown,
-  options?: { charEncoding?: "percent" | "none" },
+  options?: { charEncoding?: CharEncoding },
 ): string | undefined {
   if (value == null) {
     return;
@@ -254,7 +285,7 @@ export function encodeDeepObjectObject(
   let out = "";
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
 
   if (!isPlainObject(value)) {
@@ -278,7 +309,9 @@ export function encodeDeepObjectObject(
 
     const pairs: unknown[] = Array.isArray(cv) ? cv : [cv];
     const encoded = mapDefined(pairs, (v) => {
-      return `${encodeString(pk)}=${encodeString(serializeValue(v))}`;
+      return `${encodeKeyChars(pk, options?.charEncoding)}=${
+        encodeString(serializeValue(v))
+      }`;
     })?.join("&");
 
     out += encoded == null ? "" : `&${encoded}`;
@@ -290,25 +323,27 @@ export function encodeDeepObjectObject(
 export function encodeJSON(
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined {
   if (typeof value === "undefined") {
     return;
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
 
   const encVal = encodeString(JSON.stringify(value, jsonReplacer));
 
-  return options?.explode ? encVal : `${encodeString(key)}=${encVal}`;
+  return options?.explode
+    ? encVal
+    : `${encodeKeyChars(key, options?.charEncoding)}=${encVal}`;
 }
 
 export const encodeSimple = (
   key: string,
   value: unknown,
-  options?: { explode?: boolean; charEncoding?: "percent" | "none" },
+  options?: { explode?: boolean; charEncoding?: CharEncoding },
 ): string | undefined => {
   let out = "";
   const pairs: [string, unknown][] = options?.explode
@@ -320,7 +355,7 @@ export const encodeSimple = (
   }
 
   const encodeString = (v: string) => {
-    return options?.charEncoding === "percent" ? encodeURIComponent(v) : v;
+    return encodeChars(v, options?.charEncoding);
   };
   const encodeValue = (v: unknown) => encodeString(serializeValue(v));
 
@@ -426,7 +461,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
 
 type QueryEncoderOptions = {
   explode?: boolean;
-  charEncoding?: "percent" | "none";
+  charEncoding?: CharEncoding;
   allowEmptyValue?: string[];
 };
 

package/src/sdk/assessment.ts

@@ -8,6 +8,8 @@ import { assessmentListAssessmentPackages } from "../funcs/assessmentListAssessm
 import { assessmentPatchAssessmentPackage } from "../funcs/assessmentPatchAssessmentPackage.js";
 import { assessmentRemoveAssessmentPackage } from "../funcs/assessmentRemoveAssessmentPackage.js";
 import { assessmentUpdateAssessmentPackage } from "../funcs/assessmentUpdateAssessmentPackage.js";
+import { orderCreateAssessmentOrder } from "../funcs/orderCreateAssessmentOrder.js";
+import { orderGetAssessmentOrder } from "../funcs/orderGetAssessmentOrder.js";
 import { orderPatchAssessmentOrder } from "../funcs/orderPatchAssessmentOrder.js";
 import { orderUpdateAssessmentOrder } from "../funcs/orderUpdateAssessmentOrder.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -16,6 +18,20 @@ import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
 export class Assessment extends ClientSDK {
+  /**
+   * Create an order
+   */
+  async createAssessmentOrder(
+    request: operations.CreateAssessmentOrderRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AssessmentOrder> {
+    return unwrapAsync(orderCreateAssessmentOrder(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create an assessment package
    */
@@ -30,6 +46,20 @@ export class Assessment extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve an order
+   */
+  async getAssessmentOrder(
+    request: operations.GetAssessmentOrderRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AssessmentOrder> {
+    return unwrapAsync(orderGetAssessmentOrder(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get an assessment package
    */

package/src/sdk/models/operations/createassessmentorder.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import * as shared from "../shared/index.js";
+
+export const CreateAssessmentOrderQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  WorkspaceId: "workspace_id",
+  ConnectionId: "connection_id",
+  WebhookId: "webhook_id",
+  PackageId: "package_id",
+  Parameters: "parameters",
+  TargetUrl: "target_url",
+  Status: "status",
+  Reference: "reference",
+  ApplicationId: "application_id",
+  JobId: "job_id",
+  CompanyId: "company_id",
+  CandidateId: "candidate_id",
+  EmployeeId: "employee_id",
+  ProfileName: "profile_name",
+  ProfileFirstName: "profile_first_name",
+  ProfileLastName: "profile_last_name",
+  ProfileResumeUrl: "profile_resume_url",
+  ProfileIpAddress: "profile_ip_address",
+  ProfileDateOfBirth: "profile_date_of_birth",
+  ProfileAddresses: "profile_addresses",
+  ProfileGender: "profile_gender",
+  ProfileEmails: "profile_emails",
+  ProfileTelephones: "profile_telephones",
+  ProfileNationalIdentifier: "profile_national_identifier",
+  ProfileSocialMediaUrls: "profile_social_media_urls",
+  ResponseCompletedAt: "response_completed_at",
+  ResponseExpiresAt: "response_expires_at",
+  ResponseIssuedAt: "response_issued_at",
+  ResponseStatus: "response_status",
+  ResponseScore: "response_score",
+  ResponseMaxScore: "response_max_score",
+  ResponseUrl: "response_url",
+  ResponseRedirectUrl: "response_redirect_url",
+  ResponseDownloadUrls: "response_download_urls",
+  ResponseDetails: "response_details",
+  ResponseSource: "response_source",
+  ResponseAttributes: "response_attributes",
+  Raw: "raw",
+} as const;
+export type CreateAssessmentOrderQueryParamFields = ClosedEnum<
+  typeof CreateAssessmentOrderQueryParamFields
+>;
+
+export type CreateAssessmentOrderRequest = {
+  assessmentOrder: shared.AssessmentOrder;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<CreateAssessmentOrderQueryParamFields> | undefined;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const CreateAssessmentOrderQueryParamFields$outboundSchema:
+  z.ZodNativeEnum<typeof CreateAssessmentOrderQueryParamFields> = z.nativeEnum(
+    CreateAssessmentOrderQueryParamFields,
+  );
+
+/** @internal */
+export type CreateAssessmentOrderRequest$Outbound = {
+  AssessmentOrder: shared.AssessmentOrder$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const CreateAssessmentOrderRequest$outboundSchema: z.ZodType<
+  CreateAssessmentOrderRequest$Outbound,
+  z.ZodTypeDef,
+  CreateAssessmentOrderRequest
+> = z.object({
+  assessmentOrder: shared.AssessmentOrder$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(CreateAssessmentOrderQueryParamFields$outboundSchema)
+    .optional(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    assessmentOrder: "AssessmentOrder",
+    connectionId: "connection_id",
+  });
+});
+
+export function createAssessmentOrderRequestToJSON(
+  createAssessmentOrderRequest: CreateAssessmentOrderRequest,
+): string {
+  return JSON.stringify(
+    CreateAssessmentOrderRequest$outboundSchema.parse(
+      createAssessmentOrderRequest,
+    ),
+  );
+}

package/src/sdk/models/operations/getassessmentorder.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const GetAssessmentOrderQueryParamFields = {
+  Id: "id",
+  CreatedAt: "created_at",
+  UpdatedAt: "updated_at",
+  WorkspaceId: "workspace_id",
+  ConnectionId: "connection_id",
+  WebhookId: "webhook_id",
+  PackageId: "package_id",
+  Parameters: "parameters",
+  TargetUrl: "target_url",
+  Status: "status",
+  Reference: "reference",
+  ApplicationId: "application_id",
+  JobId: "job_id",
+  CompanyId: "company_id",
+  CandidateId: "candidate_id",
+  EmployeeId: "employee_id",
+  ProfileName: "profile_name",
+  ProfileFirstName: "profile_first_name",
+  ProfileLastName: "profile_last_name",
+  ProfileResumeUrl: "profile_resume_url",
+  ProfileIpAddress: "profile_ip_address",
+  ProfileDateOfBirth: "profile_date_of_birth",
+  ProfileAddresses: "profile_addresses",
+  ProfileGender: "profile_gender",
+  ProfileEmails: "profile_emails",
+  ProfileTelephones: "profile_telephones",
+  ProfileNationalIdentifier: "profile_national_identifier",
+  ProfileSocialMediaUrls: "profile_social_media_urls",
+  ResponseCompletedAt: "response_completed_at",
+  ResponseExpiresAt: "response_expires_at",
+  ResponseIssuedAt: "response_issued_at",
+  ResponseStatus: "response_status",
+  ResponseScore: "response_score",
+  ResponseMaxScore: "response_max_score",
+  ResponseUrl: "response_url",
+  ResponseRedirectUrl: "response_redirect_url",
+  ResponseDownloadUrls: "response_download_urls",
+  ResponseDetails: "response_details",
+  ResponseSource: "response_source",
+  ResponseAttributes: "response_attributes",
+  Raw: "raw",
+} as const;
+export type GetAssessmentOrderQueryParamFields = ClosedEnum<
+  typeof GetAssessmentOrderQueryParamFields
+>;
+
+export type GetAssessmentOrderRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Fields to return
+   */
+  fields?: Array<GetAssessmentOrderQueryParamFields> | undefined;
+  /**
+   * ID of the Order
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetAssessmentOrderQueryParamFields$outboundSchema: z.ZodNativeEnum<
+  typeof GetAssessmentOrderQueryParamFields
+> = z.nativeEnum(GetAssessmentOrderQueryParamFields);
+
+/** @internal */
+export type GetAssessmentOrderRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const GetAssessmentOrderRequest$outboundSchema: z.ZodType<
+  GetAssessmentOrderRequest$Outbound,
+  z.ZodTypeDef,
+  GetAssessmentOrderRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(GetAssessmentOrderQueryParamFields$outboundSchema).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+export function getAssessmentOrderRequestToJSON(
+  getAssessmentOrderRequest: GetAssessmentOrderRequest,
+): string {
+  return JSON.stringify(
+    GetAssessmentOrderRequest$outboundSchema.parse(getAssessmentOrderRequest),
+  );
+}

package/src/sdk/models/operations/index.ts

@@ -31,6 +31,7 @@ export * from "./createadsorganization.js";
 export * from "./createanalyticsevent.js";
 export * from "./createanalyticsproperty.js";
 export * from "./createanalyticsvisitor.js";
+export * from "./createassessmentorder.js";
 export * from "./createassessmentpackage.js";
 export * from "./createatsactivity.js";
 export * from "./createatsapplication.js";
@@ -172,6 +173,7 @@ export * from "./getanalyticsevent.js";
 export * from "./getanalyticsproperty.js";
 export * from "./getanalyticssession.js";
 export * from "./getanalyticsvisitor.js";
+export * from "./getassessmentorder.js";
 export * from "./getassessmentpackage.js";
 export * from "./getatsactivity.js";
 export * from "./getatsapplication.js";

package/src/sdk/order.ts

@@ -8,6 +8,8 @@ import { accountingListAccountingOrders } from "../funcs/accountingListAccountin
 import { accountingPatchAccountingOrder } from "../funcs/accountingPatchAccountingOrder.js";
 import { accountingRemoveAccountingOrder } from "../funcs/accountingRemoveAccountingOrder.js";
 import { accountingUpdateAccountingOrder } from "../funcs/accountingUpdateAccountingOrder.js";
+import { orderCreateAssessmentOrder } from "../funcs/orderCreateAssessmentOrder.js";
+import { orderGetAssessmentOrder } from "../funcs/orderGetAssessmentOrder.js";
 import { orderPatchAssessmentOrder } from "../funcs/orderPatchAssessmentOrder.js";
 import { orderUpdateAssessmentOrder } from "../funcs/orderUpdateAssessmentOrder.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -30,6 +32,20 @@ export class Order extends ClientSDK {
     ));
   }
 
+  /**
+   * Create an order
+   */
+  async createAssessmentOrder(
+    request: operations.CreateAssessmentOrderRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AssessmentOrder> {
+    return unwrapAsync(orderCreateAssessmentOrder(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve an order
    */
@@ -44,6 +60,20 @@ export class Order extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve an order
+   */
+  async getAssessmentOrder(
+    request: operations.GetAssessmentOrderRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AssessmentOrder> {
+    return unwrapAsync(orderGetAssessmentOrder(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all orders
    */