@homespot-sdk/api 0.0.628 → 0.0.630

package/docs/UserQueryControllerApi.md

@@ -0,0 +1,70 @@
+# UserQueryControllerApi
+
+All URIs are relative to *http://localhost:8080*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getMe**](UserQueryControllerApi.md#getme) | **GET** /user/me |  |
+
+
+
+## getMe
+
+> UserContextViewResponse getMe()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { GetMeRequest } from '@homespot-sdk/api';
+
+async function example() {
+  console.log("🚀 Testing @homespot-sdk/api SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: keycloak accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new UserQueryControllerApi(config);
+
+  try {
+    const data = await api.getMe();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserContextViewResponse**](UserContextViewResponse.md)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `*/*`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/UserSummaryViewResponse.md

@@ -0,0 +1,38 @@
+
+# UserSummaryViewResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`firstName` | string
+`lastName` | string
+
+## Example
+
+```typescript
+import type { UserSummaryViewResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+  "firstName": null,
+  "lastName": null,
+} satisfies UserSummaryViewResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UserSummaryViewResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homespot-sdk/api",
-  "version": "0.0.628",
+  "version": "0.0.630",
   "description": "OpenAPI client for @homespot-sdk/api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/UserQueryControllerApi.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Service API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  UserContextViewResponse,
+} from '../models/index';
+import {
+    UserContextViewResponseFromJSON,
+    UserContextViewResponseToJSON,
+} from '../models/index';
+
+/**
+ * UserQueryControllerApi - interface
+ * 
+ * @export
+ * @interface UserQueryControllerApiInterface
+ */
+export interface UserQueryControllerApiInterface {
+    /**
+     * 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserQueryControllerApiInterface
+     */
+    getMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserContextViewResponse>>;
+
+    /**
+     */
+    getMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserContextViewResponse>;
+
+}
+
+/**
+ * 
+ */
+export class UserQueryControllerApi extends runtime.BaseAPI implements UserQueryControllerApiInterface {
+
+    /**
+     */
+    async getMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserContextViewResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("keycloak", []);
+        }
+
+
+        let urlPath = `/user/me`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserContextViewResponseFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async getMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserContextViewResponse> {
+        const response = await this.getMeRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -4,3 +4,4 @@ export * from './AgencyControllerApi';
 export * from './AgencyQueryControllerApi';
 export * from './InvitationControllerApi';
 export * from './InvitationQueryControllerApi';
+export * from './UserQueryControllerApi';

package/src/models/InvitationViewResponse.ts

@@ -70,7 +70,6 @@ export interface InvitationViewResponse {
 export const InvitationViewResponseStatusEnum = {
     Pending: 'PENDING',
     Accepted: 'ACCEPTED',
-    Rejected: 'REJECTED',
     Cancelled: 'CANCELLED',
     Expired: 'EXPIRED'
 } as const;

package/src/models/OrganizationSummaryViewResponse.ts

@@ -0,0 +1,161 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Service API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface OrganizationSummaryViewResponse
+ */
+export interface OrganizationSummaryViewResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    agencyId: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    isOwner: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    agencyName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    subDomain: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    roleId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    memberId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    roleName: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    authorities: Array<OrganizationSummaryViewResponseAuthoritiesEnum>;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrganizationSummaryViewResponse
+     */
+    status: OrganizationSummaryViewResponseStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const OrganizationSummaryViewResponseAuthoritiesEnum = {
+    PropertiesRead: 'properties_read',
+    PropertiesWrite: 'properties_write',
+    AgentsRead: 'agents_read',
+    AgentsWrite: 'agents_write'
+} as const;
+export type OrganizationSummaryViewResponseAuthoritiesEnum = typeof OrganizationSummaryViewResponseAuthoritiesEnum[keyof typeof OrganizationSummaryViewResponseAuthoritiesEnum];
+
+/**
+ * @export
+ */
+export const OrganizationSummaryViewResponseStatusEnum = {
+    New: 'NEW',
+    Active: 'ACTIVE',
+    PaymentFailed: 'PAYMENT_FAILED',
+    Inactive: 'INACTIVE'
+} as const;
+export type OrganizationSummaryViewResponseStatusEnum = typeof OrganizationSummaryViewResponseStatusEnum[keyof typeof OrganizationSummaryViewResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the OrganizationSummaryViewResponse interface.
+ */
+export function instanceOfOrganizationSummaryViewResponse(value: object): value is OrganizationSummaryViewResponse {
+    if (!('agencyId' in value) || value['agencyId'] === undefined) return false;
+    if (!('isOwner' in value) || value['isOwner'] === undefined) return false;
+    if (!('agencyName' in value) || value['agencyName'] === undefined) return false;
+    if (!('subDomain' in value) || value['subDomain'] === undefined) return false;
+    if (!('memberId' in value) || value['memberId'] === undefined) return false;
+    if (!('roleName' in value) || value['roleName'] === undefined) return false;
+    if (!('authorities' in value) || value['authorities'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function OrganizationSummaryViewResponseFromJSON(json: any): OrganizationSummaryViewResponse {
+    return OrganizationSummaryViewResponseFromJSONTyped(json, false);
+}
+
+export function OrganizationSummaryViewResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrganizationSummaryViewResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'agencyId': json['agencyId'],
+        'isOwner': json['isOwner'],
+        'agencyName': json['agencyName'],
+        'subDomain': json['subDomain'],
+        'roleId': json['roleId'] == null ? undefined : json['roleId'],
+        'memberId': json['memberId'],
+        'roleName': json['roleName'],
+        'authorities': json['authorities'],
+        'status': json['status'],
+    };
+}
+
+export function OrganizationSummaryViewResponseToJSON(json: any): OrganizationSummaryViewResponse {
+    return OrganizationSummaryViewResponseToJSONTyped(json, false);
+}
+
+export function OrganizationSummaryViewResponseToJSONTyped(value?: OrganizationSummaryViewResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'agencyId': value['agencyId'],
+        'isOwner': value['isOwner'],
+        'agencyName': value['agencyName'],
+        'subDomain': value['subDomain'],
+        'roleId': value['roleId'],
+        'memberId': value['memberId'],
+        'roleName': value['roleName'],
+        'authorities': value['authorities'],
+        'status': value['status'],
+    };
+}
+

package/src/models/UserContextViewResponse.ts

@@ -0,0 +1,90 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Service API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { OrganizationSummaryViewResponse } from './OrganizationSummaryViewResponse';
+import {
+    OrganizationSummaryViewResponseFromJSON,
+    OrganizationSummaryViewResponseFromJSONTyped,
+    OrganizationSummaryViewResponseToJSON,
+    OrganizationSummaryViewResponseToJSONTyped,
+} from './OrganizationSummaryViewResponse';
+import type { UserSummaryViewResponse } from './UserSummaryViewResponse';
+import {
+    UserSummaryViewResponseFromJSON,
+    UserSummaryViewResponseFromJSONTyped,
+    UserSummaryViewResponseToJSON,
+    UserSummaryViewResponseToJSONTyped,
+} from './UserSummaryViewResponse';
+
+/**
+ * 
+ * @export
+ * @interface UserContextViewResponse
+ */
+export interface UserContextViewResponse {
+    /**
+     * 
+     * @type {UserSummaryViewResponse}
+     * @memberof UserContextViewResponse
+     */
+    user: UserSummaryViewResponse;
+    /**
+     * 
+     * @type {Array<OrganizationSummaryViewResponse>}
+     * @memberof UserContextViewResponse
+     */
+    organizations: Array<OrganizationSummaryViewResponse>;
+}
+
+/**
+ * Check if a given object implements the UserContextViewResponse interface.
+ */
+export function instanceOfUserContextViewResponse(value: object): value is UserContextViewResponse {
+    if (!('user' in value) || value['user'] === undefined) return false;
+    if (!('organizations' in value) || value['organizations'] === undefined) return false;
+    return true;
+}
+
+export function UserContextViewResponseFromJSON(json: any): UserContextViewResponse {
+    return UserContextViewResponseFromJSONTyped(json, false);
+}
+
+export function UserContextViewResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserContextViewResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'user': UserSummaryViewResponseFromJSON(json['user']),
+        'organizations': ((json['organizations'] as Array<any>).map(OrganizationSummaryViewResponseFromJSON)),
+    };
+}
+
+export function UserContextViewResponseToJSON(json: any): UserContextViewResponse {
+    return UserContextViewResponseToJSONTyped(json, false);
+}
+
+export function UserContextViewResponseToJSONTyped(value?: UserContextViewResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user': UserSummaryViewResponseToJSON(value['user']),
+        'organizations': ((value['organizations'] as Array<any>).map(OrganizationSummaryViewResponseToJSON)),
+    };
+}
+

package/src/models/UserSummaryViewResponse.ts

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Service API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface UserSummaryViewResponse
+ */
+export interface UserSummaryViewResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof UserSummaryViewResponse
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserSummaryViewResponse
+     */
+    firstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserSummaryViewResponse
+     */
+    lastName: string;
+}
+
+/**
+ * Check if a given object implements the UserSummaryViewResponse interface.
+ */
+export function instanceOfUserSummaryViewResponse(value: object): value is UserSummaryViewResponse {
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    return true;
+}
+
+export function UserSummaryViewResponseFromJSON(json: any): UserSummaryViewResponse {
+    return UserSummaryViewResponseFromJSONTyped(json, false);
+}
+
+export function UserSummaryViewResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserSummaryViewResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'email': json['email'],
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+    };
+}
+
+export function UserSummaryViewResponseToJSON(json: any): UserSummaryViewResponse {
+    return UserSummaryViewResponseToJSONTyped(json, false);
+}
+
+export function UserSummaryViewResponseToJSONTyped(value?: UserSummaryViewResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email': value['email'],
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+    };
+}
+

package/src/models/index.ts

@@ -5,6 +5,7 @@ export * from './CreateAgencyRequest';
 export * from './IdResponse';
 export * from './InvitationViewResponse';
 export * from './InviteMemberRequest';
+export * from './OrganizationSummaryViewResponse';
 export * from './PhotoRequest';
 export * from './PresignedUrlResponse';
 export * from './PresignedUrlsResponse';
@@ -12,3 +13,5 @@ export * from './RolesRequest';
 export * from './SocialMediaRequest';
 export * from './SocialMediasRequest';
 export * from './UploadAcknowledgmentResponse';
+export * from './UserContextViewResponse';
+export * from './UserSummaryViewResponse';