/*
* 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 EcommerceOrdersOneGlobals = {
/**
* 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 EcommerceOrdersOneRequest = {
/**
* ID of the record you are acting upon.
*/
id: string;
/**
* 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;
/**
* Include raw response. Mostly used for debugging purposes
*/
raw?: boolean | 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 EcommerceOrdersOneResponse = {
httpMeta: components.HTTPMetadata;
/**
* Orders
*/
getEcommerceOrderResponse?: components.GetEcommerceOrderResponse | undefined;
/**
* Unexpected error
*/
unexpectedErrorResponse?: components.UnexpectedErrorResponse | undefined;
};
/** @internal */
export const EcommerceOrdersOneGlobals$inboundSchema: z.ZodType<
EcommerceOrdersOneGlobals,
z.ZodTypeDef,
unknown
> = z.object({
consumerId: z.string().optional(),
appId: z.string().optional(),
});
/** @internal */
export type EcommerceOrdersOneGlobals$Outbound = {
consumerId?: string | undefined;
appId?: string | undefined;
};
/** @internal */
export const EcommerceOrdersOneGlobals$outboundSchema: z.ZodType<
EcommerceOrdersOneGlobals$Outbound,
z.ZodTypeDef,
EcommerceOrdersOneGlobals
> = 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 EcommerceOrdersOneGlobals$ {
/** @deprecated use `EcommerceOrdersOneGlobals$inboundSchema` instead. */
export const inboundSchema = EcommerceOrdersOneGlobals$inboundSchema;
/** @deprecated use `EcommerceOrdersOneGlobals$outboundSchema` instead. */
export const outboundSchema = EcommerceOrdersOneGlobals$outboundSchema;
/** @deprecated use `EcommerceOrdersOneGlobals$Outbound` instead. */
export type Outbound = EcommerceOrdersOneGlobals$Outbound;
}
export function ecommerceOrdersOneGlobalsToJSON(
ecommerceOrdersOneGlobals: EcommerceOrdersOneGlobals,
): string {
return JSON.stringify(
EcommerceOrdersOneGlobals$outboundSchema.parse(ecommerceOrdersOneGlobals),
);
}
export function ecommerceOrdersOneGlobalsFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => EcommerceOrdersOneGlobals$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'EcommerceOrdersOneGlobals' from JSON`,
);
}
/** @internal */
export const EcommerceOrdersOneRequest$inboundSchema: z.ZodType<
EcommerceOrdersOneRequest,
z.ZodTypeDef,
unknown
> = z.object({
id: z.string(),
serviceId: z.string().optional(),
raw: z.boolean().default(false),
fields: z.nullable(z.string()).optional(),
});
/** @internal */
export type EcommerceOrdersOneRequest$Outbound = {
id: string;
serviceId?: string | undefined;
raw: boolean;
fields?: string | null | undefined;
};
/** @internal */
export const EcommerceOrdersOneRequest$outboundSchema: z.ZodType<
EcommerceOrdersOneRequest$Outbound,
z.ZodTypeDef,
EcommerceOrdersOneRequest
> = z.object({
id: z.string(),
serviceId: z.string().optional(),
raw: z.boolean().default(false),
fields: z.nullable(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 EcommerceOrdersOneRequest$ {
/** @deprecated use `EcommerceOrdersOneRequest$inboundSchema` instead. */
export const inboundSchema = EcommerceOrdersOneRequest$inboundSchema;
/** @deprecated use `EcommerceOrdersOneRequest$outboundSchema` instead. */
export const outboundSchema = EcommerceOrdersOneRequest$outboundSchema;
/** @deprecated use `EcommerceOrdersOneRequest$Outbound` instead. */
export type Outbound = EcommerceOrdersOneRequest$Outbound;
}
export function ecommerceOrdersOneRequestToJSON(
ecommerceOrdersOneRequest: EcommerceOrdersOneRequest,
): string {
return JSON.stringify(
EcommerceOrdersOneRequest$outboundSchema.parse(ecommerceOrdersOneRequest),
);
}
export function ecommerceOrdersOneRequestFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => EcommerceOrdersOneRequest$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'EcommerceOrdersOneRequest' from JSON`,
);
}
/** @internal */
export const EcommerceOrdersOneResponse$inboundSchema: z.ZodType<
EcommerceOrdersOneResponse,
z.ZodTypeDef,
unknown
> = z.object({
HttpMeta: components.HTTPMetadata$inboundSchema,
GetEcommerceOrderResponse: components.GetEcommerceOrderResponse$inboundSchema
.optional(),
UnexpectedErrorResponse: components.UnexpectedErrorResponse$inboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
"HttpMeta": "httpMeta",
"GetEcommerceOrderResponse": "getEcommerceOrderResponse",
"UnexpectedErrorResponse": "unexpectedErrorResponse",
});
});
/** @internal */
export type EcommerceOrdersOneResponse$Outbound = {
HttpMeta: components.HTTPMetadata$Outbound;
GetEcommerceOrderResponse?:
| components.GetEcommerceOrderResponse$Outbound
| undefined;
UnexpectedErrorResponse?:
| components.UnexpectedErrorResponse$Outbound
| undefined;
};
/** @internal */
export const EcommerceOrdersOneResponse$outboundSchema: z.ZodType<
EcommerceOrdersOneResponse$Outbound,
z.ZodTypeDef,
EcommerceOrdersOneResponse
> = z.object({
httpMeta: components.HTTPMetadata$outboundSchema,
getEcommerceOrderResponse: components.GetEcommerceOrderResponse$outboundSchema
.optional(),
unexpectedErrorResponse: components.UnexpectedErrorResponse$outboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
httpMeta: "HttpMeta",
getEcommerceOrderResponse: "GetEcommerceOrderResponse",
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 EcommerceOrdersOneResponse$ {
/** @deprecated use `EcommerceOrdersOneResponse$inboundSchema` instead. */
export const inboundSchema = EcommerceOrdersOneResponse$inboundSchema;
/** @deprecated use `EcommerceOrdersOneResponse$outboundSchema` instead. */
export const outboundSchema = EcommerceOrdersOneResponse$outboundSchema;
/** @deprecated use `EcommerceOrdersOneResponse$Outbound` instead. */
export type Outbound = EcommerceOrdersOneResponse$Outbound;
}
export function ecommerceOrdersOneResponseToJSON(
ecommerceOrdersOneResponse: EcommerceOrdersOneResponse,
): string {
return JSON.stringify(
EcommerceOrdersOneResponse$outboundSchema.parse(ecommerceOrdersOneResponse),
);
}
export function ecommerceOrdersOneResponseFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => EcommerceOrdersOneResponse$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'EcommerceOrdersOneResponse' from JSON`,
);
}