@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,104 @@
1
+ import { HttpParameterCodec } from '@angular/common/http';
2
+ import { Param } from './param';
3
+ export interface ConfigurationParameters {
4
+ /**
5
+ * @deprecated Since 5.0. Use credentials instead
6
+ */
7
+ apiKeys?: {
8
+ [key: string]: string;
9
+ };
10
+ username?: string;
11
+ password?: string;
12
+ /**
13
+ * @deprecated Since 5.0. Use credentials instead
14
+ */
15
+ accessToken?: string | (() => string);
16
+ basePath?: string;
17
+ withCredentials?: boolean;
18
+ /**
19
+ * Takes care of encoding query- and form-parameters.
20
+ */
21
+ encoder?: HttpParameterCodec;
22
+ /**
23
+ * Override the default method for encoding path parameters in various
24
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
25
+ * <p>
26
+ * See {@link README.md} for more details
27
+ * </p>
28
+ */
29
+ encodeParam?: (param: Param) => string;
30
+ /**
31
+ * The keys are the names in the securitySchemes section of the OpenAPI
32
+ * document. They should map to the value used for authentication
33
+ * minus any standard prefixes such as 'Basic' or 'Bearer'.
34
+ */
35
+ credentials?: {
36
+ [key: string]: string | (() => string | undefined);
37
+ };
38
+ }
39
+ export declare class Configuration {
40
+ /**
41
+ * @deprecated Since 5.0. Use credentials instead
42
+ */
43
+ apiKeys?: {
44
+ [key: string]: string;
45
+ };
46
+ username?: string;
47
+ password?: string;
48
+ /**
49
+ * @deprecated Since 5.0. Use credentials instead
50
+ */
51
+ accessToken?: string | (() => string);
52
+ basePath?: string;
53
+ withCredentials?: boolean;
54
+ /**
55
+ * Takes care of encoding query- and form-parameters.
56
+ */
57
+ encoder?: HttpParameterCodec;
58
+ /**
59
+ * Encoding of various path parameter
60
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
61
+ * <p>
62
+ * See {@link README.md} for more details
63
+ * </p>
64
+ */
65
+ encodeParam: (param: Param) => string;
66
+ /**
67
+ * The keys are the names in the securitySchemes section of the OpenAPI
68
+ * document. They should map to the value used for authentication
69
+ * minus any standard prefixes such as 'Basic' or 'Bearer'.
70
+ */
71
+ credentials: {
72
+ [key: string]: string | (() => string | undefined);
73
+ };
74
+ constructor(configurationParameters?: ConfigurationParameters);
75
+ /**
76
+ * Select the correct content-type to use for a request.
77
+ * Uses {@link Configuration#isJsonMime} to determine the correct content-type.
78
+ * If no content type is found return the first found type if the contentTypes is not empty
79
+ * @param contentTypes - the array of content types that are available for selection
80
+ * @returns the selected content-type or <code>undefined</code> if no selection could be made.
81
+ */
82
+ selectHeaderContentType(contentTypes: string[]): string | undefined;
83
+ /**
84
+ * Select the correct accept content-type to use for a request.
85
+ * Uses {@link Configuration#isJsonMime} to determine the correct accept content-type.
86
+ * If no content type is found return the first found type if the contentTypes is not empty
87
+ * @param accepts - the array of content types that are available for selection.
88
+ * @returns the selected content-type or <code>undefined</code> if no selection could be made.
89
+ */
90
+ selectHeaderAccept(accepts: string[]): string | undefined;
91
+ /**
92
+ * Check if the given MIME is a JSON MIME.
93
+ * JSON MIME examples:
94
+ * application/json
95
+ * application/json; charset=UTF8
96
+ * APPLICATION/JSON
97
+ * application/vnd.company+json
98
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
99
+ * @return True if the given MIME is JSON, false otherwise.
100
+ */
101
+ isJsonMime(mime: string): boolean;
102
+ lookupCredential(key: string): string | undefined;
103
+ private defaultEncodeParam;
104
+ }
@@ -0,0 +1,11 @@
1
+ import { HttpParameterCodec } from '@angular/common/http';
2
+ /**
3
+ * Custom HttpParameterCodec
4
+ * Workaround for https://github.com/angular/angular/issues/18261
5
+ */
6
+ export declare class CustomHttpParameterCodec implements HttpParameterCodec {
7
+ encodeKey(k: string): string;
8
+ encodeValue(v: string): string;
9
+ decodeKey(k: string): string;
10
+ decodeValue(v: string): string;
11
+ }
package/lib/index.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ export * from './api/api';
2
+ export * from './model/models';
3
+ export * from './variables';
4
+ export * from './configuration';
5
+ export * from './api.module';
6
+ export * from './param';
@@ -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 AssignMemberRole422Response {
13
+ code?: AssignMemberRole422Response.CodeEnum;
14
+ /**
15
+ * Человекочитаемое описание ошибки
16
+ */
17
+ message?: string;
18
+ }
19
+ export declare namespace AssignMemberRole422Response {
20
+ type CodeEnum = 'invalidRole';
21
+ const CodeEnum: {
22
+ InvalidRole: "invalidRole";
23
+ };
24
+ }
@@ -0,0 +1,39 @@
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 { Invitee } from './invitee';
13
+ import { InvitationStatusName } from './invitationStatusName';
14
+ /**
15
+ * Приглашение для сотрудника
16
+ */
17
+ export interface Invitation {
18
+ /**
19
+ * Идентификатор приглашения
20
+ */
21
+ readonly id: string;
22
+ /**
23
+ * Дата и время создания
24
+ */
25
+ readonly createdAt: string;
26
+ /**
27
+ * Дата и время истечения срока принятия
28
+ */
29
+ expiresAt: string;
30
+ invitee: Invitee;
31
+ acceptToken?: string;
32
+ /**
33
+ * Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с данным приглашением
34
+ */
35
+ metadata?: object;
36
+ status: InvitationStatusName;
37
+ }
38
+ export declare namespace Invitation {
39
+ }
@@ -0,0 +1,11 @@
1
+ import { Invitation } from './invitation';
2
+ import { InvitationAcceptedAllOfMember } from './invitationAcceptedAllOfMember';
3
+ export interface InvitationAccepted extends Invitation {
4
+ /**
5
+ * Дата и время принятия приглашения
6
+ */
7
+ acceptedAt?: string;
8
+ member?: InvitationAcceptedAllOfMember;
9
+ }
10
+ export declare namespace InvitationAccepted {
11
+ }
@@ -0,0 +1,20 @@
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 InvitationAcceptedAllOfMember {
16
+ /**
17
+ * Идентификатор пользователя
18
+ */
19
+ readonly id: string;
20
+ }
@@ -0,0 +1,5 @@
1
+ import { Invitation } from './invitation';
2
+ export interface InvitationExpired extends Invitation {
3
+ }
4
+ export declare namespace InvitationExpired {
5
+ }
@@ -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 { Invitation } from './invitation';
13
+ export interface InvitationListResult {
14
+ result: Array<Invitation>;
15
+ }
@@ -0,0 +1,5 @@
1
+ import { Invitation } from './invitation';
2
+ export interface InvitationPending extends Invitation {
3
+ }
4
+ export declare namespace InvitationPending {
5
+ }
@@ -0,0 +1,22 @@
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 { Invitee } from './invitee';
13
+ /**
14
+ * Приглашение для сотрудника
15
+ */
16
+ export interface InvitationRequest {
17
+ invitee: Invitee;
18
+ /**
19
+ * Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с данным приглашением
20
+ */
21
+ metadata?: object;
22
+ }
@@ -0,0 +1,13 @@
1
+ import { Invitation } from './invitation';
2
+ export interface InvitationRevoked extends Invitation {
3
+ /**
4
+ * Дата и время отзыва приглашения
5
+ */
6
+ revokedAt?: string;
7
+ /**
8
+ * Причина отзыва приглашения
9
+ */
10
+ reason?: string;
11
+ }
12
+ export declare namespace InvitationRevoked {
13
+ }
@@ -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
+ export type InvitationStatusName = 'Pending' | 'Accepted' | 'Expired' | 'Revoked';
13
+ export declare const InvitationStatusName: {
14
+ Pending: InvitationStatusName;
15
+ Accepted: InvitationStatusName;
16
+ Expired: InvitationStatusName;
17
+ Revoked: InvitationStatusName;
18
+ };
@@ -0,0 +1,23 @@
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 { MemberRole } from './memberRole';
13
+ import { InviteeContact } from './inviteeContact';
14
+ /**
15
+ * Приглашаемый пользователь
16
+ */
17
+ export interface Invitee {
18
+ contact: InviteeContact;
19
+ /**
20
+ * Роли, которые будут назначены сотруднику после принятия им приглашения
21
+ */
22
+ roles: Array<MemberRole>;
23
+ }
@@ -0,0 +1,27 @@
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 InviteeContact {
16
+ type: InviteeContact.TypeEnum;
17
+ /**
18
+ * Адрес электронной почты пользователя в организации
19
+ */
20
+ email: string;
21
+ }
22
+ export declare namespace InviteeContact {
23
+ type TypeEnum = 'EMail';
24
+ const TypeEnum: {
25
+ EMail: "EMail";
26
+ };
27
+ }
@@ -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 JoinOrg422Response {
13
+ code?: JoinOrg422Response.CodeEnum;
14
+ /**
15
+ * Человекочитаемое описание ошибки
16
+ */
17
+ message?: string;
18
+ }
19
+ export declare namespace JoinOrg422Response {
20
+ type CodeEnum = 'invitationExpired';
21
+ const CodeEnum: {
22
+ InvitationExpired: "invitationExpired";
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
+ /**
13
+ * Ошибка в переданных данных
14
+ */
15
+ export interface ListOrgMembership400Response {
16
+ code: ListOrgMembership400Response.CodeEnum;
17
+ message?: string;
18
+ }
19
+ export declare namespace ListOrgMembership400Response {
20
+ type CodeEnum = 'invalidRequest';
21
+ const CodeEnum: {
22
+ InvalidRequest: "invalidRequest";
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 { MemberRole } from './memberRole';
13
+ /**
14
+ * Сотрудник организации
15
+ */
16
+ export interface Member {
17
+ /**
18
+ * Идентификатор пользователя
19
+ */
20
+ readonly id: string;
21
+ /**
22
+ * Адрес электронной почты пользователя в организации
23
+ */
24
+ userEmail: string;
25
+ /**
26
+ * Набор ролей сотрудника
27
+ */
28
+ roles: Array<MemberRole>;
29
+ }
@@ -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 MemberContext {
13
+ /**
14
+ * Идентификатор организации
15
+ */
16
+ readonly organizationId: string;
17
+ }
@@ -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 { Member } from './member';
13
+ export interface MemberOrgListResult {
14
+ result: Array<Member>;
15
+ }
@@ -0,0 +1,26 @@
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 { MemberRoleScope } from './memberRoleScope';
13
+ import { RoleId } from './roleId';
14
+ /**
15
+ * Роль сотрудника в организации
16
+ */
17
+ export interface MemberRole {
18
+ /**
19
+ * Идентификатор роли пользователя в организации
20
+ */
21
+ readonly id: string;
22
+ roleId: RoleId;
23
+ scope?: MemberRoleScope;
24
+ }
25
+ export declare namespace MemberRole {
26
+ }
@@ -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
+ import { ResourceScopeId } from './resourceScopeId';
13
+ /**
14
+ * Область действия этой роли
15
+ */
16
+ export interface MemberRoleScope {
17
+ id: ResourceScopeId;
18
+ /**
19
+ * Идентификатор доступного в рамках области ресурса
20
+ */
21
+ resourceId: string;
22
+ }
23
+ export declare namespace MemberRoleScope {
24
+ }