/*
* 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 EcommerceProductsAllGlobals = {
/**
* 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 EcommerceProductsAllRequest = {
/**
* 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 EcommerceProductsAllResponse = {
httpMeta: components.HTTPMetadata;
/**
* Products
*/
getProductsResponse?: components.GetProductsResponse | undefined;
/**
* Unexpected error
*/
unexpectedErrorResponse?: components.UnexpectedErrorResponse | undefined;
};
/** @internal */
export const EcommerceProductsAllGlobals$inboundSchema: z.ZodType<
EcommerceProductsAllGlobals,
z.ZodTypeDef,
unknown
> = z.object({
consumerId: z.string().optional(),
appId: z.string().optional(),
});
/** @internal */
export type EcommerceProductsAllGlobals$Outbound = {
consumerId?: string | undefined;
appId?: string | undefined;
};
/** @internal */
export const EcommerceProductsAllGlobals$outboundSchema: z.ZodType<
EcommerceProductsAllGlobals$Outbound,
z.ZodTypeDef,
EcommerceProductsAllGlobals
> = 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 EcommerceProductsAllGlobals$ {
/** @deprecated use `EcommerceProductsAllGlobals$inboundSchema` instead. */
export const inboundSchema = EcommerceProductsAllGlobals$inboundSchema;
/** @deprecated use `EcommerceProductsAllGlobals$outboundSchema` instead. */
export const outboundSchema = EcommerceProductsAllGlobals$outboundSchema;
/** @deprecated use `EcommerceProductsAllGlobals$Outbound` instead. */
export type Outbound = EcommerceProductsAllGlobals$Outbound;
}
export function ecommerceProductsAllGlobalsToJSON(
ecommerceProductsAllGlobals: EcommerceProductsAllGlobals,
): string {
return JSON.stringify(
EcommerceProductsAllGlobals$outboundSchema.parse(
ecommerceProductsAllGlobals,
),
);
}
export function ecommerceProductsAllGlobalsFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => EcommerceProductsAllGlobals$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'EcommerceProductsAllGlobals' from JSON`,
);
}
/** @internal */
export const EcommerceProductsAllRequest$inboundSchema: z.ZodType<
EcommerceProductsAllRequest,
z.ZodTypeDef,
unknown
> = z.object({
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, {
"pass_through": "passThrough",
});
});
/** @internal */
export type EcommerceProductsAllRequest$Outbound = {
raw: boolean;
serviceId?: string | undefined;
cursor?: string | null | undefined;
limit: number;
pass_through?: { [k: string]: any } | undefined;
fields?: string | null | undefined;
};
/** @internal */
export const EcommerceProductsAllRequest$outboundSchema: z.ZodType<
EcommerceProductsAllRequest$Outbound,
z.ZodTypeDef,
EcommerceProductsAllRequest
> = z.object({
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, {
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 EcommerceProductsAllRequest$ {
/** @deprecated use `EcommerceProductsAllRequest$inboundSchema` instead. */
export const inboundSchema = EcommerceProductsAllRequest$inboundSchema;
/** @deprecated use `EcommerceProductsAllRequest$outboundSchema` instead. */
export const outboundSchema = EcommerceProductsAllRequest$outboundSchema;
/** @deprecated use `EcommerceProductsAllRequest$Outbound` instead. */
export type Outbound = EcommerceProductsAllRequest$Outbound;
}
export function ecommerceProductsAllRequestToJSON(
ecommerceProductsAllRequest: EcommerceProductsAllRequest,
): string {
return JSON.stringify(
EcommerceProductsAllRequest$outboundSchema.parse(
ecommerceProductsAllRequest,
),
);
}
export function ecommerceProductsAllRequestFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => EcommerceProductsAllRequest$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'EcommerceProductsAllRequest' from JSON`,
);
}
/** @internal */
export const EcommerceProductsAllResponse$inboundSchema: z.ZodType<
EcommerceProductsAllResponse,
z.ZodTypeDef,
unknown
> = z.object({
HttpMeta: components.HTTPMetadata$inboundSchema,
GetProductsResponse: components.GetProductsResponse$inboundSchema.optional(),
UnexpectedErrorResponse: components.UnexpectedErrorResponse$inboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
"HttpMeta": "httpMeta",
"GetProductsResponse": "getProductsResponse",
"UnexpectedErrorResponse": "unexpectedErrorResponse",
});
});
/** @internal */
export type EcommerceProductsAllResponse$Outbound = {
HttpMeta: components.HTTPMetadata$Outbound;
GetProductsResponse?: components.GetProductsResponse$Outbound | undefined;
UnexpectedErrorResponse?:
| components.UnexpectedErrorResponse$Outbound
| undefined;
};
/** @internal */
export const EcommerceProductsAllResponse$outboundSchema: z.ZodType<
EcommerceProductsAllResponse$Outbound,
z.ZodTypeDef,
EcommerceProductsAllResponse
> = z.object({
httpMeta: components.HTTPMetadata$outboundSchema,
getProductsResponse: components.GetProductsResponse$outboundSchema.optional(),
unexpectedErrorResponse: components.UnexpectedErrorResponse$outboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
httpMeta: "HttpMeta",
getProductsResponse: "GetProductsResponse",
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 EcommerceProductsAllResponse$ {
/** @deprecated use `EcommerceProductsAllResponse$inboundSchema` instead. */
export const inboundSchema = EcommerceProductsAllResponse$inboundSchema;
/** @deprecated use `EcommerceProductsAllResponse$outboundSchema` instead. */
export const outboundSchema = EcommerceProductsAllResponse$outboundSchema;
/** @deprecated use `EcommerceProductsAllResponse$Outbound` instead. */
export type Outbound = EcommerceProductsAllResponse$Outbound;
}
export function ecommerceProductsAllResponseToJSON(
ecommerceProductsAllResponse: EcommerceProductsAllResponse,
): string {
return JSON.stringify(
EcommerceProductsAllResponse$outboundSchema.parse(
ecommerceProductsAllResponse,
),
);
}
export function ecommerceProductsAllResponseFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => EcommerceProductsAllResponse$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'EcommerceProductsAllResponse' from JSON`,
);
}