/*
* 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 * as components from "../components/index.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export type IssueTrackingCollectionUsersAllGlobals = {
/**
* ID of the consumer which you want to get or push data from
*/
consumerId?: string | undefined;
/**
* The ID of your Unify application
*/
appId?: string | undefined;
};
export type IssueTrackingCollectionUsersAllRequest = {
/**
* The collection ID
*/
collectionId: string;
/**
* Include raw response. Mostly used for debugging purposes
*/
raw?: boolean | undefined;
/**
* Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
*/
serviceId?: string | undefined;
/**
* Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
*/
cursor?: string | null | undefined;
/**
* Number of results to return. Minimum 1, Maximum 200, Default 20
*/
limit?: number | undefined;
/**
* Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
*/
passThrough?: { [k: string]: any } | undefined;
/**
* The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
*/
fields?: string | null | undefined;
};
export type IssueTrackingCollectionUsersAllResponse = {
httpMeta: components.HTTPMetadata;
/**
* Users
*/
getCollectionUsersResponse?:
| components.GetCollectionUsersResponse
| undefined;
/**
* Unexpected error
*/
unexpectedErrorResponse?: components.UnexpectedErrorResponse | undefined;
};
/** @internal */
export const IssueTrackingCollectionUsersAllGlobals$inboundSchema: z.ZodType<
IssueTrackingCollectionUsersAllGlobals,
z.ZodTypeDef,
unknown
> = z.object({
consumerId: z.string().optional(),
appId: z.string().optional(),
});
/** @internal */
export type IssueTrackingCollectionUsersAllGlobals$Outbound = {
consumerId?: string | undefined;
appId?: string | undefined;
};
/** @internal */
export const IssueTrackingCollectionUsersAllGlobals$outboundSchema: z.ZodType<
IssueTrackingCollectionUsersAllGlobals$Outbound,
z.ZodTypeDef,
IssueTrackingCollectionUsersAllGlobals
> = z.object({
consumerId: z.string().optional(),
appId: 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 IssueTrackingCollectionUsersAllGlobals$ {
/** @deprecated use `IssueTrackingCollectionUsersAllGlobals$inboundSchema` instead. */
export const inboundSchema =
IssueTrackingCollectionUsersAllGlobals$inboundSchema;
/** @deprecated use `IssueTrackingCollectionUsersAllGlobals$outboundSchema` instead. */
export const outboundSchema =
IssueTrackingCollectionUsersAllGlobals$outboundSchema;
/** @deprecated use `IssueTrackingCollectionUsersAllGlobals$Outbound` instead. */
export type Outbound = IssueTrackingCollectionUsersAllGlobals$Outbound;
}
export function issueTrackingCollectionUsersAllGlobalsToJSON(
issueTrackingCollectionUsersAllGlobals:
IssueTrackingCollectionUsersAllGlobals,
): string {
return JSON.stringify(
IssueTrackingCollectionUsersAllGlobals$outboundSchema.parse(
issueTrackingCollectionUsersAllGlobals,
),
);
}
export function issueTrackingCollectionUsersAllGlobalsFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) =>
IssueTrackingCollectionUsersAllGlobals$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'IssueTrackingCollectionUsersAllGlobals' from JSON`,
);
}
/** @internal */
export const IssueTrackingCollectionUsersAllRequest$inboundSchema: z.ZodType<
IssueTrackingCollectionUsersAllRequest,
z.ZodTypeDef,
unknown
> = z.object({
collection_id: z.string(),
raw: z.boolean().default(false),
serviceId: z.string().optional(),
cursor: z.nullable(z.string()).optional(),
limit: z.number().int().default(20),
pass_through: z.record(z.any()).optional(),
fields: z.nullable(z.string()).optional(),
}).transform((v) => {
return remap$(v, {
"collection_id": "collectionId",
"pass_through": "passThrough",
});
});
/** @internal */
export type IssueTrackingCollectionUsersAllRequest$Outbound = {
collection_id: string;
raw: boolean;
serviceId?: string | undefined;
cursor?: string | null | undefined;
limit: number;
pass_through?: { [k: string]: any } | undefined;
fields?: string | null | undefined;
};
/** @internal */
export const IssueTrackingCollectionUsersAllRequest$outboundSchema: z.ZodType<
IssueTrackingCollectionUsersAllRequest$Outbound,
z.ZodTypeDef,
IssueTrackingCollectionUsersAllRequest
> = z.object({
collectionId: z.string(),
raw: z.boolean().default(false),
serviceId: z.string().optional(),
cursor: z.nullable(z.string()).optional(),
limit: z.number().int().default(20),
passThrough: z.record(z.any()).optional(),
fields: z.nullable(z.string()).optional(),
}).transform((v) => {
return remap$(v, {
collectionId: "collection_id",
passThrough: "pass_through",
});
});
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export namespace IssueTrackingCollectionUsersAllRequest$ {
/** @deprecated use `IssueTrackingCollectionUsersAllRequest$inboundSchema` instead. */
export const inboundSchema =
IssueTrackingCollectionUsersAllRequest$inboundSchema;
/** @deprecated use `IssueTrackingCollectionUsersAllRequest$outboundSchema` instead. */
export const outboundSchema =
IssueTrackingCollectionUsersAllRequest$outboundSchema;
/** @deprecated use `IssueTrackingCollectionUsersAllRequest$Outbound` instead. */
export type Outbound = IssueTrackingCollectionUsersAllRequest$Outbound;
}
export function issueTrackingCollectionUsersAllRequestToJSON(
issueTrackingCollectionUsersAllRequest:
IssueTrackingCollectionUsersAllRequest,
): string {
return JSON.stringify(
IssueTrackingCollectionUsersAllRequest$outboundSchema.parse(
issueTrackingCollectionUsersAllRequest,
),
);
}
export function issueTrackingCollectionUsersAllRequestFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) =>
IssueTrackingCollectionUsersAllRequest$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'IssueTrackingCollectionUsersAllRequest' from JSON`,
);
}
/** @internal */
export const IssueTrackingCollectionUsersAllResponse$inboundSchema: z.ZodType<
IssueTrackingCollectionUsersAllResponse,
z.ZodTypeDef,
unknown
> = z.object({
HttpMeta: components.HTTPMetadata$inboundSchema,
GetCollectionUsersResponse: components
.GetCollectionUsersResponse$inboundSchema.optional(),
UnexpectedErrorResponse: components.UnexpectedErrorResponse$inboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
"HttpMeta": "httpMeta",
"GetCollectionUsersResponse": "getCollectionUsersResponse",
"UnexpectedErrorResponse": "unexpectedErrorResponse",
});
});
/** @internal */
export type IssueTrackingCollectionUsersAllResponse$Outbound = {
HttpMeta: components.HTTPMetadata$Outbound;
GetCollectionUsersResponse?:
| components.GetCollectionUsersResponse$Outbound
| undefined;
UnexpectedErrorResponse?:
| components.UnexpectedErrorResponse$Outbound
| undefined;
};
/** @internal */
export const IssueTrackingCollectionUsersAllResponse$outboundSchema: z.ZodType<
IssueTrackingCollectionUsersAllResponse$Outbound,
z.ZodTypeDef,
IssueTrackingCollectionUsersAllResponse
> = z.object({
httpMeta: components.HTTPMetadata$outboundSchema,
getCollectionUsersResponse: components
.GetCollectionUsersResponse$outboundSchema.optional(),
unexpectedErrorResponse: components.UnexpectedErrorResponse$outboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
httpMeta: "HttpMeta",
getCollectionUsersResponse: "GetCollectionUsersResponse",
unexpectedErrorResponse: "UnexpectedErrorResponse",
});
});
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export namespace IssueTrackingCollectionUsersAllResponse$ {
/** @deprecated use `IssueTrackingCollectionUsersAllResponse$inboundSchema` instead. */
export const inboundSchema =
IssueTrackingCollectionUsersAllResponse$inboundSchema;
/** @deprecated use `IssueTrackingCollectionUsersAllResponse$outboundSchema` instead. */
export const outboundSchema =
IssueTrackingCollectionUsersAllResponse$outboundSchema;
/** @deprecated use `IssueTrackingCollectionUsersAllResponse$Outbound` instead. */
export type Outbound = IssueTrackingCollectionUsersAllResponse$Outbound;
}
export function issueTrackingCollectionUsersAllResponseToJSON(
issueTrackingCollectionUsersAllResponse:
IssueTrackingCollectionUsersAllResponse,
): string {
return JSON.stringify(
IssueTrackingCollectionUsersAllResponse$outboundSchema.parse(
issueTrackingCollectionUsersAllResponse,
),
);
}
export function issueTrackingCollectionUsersAllResponseFromJSON(
jsonString: string,
): SafeParseResult<
IssueTrackingCollectionUsersAllResponse,
SDKValidationError
> {
return safeParse(
jsonString,
(x) =>
IssueTrackingCollectionUsersAllResponse$inboundSchema.parse(
JSON.parse(x),
),
`Failed to parse 'IssueTrackingCollectionUsersAllResponse' from JSON`,
);
}