Home / Class/ DefaultApi Class — typescript-sdk Architecture

DefaultApi Class — typescript-sdk Architecture

Architecture documentation for the DefaultApi class in DefaultApi.ts from the typescript-sdk codebase.

Entity Profile

Dependency Diagram

graph TD
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c["DefaultApi"]
  c0819722_6747_b0b6_11ec_944ce6f59300["DefaultApi.ts"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|defined in| c0819722_6747_b0b6_11ec_944ce6f59300
  486c9c78_6fb0_85bd_eec4_050f97cc95d3["generateCallGraphRaw()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 486c9c78_6fb0_85bd_eec4_050f97cc95d3
  65e51367_9905_d6a7_4b55_7822eba36751["generateCallGraph()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 65e51367_9905_d6a7_4b55_7822eba36751
  6f0f9cb8_1974_1147_65c2_5b4da28e3f6c["generateDeadCodeAnalysisRaw()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 6f0f9cb8_1974_1147_65c2_5b4da28e3f6c
  c2b30278_cc51_454c_f400_0cf896647453["generateDeadCodeAnalysis()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| c2b30278_cc51_454c_f400_0cf896647453
  20422587_ce07_2589_ea62_9eb11f041605["generateDependencyGraphRaw()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 20422587_ce07_2589_ea62_9eb11f041605
  49df7bd3_912b_d268_9120_bad6892dfe08["generateDependencyGraph()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 49df7bd3_912b_d268_9120_bad6892dfe08
  a0dd3368_5606_3ac6_6398_606765398654["generateDomainGraphRaw()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| a0dd3368_5606_3ac6_6398_606765398654
  e7e8f1ba_d87e_21b4_aa09_4c5a8682b3bc["generateDomainGraph()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| e7e8f1ba_d87e_21b4_aa09_4c5a8682b3bc
  720cd445_ea0b_fbbd_458f_1cd1b88fbc87["generateParseGraphRaw()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 720cd445_ea0b_fbbd_458f_1cd1b88fbc87
  d57695a9_fcfe_6c1f_c8a3_2a574e912256["generateParseGraph()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| d57695a9_fcfe_6c1f_c8a3_2a574e912256
  04bf905a_84f9_2e0c_78c1_caede8b1fc4e["generateSupermodelGraphRaw()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 04bf905a_84f9_2e0c_78c1_caede8b1fc4e
  811e8767_fbe9_5d3a_0688_0e4299f5e7ed["generateSupermodelGraph()"]
  cb2e2ccd_eaec_6f24_d9d6_4a68b8fd446c -->|method| 811e8767_fbe9_5d3a_0688_0e4299f5e7ed

Relationship Graph

Source Code

src/apis/DefaultApi.ts lines 67–495

export class DefaultApi extends runtime.BaseAPI {

    /**
     * Upload a zipped repository snapshot to generate the function-level call graph.
     * Call graph
     */
    async generateCallGraphRaw(requestParameters: GenerateCallGraphRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CodeGraphEnvelopeAsync>> {
        if (requestParameters['idempotencyKey'] == null) {
            throw new runtime.RequiredError(
                'idempotencyKey',
                'Required parameter "idempotencyKey" was null or undefined when calling generateCallGraph().'
            );
        }

        if (requestParameters['file'] == null) {
            throw new runtime.RequiredError(
                'file',
                'Required parameter "file" was null or undefined when calling generateCallGraph().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (requestParameters['idempotencyKey'] != null) {
            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
        }

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
        }

        const consumes: runtime.Consume[] = [
            { contentType: 'multipart/form-data' },
        ];
        // @ts-ignore: canConsumeForm may be unused
        const canConsumeForm = runtime.canConsumeForm(consumes);

        let formParams: { append(param: string, value: any): any };
        let useForm = false;
        // use FormData to transmit files using content-type "multipart/form-data"
        useForm = canConsumeForm;
        if (useForm) {
            formParams = new FormData();
        } else {
            formParams = new URLSearchParams();
        }

        if (requestParameters['file'] != null) {
            formParams.append('file', requestParameters['file'] as any);
        }

        const response = await this.request({
            path: `/v1/graphs/call`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: formParams,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => CodeGraphEnvelopeAsyncFromJSON(jsonValue));
    }

    /**
     * Upload a zipped repository snapshot to generate the function-level call graph.
     * Call graph
     */
    async generateCallGraph(requestParameters: GenerateCallGraphRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CodeGraphEnvelopeAsync> {
        const response = await this.generateCallGraphRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Upload a zipped repository snapshot to identify dead (unreachable) code candidates by combining parse graph declarations with call graph relationships.
     * Dead code analysis
     */
    async generateDeadCodeAnalysisRaw(requestParameters: GenerateDeadCodeAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeadCodeAnalysisResponseAsync>> {
        if (requestParameters['idempotencyKey'] == null) {
            throw new runtime.RequiredError(
                'idempotencyKey',

Domain

Frequently Asked Questions

What is the DefaultApi class?
DefaultApi is a class in the typescript-sdk codebase, defined in src/apis/DefaultApi.ts.
Where is DefaultApi defined?
DefaultApi is defined in src/apis/DefaultApi.ts at line 67.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free