# @vality/swag-organizations > OpenAPI client for @vality/swag-organizations Latest version **1.0.1-a72830b.0** (published 2026-06-15) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @vality/swag-organizations pnpm add @vality/swag-organizations yarn add @vality/swag-organizations bun add @vality/swag-organizations ``` ## Health **Score 45/100 (D)** — status: active. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 1.0.1-a72830b.0 | | Published | 2026-06-15 | | First published | 2022-04-04 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | OpenAPI-Generator Contributors | | Maintainers | chchmthrfckr, krickray, vality.devs, keinasylum | | Keywords | openapi-client, openapi-generator | ## Links - npm: https://www.npmjs.com/package/@vality/swag-organizations - Repository: https://github.com/valitydev/swag-organizations - Homepage: https://github.com/valitydev/swag-organizations#readme - Issues: https://github.com/valitydev/swag-organizations/issues - npm.io page: https://npm.io/package/@vality/swag-organizations ## Recent versions - 1.0.1-a72830b.0 (latest) — 2026-06-15 - 1.0.1-67dcada.0 — 2025-03-06 - 1.0.1-15bf67d.0 — 2025-02-05 - 1.0.1-e863566.0 — 2024-06-26 - 1.0.1-de0cd06.0 — 2024-02-07 - 1.0.0 — 2024-01-09 - 1.0.1-cd6cc10.0 — 2022-04-04 ## README # @vality/swag-organizations@1.0.0 Organizations API является интерфейсом для управления различными аспектами вашей организации. Все изменения состояния организации, будь то приглашение новых сотрудников, добавление ролей уже существующим сотрудникам или настройка области их ответственности осуществляются с помощью вызовов соответствующих методов API. Любые сторонние приложения, включая ваш личный кабинет, являются внешними приложениями-клиентами. Мы предоставляем REST API поверх HTTP-протокола, схема которого описывается в соответствии со стандартом [OpenAPI 3][OAS3]. Коды возврата описываются соответствующими HTTP-статусами. Платформа принимает и возвращает значения JSON в теле запросов и ответов. [OAS3]: https://swagger.io/specification/ ## Формат содержимого Любой запрос к API должен выполняться в кодировке UTF-8 и с указанием содержимого в формате JSON. ``` Content-Type: application/json; charset=utf-8 ``` ## Запросы Любой вызов методов API обязан предваряться предоставлением уникального для клиента платформы идентификатора запроса. Данный ID передается в соответствующем заголовке каждого HTTP-запроса: ``` X-Request-ID: RQID-Z08G3EFE5DZ429VVO755BM19D51 ``` Мы требуем его, чтобы иметь возможность отследить жизненный цикл любого отдельного запроса в системе, когда того требуют задачи аудита или обращения в техническую поддержку. ### Идемпотентность При совершении некоторых запросов вы можете указать _ключ идемпотентности_ – уникальный набор символов для обеспечения идемпотентной обработки запросов. ``` X-Idempotency-Key: 881D:08BA ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз. The version of the OpenAPI document: 1.0.0 ## Building To install the required dependencies and to build the typescript sources run: ```console npm install npm run build ``` ## Publishing First build the package then run `npm publish dist` (don't forget to specify the `dist` folder!) ## Consuming Navigate to the folder of your consuming project and run one of next commands. _published:_ ```console npm install @vality/swag-organizations@1.0.0 --save ``` _without publishing (not recommended):_ ```console npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save ``` _It's important to take the tgz file, otherwise you'll get trouble with links on windows_ _using `npm link`:_ In PATH_TO_GENERATED_PACKAGE/dist: ```console npm link ``` In your project: ```console npm link @vality/swag-organizations ``` __Note for Windows users:__ The Angular CLI has troubles to use linked npm packages. Please refer to this issue for a solution / workaround. Published packages are not effected by this issue. ### General usage In your Angular project: ```typescript import { ApplicationConfig } from '@angular/core'; import { provideHttpClient } from '@angular/common/http'; import { provideApi } from '@vality/swag-organizations'; export const appConfig: ApplicationConfig = { providers: [ // ... provideHttpClient(), provideApi() ], }; ``` **NOTE** If you're still using `AppModule` and haven't [migrated](https://angular.dev/reference/migrations/standalone) yet, you can still import an Angular module: ```typescript import { ApiModule } from '@vality/swag-organizations'; ``` If different from the generated base path, during app bootstrap, you can provide the base path to your service. ```typescript import { ApplicationConfig } from '@angular/core'; import { provideHttpClient } from '@angular/common/http'; import { provideApi } from '@vality/swag-organizations'; export const appConfig: ApplicationConfig = { providers: [ // ... provideHttpClient(), provideApi('http://localhost:9999') ], }; ``` ```typescript // with a custom configuration import { ApplicationConfig } from '@angular/core'; import { provideHttpClient } from '@angular/common/http'; import { provideApi } from '@vality/swag-organizations'; export const appConfig: ApplicationConfig = { providers: [ // ... provideHttpClient(), provideApi({ withCredentials: true, username: 'user', password: 'password' }) ], }; ``` ```typescript // with factory building a custom configuration import { ApplicationConfig } from '@angular/core'; import { provideHttpClient } from '@angular/common/http'; import { provideApi, Configuration } from '@vality/swag-organizations'; export const appConfig: ApplicationConfig = { providers: [ // ... provideHttpClient(), { provide: Configuration, useFactory: (authService: AuthService) => new Configuration({ basePath: 'http://localhost:9999', withCredentials: true, username: authService.getUsername(), password: authService.getPassword(), }), deps: [AuthService], multi: false } ], }; ``` ### Using multiple OpenAPI files / APIs In order to use multiple APIs generated from different OpenAPI files, you can create an alias name when importing the modules in order to avoid naming conflicts: ```typescript import { provideApi as provideUserApi } from 'my-user-api-path'; import { provideApi as provideAdminApi } from 'my-admin-api-path'; import { HttpClientModule } from '@angular/common/http'; import { environment } from '../environments/environment'; export const appConfig: ApplicationConfig = { providers: [ // ... provideHttpClient(), provideUserApi(environment.basePath), provideAdminApi(environment.basePath), ], }; ``` ### Customizing path parameter encoding Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple' and Dates for format 'date-time' are encoded correctly. Other styles (e.g. "matrix") are not that easy to encode and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]). To implement your own parameter encoding (or call another library), pass an arrow-function or method-reference to the `encodeParam` property of the Configuration-object (see [General Usage](#general-usage) above). Example value for use in your Configuration-Provider: ```typescript new Configuration({ encodeParam: (param: Param) => myFancyParamEncoder(param), }) ``` [parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations [style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values [@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander --- _Source: https://npm.io/package/@vality/swag-organizations · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._