@unified-api/typescript-sdk 2.9.22 → 2.9.24

package/src/sdk/kms.ts

@@ -2,16 +2,22 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { kmsCreateKmsComment } from "../funcs/kmsCreateKmsComment.js";
 import { kmsCreateKmsPage } from "../funcs/kmsCreateKmsPage.js";
 import { kmsCreateKmsSpace } from "../funcs/kmsCreateKmsSpace.js";
+import { kmsGetKmsComment } from "../funcs/kmsGetKmsComment.js";
 import { kmsGetKmsPage } from "../funcs/kmsGetKmsPage.js";
 import { kmsGetKmsSpace } from "../funcs/kmsGetKmsSpace.js";
+import { kmsListKmsComments } from "../funcs/kmsListKmsComments.js";
 import { kmsListKmsPages } from "../funcs/kmsListKmsPages.js";
 import { kmsListKmsSpaces } from "../funcs/kmsListKmsSpaces.js";
+import { kmsPatchKmsComment } from "../funcs/kmsPatchKmsComment.js";
 import { kmsPatchKmsPage } from "../funcs/kmsPatchKmsPage.js";
 import { kmsPatchKmsSpace } from "../funcs/kmsPatchKmsSpace.js";
+import { kmsRemoveKmsComment } from "../funcs/kmsRemoveKmsComment.js";
 import { kmsRemoveKmsPage } from "../funcs/kmsRemoveKmsPage.js";
 import { kmsRemoveKmsSpace } from "../funcs/kmsRemoveKmsSpace.js";
+import { kmsUpdateKmsComment } from "../funcs/kmsUpdateKmsComment.js";
 import { kmsUpdateKmsPage } from "../funcs/kmsUpdateKmsPage.js";
 import { kmsUpdateKmsSpace } from "../funcs/kmsUpdateKmsSpace.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -20,6 +26,20 @@ import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
 export class Kms extends ClientSDK {
+  /**
+   * Create a comment
+   */
+  async createKmsComment(
+    request: operations.CreateKmsCommentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.KmsComment> {
+    return unwrapAsync(kmsCreateKmsComment(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create a page
    */
@@ -48,6 +68,20 @@ export class Kms extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve a comment
+   */
+  async getKmsComment(
+    request: operations.GetKmsCommentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.KmsComment> {
+    return unwrapAsync(kmsGetKmsComment(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a page
    */
@@ -76,6 +110,20 @@ export class Kms extends ClientSDK {
     ));
   }
 
+  /**
+   * List all comments
+   */
+  async listKmsComments(
+    request: operations.ListKmsCommentsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.KmsComment>> {
+    return unwrapAsync(kmsListKmsComments(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all pages
    */
@@ -104,6 +152,20 @@ export class Kms extends ClientSDK {
     ));
   }
 
+  /**
+   * Update a comment
+   */
+  async patchKmsComment(
+    request: operations.PatchKmsCommentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.KmsComment> {
+    return unwrapAsync(kmsPatchKmsComment(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a page
    */
@@ -132,6 +194,20 @@ export class Kms extends ClientSDK {
     ));
   }
 
+  /**
+   * Remove a comment
+   */
+  async removeKmsComment(
+    request: operations.RemoveKmsCommentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RemoveKmsCommentResponse | undefined> {
+    return unwrapAsync(kmsRemoveKmsComment(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Remove a page
    */
@@ -160,6 +236,20 @@ export class Kms extends ClientSDK {
     ));
   }
 
+  /**
+   * Update a comment
+   */
+  async updateKmsComment(
+    request: operations.UpdateKmsCommentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.KmsComment> {
+    return unwrapAsync(kmsUpdateKmsComment(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Update a page
    */

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

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as shared from "../shared/index.js";
+
+export type CreateKmsCommentRequest = {
+  kmsComment?: shared.KmsComment | undefined;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+};
+
+/** @internal */
+export const CreateKmsCommentRequest$inboundSchema: z.ZodType<
+  CreateKmsCommentRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  KmsComment: shared.KmsComment$inboundSchema.optional(),
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "KmsComment": "kmsComment",
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type CreateKmsCommentRequest$Outbound = {
+  KmsComment?: shared.KmsComment$Outbound | undefined;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+};
+
+/** @internal */
+export const CreateKmsCommentRequest$outboundSchema: z.ZodType<
+  CreateKmsCommentRequest$Outbound,
+  z.ZodTypeDef,
+  CreateKmsCommentRequest
+> = z.object({
+  kmsComment: shared.KmsComment$outboundSchema.optional(),
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    kmsComment: "KmsComment",
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateKmsCommentRequest$ {
+  /** @deprecated use `CreateKmsCommentRequest$inboundSchema` instead. */
+  export const inboundSchema = CreateKmsCommentRequest$inboundSchema;
+  /** @deprecated use `CreateKmsCommentRequest$outboundSchema` instead. */
+  export const outboundSchema = CreateKmsCommentRequest$outboundSchema;
+  /** @deprecated use `CreateKmsCommentRequest$Outbound` instead. */
+  export type Outbound = CreateKmsCommentRequest$Outbound;
+}
+
+export function createKmsCommentRequestToJSON(
+  createKmsCommentRequest: CreateKmsCommentRequest,
+): string {
+  return JSON.stringify(
+    CreateKmsCommentRequest$outboundSchema.parse(createKmsCommentRequest),
+  );
+}
+
+export function createKmsCommentRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateKmsCommentRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateKmsCommentRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateKmsCommentRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetKmsCommentRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Comment
+   */
+  id: string;
+};
+
+/** @internal */
+export const GetKmsCommentRequest$inboundSchema: z.ZodType<
+  GetKmsCommentRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type GetKmsCommentRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+};
+
+/** @internal */
+export const GetKmsCommentRequest$outboundSchema: z.ZodType<
+  GetKmsCommentRequest$Outbound,
+  z.ZodTypeDef,
+  GetKmsCommentRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetKmsCommentRequest$ {
+  /** @deprecated use `GetKmsCommentRequest$inboundSchema` instead. */
+  export const inboundSchema = GetKmsCommentRequest$inboundSchema;
+  /** @deprecated use `GetKmsCommentRequest$outboundSchema` instead. */
+  export const outboundSchema = GetKmsCommentRequest$outboundSchema;
+  /** @deprecated use `GetKmsCommentRequest$Outbound` instead. */
+  export type Outbound = GetKmsCommentRequest$Outbound;
+}
+
+export function getKmsCommentRequestToJSON(
+  getKmsCommentRequest: GetKmsCommentRequest,
+): string {
+  return JSON.stringify(
+    GetKmsCommentRequest$outboundSchema.parse(getKmsCommentRequest),
+  );
+}
+
+export function getKmsCommentRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetKmsCommentRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetKmsCommentRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetKmsCommentRequest' from JSON`,
+  );
+}

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

@@ -31,6 +31,7 @@ export * from "./createhriscompany.js";
 export * from "./createhrisemployee.js";
 export * from "./createhrisgroup.js";
 export * from "./createhrislocation.js";
+export * from "./createkmscomment.js";
 export * from "./createkmspage.js";
 export * from "./createkmsspace.js";
 export * from "./createlmsclass.js";
@@ -94,6 +95,7 @@ export * from "./gethrisgroup.js";
 export * from "./gethrislocation.js";
 export * from "./gethrispayslip.js";
 export * from "./gethristimeoff.js";
+export * from "./getkmscomment.js";
 export * from "./getkmspage.js";
 export * from "./getkmsspace.js";
 export * from "./getlmsclass.js";
@@ -166,6 +168,7 @@ export * from "./listhrisgroups.js";
 export * from "./listhrislocations.js";
 export * from "./listhrispayslips.js";
 export * from "./listhristimeoffs.js";
+export * from "./listkmscomments.js";
 export * from "./listkmspages.js";
 export * from "./listkmsspaces.js";
 export * from "./listlmsclasses.js";
@@ -233,6 +236,7 @@ export * from "./patchhriscompany.js";
 export * from "./patchhrisemployee.js";
 export * from "./patchhrisgroup.js";
 export * from "./patchhrislocation.js";
+export * from "./patchkmscomment.js";
 export * from "./patchkmspage.js";
 export * from "./patchkmsspace.js";
 export * from "./patchlmsclass.js";
@@ -294,6 +298,7 @@ export * from "./removehriscompany.js";
 export * from "./removehrisemployee.js";
 export * from "./removehrisgroup.js";
 export * from "./removehrislocation.js";
+export * from "./removekmscomment.js";
 export * from "./removekmspage.js";
 export * from "./removekmsspace.js";
 export * from "./removelmsclass.js";
@@ -353,6 +358,7 @@ export * from "./updatehriscompany.js";
 export * from "./updatehrisemployee.js";
 export * from "./updatehrisgroup.js";
 export * from "./updatehrislocation.js";
+export * from "./updatekmscomment.js";
 export * from "./updatekmspage.js";
 export * from "./updatekmsspace.js";
 export * from "./updatelmsclass.js";

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

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListKmsCommentsRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  pageId?: string | undefined;
+  parentId?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | undefined;
+  sort?: string | undefined;
+  type?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value
+   */
+  updatedGte?: Date | undefined;
+};
+
+/** @internal */
+export const ListKmsCommentsRequest$inboundSchema: z.ZodType<
+  ListKmsCommentsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  page_id: z.string().optional(),
+  parent_id: z.string().optional(),
+  query: z.string().optional(),
+  sort: z.string().optional(),
+  type: z.string().optional(),
+  updated_gte: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+    "page_id": "pageId",
+    "parent_id": "parentId",
+    "updated_gte": "updatedGte",
+  });
+});
+
+/** @internal */
+export type ListKmsCommentsRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  page_id?: string | undefined;
+  parent_id?: string | undefined;
+  query?: string | undefined;
+  sort?: string | undefined;
+  type?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListKmsCommentsRequest$outboundSchema: z.ZodType<
+  ListKmsCommentsRequest$Outbound,
+  z.ZodTypeDef,
+  ListKmsCommentsRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  pageId: z.string().optional(),
+  parentId: z.string().optional(),
+  query: z.string().optional(),
+  sort: z.string().optional(),
+  type: z.string().optional(),
+  updatedGte: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    pageId: "page_id",
+    parentId: "parent_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListKmsCommentsRequest$ {
+  /** @deprecated use `ListKmsCommentsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListKmsCommentsRequest$inboundSchema;
+  /** @deprecated use `ListKmsCommentsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListKmsCommentsRequest$outboundSchema;
+  /** @deprecated use `ListKmsCommentsRequest$Outbound` instead. */
+  export type Outbound = ListKmsCommentsRequest$Outbound;
+}
+
+export function listKmsCommentsRequestToJSON(
+  listKmsCommentsRequest: ListKmsCommentsRequest,
+): string {
+  return JSON.stringify(
+    ListKmsCommentsRequest$outboundSchema.parse(listKmsCommentsRequest),
+  );
+}
+
+export function listKmsCommentsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListKmsCommentsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListKmsCommentsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListKmsCommentsRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as shared from "../shared/index.js";
+
+export type PatchKmsCommentRequest = {
+  kmsComment?: shared.KmsComment | undefined;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Comment
+   */
+  id: string;
+};
+
+/** @internal */
+export const PatchKmsCommentRequest$inboundSchema: z.ZodType<
+  PatchKmsCommentRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  KmsComment: shared.KmsComment$inboundSchema.optional(),
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "KmsComment": "kmsComment",
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type PatchKmsCommentRequest$Outbound = {
+  KmsComment?: shared.KmsComment$Outbound | undefined;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+};
+
+/** @internal */
+export const PatchKmsCommentRequest$outboundSchema: z.ZodType<
+  PatchKmsCommentRequest$Outbound,
+  z.ZodTypeDef,
+  PatchKmsCommentRequest
+> = z.object({
+  kmsComment: shared.KmsComment$outboundSchema.optional(),
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    kmsComment: "KmsComment",
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PatchKmsCommentRequest$ {
+  /** @deprecated use `PatchKmsCommentRequest$inboundSchema` instead. */
+  export const inboundSchema = PatchKmsCommentRequest$inboundSchema;
+  /** @deprecated use `PatchKmsCommentRequest$outboundSchema` instead. */
+  export const outboundSchema = PatchKmsCommentRequest$outboundSchema;
+  /** @deprecated use `PatchKmsCommentRequest$Outbound` instead. */
+  export type Outbound = PatchKmsCommentRequest$Outbound;
+}
+
+export function patchKmsCommentRequestToJSON(
+  patchKmsCommentRequest: PatchKmsCommentRequest,
+): string {
+  return JSON.stringify(
+    PatchKmsCommentRequest$outboundSchema.parse(patchKmsCommentRequest),
+  );
+}
+
+export function patchKmsCommentRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PatchKmsCommentRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PatchKmsCommentRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PatchKmsCommentRequest' from JSON`,
+  );
+}