@homespot-sdk/api 0.0.634 → 0.0.635

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 (38) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +5 -2
  3. package/dist/apis/AgencyQueryControllerApi.d.ts +17 -1
  4. package/dist/apis/AgencyQueryControllerApi.js +28 -0
  5. package/dist/esm/apis/AgencyQueryControllerApi.d.ts +17 -1
  6. package/dist/esm/apis/AgencyQueryControllerApi.js +29 -1
  7. package/dist/esm/models/GroupedPermissionsResponse.d.ts +48 -0
  8. package/dist/esm/models/GroupedPermissionsResponse.js +56 -0
  9. package/dist/esm/models/OrganizationSummaryViewResponse.d.ts +8 -7
  10. package/dist/esm/models/OrganizationSummaryViewResponse.js +9 -8
  11. package/dist/esm/models/PermissionResponse.d.ts +60 -0
  12. package/dist/esm/models/PermissionResponse.js +67 -0
  13. package/dist/esm/models/RolesRequest.d.ts +8 -7
  14. package/dist/esm/models/RolesRequest.js +9 -8
  15. package/dist/esm/models/index.d.ts +2 -0
  16. package/dist/esm/models/index.js +2 -0
  17. package/dist/models/GroupedPermissionsResponse.d.ts +48 -0
  18. package/dist/models/GroupedPermissionsResponse.js +64 -0
  19. package/dist/models/OrganizationSummaryViewResponse.d.ts +8 -7
  20. package/dist/models/OrganizationSummaryViewResponse.js +10 -9
  21. package/dist/models/PermissionResponse.d.ts +60 -0
  22. package/dist/models/PermissionResponse.js +75 -0
  23. package/dist/models/RolesRequest.d.ts +8 -7
  24. package/dist/models/RolesRequest.js +10 -9
  25. package/dist/models/index.d.ts +2 -0
  26. package/dist/models/index.js +2 -0
  27. package/docs/AgencyQueryControllerApi.md +62 -0
  28. package/docs/GroupedPermissionsResponse.md +36 -0
  29. package/docs/OrganizationSummaryViewResponse.md +2 -2
  30. package/docs/PermissionResponse.md +36 -0
  31. package/docs/RolesRequest.md +2 -2
  32. package/package.json +1 -1
  33. package/src/apis/AgencyQueryControllerApi.ts +47 -0
  34. package/src/models/GroupedPermissionsResponse.ts +95 -0
  35. package/src/models/OrganizationSummaryViewResponse.ts +11 -10
  36. package/src/models/PermissionResponse.ts +101 -0
  37. package/src/models/RolesRequest.ts +11 -10
  38. package/src/models/index.ts +2 -0
@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
17
17
  import type {
18
18
  AgencyPeekViewResponse,
19
19
  AgencyViewResponse,
20
+ GroupedPermissionsResponse,
20
21
  Pageable,
21
22
  PagedModelAgencyPeekViewResponse,
22
23
  } from '../models/index';
@@ -25,6 +26,8 @@ import {
25
26
  AgencyPeekViewResponseToJSON,
26
27
  AgencyViewResponseFromJSON,
27
28
  AgencyViewResponseToJSON,
29
+ GroupedPermissionsResponseFromJSON,
30
+ GroupedPermissionsResponseToJSON,
28
31
  PageableFromJSON,
29
32
  PageableToJSON,
30
33
  PagedModelAgencyPeekViewResponseFromJSON,
@@ -91,6 +94,18 @@ export interface AgencyQueryControllerApiInterface {
91
94
  */
92
95
  getAllAgencies(requestParameters: GetAllAgenciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PagedModelAgencyPeekViewResponse>;
93
96
 
97
+ /**
98
+ *
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ * @memberof AgencyQueryControllerApiInterface
102
+ */
103
+ getAllPermissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GroupedPermissionsResponse>>>;
104
+
105
+ /**
106
+ */
107
+ getAllPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GroupedPermissionsResponse>>;
108
+
94
109
  }
95
110
 
96
111
  /**
@@ -225,6 +240,38 @@ export class AgencyQueryControllerApi extends runtime.BaseAPI implements AgencyQ
225
240
  return await response.value();
226
241
  }
227
242
 
243
+ /**
244
+ */
245
+ async getAllPermissionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GroupedPermissionsResponse>>> {
246
+ const queryParameters: any = {};
247
+
248
+ const headerParameters: runtime.HTTPHeaders = {};
249
+
250
+ if (this.configuration && this.configuration.accessToken) {
251
+ // oauth required
252
+ headerParameters["Authorization"] = await this.configuration.accessToken("keycloak", []);
253
+ }
254
+
255
+
256
+ let urlPath = `/agency/roles/permissions`;
257
+
258
+ const response = await this.request({
259
+ path: urlPath,
260
+ method: 'GET',
261
+ headers: headerParameters,
262
+ query: queryParameters,
263
+ }, initOverrides);
264
+
265
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GroupedPermissionsResponseFromJSON));
266
+ }
267
+
268
+ /**
269
+ */
270
+ async getAllPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GroupedPermissionsResponse>> {
271
+ const response = await this.getAllPermissionsRaw(initOverrides);
272
+ return await response.value();
273
+ }
274
+
228
275
  }
229
276
 
230
277
  /**
@@ -0,0 +1,95 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Service API
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { PermissionResponse } from './PermissionResponse';
17
+ import {
18
+ PermissionResponseFromJSON,
19
+ PermissionResponseFromJSONTyped,
20
+ PermissionResponseToJSON,
21
+ PermissionResponseToJSONTyped,
22
+ } from './PermissionResponse';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface GroupedPermissionsResponse
28
+ */
29
+ export interface GroupedPermissionsResponse {
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof GroupedPermissionsResponse
34
+ */
35
+ group: GroupedPermissionsResponseGroupEnum;
36
+ /**
37
+ *
38
+ * @type {Array<PermissionResponse>}
39
+ * @memberof GroupedPermissionsResponse
40
+ */
41
+ permissions: Array<PermissionResponse>;
42
+ }
43
+
44
+
45
+ /**
46
+ * @export
47
+ */
48
+ export const GroupedPermissionsResponseGroupEnum = {
49
+ Agency: 'AGENCY',
50
+ Invitation: 'INVITATION',
51
+ Role: 'ROLE'
52
+ } as const;
53
+ export type GroupedPermissionsResponseGroupEnum = typeof GroupedPermissionsResponseGroupEnum[keyof typeof GroupedPermissionsResponseGroupEnum];
54
+
55
+
56
+ /**
57
+ * Check if a given object implements the GroupedPermissionsResponse interface.
58
+ */
59
+ export function instanceOfGroupedPermissionsResponse(value: object): value is GroupedPermissionsResponse {
60
+ if (!('group' in value) || value['group'] === undefined) return false;
61
+ if (!('permissions' in value) || value['permissions'] === undefined) return false;
62
+ return true;
63
+ }
64
+
65
+ export function GroupedPermissionsResponseFromJSON(json: any): GroupedPermissionsResponse {
66
+ return GroupedPermissionsResponseFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function GroupedPermissionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupedPermissionsResponse {
70
+ if (json == null) {
71
+ return json;
72
+ }
73
+ return {
74
+
75
+ 'group': json['group'],
76
+ 'permissions': ((json['permissions'] as Array<any>).map(PermissionResponseFromJSON)),
77
+ };
78
+ }
79
+
80
+ export function GroupedPermissionsResponseToJSON(json: any): GroupedPermissionsResponse {
81
+ return GroupedPermissionsResponseToJSONTyped(json, false);
82
+ }
83
+
84
+ export function GroupedPermissionsResponseToJSONTyped(value?: GroupedPermissionsResponse | null, ignoreDiscriminator: boolean = false): any {
85
+ if (value == null) {
86
+ return value;
87
+ }
88
+
89
+ return {
90
+
91
+ 'group': value['group'],
92
+ 'permissions': ((value['permissions'] as Array<any>).map(PermissionResponseToJSON)),
93
+ };
94
+ }
95
+
@@ -66,7 +66,7 @@ export interface OrganizationSummaryViewResponse {
66
66
  * @type {Array<string>}
67
67
  * @memberof OrganizationSummaryViewResponse
68
68
  */
69
- authorities: Array<OrganizationSummaryViewResponseAuthoritiesEnum>;
69
+ permissions: Array<OrganizationSummaryViewResponsePermissionsEnum>;
70
70
  /**
71
71
  *
72
72
  * @type {string}
@@ -79,13 +79,14 @@ export interface OrganizationSummaryViewResponse {
79
79
  /**
80
80
  * @export
81
81
  */
82
- export const OrganizationSummaryViewResponseAuthoritiesEnum = {
83
- PropertiesRead: 'properties_read',
84
- PropertiesWrite: 'properties_write',
85
- AgentsRead: 'agents_read',
86
- AgentsWrite: 'agents_write'
82
+ export const OrganizationSummaryViewResponsePermissionsEnum = {
83
+ AgencyWrite: 'AGENCY_WRITE',
84
+ InvitationRead: 'INVITATION_READ',
85
+ InvitationWrite: 'INVITATION_WRITE',
86
+ RoleRead: 'ROLE_READ',
87
+ RoleWrite: 'ROLE_WRITE'
87
88
  } as const;
88
- export type OrganizationSummaryViewResponseAuthoritiesEnum = typeof OrganizationSummaryViewResponseAuthoritiesEnum[keyof typeof OrganizationSummaryViewResponseAuthoritiesEnum];
89
+ export type OrganizationSummaryViewResponsePermissionsEnum = typeof OrganizationSummaryViewResponsePermissionsEnum[keyof typeof OrganizationSummaryViewResponsePermissionsEnum];
89
90
 
90
91
  /**
91
92
  * @export
@@ -109,7 +110,7 @@ export function instanceOfOrganizationSummaryViewResponse(value: object): value
109
110
  if (!('subDomain' in value) || value['subDomain'] === undefined) return false;
110
111
  if (!('memberId' in value) || value['memberId'] === undefined) return false;
111
112
  if (!('roleName' in value) || value['roleName'] === undefined) return false;
112
- if (!('authorities' in value) || value['authorities'] === undefined) return false;
113
+ if (!('permissions' in value) || value['permissions'] === undefined) return false;
113
114
  if (!('status' in value) || value['status'] === undefined) return false;
114
115
  return true;
115
116
  }
@@ -131,7 +132,7 @@ export function OrganizationSummaryViewResponseFromJSONTyped(json: any, ignoreDi
131
132
  'roleId': json['roleId'] == null ? undefined : json['roleId'],
132
133
  'memberId': json['memberId'],
133
134
  'roleName': json['roleName'],
134
- 'authorities': json['authorities'],
135
+ 'permissions': json['permissions'],
135
136
  'status': json['status'],
136
137
  };
137
138
  }
@@ -154,7 +155,7 @@ export function OrganizationSummaryViewResponseToJSONTyped(value?: OrganizationS
154
155
  'roleId': value['roleId'],
155
156
  'memberId': value['memberId'],
156
157
  'roleName': value['roleName'],
157
- 'authorities': value['authorities'],
158
+ 'permissions': value['permissions'],
158
159
  'status': value['status'],
159
160
  };
160
161
  }
@@ -0,0 +1,101 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Service API
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface PermissionResponse
20
+ */
21
+ export interface PermissionResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PermissionResponse
26
+ */
27
+ permission: PermissionResponsePermissionEnum;
28
+ /**
29
+ *
30
+ * @type {Array<string>}
31
+ * @memberof PermissionResponse
32
+ */
33
+ implied: Array<PermissionResponseImpliedEnum>;
34
+ }
35
+
36
+
37
+ /**
38
+ * @export
39
+ */
40
+ export const PermissionResponsePermissionEnum = {
41
+ AgencyWrite: 'AGENCY_WRITE',
42
+ InvitationRead: 'INVITATION_READ',
43
+ InvitationWrite: 'INVITATION_WRITE',
44
+ RoleRead: 'ROLE_READ',
45
+ RoleWrite: 'ROLE_WRITE'
46
+ } as const;
47
+ export type PermissionResponsePermissionEnum = typeof PermissionResponsePermissionEnum[keyof typeof PermissionResponsePermissionEnum];
48
+
49
+ /**
50
+ * @export
51
+ */
52
+ export const PermissionResponseImpliedEnum = {
53
+ AgencyWrite: 'AGENCY_WRITE',
54
+ InvitationRead: 'INVITATION_READ',
55
+ InvitationWrite: 'INVITATION_WRITE',
56
+ RoleRead: 'ROLE_READ',
57
+ RoleWrite: 'ROLE_WRITE'
58
+ } as const;
59
+ export type PermissionResponseImpliedEnum = typeof PermissionResponseImpliedEnum[keyof typeof PermissionResponseImpliedEnum];
60
+
61
+
62
+ /**
63
+ * Check if a given object implements the PermissionResponse interface.
64
+ */
65
+ export function instanceOfPermissionResponse(value: object): value is PermissionResponse {
66
+ if (!('permission' in value) || value['permission'] === undefined) return false;
67
+ if (!('implied' in value) || value['implied'] === undefined) return false;
68
+ return true;
69
+ }
70
+
71
+ export function PermissionResponseFromJSON(json: any): PermissionResponse {
72
+ return PermissionResponseFromJSONTyped(json, false);
73
+ }
74
+
75
+ export function PermissionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PermissionResponse {
76
+ if (json == null) {
77
+ return json;
78
+ }
79
+ return {
80
+
81
+ 'permission': json['permission'],
82
+ 'implied': json['implied'],
83
+ };
84
+ }
85
+
86
+ export function PermissionResponseToJSON(json: any): PermissionResponse {
87
+ return PermissionResponseToJSONTyped(json, false);
88
+ }
89
+
90
+ export function PermissionResponseToJSONTyped(value?: PermissionResponse | null, ignoreDiscriminator: boolean = false): any {
91
+ if (value == null) {
92
+ return value;
93
+ }
94
+
95
+ return {
96
+
97
+ 'permission': value['permission'],
98
+ 'implied': value['implied'],
99
+ };
100
+ }
101
+
@@ -36,20 +36,21 @@ export interface RolesRequest {
36
36
  * @type {Array<string>}
37
37
  * @memberof RolesRequest
38
38
  */
39
- authorities: Array<RolesRequestAuthoritiesEnum>;
39
+ permissions: Array<RolesRequestPermissionsEnum>;
40
40
  }
41
41
 
42
42
 
43
43
  /**
44
44
  * @export
45
45
  */
46
- export const RolesRequestAuthoritiesEnum = {
47
- PropertiesRead: 'properties_read',
48
- PropertiesWrite: 'properties_write',
49
- AgentsRead: 'agents_read',
50
- AgentsWrite: 'agents_write'
46
+ export const RolesRequestPermissionsEnum = {
47
+ AgencyWrite: 'AGENCY_WRITE',
48
+ InvitationRead: 'INVITATION_READ',
49
+ InvitationWrite: 'INVITATION_WRITE',
50
+ RoleRead: 'ROLE_READ',
51
+ RoleWrite: 'ROLE_WRITE'
51
52
  } as const;
52
- export type RolesRequestAuthoritiesEnum = typeof RolesRequestAuthoritiesEnum[keyof typeof RolesRequestAuthoritiesEnum];
53
+ export type RolesRequestPermissionsEnum = typeof RolesRequestPermissionsEnum[keyof typeof RolesRequestPermissionsEnum];
53
54
 
54
55
 
55
56
  /**
@@ -58,7 +59,7 @@ export type RolesRequestAuthoritiesEnum = typeof RolesRequestAuthoritiesEnum[key
58
59
  export function instanceOfRolesRequest(value: object): value is RolesRequest {
59
60
  if (!('name' in value) || value['name'] === undefined) return false;
60
61
  if (!('description' in value) || value['description'] === undefined) return false;
61
- if (!('authorities' in value) || value['authorities'] === undefined) return false;
62
+ if (!('permissions' in value) || value['permissions'] === undefined) return false;
62
63
  return true;
63
64
  }
64
65
 
@@ -74,7 +75,7 @@ export function RolesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolea
74
75
 
75
76
  'name': json['name'],
76
77
  'description': json['description'],
77
- 'authorities': json['authorities'],
78
+ 'permissions': json['permissions'],
78
79
  };
79
80
  }
80
81
 
@@ -91,7 +92,7 @@ export function RolesRequestToJSONTyped(value?: RolesRequest | null, ignoreDiscr
91
92
 
92
93
  'name': value['name'],
93
94
  'description': value['description'],
94
- 'authorities': value['authorities'],
95
+ 'permissions': value['permissions'],
95
96
  };
96
97
  }
97
98
 
@@ -5,6 +5,7 @@ export * from './AddressViewResponse';
5
5
  export * from './AgencyPeekViewResponse';
6
6
  export * from './AgencyViewResponse';
7
7
  export * from './CreateAgencyRequest';
8
+ export * from './GroupedPermissionsResponse';
8
9
  export * from './IdResponse';
9
10
  export * from './InvitationDetailsRequest';
10
11
  export * from './InvitationDetailsResponse';
@@ -17,6 +18,7 @@ export * from './Pageable';
17
18
  export * from './PagedModelAgencyPeekViewResponse';
18
19
  export * from './PagedModelInvitationViewResponse';
19
20
  export * from './PagedModelMemberViewResponse';
21
+ export * from './PermissionResponse';
20
22
  export * from './PhotoRequest';
21
23
  export * from './PresignedUrlResponse';
22
24
  export * from './PresignedUrlsResponse';