/*
* 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 AccountingCreditNotesAllGlobals = {
/**
* 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 AccountingCreditNotesAllRequest = {
/**
* 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;
/**
* Apply filters
*/
filter?: components.CreditNotesFilter | undefined;
/**
* Apply sorting
*/
sort?: components.CreditNotesSort | 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 AccountingCreditNotesAllResponse = {
httpMeta: components.HTTPMetadata;
/**
* Credit Notes
*/
getCreditNotesResponse?: components.GetCreditNotesResponse | undefined;
/**
* Unexpected error
*/
unexpectedErrorResponse?: components.UnexpectedErrorResponse | undefined;
};
/** @internal */
export const AccountingCreditNotesAllGlobals$inboundSchema: z.ZodType<
AccountingCreditNotesAllGlobals,
z.ZodTypeDef,
unknown
> = z.object({
consumerId: z.string().optional(),
appId: z.string().optional(),
});
/** @internal */
export type AccountingCreditNotesAllGlobals$Outbound = {
consumerId?: string | undefined;
appId?: string | undefined;
};
/** @internal */
export const AccountingCreditNotesAllGlobals$outboundSchema: z.ZodType<
AccountingCreditNotesAllGlobals$Outbound,
z.ZodTypeDef,
AccountingCreditNotesAllGlobals
> = 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 AccountingCreditNotesAllGlobals$ {
/** @deprecated use `AccountingCreditNotesAllGlobals$inboundSchema` instead. */
export const inboundSchema = AccountingCreditNotesAllGlobals$inboundSchema;
/** @deprecated use `AccountingCreditNotesAllGlobals$outboundSchema` instead. */
export const outboundSchema = AccountingCreditNotesAllGlobals$outboundSchema;
/** @deprecated use `AccountingCreditNotesAllGlobals$Outbound` instead. */
export type Outbound = AccountingCreditNotesAllGlobals$Outbound;
}
export function accountingCreditNotesAllGlobalsToJSON(
accountingCreditNotesAllGlobals: AccountingCreditNotesAllGlobals,
): string {
return JSON.stringify(
AccountingCreditNotesAllGlobals$outboundSchema.parse(
accountingCreditNotesAllGlobals,
),
);
}
export function accountingCreditNotesAllGlobalsFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => AccountingCreditNotesAllGlobals$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'AccountingCreditNotesAllGlobals' from JSON`,
);
}
/** @internal */
export const AccountingCreditNotesAllRequest$inboundSchema: z.ZodType<
AccountingCreditNotesAllRequest,
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),
filter: components.CreditNotesFilter$inboundSchema.optional(),
sort: components.CreditNotesSort$inboundSchema.optional(),
pass_through: z.record(z.any()).optional(),
fields: z.nullable(z.string()).optional(),
}).transform((v) => {
return remap$(v, {
"pass_through": "passThrough",
});
});
/** @internal */
export type AccountingCreditNotesAllRequest$Outbound = {
raw: boolean;
serviceId?: string | undefined;
cursor?: string | null | undefined;
limit: number;
filter?: components.CreditNotesFilter$Outbound | undefined;
sort?: components.CreditNotesSort$Outbound | undefined;
pass_through?: { [k: string]: any } | undefined;
fields?: string | null | undefined;
};
/** @internal */
export const AccountingCreditNotesAllRequest$outboundSchema: z.ZodType<
AccountingCreditNotesAllRequest$Outbound,
z.ZodTypeDef,
AccountingCreditNotesAllRequest
> = z.object({
raw: z.boolean().default(false),
serviceId: z.string().optional(),
cursor: z.nullable(z.string()).optional(),
limit: z.number().int().default(20),
filter: components.CreditNotesFilter$outboundSchema.optional(),
sort: components.CreditNotesSort$outboundSchema.optional(),
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 AccountingCreditNotesAllRequest$ {
/** @deprecated use `AccountingCreditNotesAllRequest$inboundSchema` instead. */
export const inboundSchema = AccountingCreditNotesAllRequest$inboundSchema;
/** @deprecated use `AccountingCreditNotesAllRequest$outboundSchema` instead. */
export const outboundSchema = AccountingCreditNotesAllRequest$outboundSchema;
/** @deprecated use `AccountingCreditNotesAllRequest$Outbound` instead. */
export type Outbound = AccountingCreditNotesAllRequest$Outbound;
}
export function accountingCreditNotesAllRequestToJSON(
accountingCreditNotesAllRequest: AccountingCreditNotesAllRequest,
): string {
return JSON.stringify(
AccountingCreditNotesAllRequest$outboundSchema.parse(
accountingCreditNotesAllRequest,
),
);
}
export function accountingCreditNotesAllRequestFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => AccountingCreditNotesAllRequest$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'AccountingCreditNotesAllRequest' from JSON`,
);
}
/** @internal */
export const AccountingCreditNotesAllResponse$inboundSchema: z.ZodType<
AccountingCreditNotesAllResponse,
z.ZodTypeDef,
unknown
> = z.object({
HttpMeta: components.HTTPMetadata$inboundSchema,
GetCreditNotesResponse: components.GetCreditNotesResponse$inboundSchema
.optional(),
UnexpectedErrorResponse: components.UnexpectedErrorResponse$inboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
"HttpMeta": "httpMeta",
"GetCreditNotesResponse": "getCreditNotesResponse",
"UnexpectedErrorResponse": "unexpectedErrorResponse",
});
});
/** @internal */
export type AccountingCreditNotesAllResponse$Outbound = {
HttpMeta: components.HTTPMetadata$Outbound;
GetCreditNotesResponse?:
| components.GetCreditNotesResponse$Outbound
| undefined;
UnexpectedErrorResponse?:
| components.UnexpectedErrorResponse$Outbound
| undefined;
};
/** @internal */
export const AccountingCreditNotesAllResponse$outboundSchema: z.ZodType<
AccountingCreditNotesAllResponse$Outbound,
z.ZodTypeDef,
AccountingCreditNotesAllResponse
> = z.object({
httpMeta: components.HTTPMetadata$outboundSchema,
getCreditNotesResponse: components.GetCreditNotesResponse$outboundSchema
.optional(),
unexpectedErrorResponse: components.UnexpectedErrorResponse$outboundSchema
.optional(),
}).transform((v) => {
return remap$(v, {
httpMeta: "HttpMeta",
getCreditNotesResponse: "GetCreditNotesResponse",
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 AccountingCreditNotesAllResponse$ {
/** @deprecated use `AccountingCreditNotesAllResponse$inboundSchema` instead. */
export const inboundSchema = AccountingCreditNotesAllResponse$inboundSchema;
/** @deprecated use `AccountingCreditNotesAllResponse$outboundSchema` instead. */
export const outboundSchema = AccountingCreditNotesAllResponse$outboundSchema;
/** @deprecated use `AccountingCreditNotesAllResponse$Outbound` instead. */
export type Outbound = AccountingCreditNotesAllResponse$Outbound;
}
export function accountingCreditNotesAllResponseToJSON(
accountingCreditNotesAllResponse: AccountingCreditNotesAllResponse,
): string {
return JSON.stringify(
AccountingCreditNotesAllResponse$outboundSchema.parse(
accountingCreditNotesAllResponse,
),
);
}
export function accountingCreditNotesAllResponseFromJSON(
jsonString: string,
): SafeParseResult {
return safeParse(
jsonString,
(x) => AccountingCreditNotesAllResponse$inboundSchema.parse(JSON.parse(x)),
`Failed to parse 'AccountingCreditNotesAllResponse' from JSON`,
);
}