attio-js
Version:
Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.
105 lines • 5.06 kB
TypeScript
import * as z from "zod";
import { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { Task, Task$Outbound } from "../components/task.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
/**
* Optionally sort the results. "created_at:asc" returns oldest results first, "created_at:desc" returns the newest results first. If unspecified, defaults to "created_at:asc" (oldest results first).
*/
export declare const GetV2TasksSort: {
readonly CreatedAtAsc: "created_at:asc";
readonly CreatedAtDesc: "created_at:desc";
};
/**
* Optionally sort the results. "created_at:asc" returns oldest results first, "created_at:desc" returns the newest results first. If unspecified, defaults to "created_at:asc" (oldest results first).
*/
export type GetV2TasksSort = ClosedEnum<typeof GetV2TasksSort>;
export type GetV2TasksRequest = {
limit?: number | undefined;
offset?: number | undefined;
/**
* Optionally sort the results. "created_at:asc" returns oldest results first, "created_at:desc" returns the newest results first. If unspecified, defaults to "created_at:asc" (oldest results first).
*/
sort?: GetV2TasksSort | undefined;
linkedObject?: string | undefined;
linkedRecordId?: string | undefined;
assignee?: string | null | undefined;
isCompleted?: boolean | undefined;
};
/**
* Success
*/
export type GetV2TasksResponse = {
data: Array<Task>;
};
/** @internal */
export declare const GetV2TasksSort$inboundSchema: z.ZodNativeEnum<typeof GetV2TasksSort>;
/** @internal */
export declare const GetV2TasksSort$outboundSchema: z.ZodNativeEnum<typeof GetV2TasksSort>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace GetV2TasksSort$ {
/** @deprecated use `GetV2TasksSort$inboundSchema` instead. */
const inboundSchema: z.ZodNativeEnum<{
readonly CreatedAtAsc: "created_at:asc";
readonly CreatedAtDesc: "created_at:desc";
}>;
/** @deprecated use `GetV2TasksSort$outboundSchema` instead. */
const outboundSchema: z.ZodNativeEnum<{
readonly CreatedAtAsc: "created_at:asc";
readonly CreatedAtDesc: "created_at:desc";
}>;
}
/** @internal */
export declare const GetV2TasksRequest$inboundSchema: z.ZodType<GetV2TasksRequest, z.ZodTypeDef, unknown>;
/** @internal */
export type GetV2TasksRequest$Outbound = {
limit?: number | undefined;
offset?: number | undefined;
sort?: string | undefined;
linked_object?: string | undefined;
linked_record_id?: string | undefined;
assignee?: string | null | undefined;
is_completed?: boolean | undefined;
};
/** @internal */
export declare const GetV2TasksRequest$outboundSchema: z.ZodType<GetV2TasksRequest$Outbound, z.ZodTypeDef, GetV2TasksRequest>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace GetV2TasksRequest$ {
/** @deprecated use `GetV2TasksRequest$inboundSchema` instead. */
const inboundSchema: z.ZodType<GetV2TasksRequest, z.ZodTypeDef, unknown>;
/** @deprecated use `GetV2TasksRequest$outboundSchema` instead. */
const outboundSchema: z.ZodType<GetV2TasksRequest$Outbound, z.ZodTypeDef, GetV2TasksRequest>;
/** @deprecated use `GetV2TasksRequest$Outbound` instead. */
type Outbound = GetV2TasksRequest$Outbound;
}
export declare function getV2TasksRequestToJSON(getV2TasksRequest: GetV2TasksRequest): string;
export declare function getV2TasksRequestFromJSON(jsonString: string): SafeParseResult<GetV2TasksRequest, SDKValidationError>;
/** @internal */
export declare const GetV2TasksResponse$inboundSchema: z.ZodType<GetV2TasksResponse, z.ZodTypeDef, unknown>;
/** @internal */
export type GetV2TasksResponse$Outbound = {
data: Array<Task$Outbound>;
};
/** @internal */
export declare const GetV2TasksResponse$outboundSchema: z.ZodType<GetV2TasksResponse$Outbound, z.ZodTypeDef, GetV2TasksResponse>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace GetV2TasksResponse$ {
/** @deprecated use `GetV2TasksResponse$inboundSchema` instead. */
const inboundSchema: z.ZodType<GetV2TasksResponse, z.ZodTypeDef, unknown>;
/** @deprecated use `GetV2TasksResponse$outboundSchema` instead. */
const outboundSchema: z.ZodType<GetV2TasksResponse$Outbound, z.ZodTypeDef, GetV2TasksResponse>;
/** @deprecated use `GetV2TasksResponse$Outbound` instead. */
type Outbound = GetV2TasksResponse$Outbound;
}
export declare function getV2TasksResponseToJSON(getV2TasksResponse: GetV2TasksResponse): string;
export declare function getV2TasksResponseFromJSON(jsonString: string): SafeParseResult<GetV2TasksResponse, SDKValidationError>;
//# sourceMappingURL=getv2tasks.d.ts.map