attio-js
Version:
Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.
123 lines • 6.79 kB
TypeScript
import * as z from "zod";
import { Result as SafeParseResult } from "../../types/fp.js";
import { ObjectT, ObjectT$Outbound } from "../components/object.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export type PatchV2ObjectsObjectData = {
/**
* A unique, human-readable slug to access the object through URLs and API calls. Should be formatted in snake case.
*/
apiSlug?: string | undefined;
/**
* The singular form of the object's name.
*/
singularNoun?: string | undefined;
/**
* The plural form of the object's name.
*/
pluralNoun?: string | undefined;
};
export type PatchV2ObjectsObjectRequestBody = {
data: PatchV2ObjectsObjectData;
};
export type PatchV2ObjectsObjectRequest = {
object: string;
requestBody: PatchV2ObjectsObjectRequestBody;
};
/**
* Success
*/
export type PatchV2ObjectsObjectResponse = {
data: ObjectT;
};
/** @internal */
export declare const PatchV2ObjectsObjectData$inboundSchema: z.ZodType<PatchV2ObjectsObjectData, z.ZodTypeDef, unknown>;
/** @internal */
export type PatchV2ObjectsObjectData$Outbound = {
api_slug?: string | undefined;
singular_noun?: string | undefined;
plural_noun?: string | undefined;
};
/** @internal */
export declare const PatchV2ObjectsObjectData$outboundSchema: z.ZodType<PatchV2ObjectsObjectData$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectData>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace PatchV2ObjectsObjectData$ {
/** @deprecated use `PatchV2ObjectsObjectData$inboundSchema` instead. */
const inboundSchema: z.ZodType<PatchV2ObjectsObjectData, z.ZodTypeDef, unknown>;
/** @deprecated use `PatchV2ObjectsObjectData$outboundSchema` instead. */
const outboundSchema: z.ZodType<PatchV2ObjectsObjectData$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectData>;
/** @deprecated use `PatchV2ObjectsObjectData$Outbound` instead. */
type Outbound = PatchV2ObjectsObjectData$Outbound;
}
export declare function patchV2ObjectsObjectDataToJSON(patchV2ObjectsObjectData: PatchV2ObjectsObjectData): string;
export declare function patchV2ObjectsObjectDataFromJSON(jsonString: string): SafeParseResult<PatchV2ObjectsObjectData, SDKValidationError>;
/** @internal */
export declare const PatchV2ObjectsObjectRequestBody$inboundSchema: z.ZodType<PatchV2ObjectsObjectRequestBody, z.ZodTypeDef, unknown>;
/** @internal */
export type PatchV2ObjectsObjectRequestBody$Outbound = {
data: PatchV2ObjectsObjectData$Outbound;
};
/** @internal */
export declare const PatchV2ObjectsObjectRequestBody$outboundSchema: z.ZodType<PatchV2ObjectsObjectRequestBody$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectRequestBody>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace PatchV2ObjectsObjectRequestBody$ {
/** @deprecated use `PatchV2ObjectsObjectRequestBody$inboundSchema` instead. */
const inboundSchema: z.ZodType<PatchV2ObjectsObjectRequestBody, z.ZodTypeDef, unknown>;
/** @deprecated use `PatchV2ObjectsObjectRequestBody$outboundSchema` instead. */
const outboundSchema: z.ZodType<PatchV2ObjectsObjectRequestBody$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectRequestBody>;
/** @deprecated use `PatchV2ObjectsObjectRequestBody$Outbound` instead. */
type Outbound = PatchV2ObjectsObjectRequestBody$Outbound;
}
export declare function patchV2ObjectsObjectRequestBodyToJSON(patchV2ObjectsObjectRequestBody: PatchV2ObjectsObjectRequestBody): string;
export declare function patchV2ObjectsObjectRequestBodyFromJSON(jsonString: string): SafeParseResult<PatchV2ObjectsObjectRequestBody, SDKValidationError>;
/** @internal */
export declare const PatchV2ObjectsObjectRequest$inboundSchema: z.ZodType<PatchV2ObjectsObjectRequest, z.ZodTypeDef, unknown>;
/** @internal */
export type PatchV2ObjectsObjectRequest$Outbound = {
object: string;
RequestBody: PatchV2ObjectsObjectRequestBody$Outbound;
};
/** @internal */
export declare const PatchV2ObjectsObjectRequest$outboundSchema: z.ZodType<PatchV2ObjectsObjectRequest$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectRequest>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace PatchV2ObjectsObjectRequest$ {
/** @deprecated use `PatchV2ObjectsObjectRequest$inboundSchema` instead. */
const inboundSchema: z.ZodType<PatchV2ObjectsObjectRequest, z.ZodTypeDef, unknown>;
/** @deprecated use `PatchV2ObjectsObjectRequest$outboundSchema` instead. */
const outboundSchema: z.ZodType<PatchV2ObjectsObjectRequest$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectRequest>;
/** @deprecated use `PatchV2ObjectsObjectRequest$Outbound` instead. */
type Outbound = PatchV2ObjectsObjectRequest$Outbound;
}
export declare function patchV2ObjectsObjectRequestToJSON(patchV2ObjectsObjectRequest: PatchV2ObjectsObjectRequest): string;
export declare function patchV2ObjectsObjectRequestFromJSON(jsonString: string): SafeParseResult<PatchV2ObjectsObjectRequest, SDKValidationError>;
/** @internal */
export declare const PatchV2ObjectsObjectResponse$inboundSchema: z.ZodType<PatchV2ObjectsObjectResponse, z.ZodTypeDef, unknown>;
/** @internal */
export type PatchV2ObjectsObjectResponse$Outbound = {
data: ObjectT$Outbound;
};
/** @internal */
export declare const PatchV2ObjectsObjectResponse$outboundSchema: z.ZodType<PatchV2ObjectsObjectResponse$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectResponse>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace PatchV2ObjectsObjectResponse$ {
/** @deprecated use `PatchV2ObjectsObjectResponse$inboundSchema` instead. */
const inboundSchema: z.ZodType<PatchV2ObjectsObjectResponse, z.ZodTypeDef, unknown>;
/** @deprecated use `PatchV2ObjectsObjectResponse$outboundSchema` instead. */
const outboundSchema: z.ZodType<PatchV2ObjectsObjectResponse$Outbound, z.ZodTypeDef, PatchV2ObjectsObjectResponse>;
/** @deprecated use `PatchV2ObjectsObjectResponse$Outbound` instead. */
type Outbound = PatchV2ObjectsObjectResponse$Outbound;
}
export declare function patchV2ObjectsObjectResponseToJSON(patchV2ObjectsObjectResponse: PatchV2ObjectsObjectResponse): string;
export declare function patchV2ObjectsObjectResponseFromJSON(jsonString: string): SafeParseResult<PatchV2ObjectsObjectResponse, SDKValidationError>;
//# sourceMappingURL=patchv2objectsobject.d.ts.map