@devma/qloo
Version:
TypeScript SDK for the Qloo Insights API - Generate taste-based insights and recommendations
119 lines • 5.89 kB
TypeScript
import * as z from "zod";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export type GetAudiencesRequest = {
/**
* Filter by a comma-separated list of parental entity types (`urn:audience:communities`). Each type must match exactly.
*/
filterParentsTypes?: Array<string> | undefined;
/**
* Filter by a comma-separated list of audience IDs.
*/
filterResultsAudiences?: Array<string> | undefined;
/**
* Filter by a list of audience types.
*/
filterAudienceTypes?: Array<string> | undefined;
/**
* Filter by the minimum popularity percentile required for a Point of Interest (float, between 0 and 1; closer to 1 indicates higher popularity, e.g., 0.98 for the 98th percentile).
*/
filterPopularityMin?: number | undefined;
/**
* Filter by the maximum popularity percentile a Point of Interest must have (float, between 0 and 1; closer to 1 indicates higher popularity, e.g., 0.98 for the 98th percentile).
*/
filterPopularityMax?: number | undefined;
/**
* The page number of results to return. This is equivalent to take + offset and is the recommended approach for most use cases.
*/
page?: number | undefined;
/**
* The number of results to return.
*/
take?: number | undefined;
};
export type GetAudiencesResults = {
entities?: Array<any> | undefined;
duration?: number | undefined;
};
/**
* Successful Operation
*/
export type GetAudiencesResponse = {
success?: boolean | undefined;
results?: GetAudiencesResults | undefined;
};
/** @internal */
export declare const GetAudiencesRequest$inboundSchema: z.ZodType<GetAudiencesRequest, z.ZodTypeDef, unknown>;
/** @internal */
export type GetAudiencesRequest$Outbound = {
"filter.parents.types"?: Array<string> | undefined;
"filter.results.audiences"?: Array<string> | undefined;
"filter.audience.types"?: Array<string> | undefined;
"filter.popularity.min"?: number | undefined;
"filter.popularity.max"?: number | undefined;
page?: number | undefined;
take?: number | undefined;
};
/** @internal */
export declare const GetAudiencesRequest$outboundSchema: z.ZodType<GetAudiencesRequest$Outbound, z.ZodTypeDef, GetAudiencesRequest>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace GetAudiencesRequest$ {
/** @deprecated use `GetAudiencesRequest$inboundSchema` instead. */
const inboundSchema: z.ZodType<GetAudiencesRequest, z.ZodTypeDef, unknown>;
/** @deprecated use `GetAudiencesRequest$outboundSchema` instead. */
const outboundSchema: z.ZodType<GetAudiencesRequest$Outbound, z.ZodTypeDef, GetAudiencesRequest>;
/** @deprecated use `GetAudiencesRequest$Outbound` instead. */
type Outbound = GetAudiencesRequest$Outbound;
}
export declare function getAudiencesRequestToJSON(getAudiencesRequest: GetAudiencesRequest): string;
export declare function getAudiencesRequestFromJSON(jsonString: string): SafeParseResult<GetAudiencesRequest, SDKValidationError>;
/** @internal */
export declare const GetAudiencesResults$inboundSchema: z.ZodType<GetAudiencesResults, z.ZodTypeDef, unknown>;
/** @internal */
export type GetAudiencesResults$Outbound = {
entities?: Array<any> | undefined;
duration?: number | undefined;
};
/** @internal */
export declare const GetAudiencesResults$outboundSchema: z.ZodType<GetAudiencesResults$Outbound, z.ZodTypeDef, GetAudiencesResults>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace GetAudiencesResults$ {
/** @deprecated use `GetAudiencesResults$inboundSchema` instead. */
const inboundSchema: z.ZodType<GetAudiencesResults, z.ZodTypeDef, unknown>;
/** @deprecated use `GetAudiencesResults$outboundSchema` instead. */
const outboundSchema: z.ZodType<GetAudiencesResults$Outbound, z.ZodTypeDef, GetAudiencesResults>;
/** @deprecated use `GetAudiencesResults$Outbound` instead. */
type Outbound = GetAudiencesResults$Outbound;
}
export declare function getAudiencesResultsToJSON(getAudiencesResults: GetAudiencesResults): string;
export declare function getAudiencesResultsFromJSON(jsonString: string): SafeParseResult<GetAudiencesResults, SDKValidationError>;
/** @internal */
export declare const GetAudiencesResponse$inboundSchema: z.ZodType<GetAudiencesResponse, z.ZodTypeDef, unknown>;
/** @internal */
export type GetAudiencesResponse$Outbound = {
success?: boolean | undefined;
results?: GetAudiencesResults$Outbound | undefined;
};
/** @internal */
export declare const GetAudiencesResponse$outboundSchema: z.ZodType<GetAudiencesResponse$Outbound, z.ZodTypeDef, GetAudiencesResponse>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace GetAudiencesResponse$ {
/** @deprecated use `GetAudiencesResponse$inboundSchema` instead. */
const inboundSchema: z.ZodType<GetAudiencesResponse, z.ZodTypeDef, unknown>;
/** @deprecated use `GetAudiencesResponse$outboundSchema` instead. */
const outboundSchema: z.ZodType<GetAudiencesResponse$Outbound, z.ZodTypeDef, GetAudiencesResponse>;
/** @deprecated use `GetAudiencesResponse$Outbound` instead. */
type Outbound = GetAudiencesResponse$Outbound;
}
export declare function getAudiencesResponseToJSON(getAudiencesResponse: GetAudiencesResponse): string;
export declare function getAudiencesResponseFromJSON(jsonString: string): SafeParseResult<GetAudiencesResponse, SDKValidationError>;
//# sourceMappingURL=getaudiences.d.ts.map