@webitel/api-services
    Preparing search index...

    @webitel/api-services

    @webitel/api-services

    Source: webitel swagger file.

    API clients – self-written api wrappers on top of gen services.

    @webitel/api-services/gen

    // zod, services, msw
    import {
        createSourceBody, // zod
        getSources, // api service
        getListSourcesResponseMock, // mock
    } from '@webitel/api-services/gen';

    @webitel/api-services/gen/models

    import {
        // enums, types and interfaces
    } from '@webitel/api-services/gen/models';

    @webitel/api-services/gen/utils

    import {
        // get list of top-level field keys. useful to sanitize fieldsToSend
        getShallowFieldsToSendFromZodSchema,
        // DONT USE. same, but for nested fields
        getFieldsToSendFromZodSchema,
        // pass zod schema, pass empty object, get object with default values
        getDefaultsFromZodSchema,
    } from '@webitel/api-services/gen/utils';

    @webitel/api-services/api

    See "contents" section.

    import { ContactsAPI } from '@webitel/api-services/api';

    @webitel/api-services/api/transformers

    API transformers, used to transform data before sending it to the server or after receiving it from the server.

    import { applyTransform } from '@webitel/api-services/api';

    @webitel/api-services/api/defaults

    API defaults: default axios instance, default getList response, etc

    import { getDefaultInstance } from '@webitel/api-services/api/defaults';

    Useful for parallel development, testing, and debugging. Calling a mock returns fake generated data, without sending a request to the server.

    import { getSources } from '@webitel/api-services/gen';

    const searchSources = getSources().listSources();

    ->

    import { getListSourcesResponseMock } from '@webitel/api-services/gen';

    A: Run this manual workflow.

    A: https://raw.githubusercontent.com/webitel/protos/main/swagger/api.json

    A: Automated version patching on each action run. minor/major version bump is manual, if needed.

    Settings

    Member Visibility

    On This Page