@resolution/confluence-api-client 0.7.12 → 0.11.0

package/lib/openapi/core/CommonHttpClient.d.ts

@@ -12,6 +12,10 @@ export interface CommonHttpClientOptions {
     errorClass: {
         new (url: URL, request: CommonHttpClientFetchRequest | undefined, response: CommonHttpClientFetchResponse | undefined, options: CommonHttpClientOptions | undefined, message: string): Error;
     };
+    /**
+     * Class name of the API client.
+     */
+    apiClientClassName: string;
     /**
      * Default headers to be sent with each request.
      */
@@ -31,7 +35,7 @@ export interface CommonHttpClientOptions {
     /**
      * Type of the response body for binary responses.
      */
-    binaryResponseType: "blob" | "readableStream";
+    binaryResponseType: 'blob' | 'readableStream';
     /**
      * Format the HTTP error message.
      */
@@ -40,6 +44,26 @@ export interface CommonHttpClientOptions {
      * Custom validation error handling. Can be used to log errors.
      */
     handleValidationError?: (error: Error) => void;
+    /**
+     * Deprecated operations. Used to warn about deprecated operations.
+     */
+    deprecatedOperations?: {
+        [methodAndPath: string]: string;
+    };
+    /**
+     * Log a deprecation warning.
+     */
+    logDeprecationWarning?(params: {
+        /**
+         * Either operation method name in case if it's not part of the service, or service name and operation method
+         * name separated by a dot.
+         *
+         * Examples: `users.getUserById`, `getSystemConfig`
+         */
+        operationName: string;
+        path: string;
+        method: CommonHttpClientFetchRequest['method'];
+    }): void;
 }
 /**
  * Request headers as used by the fetch function.
@@ -60,7 +84,7 @@ export interface CommonHttpClientFetchRequest {
     /**
      * HTTP Method.
      */
-    method: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "PATCH";
+    method: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'PATCH';
     /**
      * Request headers.
      */
@@ -72,15 +96,15 @@ export interface CommonHttpClientFetchRequest {
     /**
      * Cache mode.
      */
-    cache: "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload";
+    cache: 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload';
     /**
      * Credentials mode.
      */
-    credentials: "include" | "omit" | "same-origin";
+    credentials: 'include' | 'omit' | 'same-origin';
     /**
      * Redirect mode.
      */
-    redirect: "error" | "follow" | "manual";
+    redirect: 'error' | 'follow' | 'manual';
     /**
      * Custom request properties. Can be used to pass metadata to the fetch function.
      */
@@ -89,7 +113,7 @@ export interface CommonHttpClientFetchRequest {
 /**
  * Parameter serialization style.
  */
-export type CommonHttpClientRequestParameterSerializeStyle = "simple" | "label" | "matrix" | "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+export type CommonHttpClientRequestParameterSerializeStyle = 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
 /**
  * Information about how to serialize a request parameter.
  */
@@ -106,7 +130,7 @@ export interface CommonHttpClientRequestParameterSerializeInfo {
 /**
  * Request parameter location.
  */
-export type CommonHttpClientRequestParameterLocation = "path" | "query" | "header" | "cookie";
+export type CommonHttpClientRequestParameterLocation = 'path' | 'query' | 'header' | 'cookie';
 /**
  * Request parameters.
  */
@@ -116,7 +140,7 @@ export type CommonHttpClientRequestParameters = {
 /**
  * Request in terms of OpenAPI.
  */
-export type CommonHttpClientRequest = Omit<CommonHttpClientFetchRequest, "body" | "headers" | "cache" | "credentials" | "redirect"> & {
+export type CommonHttpClientRequest = Omit<CommonHttpClientFetchRequest, 'body' | 'headers' | 'cache' | 'credentials' | 'redirect'> & {
     /**
      * Path to the resource.
      */
@@ -141,7 +165,7 @@ export type CommonHttpClientRequest = Omit<CommonHttpClientFetchRequest, "body"
      * Request parameters serialization information.
      */
     parameters?: CommonHttpClientRequestParameters;
-} & Partial<Pick<CommonHttpClientFetchRequest, "cache" | "credentials" | "redirect">>;
+} & Partial<Pick<CommonHttpClientFetchRequest, 'cache' | 'credentials' | 'redirect'>>;
 /**
  * Response of the fetch function.
  */
@@ -176,16 +200,16 @@ export interface CommonHttpClientFetchResponse {
     customRequestProps?: Record<string, unknown>;
 }
 export type CommonHttpClientResponseHeaders = Record<string, string> & {
-    "set-cookie"?: string[];
+    'set-cookie'?: string[];
 };
 export type CommonHttpClientFetchResponseBody = {
-    type: "json";
+    type: 'json';
     data: unknown;
 } | {
-    type: "blob";
+    type: 'blob';
     data: Blob;
 } | {
-    type: "readableStream";
+    type: 'readableStream';
     data: ReadableStream<Uint8Array>;
 };
 export interface CommonHttpClientResponse<T> {
@@ -218,18 +242,18 @@ type ResponseByMediaType<T extends CommonHttpClientResponse<unknown>, K extends
     body: infer _Body;
     response: CommonHttpClientFetchResponse;
 }) => void ? T : never : never;
-export declare function checkReponseMediaType<T extends CommonHttpClientResponse<unknown>, K extends string>(response: T, mediaType: K): response is ResponseByMediaType<T, K> extends never ? ResponseByMediaType<T, "*/*"> : ResponseByMediaType<T, K>;
+export declare function checkReponseMediaType<T extends CommonHttpClientResponse<unknown>, K extends string>(response: T, mediaType: K): response is ResponseByMediaType<T, K> extends never ? ResponseByMediaType<T, '*/*'> : ResponseByMediaType<T, K>;
 export declare function isJsonMediaType(mediaType: string): boolean;
 type AsCreatedResponseFunction<KCreated extends string, KOther extends string> = <T extends CommonHttpClientResponse<unknown>>(response: T) => ({
     [K in KCreated]: Extract<T, {
         status: 201;
-    }>["body"];
+    }>['body'];
 } & {
     created: true;
 }) | ({
     [K in KOther]: Extract<T, {
         status: 200;
-    }>["body"];
+    }>['body'];
 } & {
     created: false;
 });
@@ -258,6 +282,11 @@ export declare class CommonHttpClient {
     setOptions(options: CommonHttpClientOptions): void;
     /** Get the current configuration. */
     getOptions(): CommonHttpClientOptions;
+    /** Logs a deprecation warning if the operation is deprecated. */
+    protected logDeprecationWarningIfNecessary(params: {
+        path: string;
+        method: CommonHttpClientFetchRequest['method'];
+    }): void;
     /** Turns an object with query params into a URLSearchParams object. */
     protected getSearchParams(params: Record<string, unknown>, parameters: Record<string, CommonHttpClientRequestParameterSerializeInfo>): URLSearchParams;
     /** Build the URL path from the request by applying path params. */
@@ -271,7 +300,7 @@ export declare class CommonHttpClient {
     /** Post-process the response. */
     responseHandler(distribution: {
         [statusCode: string]: {
-            [mediaType: string]: CommonHttpClientFetchResponseBody["type"];
+            [mediaType: string]: CommonHttpClientFetchResponseBody['type'];
         };
     }): (response: CommonHttpClientFetchResponse) => Promise<CommonHttpClientResponse<unknown>>;
     validation<D>(validator: (data: D) => D): (data: D) => D;