@unified-api/typescript-sdk 2.73.15 → 2.73.16

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

@@ -0,0 +1,133 @@
+/*
+ * 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 ListTaskChangesRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | 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;
+  sort?: string | undefined;
+  /**
+   * The task ID to filter by
+   */
+  taskId?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListTaskChangesRequest$inboundSchema: z.ZodType<
+  ListTaskChangesRequest,
+  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(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  task_id: z.string().optional(),
+  updated_gte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+    "task_id": "taskId",
+    "updated_gte": "updatedGte",
+  });
+});
+
+/** @internal */
+export type ListTaskChangesRequest$Outbound = {
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  task_id?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListTaskChangesRequest$outboundSchema: z.ZodType<
+  ListTaskChangesRequest$Outbound,
+  z.ZodTypeDef,
+  ListTaskChangesRequest
+> = z.object({
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  taskId: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    taskId: "task_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 ListTaskChangesRequest$ {
+  /** @deprecated use `ListTaskChangesRequest$inboundSchema` instead. */
+  export const inboundSchema = ListTaskChangesRequest$inboundSchema;
+  /** @deprecated use `ListTaskChangesRequest$outboundSchema` instead. */
+  export const outboundSchema = ListTaskChangesRequest$outboundSchema;
+  /** @deprecated use `ListTaskChangesRequest$Outbound` instead. */
+  export type Outbound = ListTaskChangesRequest$Outbound;
+}
+
+export function listTaskChangesRequestToJSON(
+  listTaskChangesRequest: ListTaskChangesRequest,
+): string {
+  return JSON.stringify(
+    ListTaskChangesRequest$outboundSchema.parse(listTaskChangesRequest),
+  );
+}
+
+export function listTaskChangesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTaskChangesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTaskChangesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTaskChangesRequest' from JSON`,
+  );
+}

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

@@ -218,6 +218,8 @@ export * from "./scimusergroups.js";
 export * from "./security.js";
 export * from "./storagefile.js";
 export * from "./storagepermission.js";
+export * from "./taskchange.js";
+export * from "./taskchangeitem.js";
 export * from "./taskcomment.js";
 export * from "./taskmetadata.js";
 export * from "./taskproject.js";

package/src/sdk/models/shared/propertyconnectionpermissions.ts

@@ -140,6 +140,7 @@ export const PropertyConnectionPermissions = {
   TaskProjectWrite: "task_project_write",
   TaskTaskRead: "task_task_read",
   TaskTaskWrite: "task_task_write",
+  TaskChangeRead: "task_change_read",
   TaskCommentRead: "task_comment_read",
   TaskCommentWrite: "task_comment_write",
   ScimUsersRead: "scim_users_read",

package/src/sdk/models/shared/taskchange.ts

@@ -0,0 +1,109 @@
+/*
+ * 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 {
+  TaskChangeItem,
+  TaskChangeItem$inboundSchema,
+  TaskChangeItem$Outbound,
+  TaskChangeItem$outboundSchema,
+} from "./taskchangeitem.js";
+
+export type TaskChange = {
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  items?: Array<TaskChangeItem> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  taskId?: string | undefined;
+  updatedAt?: Date | undefined;
+  userId?: string | undefined;
+};
+
+/** @internal */
+export const TaskChange$inboundSchema: z.ZodType<
+  TaskChange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  items: z.array(TaskChangeItem$inboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  task_id: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  user_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "task_id": "taskId",
+    "updated_at": "updatedAt",
+    "user_id": "userId",
+  });
+});
+
+/** @internal */
+export type TaskChange$Outbound = {
+  created_at?: string | undefined;
+  id?: string | undefined;
+  items?: Array<TaskChangeItem$Outbound> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  task_id?: string | undefined;
+  updated_at?: string | undefined;
+  user_id?: string | undefined;
+};
+
+/** @internal */
+export const TaskChange$outboundSchema: z.ZodType<
+  TaskChange$Outbound,
+  z.ZodTypeDef,
+  TaskChange
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  items: z.array(TaskChangeItem$outboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  taskId: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  userId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    taskId: "task_id",
+    updatedAt: "updated_at",
+    userId: "user_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TaskChange$ {
+  /** @deprecated use `TaskChange$inboundSchema` instead. */
+  export const inboundSchema = TaskChange$inboundSchema;
+  /** @deprecated use `TaskChange$outboundSchema` instead. */
+  export const outboundSchema = TaskChange$outboundSchema;
+  /** @deprecated use `TaskChange$Outbound` instead. */
+  export type Outbound = TaskChange$Outbound;
+}
+
+export function taskChangeToJSON(taskChange: TaskChange): string {
+  return JSON.stringify(TaskChange$outboundSchema.parse(taskChange));
+}
+
+export function taskChangeFromJSON(
+  jsonString: string,
+): SafeParseResult<TaskChange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TaskChange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TaskChange' from JSON`,
+  );
+}

package/src/sdk/models/shared/taskchangeitem.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TaskChangeItem = {
+  field: string;
+  from?: string | undefined;
+  to?: string | undefined;
+};
+
+/** @internal */
+export const TaskChangeItem$inboundSchema: z.ZodType<
+  TaskChangeItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  field: z.string(),
+  from: z.string().optional(),
+  to: z.string().optional(),
+});
+
+/** @internal */
+export type TaskChangeItem$Outbound = {
+  field: string;
+  from?: string | undefined;
+  to?: string | undefined;
+};
+
+/** @internal */
+export const TaskChangeItem$outboundSchema: z.ZodType<
+  TaskChangeItem$Outbound,
+  z.ZodTypeDef,
+  TaskChangeItem
+> = z.object({
+  field: z.string(),
+  from: z.string().optional(),
+  to: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TaskChangeItem$ {
+  /** @deprecated use `TaskChangeItem$inboundSchema` instead. */
+  export const inboundSchema = TaskChangeItem$inboundSchema;
+  /** @deprecated use `TaskChangeItem$outboundSchema` instead. */
+  export const outboundSchema = TaskChangeItem$outboundSchema;
+  /** @deprecated use `TaskChangeItem$Outbound` instead. */
+  export type Outbound = TaskChangeItem$Outbound;
+}
+
+export function taskChangeItemToJSON(taskChangeItem: TaskChangeItem): string {
+  return JSON.stringify(TaskChangeItem$outboundSchema.parse(taskChangeItem));
+}
+
+export function taskChangeItemFromJSON(
+  jsonString: string,
+): SafeParseResult<TaskChangeItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TaskChangeItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TaskChangeItem' from JSON`,
+  );
+}

package/src/sdk/models/shared/webhook.ts

@@ -103,6 +103,7 @@ export const ObjectType = {
   TaskProject: "task_project",
   TaskTask: "task_task",
   TaskComment: "task_comment",
+  TaskChange: "task_change",
   ScimUsers: "scim_users",
   ScimGroups: "scim_groups",
   LmsCourse: "lms_course",

package/src/sdk/sdk.ts

@@ -19,6 +19,7 @@ import { Calendar } from "./calendar.js";
 import { Call } from "./call.js";
 import { Candidate } from "./candidate.js";
 import { Category } from "./category.js";
+import { Change } from "./change.js";
 import { Channel } from "./channel.js";
 import { Class } from "./class.js";
 import { Collection } from "./collection.js";
@@ -536,6 +537,11 @@ export class UnifiedTo extends ClientSDK {
     return (this._task ??= new Task(this._options));
   }
 
+  private _change?: Change;
+  get change(): Change {
+    return (this._change ??= new Change(this._options));
+  }
+
   private _project?: Project;
   get project(): Project {
     return (this._project ??= new Project(this._options));

package/src/sdk/task.ts

@@ -10,8 +10,10 @@ import { commentRemoveTaskComment } from "../funcs/commentRemoveTaskComment.js";
 import { commentUpdateTaskComment } from "../funcs/commentUpdateTaskComment.js";
 import { taskCreateTaskProject } from "../funcs/taskCreateTaskProject.js";
 import { taskCreateTaskTask } from "../funcs/taskCreateTaskTask.js";
+import { taskGetTaskChange } from "../funcs/taskGetTaskChange.js";
 import { taskGetTaskProject } from "../funcs/taskGetTaskProject.js";
 import { taskGetTaskTask } from "../funcs/taskGetTaskTask.js";
+import { taskListTaskChanges } from "../funcs/taskListTaskChanges.js";
 import { taskListTaskProjects } from "../funcs/taskListTaskProjects.js";
 import { taskListTaskTasks } from "../funcs/taskListTaskTasks.js";
 import { taskPatchTaskProject } from "../funcs/taskPatchTaskProject.js";
@@ -68,6 +70,20 @@ export class Task extends ClientSDK {
     ));
   }
 
+  /**
+   * Retrieve a change
+   */
+  async getTaskChange(
+    request: operations.GetTaskChangeRequest,
+    options?: RequestOptions,
+  ): Promise<shared.TaskChange> {
+    return unwrapAsync(taskGetTaskChange(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a comment
    */
@@ -110,6 +126,20 @@ export class Task extends ClientSDK {
     ));
   }
 
+  /**
+   * List all changes
+   */
+  async listTaskChanges(
+    request: operations.ListTaskChangesRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.TaskChange>> {
+    return unwrapAsync(taskListTaskChanges(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List all comments
    */