@resolution/jira-api-client 0.4.6 → 0.5.1

package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts

@@ -0,0 +1,46 @@
+import * as commonHttpClient from "./core/CommonHttpClient";
+import { CommonHttpService } from "./core/CommonHttpService";
+import type { I18nErrorMessage } from "./models/assets";
+import type { ErrorResponse } from "./models/common";
+import type { Form, FormAnswer } from "./models/request";
+import { AssetsService } from "./services/AssetsService";
+import { CustomerService } from "./services/CustomerService";
+import { InfoService } from "./services/InfoService";
+import { KnowledgebaseService } from "./services/KnowledgebaseService";
+import { OrganizationService } from "./services/OrganizationService";
+import { RequestService } from "./services/RequestService";
+import { RequesttypeService } from "./services/RequesttypeService";
+import { ServicedeskService } from "./services/ServicedeskService";
+export type BaseJiraServiceManagementApiClientOptions = Partial<commonHttpClient.CommonHttpClientOptions>;
+export declare class BaseJiraServiceManagementApiClientError extends commonHttpClient.CommonHttpClientError {
+    name: string;
+}
+/**
+ * Service Management Public REST API
+ *
+ * Public REST API for Jira Service Management
+ *
+ * @version 1001.0.0-SNAPSHOT-7a4eaa71561009e58ded1503889be69ca87a407d
+ */
+export declare class BaseJiraServiceManagementApiClient extends CommonHttpService {
+    client: commonHttpClient.CommonHttpClient;
+    getClient: () => commonHttpClient.CommonHttpClient;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-assets */
+    get assets(): AssetsService;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-customer */
+    get customer(): CustomerService;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-info */
+    get info(): InfoService;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-knowledgebase */
+    get knowledgebase(): KnowledgebaseService;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-organization */
+    get organization(): OrganizationService;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request */
+    get request(): RequestService;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-requesttype */
+    get requesttype(): RequesttypeService;
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk */
+    get servicedesk(): ServicedeskService;
+    constructor(options?: BaseJiraServiceManagementApiClientOptions);
+}
+export type { Form, FormAnswer, I18nErrorMessage, ErrorResponse };

package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseJiraServiceManagementApiClient = exports.BaseJiraServiceManagementApiClientError = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const commonHttpClient = require("./core/CommonHttpClient");
+const CommonHttpService_1 = require("./core/CommonHttpService");
+const AssetsService_1 = require("./services/AssetsService");
+const CustomerService_1 = require("./services/CustomerService");
+const InfoService_1 = require("./services/InfoService");
+const KnowledgebaseService_1 = require("./services/KnowledgebaseService");
+const OrganizationService_1 = require("./services/OrganizationService");
+const RequestService_1 = require("./services/RequestService");
+const RequesttypeService_1 = require("./services/RequesttypeService");
+const ServicedeskService_1 = require("./services/ServicedeskService");
+const validationSchemaStorage_1 = require("./validationSchemaStorage");
+class BaseJiraServiceManagementApiClientError extends commonHttpClient.CommonHttpClientError {
+    constructor() {
+        super(...arguments);
+        this.name = "BaseJiraServiceManagementApiClientError";
+    }
+}
+exports.BaseJiraServiceManagementApiClientError = BaseJiraServiceManagementApiClientError;
+/**
+ * Service Management Public REST API
+ *
+ * Public REST API for Jira Service Management
+ *
+ * @version 1001.0.0-SNAPSHOT-7a4eaa71561009e58ded1503889be69ca87a407d
+ */
+class BaseJiraServiceManagementApiClient extends CommonHttpService_1.CommonHttpService {
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-assets */
+    get assets() {
+        return this.getServiceInstance(AssetsService_1.AssetsService);
+    }
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-customer */
+    get customer() {
+        return this.getServiceInstance(CustomerService_1.CustomerService);
+    }
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-info */
+    get info() {
+        return this.getServiceInstance(InfoService_1.InfoService);
+    }
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-knowledgebase */
+    get knowledgebase() {
+        return this.getServiceInstance(KnowledgebaseService_1.KnowledgebaseService);
+    }
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-organization */
+    get organization() {
+        return this.getServiceInstance(OrganizationService_1.OrganizationService);
+    }
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request */
+    get request() {
+        return this.getServiceInstance(RequestService_1.RequestService);
+    }
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-requesttype */
+    get requesttype() {
+        return this.getServiceInstance(RequesttypeService_1.RequesttypeService);
+    }
+    /** @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk */
+    get servicedesk() {
+        return this.getServiceInstance(ServicedeskService_1.ServicedeskService);
+    }
+    constructor(options) {
+        super(() => this.client);
+        this.client = new commonHttpClient.CommonHttpClient({
+            baseUrl: "https://your-domain.atlassian.net",
+            binaryResponseType: "blob",
+            errorClass: BaseJiraServiceManagementApiClientError,
+        });
+        this.getClient = () => this.client;
+        this.client.setOptions(Object.assign(Object.assign({}, this.client.getOptions()), options));
+    }
+}
+exports.BaseJiraServiceManagementApiClient = BaseJiraServiceManagementApiClient;
+validationSchemaStorage_1.validationSchemaStorage.setErrorClass(BaseJiraServiceManagementApiClientError);
+//# sourceMappingURL=BaseJiraServiceManagementApiClient.js.map

package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseJiraServiceManagementApiClient.js","sourceRoot":"","sources":["../../../src/openapi/serviceManagement/BaseJiraServiceManagementApiClient.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,4DAA4D;AAC5D,gEAA6D;AAI7D,4DAAyD;AACzD,gEAA6D;AAC7D,wDAAqD;AACrD,0EAAuE;AACvE,wEAAqE;AACrE,8DAA2D;AAC3D,sEAAmE;AACnE,sEAAmE;AACnE,uEAAoE;AAGpE,MAAa,uCAAwC,SAAQ,gBAAgB,CAAC,qBAAqB;IAAnG;;QACE,SAAI,GAAG,yCAAyC,CAAC;IACnD,CAAC;CAAA;AAFD,0FAEC;AACD;;;;;;GAMG;AACH,MAAa,kCAAmC,SAAQ,qCAAiB;IAOvE,yFAAyF;IACzF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,kBAAkB,CAAC,6BAAa,CAAC,CAAC;IAChD,CAAC;IACD,2FAA2F;IAC3F,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD,uFAAuF;IACvF,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,kBAAkB,CAAC,yBAAW,CAAC,CAAC;IAC9C,CAAC;IACD,gGAAgG;IAChG,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,2CAAoB,CAAC,CAAC;IACvD,CAAC;IACD,+FAA+F;IAC/F,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,kBAAkB,CAAC,yCAAmB,CAAC,CAAC;IACtD,CAAC;IACD,0FAA0F;IAC1F,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,kBAAkB,CAAC,+BAAc,CAAC,CAAC;IACjD,CAAC;IACD,8FAA8F;IAC9F,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,kBAAkB,CAAC,uCAAkB,CAAC,CAAC;IACrD,CAAC;IACD,8FAA8F;IAC9F,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,kBAAkB,CAAC,uCAAkB,CAAC,CAAC;IACrD,CAAC;IACD,YAAY,OAAmD;QAC7D,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAvC3B,WAAM,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YAC7C,OAAO,EAAE,mCAAmC;YAC5C,kBAAkB,EAAE,MAAM;YAC1B,UAAU,EAAE,uCAAuC;SACpD,CAAC,CAAC;QACH,cAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAmC5B,IAAI,CAAC,MAAM,CAAC,UAAU,iCACjB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GACxB,OAAO,EACV,CAAC;IACL,CAAC;CACF;AA9CD,gFA8CC;AACD,iDAAuB,CAAC,aAAa,CAAC,uCAAuC,CAAC,CAAC"}

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

@@ -0,0 +1,196 @@
+export interface CommonHttpClientOptions {
+    baseUrl: string;
+    errorClass: {
+        new (url: URL, request: CommonHttpClientFetchRequest | undefined, response: CommonHttpClientFetchResponse | undefined, options: CommonHttpClientOptions | undefined, message: string): Error;
+    };
+    headers?: CommonHttpClientRequestHeaders;
+    preprocessRequest?: (request: CommonHttpClientRequest) => Promise<CommonHttpClientRequest>;
+    preprocessFetchResponse?: (response: CommonHttpClientFetchResponse, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
+    fetch?: (url: URL, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
+    binaryResponseType: "blob" | "readableStream";
+    formatHttpErrorMessage?: (response: CommonHttpClientFetchResponse, request: CommonHttpClientFetchRequest) => string;
+}
+export interface CommonHttpClientRequestHeaders {
+    [headerName: string]: string | undefined | null;
+}
+export interface CommonHttpClientFetchRequestHeaders {
+    [headerName: string]: string;
+}
+/**
+ * Request prepared for the fetch function.
+ */
+export interface CommonHttpClientFetchRequest {
+    /**
+     * HTTP Method.
+     */
+    method: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "PATCH";
+    /**
+     * Request headers.
+     */
+    headers: CommonHttpClientFetchRequestHeaders;
+    /**
+     * Request body.
+     */
+    body?: BodyInit;
+    /**
+     * Cache mode.
+     */
+    cache: "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload";
+    /**
+     * Credentials mode.
+     */
+    credentials: "include" | "omit" | "same-origin";
+    /**
+     * Redirect mode.
+     */
+    redirect: "error" | "follow" | "manual";
+    /**
+     * Custom request properties. Can be used to pass metadata to the fetch function.
+     */
+    customRequestProps?: Record<string, unknown>;
+}
+/**
+ * Request in terms of OpenAPI.
+ */
+export type CommonHttpClientRequest = Omit<CommonHttpClientFetchRequest, "body" | "headers" | "cache" | "credentials" | "redirect"> & {
+    /**
+     * Path to the resource.
+     */
+    path: string;
+    /**
+     * Path parameters, i.e. {id}.
+     */
+    pathParams?: Record<string, unknown>;
+    /**
+     * Query parameters.
+     */
+    query?: Record<string, unknown>;
+    /**
+     * Request body.
+     */
+    body?: unknown;
+    /**
+     * Request headers.
+     */
+    headers?: CommonHttpClientRequestHeaders;
+} & Partial<Pick<CommonHttpClientFetchRequest, "cache" | "credentials" | "redirect">>;
+/**
+ * Response of the fetch function.
+ */
+export interface CommonHttpClientFetchResponse {
+    /**
+     * HTTP status code.
+     */
+    status: number;
+    /**
+     * HTTP status code explanation.
+     */
+    statusText: string;
+    /**
+     * Response body.
+     */
+    body: CommonHttpClientFetchResponseBody;
+    /**
+     * Whether the request was successful. True for 2xx status codes.
+     */
+    ok: boolean;
+    /**
+     * The final URL of the request (after redirects).
+     */
+    url: string;
+    /**
+     * Response headers.
+     */
+    headers: CommonHttpClientResponseHeaders;
+    /**
+     * Custom request properties. Can be used to pass metadata outside the fetch function.
+     */
+    customRequestProps?: Record<string, unknown>;
+}
+export type CommonHttpClientResponseHeaders = Record<string, string> & {
+    "set-cookie"?: string[];
+};
+export type CommonHttpClientFetchResponseBody = {
+    type: "json";
+    data: unknown;
+} | {
+    type: "blob";
+    data: Blob;
+} | {
+    type: "readableStream";
+    data: ReadableStream<Uint8Array>;
+};
+export interface CommonHttpClientResponse<T> {
+    status: number;
+    mediaType?: string;
+    body: T;
+    response: CommonHttpClientFetchResponse;
+}
+export declare class CommonHttpClientError extends Error {
+    readonly url: URL;
+    readonly request: CommonHttpClientFetchRequest | undefined;
+    readonly response: CommonHttpClientFetchResponse | undefined;
+    readonly options: CommonHttpClientOptions | undefined;
+    constructor(url: URL, request: CommonHttpClientFetchRequest | undefined, response: CommonHttpClientFetchResponse | undefined, options: CommonHttpClientOptions | undefined, message: string);
+}
+/**
+ * `extends unknown` is a trick to split the union into individual types.
+ */
+type ResponseByMediaType<T extends CommonHttpClientResponse<unknown>, K extends string> = T extends unknown ? ((a: T) => void) extends (a: {
+    mediaType: K;
+    status: infer _Status;
+    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 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"];
+} & {
+    created: true;
+}) | ({
+    [K in KOther]: Extract<T, {
+        status: 200;
+    }>["body"];
+} & {
+    created: false;
+});
+export declare function asCreatedResponse<KCreated extends string>(keyCreated: KCreated): AsCreatedResponseFunction<KCreated, KCreated>;
+export declare function asCreatedResponse<KCreated extends string, KOther extends string>(keyCreated: KCreated, keyOther: KOther): AsCreatedResponseFunction<KCreated, KOther>;
+export declare const getBody: <T>({ body }: CommonHttpClientResponse<T>) => T;
+export declare const castResponse: <T extends Omit<CommonHttpClientResponse<unknown>, "response">>() => (response: CommonHttpClientResponse<unknown>) => WithResponse<T>;
+export declare const discardResult: () => void;
+export type WithResponse<T> = T & {
+    response: CommonHttpClientFetchResponse;
+};
+export declare function createClientWithServices<TOptions, TClient extends {
+    getClient(): CommonHttpClient;
+}, TServices extends Record<string, {
+    new (client: CommonHttpClient): unknown;
+}>>(this: {
+    new (options?: TOptions): TClient;
+}, services: TServices, options?: TOptions): TClient & {
+    [K in keyof TServices as K extends string ? Uncapitalize<K extends `${infer TName}Service` ? TName : K> : K]: InstanceType<TServices[K]>;
+};
+export declare class CommonHttpClient {
+    protected options: CommonHttpClientOptions;
+    constructor(options: CommonHttpClientOptions);
+    setOptions(options: CommonHttpClientOptions): void;
+    getOptions(): CommonHttpClientOptions;
+    protected getSearchParams(params: Record<string, unknown>): URLSearchParams;
+    protected buildUrlPath(request: CommonHttpClientRequest): string;
+    protected buildUrl(request: CommonHttpClientRequest): URL;
+    protected fetch(url: URL, request: CommonHttpClientFetchRequest): Promise<CommonHttpClientFetchResponse>;
+    request(request: CommonHttpClientRequest): Promise<CommonHttpClientFetchResponse>;
+    responseHandler(distribution: {
+        [statusCode: string]: {
+            [mediaType: string]: CommonHttpClientFetchResponseBody["type"];
+        };
+    }): (response: CommonHttpClientFetchResponse) => Promise<CommonHttpClientResponse<unknown>>;
+    private cleanupHeaders;
+    protected getRequestBody(request: CommonHttpClientRequest): BodyInit | undefined;
+    protected preprocessRequest(request: CommonHttpClientRequest): Promise<CommonHttpClientRequest>;
+}
+export {};