Method patch

src/zodios.ts:368–384

* make a patch request to the api * @param path - the path to api endpoint * @param data - the data to send * @param config - the config to setup axios options and parameters * @returns response validated with zod schema provided in the api description

(
    path: Path,
    data: ReadonlyDeep<UndefinedIfNever<ZodiosBodyByPath<Api, "patch", Path>>>,
    ...[config]: RequiredKeys<TConfig> extends never
      ? [config?: ReadonlyDeep<TConfig>]
      : [config: ReadonlyDeep<TConfig>]
  )

   * @returns response validated with zod schema provided in the api description
   */
  async patch<
    Path extends ZodiosPathsByMethod<Api, "patch">,
    TConfig extends ZodiosRequestOptionsByPath<Api, "patch", Path>
  >(
    path: Path,
    data: ReadonlyDeep<UndefinedIfNever<ZodiosBodyByPath<Api, "patch", Path>>>,
    ...[config]: RequiredKeys<TConfig> extends never
      ? [config?: ReadonlyDeep<TConfig>]
      : [config: ReadonlyDeep<TConfig>]
  ): Promise<ZodiosResponseByPath<Api, "patch", Path>> {
    return this.request({
      ...config,
      method: "patch",
      url: path,
      data,
    } as any);
  }

  /**
   * make a delete request to the api