import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This * * @remarks * values is ignored if `cursor[before]` or `cursor[after]` are set. */ export declare const GetMediaExtendedAudioDescriptionsEnabled: { readonly Zero: 0; readonly One: 1; }; /** * If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This * * @remarks * values is ignored if `cursor[before]` or `cursor[after]` are set. */ export type GetMediaExtendedAudioDescriptionsEnabled = ClosedEnum; /** * If `cursor[enabled]` is set to 1 than cursor pagination is enabled and the * * @remarks * first set of records are fetched up to the `per_page`. Cursor * pagination will also be turned on if `cursor[before]` or `cursor[after]` * are set. Records returned will have a `cursor` property set which can be used to fetch more records in the same `sort_by` ordering. * The cursor value of the last record can be used to fetch records after the current result set and * the cursor of the first record can be used to fetch records before the result set. * * NOTE: a cursor value is only valid if the `sort_by` value hasn't changed from the * last fetch. For example, you cannot fetch using `sort_by` id and than pass that * cursor value to a `sort_by` name. */ export type GetMediaExtendedAudioDescriptionsCursor = { /** * If `cursor[enabled]` is set to 1, the first result set will be fetched with cursor pagination enabled. This * * @remarks * values is ignored if `cursor[before]` or `cursor[after]` are set. */ enabled?: GetMediaExtendedAudioDescriptionsEnabled | undefined; /** * If `cursor[before]` is set than cursor pagination is enabled and all records * * @remarks * before the cursor up to the `per_page` are returned. This feature is useful for * fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending * order. */ before?: string | undefined; /** * If `cursor[after]` is set than cursor pagination is enabled and all records * * @remarks * after the cursor up to the `per_page` are returned. */ after?: string | undefined; }; /** * Field to order by. The default is id. */ export declare const GetMediaExtendedAudioDescriptionsSortBy: { readonly Id: "id"; }; /** * Field to order by. The default is id. */ export type GetMediaExtendedAudioDescriptionsSortBy = ClosedEnum; /** * Direction to order by. (0 = desc, 1 = asc; default is 1) */ export declare const GetMediaExtendedAudioDescriptionsSortDirection: { readonly Zero: 0; readonly One: 1; }; /** * Direction to order by. (0 = desc, 1 = asc; default is 1) */ export type GetMediaExtendedAudioDescriptionsSortDirection = ClosedEnum; export type GetMediaExtendedAudioDescriptionsRequest = { /** * The page number to retrieve. This cannot be combined with `cursor`, * * @remarks * pagination. */ page?: number | undefined; /** * The number of medias per page. Use this for both offset pagination and cursor pagination. */ perPage?: number | undefined; /** * If `cursor[enabled]` is set to 1 than cursor pagination is enabled and the * * @remarks * first set of records are fetched up to the `per_page`. Cursor * pagination will also be turned on if `cursor[before]` or `cursor[after]` * are set. Records returned will have a `cursor` property set which can be used to fetch more records in the same `sort_by` ordering. * The cursor value of the last record can be used to fetch records after the current result set and * the cursor of the first record can be used to fetch records before the result set. * * NOTE: a cursor value is only valid if the `sort_by` value hasn't changed from the * last fetch. For example, you cannot fetch using `sort_by` id and than pass that * cursor value to a `sort_by` name. */ cursor?: GetMediaExtendedAudioDescriptionsCursor | undefined; /** * Filter extended audio descriptions to only those matching these hashed ids. */ hashedIds?: Array | undefined; /** * Field to order by. The default is id. */ sortBy?: GetMediaExtendedAudioDescriptionsSortBy | undefined; /** * Direction to order by. (0 = desc, 1 = asc; default is 1) */ sortDirection?: GetMediaExtendedAudioDescriptionsSortDirection | undefined; }; export type GetMediaExtendedAudioDescriptionsMedia = { /** * A unique alphanumeric identifier for the record. */ id: string; /** * A URL for fetching all the records of the given record type. You can pass hashed_ids as a param with multiple values * * @remarks * to do a batch fetch for this records type. */ indexUrl: string; /** * A URL that can be used to fetch this record. */ url: string; }; export type GetMediaExtendedAudioDescriptionsProvidedMediaFile = { /** * A unique alphanumeric identifier for the record. */ id: string; /** * A URL for fetching all the records of the given record type. You can pass hashed_ids as a param with multiple values * * @remarks * to do a batch fetch for this records type. */ indexUrl: string; /** * A URL that can be used to fetch this record. */ url: string; }; export type GetMediaExtendedAudioDescriptionsContact = { /** * A unique alphanumeric identifier for the record. */ id: string; /** * A URL for fetching all the records of the given record type. You can pass hashed_ids as a param with multiple values * * @remarks * to do a batch fetch for this records type. */ indexUrl: string; /** * A URL that can be used to fetch this record. */ url: string; }; export type GetMediaExtendedAudioDescriptionsResponse = { id?: string | undefined; ietfLanguageTag?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; media?: GetMediaExtendedAudioDescriptionsMedia | undefined; providedMediaFile?: GetMediaExtendedAudioDescriptionsProvidedMediaFile | undefined; contact?: GetMediaExtendedAudioDescriptionsContact | undefined; }; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsEnabled$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetMediaExtendedAudioDescriptionsCursor$Outbound = { enabled?: number | undefined; before?: string | undefined; after?: string | undefined; }; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsCursor$outboundSchema: z.ZodType; export declare function getMediaExtendedAudioDescriptionsCursorToJSON(getMediaExtendedAudioDescriptionsCursor: GetMediaExtendedAudioDescriptionsCursor): string; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsSortBy$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsSortDirection$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetMediaExtendedAudioDescriptionsRequest$Outbound = { page?: number | undefined; per_page?: number | undefined; cursor?: GetMediaExtendedAudioDescriptionsCursor$Outbound | undefined; "hashed_ids[]"?: Array | undefined; sort_by?: string | undefined; sort_direction?: number | undefined; }; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsRequest$outboundSchema: z.ZodType; export declare function getMediaExtendedAudioDescriptionsRequestToJSON(getMediaExtendedAudioDescriptionsRequest: GetMediaExtendedAudioDescriptionsRequest): string; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsMedia$inboundSchema: z.ZodType; export declare function getMediaExtendedAudioDescriptionsMediaFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsProvidedMediaFile$inboundSchema: z.ZodType; export declare function getMediaExtendedAudioDescriptionsProvidedMediaFileFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsContact$inboundSchema: z.ZodType; export declare function getMediaExtendedAudioDescriptionsContactFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const GetMediaExtendedAudioDescriptionsResponse$inboundSchema: z.ZodType; export declare function getMediaExtendedAudioDescriptionsResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getmediaextendedaudiodescriptions.d.ts.map