@vality/swag-organizations 1.0.1-cd6cc10.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.
- package/README.md +24 -0
- package/esm2020/lib/api/api.mjs +10 -0
- package/esm2020/lib/api/invitations.service.mjs +351 -0
- package/esm2020/lib/api/members.service.mjs +396 -0
- package/esm2020/lib/api/orgs.service.mjs +620 -0
- package/esm2020/lib/api/roles.service.mjs +206 -0
- package/esm2020/lib/api.module.mjs +40 -0
- package/esm2020/lib/configuration.mjs +80 -0
- package/esm2020/lib/encoder.mjs +19 -0
- package/esm2020/lib/index.mjs +6 -0
- package/esm2020/lib/model/inline-object-1.mjs +18 -0
- package/esm2020/lib/model/inline-object.mjs +13 -0
- package/esm2020/lib/model/inline-response-400.mjs +18 -0
- package/esm2020/lib/model/inline-response-422-1.mjs +18 -0
- package/esm2020/lib/model/inline-response-422-2.mjs +18 -0
- package/esm2020/lib/model/inline-response-422-3.mjs +18 -0
- package/esm2020/lib/model/inline-response-422.mjs +18 -0
- package/esm2020/lib/model/invitation-accepted-all-of-member.mjs +13 -0
- package/esm2020/lib/model/invitation-accepted-all-of.mjs +2 -0
- package/esm2020/lib/model/invitation-accepted.mjs +2 -0
- package/esm2020/lib/model/invitation-expired.mjs +2 -0
- package/esm2020/lib/model/invitation-list-result.mjs +2 -0
- package/esm2020/lib/model/invitation-pending.mjs +2 -0
- package/esm2020/lib/model/invitation-request.mjs +2 -0
- package/esm2020/lib/model/invitation-revoked-all-of.mjs +13 -0
- package/esm2020/lib/model/invitation-revoked.mjs +2 -0
- package/esm2020/lib/model/invitation-status-name.mjs +18 -0
- package/esm2020/lib/model/invitation.mjs +2 -0
- package/esm2020/lib/model/invitee-contact.mjs +18 -0
- package/esm2020/lib/model/invitee.mjs +2 -0
- package/esm2020/lib/model/member-context.mjs +13 -0
- package/esm2020/lib/model/member-org-list-result.mjs +2 -0
- package/esm2020/lib/model/member-role-scope.mjs +2 -0
- package/esm2020/lib/model/member-role.mjs +2 -0
- package/esm2020/lib/model/member.mjs +2 -0
- package/esm2020/lib/model/models.mjs +35 -0
- package/esm2020/lib/model/organization-join-request.mjs +13 -0
- package/esm2020/lib/model/organization-membership.mjs +2 -0
- package/esm2020/lib/model/organization-search-result.mjs +2 -0
- package/esm2020/lib/model/organization-switch-request.mjs +13 -0
- package/esm2020/lib/model/organization.mjs +13 -0
- package/esm2020/lib/model/resource-scope-id.mjs +15 -0
- package/esm2020/lib/model/role-available-list-result.mjs +2 -0
- package/esm2020/lib/model/role-id.mjs +18 -0
- package/esm2020/lib/model/role.mjs +2 -0
- package/esm2020/lib/variables.mjs +9 -0
- package/esm2020/public-api.mjs +2 -0
- package/esm2020/vality-swag-organizations.mjs +5 -0
- package/fesm2015/vality-swag-organizations.mjs +1876 -0
- package/fesm2015/vality-swag-organizations.mjs.map +1 -0
- package/fesm2020/vality-swag-organizations.mjs +1950 -0
- package/fesm2020/vality-swag-organizations.mjs.map +1 -0
- package/lib/api/api.d.ts +9 -0
- package/lib/api/invitations.service.d.ts +128 -0
- package/lib/api/members.service.d.ts +150 -0
- package/lib/api/orgs.service.d.ts +238 -0
- package/lib/api/roles.service.d.ts +69 -0
- package/lib/api.module.d.ts +11 -0
- package/lib/configuration.d.ts +80 -0
- package/lib/encoder.d.ts +11 -0
- package/lib/index.d.ts +5 -0
- package/lib/model/inline-object-1.d.ts +24 -0
- package/lib/model/inline-object.d.ts +17 -0
- package/lib/model/inline-response-400.d.ts +24 -0
- package/lib/model/inline-response-422-1.d.ts +24 -0
- package/lib/model/inline-response-422-2.d.ts +24 -0
- package/lib/model/inline-response-422-3.d.ts +24 -0
- package/lib/model/inline-response-422.d.ts +24 -0
- package/lib/model/invitation-accepted-all-of-member.d.ts +20 -0
- package/lib/model/invitation-accepted-all-of.d.ts +19 -0
- package/lib/model/invitation-accepted.d.ts +9 -0
- package/lib/model/invitation-expired.d.ts +3 -0
- package/lib/model/invitation-list-result.d.ts +15 -0
- package/lib/model/invitation-pending.d.ts +3 -0
- package/lib/model/invitation-request.d.ts +22 -0
- package/lib/model/invitation-revoked-all-of.d.ts +21 -0
- package/lib/model/invitation-revoked.d.ts +11 -0
- package/lib/model/invitation-status-name.d.ts +18 -0
- package/lib/model/invitation.d.ts +37 -0
- package/lib/model/invitee-contact.d.ts +27 -0
- package/lib/model/invitee.d.ts +23 -0
- package/lib/model/member-context.d.ts +17 -0
- package/lib/model/member-org-list-result.d.ts +15 -0
- package/lib/model/member-role-scope.d.ts +22 -0
- package/lib/model/member-role.d.ts +24 -0
- package/lib/model/member.d.ts +29 -0
- package/lib/model/models.d.ts +34 -0
- package/lib/model/organization-join-request.d.ts +17 -0
- package/lib/model/organization-membership.d.ts +17 -0
- package/lib/model/organization-search-result.d.ts +19 -0
- package/lib/model/organization-switch-request.d.ts +17 -0
- package/lib/model/organization.d.ts +37 -0
- package/lib/model/resource-scope-id.d.ts +18 -0
- package/lib/model/role-available-list-result.d.ts +15 -0
- package/lib/model/role-id.d.ts +21 -0
- package/lib/model/role.d.ts +27 -0
- package/lib/variables.d.ts +8 -0
- package/package.json +36 -0
- package/public-api.d.ts +1 -0
- package/src/lib/README.md +203 -0
- package/vality-swag-organizations.d.ts +5 -0
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { HttpParameterCodec } from '@angular/common/http';
|
|
2
|
+
export interface ConfigurationParameters {
|
|
3
|
+
/**
|
|
4
|
+
* @deprecated Since 5.0. Use credentials instead
|
|
5
|
+
*/
|
|
6
|
+
apiKeys?: {
|
|
7
|
+
[key: string]: string;
|
|
8
|
+
};
|
|
9
|
+
username?: string;
|
|
10
|
+
password?: string;
|
|
11
|
+
/**
|
|
12
|
+
* @deprecated Since 5.0. Use credentials instead
|
|
13
|
+
*/
|
|
14
|
+
accessToken?: string | (() => string);
|
|
15
|
+
basePath?: string;
|
|
16
|
+
withCredentials?: boolean;
|
|
17
|
+
encoder?: HttpParameterCodec;
|
|
18
|
+
/**
|
|
19
|
+
* The keys are the names in the securitySchemes section of the OpenAPI
|
|
20
|
+
* document. They should map to the value used for authentication
|
|
21
|
+
* minus any standard prefixes such as 'Basic' or 'Bearer'.
|
|
22
|
+
*/
|
|
23
|
+
credentials?: {
|
|
24
|
+
[key: string]: string | (() => string | undefined);
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
export declare class Configuration {
|
|
28
|
+
/**
|
|
29
|
+
* @deprecated Since 5.0. Use credentials instead
|
|
30
|
+
*/
|
|
31
|
+
apiKeys?: {
|
|
32
|
+
[key: string]: string;
|
|
33
|
+
};
|
|
34
|
+
username?: string;
|
|
35
|
+
password?: string;
|
|
36
|
+
/**
|
|
37
|
+
* @deprecated Since 5.0. Use credentials instead
|
|
38
|
+
*/
|
|
39
|
+
accessToken?: string | (() => string);
|
|
40
|
+
basePath?: string;
|
|
41
|
+
withCredentials?: boolean;
|
|
42
|
+
encoder?: HttpParameterCodec;
|
|
43
|
+
/**
|
|
44
|
+
* The keys are the names in the securitySchemes section of the OpenAPI
|
|
45
|
+
* document. They should map to the value used for authentication
|
|
46
|
+
* minus any standard prefixes such as 'Basic' or 'Bearer'.
|
|
47
|
+
*/
|
|
48
|
+
credentials: {
|
|
49
|
+
[key: string]: string | (() => string | undefined);
|
|
50
|
+
};
|
|
51
|
+
constructor(configurationParameters?: ConfigurationParameters);
|
|
52
|
+
/**
|
|
53
|
+
* Select the correct content-type to use for a request.
|
|
54
|
+
* Uses {@link Configuration#isJsonMime} to determine the correct content-type.
|
|
55
|
+
* If no content type is found return the first found type if the contentTypes is not empty
|
|
56
|
+
* @param contentTypes - the array of content types that are available for selection
|
|
57
|
+
* @returns the selected content-type or <code>undefined</code> if no selection could be made.
|
|
58
|
+
*/
|
|
59
|
+
selectHeaderContentType(contentTypes: string[]): string | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* Select the correct accept content-type to use for a request.
|
|
62
|
+
* Uses {@link Configuration#isJsonMime} to determine the correct accept content-type.
|
|
63
|
+
* If no content type is found return the first found type if the contentTypes is not empty
|
|
64
|
+
* @param accepts - the array of content types that are available for selection.
|
|
65
|
+
* @returns the selected content-type or <code>undefined</code> if no selection could be made.
|
|
66
|
+
*/
|
|
67
|
+
selectHeaderAccept(accepts: string[]): string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* Check if the given MIME is a JSON MIME.
|
|
70
|
+
* JSON MIME examples:
|
|
71
|
+
* application/json
|
|
72
|
+
* application/json; charset=UTF8
|
|
73
|
+
* APPLICATION/JSON
|
|
74
|
+
* application/vnd.company+json
|
|
75
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
76
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
77
|
+
*/
|
|
78
|
+
isJsonMime(mime: string): boolean;
|
|
79
|
+
lookupCredential(key: string): string | undefined;
|
|
80
|
+
}
|
package/lib/encoder.d.ts
ADDED
|
@@ -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,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 InlineObject1 {
|
|
13
|
+
status: InlineObject1.StatusEnum;
|
|
14
|
+
/**
|
|
15
|
+
* Причина отзыва приглашения
|
|
16
|
+
*/
|
|
17
|
+
reason?: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace InlineObject1 {
|
|
20
|
+
type StatusEnum = 'Revoked';
|
|
21
|
+
const StatusEnum: {
|
|
22
|
+
Revoked: "Revoked";
|
|
23
|
+
};
|
|
24
|
+
}
|
|
@@ -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 InlineObject {
|
|
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
|
+
/**
|
|
13
|
+
* Ошибка в переданных данных
|
|
14
|
+
*/
|
|
15
|
+
export interface InlineResponse400 {
|
|
16
|
+
code: InlineResponse400.CodeEnum;
|
|
17
|
+
message?: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace InlineResponse400 {
|
|
20
|
+
type CodeEnum = 'invalidRequest';
|
|
21
|
+
const CodeEnum: {
|
|
22
|
+
InvalidRequest: "invalidRequest";
|
|
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 InlineResponse4221 {
|
|
13
|
+
code?: InlineResponse4221.CodeEnum;
|
|
14
|
+
/**
|
|
15
|
+
* Человекочитаемое описание ошибки
|
|
16
|
+
*/
|
|
17
|
+
message?: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace InlineResponse4221 {
|
|
20
|
+
type CodeEnum = 'invalidRole';
|
|
21
|
+
const CodeEnum: {
|
|
22
|
+
InvalidRole: "invalidRole";
|
|
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 InlineResponse4222 {
|
|
13
|
+
code?: InlineResponse4222.CodeEnum;
|
|
14
|
+
/**
|
|
15
|
+
* Человекочитаемое описание ошибки
|
|
16
|
+
*/
|
|
17
|
+
message?: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace InlineResponse4222 {
|
|
20
|
+
type CodeEnum = 'onlyRoleLeft';
|
|
21
|
+
const CodeEnum: {
|
|
22
|
+
OnlyRoleLeft: "onlyRoleLeft";
|
|
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 InlineResponse4223 {
|
|
13
|
+
code?: InlineResponse4223.CodeEnum;
|
|
14
|
+
/**
|
|
15
|
+
* Человекочитаемое описание ошибки
|
|
16
|
+
*/
|
|
17
|
+
message?: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace InlineResponse4223 {
|
|
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 InlineResponse422 {
|
|
13
|
+
code?: InlineResponse422.CodeEnum;
|
|
14
|
+
/**
|
|
15
|
+
* Человекочитаемое описание ошибки
|
|
16
|
+
*/
|
|
17
|
+
message?: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace InlineResponse422 {
|
|
20
|
+
type CodeEnum = 'invitationExpired';
|
|
21
|
+
const CodeEnum: {
|
|
22
|
+
InvitationExpired: "invitationExpired";
|
|
23
|
+
};
|
|
24
|
+
}
|
|
@@ -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,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 { InvitationAcceptedAllOfMember } from './invitation-accepted-all-of-member';
|
|
13
|
+
export interface InvitationAcceptedAllOf {
|
|
14
|
+
/**
|
|
15
|
+
* Дата и время принятия приглашения
|
|
16
|
+
*/
|
|
17
|
+
acceptedAt?: string;
|
|
18
|
+
member?: InvitationAcceptedAllOfMember;
|
|
19
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Invitation } from './invitation';
|
|
2
|
+
import { InvitationAcceptedAllOfMember } from './invitation-accepted-all-of-member';
|
|
3
|
+
export interface InvitationAccepted extends Invitation {
|
|
4
|
+
/**
|
|
5
|
+
* Дата и время принятия приглашения
|
|
6
|
+
*/
|
|
7
|
+
acceptedAt?: string;
|
|
8
|
+
member?: InvitationAcceptedAllOfMember;
|
|
9
|
+
}
|
|
@@ -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,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,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
|
+
export interface InvitationRevokedAllOf {
|
|
13
|
+
/**
|
|
14
|
+
* Дата и время отзыва приглашения
|
|
15
|
+
*/
|
|
16
|
+
revokedAt?: string;
|
|
17
|
+
/**
|
|
18
|
+
* Причина отзыва приглашения
|
|
19
|
+
*/
|
|
20
|
+
reason?: string;
|
|
21
|
+
}
|
|
@@ -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 declare 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,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
|
+
import { Invitee } from './invitee';
|
|
13
|
+
import { InvitationStatusName } from './invitation-status-name';
|
|
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 | null;
|
|
32
|
+
/**
|
|
33
|
+
* Произвольный, специфичный для клиента API и непрозрачный для системы набор данных, ассоциированных с данным приглашением
|
|
34
|
+
*/
|
|
35
|
+
metadata?: object;
|
|
36
|
+
status: InvitationStatusName;
|
|
37
|
+
}
|
|
@@ -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,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 './member-role';
|
|
13
|
+
import { InviteeContact } from './invitee-contact';
|
|
14
|
+
/**
|
|
15
|
+
* Приглашаемый пользователь
|
|
16
|
+
*/
|
|
17
|
+
export interface Invitee {
|
|
18
|
+
contact: InviteeContact;
|
|
19
|
+
/**
|
|
20
|
+
* Роли, которые будут назначены сотруднику после принятия им приглашения
|
|
21
|
+
*/
|
|
22
|
+
roles: Array<MemberRole>;
|
|
23
|
+
}
|