@vality/swag-organizations 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/README.md +24 -0
  2. package/esm2022/lib/api/api.mjs +10 -0
  3. package/esm2022/lib/api/invitations.service.mjs +361 -0
  4. package/esm2022/lib/api/members.service.mjs +406 -0
  5. package/esm2022/lib/api/orgs.service.mjs +637 -0
  6. package/esm2022/lib/api/roles.service.mjs +212 -0
  7. package/esm2022/lib/api.module.mjs +40 -0
  8. package/esm2022/lib/configuration.mjs +99 -0
  9. package/esm2022/lib/encoder.mjs +19 -0
  10. package/esm2022/lib/index.mjs +7 -0
  11. package/esm2022/lib/model/assignMemberRole422Response.mjs +18 -0
  12. package/esm2022/lib/model/invitation.mjs +2 -0
  13. package/esm2022/lib/model/invitationAccepted.mjs +2 -0
  14. package/esm2022/lib/model/invitationAcceptedAllOfMember.mjs +13 -0
  15. package/esm2022/lib/model/invitationExpired.mjs +2 -0
  16. package/esm2022/lib/model/invitationListResult.mjs +2 -0
  17. package/esm2022/lib/model/invitationPending.mjs +2 -0
  18. package/esm2022/lib/model/invitationRequest.mjs +2 -0
  19. package/esm2022/lib/model/invitationRevoked.mjs +2 -0
  20. package/esm2022/lib/model/invitationStatusName.mjs +18 -0
  21. package/esm2022/lib/model/invitee.mjs +2 -0
  22. package/esm2022/lib/model/inviteeContact.mjs +18 -0
  23. package/esm2022/lib/model/joinOrg422Response.mjs +18 -0
  24. package/esm2022/lib/model/listOrgMembership400Response.mjs +18 -0
  25. package/esm2022/lib/model/member.mjs +2 -0
  26. package/esm2022/lib/model/memberContext.mjs +13 -0
  27. package/esm2022/lib/model/memberOrgListResult.mjs +2 -0
  28. package/esm2022/lib/model/memberRole.mjs +2 -0
  29. package/esm2022/lib/model/memberRoleScope.mjs +2 -0
  30. package/esm2022/lib/model/models.mjs +33 -0
  31. package/esm2022/lib/model/organization.mjs +13 -0
  32. package/esm2022/lib/model/organizationJoinRequest.mjs +13 -0
  33. package/esm2022/lib/model/organizationMembership.mjs +2 -0
  34. package/esm2022/lib/model/organizationSearchResult.mjs +2 -0
  35. package/esm2022/lib/model/organizationSwitchRequest.mjs +13 -0
  36. package/esm2022/lib/model/patchOrgRequest.mjs +13 -0
  37. package/esm2022/lib/model/removeMemberRole422Response.mjs +18 -0
  38. package/esm2022/lib/model/resourceScopeId.mjs +15 -0
  39. package/esm2022/lib/model/revokeInvitation422Response.mjs +18 -0
  40. package/esm2022/lib/model/revokeInvitationRequest.mjs +18 -0
  41. package/esm2022/lib/model/role.mjs +2 -0
  42. package/esm2022/lib/model/roleAvailableListResult.mjs +2 -0
  43. package/esm2022/lib/model/roleId.mjs +18 -0
  44. package/esm2022/lib/param.mjs +2 -0
  45. package/esm2022/lib/variables.mjs +9 -0
  46. package/esm2022/public-api.mjs +2 -0
  47. package/esm2022/vality-swag-organizations.mjs +5 -0
  48. package/fesm2022/vality-swag-organizations.mjs +2004 -0
  49. package/fesm2022/vality-swag-organizations.mjs.map +1 -0
  50. package/index.d.ts +5 -0
  51. package/lib/api/api.d.ts +9 -0
  52. package/lib/api/invitations.service.d.ts +128 -0
  53. package/lib/api/members.service.d.ts +150 -0
  54. package/lib/api/orgs.service.d.ts +238 -0
  55. package/lib/api/roles.service.d.ts +69 -0
  56. package/lib/api.module.d.ts +11 -0
  57. package/lib/configuration.d.ts +104 -0
  58. package/lib/encoder.d.ts +11 -0
  59. package/lib/index.d.ts +6 -0
  60. package/lib/model/assignMemberRole422Response.d.ts +24 -0
  61. package/lib/model/invitation.d.ts +39 -0
  62. package/lib/model/invitationAccepted.d.ts +11 -0
  63. package/lib/model/invitationAcceptedAllOfMember.d.ts +20 -0
  64. package/lib/model/invitationExpired.d.ts +5 -0
  65. package/lib/model/invitationListResult.d.ts +15 -0
  66. package/lib/model/invitationPending.d.ts +5 -0
  67. package/lib/model/invitationRequest.d.ts +22 -0
  68. package/lib/model/invitationRevoked.d.ts +13 -0
  69. package/lib/model/invitationStatusName.d.ts +18 -0
  70. package/lib/model/invitee.d.ts +23 -0
  71. package/lib/model/inviteeContact.d.ts +27 -0
  72. package/lib/model/joinOrg422Response.d.ts +24 -0
  73. package/lib/model/listOrgMembership400Response.d.ts +24 -0
  74. package/lib/model/member.d.ts +29 -0
  75. package/lib/model/memberContext.d.ts +17 -0
  76. package/lib/model/memberOrgListResult.d.ts +15 -0
  77. package/lib/model/memberRole.d.ts +26 -0
  78. package/lib/model/memberRoleScope.d.ts +24 -0
  79. package/lib/model/models.d.ts +32 -0
  80. package/lib/model/organization.d.ts +37 -0
  81. package/lib/model/organizationJoinRequest.d.ts +17 -0
  82. package/lib/model/organizationMembership.d.ts +17 -0
  83. package/lib/model/organizationSearchResult.d.ts +19 -0
  84. package/lib/model/organizationSwitchRequest.d.ts +17 -0
  85. package/lib/model/patchOrgRequest.d.ts +17 -0
  86. package/lib/model/removeMemberRole422Response.d.ts +24 -0
  87. package/lib/model/resourceScopeId.d.ts +18 -0
  88. package/lib/model/revokeInvitation422Response.d.ts +24 -0
  89. package/lib/model/revokeInvitationRequest.d.ts +24 -0
  90. package/lib/model/role.d.ts +29 -0
  91. package/lib/model/roleAvailableListResult.d.ts +15 -0
  92. package/lib/model/roleId.d.ts +21 -0
  93. package/lib/param.d.ts +37 -0
  94. package/lib/variables.d.ts +8 -0
  95. package/package.json +30 -0
  96. package/public-api.d.ts +1 -0
@@ -0,0 +1,32 @@
1
+ export * from './assignMemberRole422Response';
2
+ export * from './invitation';
3
+ export * from './invitationAccepted';
4
+ export * from './invitationAcceptedAllOfMember';
5
+ export * from './invitationExpired';
6
+ export * from './invitationListResult';
7
+ export * from './invitationPending';
8
+ export * from './invitationRequest';
9
+ export * from './invitationRevoked';
10
+ export * from './invitationStatusName';
11
+ export * from './invitee';
12
+ export * from './inviteeContact';
13
+ export * from './joinOrg422Response';
14
+ export * from './listOrgMembership400Response';
15
+ export * from './member';
16
+ export * from './memberContext';
17
+ export * from './memberOrgListResult';
18
+ export * from './memberRole';
19
+ export * from './memberRoleScope';
20
+ export * from './organization';
21
+ export * from './organizationJoinRequest';
22
+ export * from './organizationMembership';
23
+ export * from './organizationSearchResult';
24
+ export * from './organizationSwitchRequest';
25
+ export * from './patchOrgRequest';
26
+ export * from './removeMemberRole422Response';
27
+ export * from './resourceScopeId';
28
+ export * from './revokeInvitation422Response';
29
+ export * from './revokeInvitationRequest';
30
+ export * from './role';
31
+ export * from './roleAvailableListResult';
32
+ export * from './roleId';
@@ -0,0 +1,37 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Модель организации
14
+ */
15
+ export interface Organization {
16
+ /**
17
+ * Идентификатор организации
18
+ */
19
+ readonly id: string;
20
+ /**
21
+ * Дата и время создания организации
22
+ */
23
+ readonly createdAt: string;
24
+ /**
25
+ * Название организации в человекочитаемом виде
26
+ */
27
+ name: string;
28
+ owner: string;
29
+ /**
30
+ * Идентификатор [участника](https://developer.rbk.money/api/#tag/Parties), которым заведует данная организация
31
+ */
32
+ readonly party?: string;
33
+ /**
34
+ * Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с данной организацией
35
+ */
36
+ metadata?: object;
37
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface OrganizationJoinRequest {
13
+ /**
14
+ * Токен для принятия приглашения пользователем
15
+ */
16
+ invitation: string;
17
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Organization } from './organization';
13
+ import { Member } from './member';
14
+ export interface OrganizationMembership {
15
+ org: Organization;
16
+ member: Member;
17
+ }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Organization } from './organization';
13
+ export interface OrganizationSearchResult {
14
+ /**
15
+ * Токен, сигнализирующий о том, что в ответе передана только часть данных. Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. Если токена нет, получена последняя часть данных.
16
+ */
17
+ continuationToken?: string;
18
+ result: Array<Organization>;
19
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface OrganizationSwitchRequest {
13
+ /**
14
+ * Идентификатор организации
15
+ */
16
+ organizationId: string;
17
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface PatchOrgRequest {
13
+ /**
14
+ * Название организации
15
+ */
16
+ name?: string;
17
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface RemoveMemberRole422Response {
13
+ code?: RemoveMemberRole422Response.CodeEnum;
14
+ /**
15
+ * Человекочитаемое описание ошибки
16
+ */
17
+ message?: string;
18
+ }
19
+ export declare namespace RemoveMemberRole422Response {
20
+ type CodeEnum = 'onlyRoleLeft';
21
+ const CodeEnum: {
22
+ OnlyRoleLeft: "onlyRoleLeft";
23
+ };
24
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Идентификатор ограничения для роли
14
+ */
15
+ export type ResourceScopeId = 'Shop';
16
+ export declare const ResourceScopeId: {
17
+ Shop: "Shop";
18
+ };
@@ -0,0 +1,24 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface RevokeInvitation422Response {
13
+ code?: RevokeInvitation422Response.CodeEnum;
14
+ /**
15
+ * Человекочитаемое описание ошибки
16
+ */
17
+ message?: string;
18
+ }
19
+ export declare namespace RevokeInvitation422Response {
20
+ type CodeEnum = 'invalidStatus';
21
+ const CodeEnum: {
22
+ InvalidStatus: "invalidStatus";
23
+ };
24
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface RevokeInvitationRequest {
13
+ status: RevokeInvitationRequest.StatusEnum;
14
+ /**
15
+ * Причина отзыва приглашения
16
+ */
17
+ reason?: string;
18
+ }
19
+ export declare namespace RevokeInvitationRequest {
20
+ type StatusEnum = 'Revoked';
21
+ const StatusEnum: {
22
+ Revoked: "Revoked";
23
+ };
24
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ResourceScopeId } from './resourceScopeId';
13
+ import { RoleId } from './roleId';
14
+ /**
15
+ * Роль в организации
16
+ */
17
+ export interface Role {
18
+ id: RoleId;
19
+ /**
20
+ * Название роли в человекочитаемом виде
21
+ */
22
+ name: string;
23
+ /**
24
+ * Возможные области действия для роли
25
+ */
26
+ scopes?: Array<ResourceScopeId>;
27
+ }
28
+ export declare namespace Role {
29
+ }
@@ -0,0 +1,15 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Role } from './role';
13
+ export interface RoleAvailableListResult {
14
+ result: Array<Role>;
15
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * RBKmoney Organizations API
3
+ * RBKmoney 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 ``` Даже если платформа получит множество запросов на совершение определённой операции с одним и тем же значением ключа идемпотентности, эта операция будет выполнена _не более чем один_ раз. Таким образом, в случае кратковременных проблем с сетевой доступностью вы можете отправлять запросы повторно и быть уверенными в том, что, например, приглашение новому сотруднику в итоге будет отправлено только один раз.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@rbk.money
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Идентификатор роли
14
+ */
15
+ export type RoleId = 'Administrator' | 'Accountant' | 'Integrator' | 'Manager';
16
+ export declare const RoleId: {
17
+ Administrator: RoleId;
18
+ Accountant: RoleId;
19
+ Integrator: RoleId;
20
+ Manager: RoleId;
21
+ };
package/lib/param.d.ts ADDED
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Standard parameter styles defined by OpenAPI spec
3
+ */
4
+ export type StandardParamStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
5
+ /**
6
+ * The OpenAPI standard {@link StandardParamStyle}s may be extended by custom styles by the user.
7
+ */
8
+ export type ParamStyle = StandardParamStyle | string;
9
+ /**
10
+ * Standard parameter locations defined by OpenAPI spec
11
+ */
12
+ export type ParamLocation = 'query' | 'header' | 'path' | 'cookie';
13
+ /**
14
+ * Standard types as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
15
+ */
16
+ export type StandardDataType = "integer" | "number" | "boolean" | "string" | "object" | "array";
17
+ /**
18
+ * Standard {@link DataType}s plus your own types/classes.
19
+ */
20
+ export type DataType = StandardDataType | string;
21
+ /**
22
+ * Standard formats as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
23
+ */
24
+ export type StandardDataFormat = "int32" | "int64" | "float" | "double" | "byte" | "binary" | "date" | "date-time" | "password";
25
+ export type DataFormat = StandardDataFormat | string;
26
+ /**
27
+ * The parameter to encode.
28
+ */
29
+ export interface Param {
30
+ name: string;
31
+ value: unknown;
32
+ in: ParamLocation;
33
+ style: ParamStyle;
34
+ explode: boolean;
35
+ dataType: DataType;
36
+ dataFormat: DataFormat | undefined;
37
+ }
@@ -0,0 +1,8 @@
1
+ import { InjectionToken } from '@angular/core';
2
+ export declare const BASE_PATH: InjectionToken<string>;
3
+ export declare const COLLECTION_FORMATS: {
4
+ csv: string;
5
+ tsv: string;
6
+ ssv: string;
7
+ pipes: string;
8
+ };
package/package.json ADDED
@@ -0,0 +1,30 @@
1
+ {
2
+ "name": "@vality/swag-organizations",
3
+ "version": "1.0.0",
4
+ "peerDependencies": {
5
+ "@angular/common": "^17.0.0",
6
+ "@angular/core": "^17.0.0"
7
+ },
8
+ "dependencies": {
9
+ "tslib": "^2.3.0"
10
+ },
11
+ "sideEffects": false,
12
+ "module": "fesm2022/vality-swag-organizations.mjs",
13
+ "typings": "index.d.ts",
14
+ "exports": {
15
+ "./package.json": {
16
+ "default": "./package.json"
17
+ },
18
+ ".": {
19
+ "types": "./index.d.ts",
20
+ "esm2022": "./esm2022/vality-swag-organizations.mjs",
21
+ "esm": "./esm2022/vality-swag-organizations.mjs",
22
+ "default": "./fesm2022/vality-swag-organizations.mjs"
23
+ }
24
+ },
25
+ "license": "MIT",
26
+ "publishConfig": {
27
+ "access": "public",
28
+ "registry": "https://registry.npmjs.org/"
29
+ }
30
+ }
@@ -0,0 +1 @@
1
+ export * from "./lib";