/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod/v3";
import { remap as remap$ } from "../../../lib/primitives.js";
import { safeParse } from "../../../lib/schemas.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import * as shared from "../shared/index.js";

export type GetTagsGlobals = {
  /**
   * Indicates the client accepts the indicated media types
   */
  accepts?: shared.Accepts | undefined;
  /**
   * An opaque identifier unique to the client
   */
  clientIdentifier?: string | undefined;
  /**
   * The name of the client product
   */
  product?: string | undefined;
  /**
   * The version of the client application
   */
  version?: string | undefined;
  /**
   * The platform of the client
   */
  platform?: string | undefined;
  /**
   * The version of the platform
   */
  platformVersion?: string | undefined;
  /**
   * A relatively friendly name for the client device
   */
  device?: string | undefined;
  /**
   * A potentially less friendly identifier for the device model
   */
  model?: string | undefined;
  /**
   * The device vendor
   */
  deviceVendor?: string | undefined;
  /**
   * A friendly name for the client
   */
  deviceName?: string | undefined;
  /**
   * The marketplace on which the client application is distributed
   */
  marketplace?: string | undefined;
};

export type GetTagsRequest = {
  /**
   * Indicates the client accepts the indicated media types
   */
  accepts?: shared.Accepts | undefined;
  /**
   * An opaque identifier unique to the client
   */
  clientIdentifier?: string | undefined;
  /**
   * The name of the client product
   */
  product?: string | undefined;
  /**
   * The version of the client application
   */
  version?: string | undefined;
  /**
   * The platform of the client
   */
  platform?: string | undefined;
  /**
   * The version of the platform
   */
  platformVersion?: string | undefined;
  /**
   * A relatively friendly name for the client device
   */
  device?: string | undefined;
  /**
   * A potentially less friendly identifier for the device model
   */
  model?: string | undefined;
  /**
   * The device vendor
   */
  deviceVendor?: string | undefined;
  /**
   * A friendly name for the client
   */
  deviceName?: string | undefined;
  /**
   * The marketplace on which the client application is distributed
   */
  marketplace?: string | undefined;
  /**
   * The type of media to retrieve or filter by.
   *
   * @remarks
   *
   * 1 = movie
   * 2 = show
   * 3 = season
   * 4 = episode
   * 5 = artist
   * 6 = album
   * 7 = track
   * 8 = photo_album
   * 9 = photo
   *
   * E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
   */
  type?: shared.MediaType | undefined;
};

export type GetTagsDirectory = {
  /**
   * The filter string to view metadata wit this tag
   */
  filter?: string | undefined;
  id?: number | undefined;
  /**
   * The name of the tag
   */
  tag?: string | undefined;
  /**
   * The key of this tag.  This is a universal key across all PMS instances and plex.tv services
   */
  tagKey?: string | undefined;
  /**
   * The type of the tag
   */
  tagType?: number | undefined;
  /**
   * The URL to a thumbnail for this tag
   */
  thumb?: string | undefined;
};

/**
 * `MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
 *
 * @remarks
 * Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
 * The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
 */
export type GetTagsMediaContainer = {
  identifier?: string | undefined;
  /**
   * The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.
   *
   * @remarks
   */
  offset?: number | undefined;
  size?: number | undefined;
  /**
   * The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.
   *
   * @remarks
   */
  totalSize?: number | undefined;
  directory?: Array<GetTagsDirectory> | undefined;
};

/**
 * OK
 */
export type GetTagsResponseBody = {
  mediaContainer?: GetTagsMediaContainer | undefined;
};

export type GetTagsResponse = {
  /**
   * HTTP response content type for this operation
   */
  contentType: string;
  /**
   * HTTP response status code for this operation
   */
  statusCode: number;
  /**
   * Raw HTTP response; suitable for custom response parsing
   */
  rawResponse: Response;
  /**
   * OK
   */
  object?: GetTagsResponseBody | undefined;
};

/** @internal */
export type GetTagsRequest$Outbound = {
  accepts: string;
  "Client-Identifier"?: string | undefined;
  Product?: string | undefined;
  Version?: string | undefined;
  Platform?: string | undefined;
  "Platform-Version"?: string | undefined;
  Device?: string | undefined;
  Model?: string | undefined;
  "Device-Vendor"?: string | undefined;
  "Device-Name"?: string | undefined;
  Marketplace?: string | undefined;
  type?: number | undefined;
};

/** @internal */
export const GetTagsRequest$outboundSchema: z.ZodType<
  GetTagsRequest$Outbound,
  z.ZodTypeDef,
  GetTagsRequest
> = z.object({
  accepts: shared.Accepts$outboundSchema.default(shared.Accepts.ApplicationXml),
  clientIdentifier: z.string().optional(),
  product: z.string().optional(),
  version: z.string().optional(),
  platform: z.string().optional(),
  platformVersion: z.string().optional(),
  device: z.string().optional(),
  model: z.string().optional(),
  deviceVendor: z.string().optional(),
  deviceName: z.string().optional(),
  marketplace: z.string().optional(),
  type: shared.MediaType$outboundSchema.optional(),
}).transform((v) => {
  return remap$(v, {
    clientIdentifier: "Client-Identifier",
    product: "Product",
    version: "Version",
    platform: "Platform",
    platformVersion: "Platform-Version",
    device: "Device",
    model: "Model",
    deviceVendor: "Device-Vendor",
    deviceName: "Device-Name",
    marketplace: "Marketplace",
  });
});

export function getTagsRequestToJSON(getTagsRequest: GetTagsRequest): string {
  return JSON.stringify(GetTagsRequest$outboundSchema.parse(getTagsRequest));
}

/** @internal */
export const GetTagsDirectory$inboundSchema: z.ZodType<
  GetTagsDirectory,
  z.ZodTypeDef,
  unknown
> = z.object({
  filter: z.string().optional(),
  id: z.number().int().optional(),
  tag: z.string().optional(),
  tagKey: z.string().optional(),
  tagType: z.number().int().optional(),
  thumb: z.string().optional(),
});

export function getTagsDirectoryFromJSON(
  jsonString: string,
): SafeParseResult<GetTagsDirectory, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetTagsDirectory$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetTagsDirectory' from JSON`,
  );
}

/** @internal */
export const GetTagsMediaContainer$inboundSchema: z.ZodType<
  GetTagsMediaContainer,
  z.ZodTypeDef,
  unknown
> = z.object({
  identifier: z.string().optional(),
  offset: z.number().int().optional(),
  size: z.number().int().optional(),
  totalSize: z.number().int().optional(),
  Directory: z.array(z.lazy(() => GetTagsDirectory$inboundSchema)).optional(),
}).transform((v) => {
  return remap$(v, {
    "Directory": "directory",
  });
});

export function getTagsMediaContainerFromJSON(
  jsonString: string,
): SafeParseResult<GetTagsMediaContainer, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetTagsMediaContainer$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetTagsMediaContainer' from JSON`,
  );
}

/** @internal */
export const GetTagsResponseBody$inboundSchema: z.ZodType<
  GetTagsResponseBody,
  z.ZodTypeDef,
  unknown
> = z.object({
  MediaContainer: z.lazy(() => GetTagsMediaContainer$inboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    "MediaContainer": "mediaContainer",
  });
});

export function getTagsResponseBodyFromJSON(
  jsonString: string,
): SafeParseResult<GetTagsResponseBody, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetTagsResponseBody$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetTagsResponseBody' from JSON`,
  );
}

/** @internal */
export const GetTagsResponse$inboundSchema: z.ZodType<
  GetTagsResponse,
  z.ZodTypeDef,
  unknown
> = z.object({
  ContentType: z.string(),
  StatusCode: z.number().int(),
  RawResponse: z.instanceof(Response),
  object: z.lazy(() => GetTagsResponseBody$inboundSchema).optional(),
}).transform((v) => {
  return remap$(v, {
    "ContentType": "contentType",
    "StatusCode": "statusCode",
    "RawResponse": "rawResponse",
  });
});

export function getTagsResponseFromJSON(
  jsonString: string,
): SafeParseResult<GetTagsResponse, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => GetTagsResponse$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'GetTagsResponse' from JSON`,
  );
}
