@homespot-sdk/api 0.0.633 → 0.0.634
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/.openapi-generator/FILES +20 -0
- package/README.md +27 -13
- package/dist/apis/AgencyControllerApi.d.ts +0 -14
- package/dist/apis/AgencyControllerApi.js +10 -38
- package/dist/apis/AgencyQueryControllerApi.d.ts +53 -1
- package/dist/apis/AgencyQueryControllerApi.js +79 -1
- package/dist/apis/InvitationControllerApi.d.ts +0 -2
- package/dist/apis/InvitationControllerApi.js +5 -7
- package/dist/apis/InvitationQueryControllerApi.d.ts +27 -5
- package/dist/apis/InvitationQueryControllerApi.js +45 -5
- package/dist/apis/MemberQueryControllerApi.d.ts +46 -0
- package/dist/apis/MemberQueryControllerApi.js +67 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AgencyControllerApi.d.ts +0 -14
- package/dist/esm/apis/AgencyControllerApi.js +10 -38
- package/dist/esm/apis/AgencyQueryControllerApi.d.ts +53 -1
- package/dist/esm/apis/AgencyQueryControllerApi.js +79 -1
- package/dist/esm/apis/InvitationControllerApi.d.ts +0 -2
- package/dist/esm/apis/InvitationControllerApi.js +5 -7
- package/dist/esm/apis/InvitationQueryControllerApi.d.ts +27 -5
- package/dist/esm/apis/InvitationQueryControllerApi.js +46 -6
- package/dist/esm/apis/MemberQueryControllerApi.d.ts +46 -0
- package/dist/esm/apis/MemberQueryControllerApi.js +63 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/AgencyPeekViewResponse.d.ts +102 -0
- package/dist/esm/models/AgencyPeekViewResponse.js +88 -0
- package/dist/esm/models/InvitationDetailsRequest.d.ts +38 -0
- package/dist/esm/models/InvitationDetailsRequest.js +47 -0
- package/dist/esm/models/InvitationDetailsResponse.d.ts +72 -0
- package/dist/esm/models/InvitationDetailsResponse.js +70 -0
- package/dist/esm/models/InviteMemberRequest.d.ts +3 -2
- package/dist/esm/models/InviteMemberRequest.js +3 -2
- package/dist/esm/models/MemberViewResponse.d.ts +74 -0
- package/dist/esm/models/MemberViewResponse.js +69 -0
- package/dist/esm/models/PageMetadata.d.ts +50 -0
- package/dist/esm/models/PageMetadata.js +47 -0
- package/dist/esm/models/Pageable.d.ts +44 -0
- package/dist/esm/models/Pageable.js +45 -0
- package/dist/esm/models/PagedModelAgencyPeekViewResponse.d.ts +40 -0
- package/dist/esm/models/PagedModelAgencyPeekViewResponse.js +45 -0
- package/dist/esm/models/PagedModelInvitationViewResponse.d.ts +40 -0
- package/dist/esm/models/PagedModelInvitationViewResponse.js +45 -0
- package/dist/esm/models/PagedModelMemberViewResponse.d.ts +40 -0
- package/dist/esm/models/PagedModelMemberViewResponse.js +45 -0
- package/dist/esm/models/index.d.ts +9 -0
- package/dist/esm/models/index.js +9 -0
- package/dist/models/AgencyPeekViewResponse.d.ts +102 -0
- package/dist/models/AgencyPeekViewResponse.js +96 -0
- package/dist/models/InvitationDetailsRequest.d.ts +38 -0
- package/dist/models/InvitationDetailsRequest.js +54 -0
- package/dist/models/InvitationDetailsResponse.d.ts +72 -0
- package/dist/models/InvitationDetailsResponse.js +78 -0
- package/dist/models/InviteMemberRequest.d.ts +3 -2
- package/dist/models/InviteMemberRequest.js +3 -2
- package/dist/models/MemberViewResponse.d.ts +74 -0
- package/dist/models/MemberViewResponse.js +76 -0
- package/dist/models/PageMetadata.d.ts +50 -0
- package/dist/models/PageMetadata.js +54 -0
- package/dist/models/Pageable.d.ts +44 -0
- package/dist/models/Pageable.js +52 -0
- package/dist/models/PagedModelAgencyPeekViewResponse.d.ts +40 -0
- package/dist/models/PagedModelAgencyPeekViewResponse.js +52 -0
- package/dist/models/PagedModelInvitationViewResponse.d.ts +40 -0
- package/dist/models/PagedModelInvitationViewResponse.js +52 -0
- package/dist/models/PagedModelMemberViewResponse.d.ts +40 -0
- package/dist/models/PagedModelMemberViewResponse.js +52 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/docs/AgencyControllerApi.md +20 -41
- package/docs/AgencyPeekViewResponse.md +54 -0
- package/docs/AgencyQueryControllerApi.md +143 -0
- package/docs/InvitationControllerApi.md +3 -6
- package/docs/InvitationDetailsRequest.md +36 -0
- package/docs/InvitationDetailsResponse.md +44 -0
- package/docs/InvitationQueryControllerApi.md +78 -5
- package/docs/InviteMemberRequest.md +1 -1
- package/docs/MemberQueryControllerApi.md +78 -0
- package/docs/MemberViewResponse.md +48 -0
- package/docs/PageMetadata.md +40 -0
- package/docs/Pageable.md +38 -0
- package/docs/PagedModelAgencyPeekViewResponse.md +36 -0
- package/docs/PagedModelInvitationViewResponse.md +36 -0
- package/docs/PagedModelMemberViewResponse.md +36 -0
- package/package.json +1 -1
- package/src/apis/AgencyControllerApi.ts +10 -80
- package/src/apis/AgencyQueryControllerApi.ts +143 -0
- package/src/apis/InvitationControllerApi.ts +6 -13
- package/src/apis/InvitationQueryControllerApi.ts +91 -12
- package/src/apis/MemberQueryControllerApi.ts +102 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AgencyPeekViewResponse.ts +167 -0
- package/src/models/InvitationDetailsRequest.ts +75 -0
- package/src/models/InvitationDetailsResponse.ts +123 -0
- package/src/models/InviteMemberRequest.ts +12 -4
- package/src/models/MemberViewResponse.ts +128 -0
- package/src/models/PageMetadata.ts +89 -0
- package/src/models/Pageable.ts +81 -0
- package/src/models/PagedModelAgencyPeekViewResponse.ts +88 -0
- package/src/models/PagedModelInvitationViewResponse.ts +88 -0
- package/src/models/PagedModelMemberViewResponse.ts +88 -0
- package/src/models/index.ts +9 -0
package/dist/models/index.js
CHANGED
|
@@ -18,12 +18,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
18
18
|
/* eslint-disable */
|
|
19
19
|
__exportStar(require("./AddressRequest"), exports);
|
|
20
20
|
__exportStar(require("./AddressViewResponse"), exports);
|
|
21
|
+
__exportStar(require("./AgencyPeekViewResponse"), exports);
|
|
21
22
|
__exportStar(require("./AgencyViewResponse"), exports);
|
|
22
23
|
__exportStar(require("./CreateAgencyRequest"), exports);
|
|
23
24
|
__exportStar(require("./IdResponse"), exports);
|
|
25
|
+
__exportStar(require("./InvitationDetailsRequest"), exports);
|
|
26
|
+
__exportStar(require("./InvitationDetailsResponse"), exports);
|
|
24
27
|
__exportStar(require("./InvitationViewResponse"), exports);
|
|
25
28
|
__exportStar(require("./InviteMemberRequest"), exports);
|
|
29
|
+
__exportStar(require("./MemberViewResponse"), exports);
|
|
26
30
|
__exportStar(require("./OrganizationSummaryViewResponse"), exports);
|
|
31
|
+
__exportStar(require("./PageMetadata"), exports);
|
|
32
|
+
__exportStar(require("./Pageable"), exports);
|
|
33
|
+
__exportStar(require("./PagedModelAgencyPeekViewResponse"), exports);
|
|
34
|
+
__exportStar(require("./PagedModelInvitationViewResponse"), exports);
|
|
35
|
+
__exportStar(require("./PagedModelMemberViewResponse"), exports);
|
|
27
36
|
__exportStar(require("./PhotoRequest"), exports);
|
|
28
37
|
__exportStar(require("./PresignedUrlResponse"), exports);
|
|
29
38
|
__exportStar(require("./PresignedUrlsResponse"), exports);
|
|
@@ -5,15 +5,15 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**activateAgency**](AgencyControllerApi.md#activateagency) | **POST** /agency/{agencyId}/activate | |
|
|
8
|
-
| [**addRole**](AgencyControllerApi.md#addrole) | **POST** /agency/
|
|
9
|
-
| [**correctRegistrationDetails**](AgencyControllerApi.md#correctregistrationdetails) | **
|
|
8
|
+
| [**addRole**](AgencyControllerApi.md#addrole) | **POST** /agency/roles | |
|
|
9
|
+
| [**correctRegistrationDetails**](AgencyControllerApi.md#correctregistrationdetails) | **PUT** /agency/{agencyId}/details | |
|
|
10
10
|
| [**createAgency**](AgencyControllerApi.md#createagencyoperation) | **POST** /agency | |
|
|
11
|
-
| [**generatePresignedUrl**](AgencyControllerApi.md#generatepresignedurl) | **
|
|
12
|
-
| [**notifyCoverUploadCompletion**](AgencyControllerApi.md#notifycoveruploadcompletion) | **POST** /agency/
|
|
13
|
-
| [**notifyLogoUploadCompletion**](AgencyControllerApi.md#notifylogouploadcompletion) | **POST** /agency/
|
|
14
|
-
| [**removeRole**](AgencyControllerApi.md#removerole) | **DELETE** /agency/
|
|
15
|
-
| [**updateRole**](AgencyControllerApi.md#updaterole) | **PUT** /agency/
|
|
16
|
-
| [**updateSocialUrls**](AgencyControllerApi.md#updatesocialurls) | **PUT** /agency/
|
|
11
|
+
| [**generatePresignedUrl**](AgencyControllerApi.md#generatepresignedurl) | **POST** /agency/presigned-urls | |
|
|
12
|
+
| [**notifyCoverUploadCompletion**](AgencyControllerApi.md#notifycoveruploadcompletion) | **POST** /agency/presigned-urls/notify/cover | |
|
|
13
|
+
| [**notifyLogoUploadCompletion**](AgencyControllerApi.md#notifylogouploadcompletion) | **POST** /agency/presigned-urls/notify/logo | |
|
|
14
|
+
| [**removeRole**](AgencyControllerApi.md#removerole) | **DELETE** /agency/roles/{roleId} | |
|
|
15
|
+
| [**updateRole**](AgencyControllerApi.md#updaterole) | **PUT** /agency/roles/{roleId} | |
|
|
16
|
+
| [**updateSocialUrls**](AgencyControllerApi.md#updatesocialurls) | **PUT** /agency/social-media | |
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -81,14 +81,14 @@ example().catch(console.error);
|
|
|
81
81
|
### HTTP response details
|
|
82
82
|
| Status code | Description | Response headers |
|
|
83
83
|
|-------------|-------------|------------------|
|
|
84
|
-
| **
|
|
84
|
+
| **204** | No Content | - |
|
|
85
85
|
|
|
86
86
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
87
87
|
|
|
88
88
|
|
|
89
89
|
## addRole
|
|
90
90
|
|
|
91
|
-
> addRole(
|
|
91
|
+
> addRole(rolesRequest)
|
|
92
92
|
|
|
93
93
|
|
|
94
94
|
|
|
@@ -110,8 +110,6 @@ async function example() {
|
|
|
110
110
|
const api = new AgencyControllerApi(config);
|
|
111
111
|
|
|
112
112
|
const body = {
|
|
113
|
-
// string
|
|
114
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
115
113
|
// RolesRequest
|
|
116
114
|
rolesRequest: ...,
|
|
117
115
|
} satisfies AddRoleRequest;
|
|
@@ -133,7 +131,6 @@ example().catch(console.error);
|
|
|
133
131
|
|
|
134
132
|
| Name | Type | Description | Notes |
|
|
135
133
|
|------------- | ------------- | ------------- | -------------|
|
|
136
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
137
134
|
| **rolesRequest** | [RolesRequest](RolesRequest.md) | | |
|
|
138
135
|
|
|
139
136
|
### Return type
|
|
@@ -225,7 +222,7 @@ example().catch(console.error);
|
|
|
225
222
|
### HTTP response details
|
|
226
223
|
| Status code | Description | Response headers |
|
|
227
224
|
|-------------|-------------|------------------|
|
|
228
|
-
| **
|
|
225
|
+
| **204** | No Content | - |
|
|
229
226
|
|
|
230
227
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
231
228
|
|
|
@@ -301,7 +298,7 @@ example().catch(console.error);
|
|
|
301
298
|
|
|
302
299
|
## generatePresignedUrl
|
|
303
300
|
|
|
304
|
-
> PresignedUrlsResponse generatePresignedUrl(
|
|
301
|
+
> PresignedUrlsResponse generatePresignedUrl(photoRequest)
|
|
305
302
|
|
|
306
303
|
|
|
307
304
|
|
|
@@ -323,8 +320,6 @@ async function example() {
|
|
|
323
320
|
const api = new AgencyControllerApi(config);
|
|
324
321
|
|
|
325
322
|
const body = {
|
|
326
|
-
// string
|
|
327
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
328
323
|
// PhotoRequest
|
|
329
324
|
photoRequest: ...,
|
|
330
325
|
} satisfies GeneratePresignedUrlRequest;
|
|
@@ -346,7 +341,6 @@ example().catch(console.error);
|
|
|
346
341
|
|
|
347
342
|
| Name | Type | Description | Notes |
|
|
348
343
|
|------------- | ------------- | ------------- | -------------|
|
|
349
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
350
344
|
| **photoRequest** | [PhotoRequest](PhotoRequest.md) | | |
|
|
351
345
|
|
|
352
346
|
### Return type
|
|
@@ -373,7 +367,7 @@ example().catch(console.error);
|
|
|
373
367
|
|
|
374
368
|
## notifyCoverUploadCompletion
|
|
375
369
|
|
|
376
|
-
> UploadAcknowledgmentResponse notifyCoverUploadCompletion(
|
|
370
|
+
> UploadAcknowledgmentResponse notifyCoverUploadCompletion(photoRequest)
|
|
377
371
|
|
|
378
372
|
|
|
379
373
|
|
|
@@ -395,8 +389,6 @@ async function example() {
|
|
|
395
389
|
const api = new AgencyControllerApi(config);
|
|
396
390
|
|
|
397
391
|
const body = {
|
|
398
|
-
// string
|
|
399
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
400
392
|
// PhotoRequest
|
|
401
393
|
photoRequest: ...,
|
|
402
394
|
} satisfies NotifyCoverUploadCompletionRequest;
|
|
@@ -418,7 +410,6 @@ example().catch(console.error);
|
|
|
418
410
|
|
|
419
411
|
| Name | Type | Description | Notes |
|
|
420
412
|
|------------- | ------------- | ------------- | -------------|
|
|
421
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
422
413
|
| **photoRequest** | [PhotoRequest](PhotoRequest.md) | | |
|
|
423
414
|
|
|
424
415
|
### Return type
|
|
@@ -445,7 +436,7 @@ example().catch(console.error);
|
|
|
445
436
|
|
|
446
437
|
## notifyLogoUploadCompletion
|
|
447
438
|
|
|
448
|
-
> UploadAcknowledgmentResponse notifyLogoUploadCompletion(
|
|
439
|
+
> UploadAcknowledgmentResponse notifyLogoUploadCompletion(photoRequest)
|
|
449
440
|
|
|
450
441
|
|
|
451
442
|
|
|
@@ -467,8 +458,6 @@ async function example() {
|
|
|
467
458
|
const api = new AgencyControllerApi(config);
|
|
468
459
|
|
|
469
460
|
const body = {
|
|
470
|
-
// string
|
|
471
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
472
461
|
// PhotoRequest
|
|
473
462
|
photoRequest: ...,
|
|
474
463
|
} satisfies NotifyLogoUploadCompletionRequest;
|
|
@@ -490,7 +479,6 @@ example().catch(console.error);
|
|
|
490
479
|
|
|
491
480
|
| Name | Type | Description | Notes |
|
|
492
481
|
|------------- | ------------- | ------------- | -------------|
|
|
493
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
494
482
|
| **photoRequest** | [PhotoRequest](PhotoRequest.md) | | |
|
|
495
483
|
|
|
496
484
|
### Return type
|
|
@@ -517,7 +505,7 @@ example().catch(console.error);
|
|
|
517
505
|
|
|
518
506
|
## removeRole
|
|
519
507
|
|
|
520
|
-
> removeRole(
|
|
508
|
+
> removeRole(roleId)
|
|
521
509
|
|
|
522
510
|
|
|
523
511
|
|
|
@@ -539,8 +527,6 @@ async function example() {
|
|
|
539
527
|
const api = new AgencyControllerApi(config);
|
|
540
528
|
|
|
541
529
|
const body = {
|
|
542
|
-
// string
|
|
543
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
544
530
|
// number
|
|
545
531
|
roleId: 56,
|
|
546
532
|
} satisfies RemoveRoleRequest;
|
|
@@ -562,7 +548,6 @@ example().catch(console.error);
|
|
|
562
548
|
|
|
563
549
|
| Name | Type | Description | Notes |
|
|
564
550
|
|------------- | ------------- | ------------- | -------------|
|
|
565
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
566
551
|
| **roleId** | `number` | | [Defaults to `undefined`] |
|
|
567
552
|
|
|
568
553
|
### Return type
|
|
@@ -582,14 +567,14 @@ example().catch(console.error);
|
|
|
582
567
|
### HTTP response details
|
|
583
568
|
| Status code | Description | Response headers |
|
|
584
569
|
|-------------|-------------|------------------|
|
|
585
|
-
| **
|
|
570
|
+
| **204** | No Content | - |
|
|
586
571
|
|
|
587
572
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
588
573
|
|
|
589
574
|
|
|
590
575
|
## updateRole
|
|
591
576
|
|
|
592
|
-
> updateRole(
|
|
577
|
+
> updateRole(roleId, rolesRequest)
|
|
593
578
|
|
|
594
579
|
|
|
595
580
|
|
|
@@ -611,8 +596,6 @@ async function example() {
|
|
|
611
596
|
const api = new AgencyControllerApi(config);
|
|
612
597
|
|
|
613
598
|
const body = {
|
|
614
|
-
// string
|
|
615
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
616
599
|
// number
|
|
617
600
|
roleId: 56,
|
|
618
601
|
// RolesRequest
|
|
@@ -636,7 +619,6 @@ example().catch(console.error);
|
|
|
636
619
|
|
|
637
620
|
| Name | Type | Description | Notes |
|
|
638
621
|
|------------- | ------------- | ------------- | -------------|
|
|
639
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
640
622
|
| **roleId** | `number` | | [Defaults to `undefined`] |
|
|
641
623
|
| **rolesRequest** | [RolesRequest](RolesRequest.md) | | |
|
|
642
624
|
|
|
@@ -657,14 +639,14 @@ example().catch(console.error);
|
|
|
657
639
|
### HTTP response details
|
|
658
640
|
| Status code | Description | Response headers |
|
|
659
641
|
|-------------|-------------|------------------|
|
|
660
|
-
| **
|
|
642
|
+
| **204** | No Content | - |
|
|
661
643
|
|
|
662
644
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
663
645
|
|
|
664
646
|
|
|
665
647
|
## updateSocialUrls
|
|
666
648
|
|
|
667
|
-
> updateSocialUrls(
|
|
649
|
+
> updateSocialUrls(socialMediasRequest)
|
|
668
650
|
|
|
669
651
|
|
|
670
652
|
|
|
@@ -686,8 +668,6 @@ async function example() {
|
|
|
686
668
|
const api = new AgencyControllerApi(config);
|
|
687
669
|
|
|
688
670
|
const body = {
|
|
689
|
-
// string
|
|
690
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
691
671
|
// SocialMediasRequest
|
|
692
672
|
socialMediasRequest: ...,
|
|
693
673
|
} satisfies UpdateSocialUrlsRequest;
|
|
@@ -709,7 +689,6 @@ example().catch(console.error);
|
|
|
709
689
|
|
|
710
690
|
| Name | Type | Description | Notes |
|
|
711
691
|
|------------- | ------------- | ------------- | -------------|
|
|
712
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
713
692
|
| **socialMediasRequest** | [SocialMediasRequest](SocialMediasRequest.md) | | |
|
|
714
693
|
|
|
715
694
|
### Return type
|
|
@@ -729,7 +708,7 @@ example().catch(console.error);
|
|
|
729
708
|
### HTTP response details
|
|
730
709
|
| Status code | Description | Response headers |
|
|
731
710
|
|-------------|-------------|------------------|
|
|
732
|
-
| **
|
|
711
|
+
| **204** | No Content | - |
|
|
733
712
|
|
|
734
713
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
735
714
|
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
|
|
2
|
+
# AgencyPeekViewResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`owner` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`email` | string
|
|
13
|
+
`seats` | string
|
|
14
|
+
`subDomain` | string
|
|
15
|
+
`phone` | string
|
|
16
|
+
`website` | string
|
|
17
|
+
`yearSince` | string
|
|
18
|
+
`status` | string
|
|
19
|
+
`logo` | string
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { AgencyPeekViewResponse } from '@homespot-sdk/api'
|
|
25
|
+
|
|
26
|
+
// TODO: Update the object below with actual values
|
|
27
|
+
const example = {
|
|
28
|
+
"id": null,
|
|
29
|
+
"owner": null,
|
|
30
|
+
"name": null,
|
|
31
|
+
"email": null,
|
|
32
|
+
"seats": null,
|
|
33
|
+
"subDomain": null,
|
|
34
|
+
"phone": null,
|
|
35
|
+
"website": null,
|
|
36
|
+
"yearSince": null,
|
|
37
|
+
"status": null,
|
|
38
|
+
"logo": null,
|
|
39
|
+
} satisfies AgencyPeekViewResponse
|
|
40
|
+
|
|
41
|
+
console.log(example)
|
|
42
|
+
|
|
43
|
+
// Convert the instance to a JSON string
|
|
44
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
45
|
+
console.log(exampleJSON)
|
|
46
|
+
|
|
47
|
+
// Parse the JSON string back to an object
|
|
48
|
+
const exampleParsed = JSON.parse(exampleJSON) as AgencyPeekViewResponse
|
|
49
|
+
console.log(exampleParsed)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
53
|
+
|
|
54
|
+
|
|
@@ -5,6 +5,8 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**getAgency**](AgencyQueryControllerApi.md#getagency) | **GET** /agency/{agencyId} | |
|
|
8
|
+
| [**getAgencyBySubdomain**](AgencyQueryControllerApi.md#getagencybysubdomain) | **GET** /agency/subdomain/{subDomain} | |
|
|
9
|
+
| [**getAllAgencies**](AgencyQueryControllerApi.md#getallagencies) | **GET** /agency | |
|
|
8
10
|
|
|
9
11
|
|
|
10
12
|
|
|
@@ -76,3 +78,144 @@ example().catch(console.error);
|
|
|
76
78
|
|
|
77
79
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
78
80
|
|
|
81
|
+
|
|
82
|
+
## getAgencyBySubdomain
|
|
83
|
+
|
|
84
|
+
> AgencyPeekViewResponse getAgencyBySubdomain(subDomain)
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
### Example
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import {
|
|
92
|
+
Configuration,
|
|
93
|
+
AgencyQueryControllerApi,
|
|
94
|
+
} from '@homespot-sdk/api';
|
|
95
|
+
import type { GetAgencyBySubdomainRequest } from '@homespot-sdk/api';
|
|
96
|
+
|
|
97
|
+
async function example() {
|
|
98
|
+
console.log("🚀 Testing @homespot-sdk/api SDK...");
|
|
99
|
+
const config = new Configuration({
|
|
100
|
+
// To configure OAuth2 access token for authorization: keycloak accessCode
|
|
101
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
102
|
+
});
|
|
103
|
+
const api = new AgencyQueryControllerApi(config);
|
|
104
|
+
|
|
105
|
+
const body = {
|
|
106
|
+
// string
|
|
107
|
+
subDomain: subDomain_example,
|
|
108
|
+
} satisfies GetAgencyBySubdomainRequest;
|
|
109
|
+
|
|
110
|
+
try {
|
|
111
|
+
const data = await api.getAgencyBySubdomain(body);
|
|
112
|
+
console.log(data);
|
|
113
|
+
} catch (error) {
|
|
114
|
+
console.error(error);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
// Run the test
|
|
119
|
+
example().catch(console.error);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
| Name | Type | Description | Notes |
|
|
126
|
+
|------------- | ------------- | ------------- | -------------|
|
|
127
|
+
| **subDomain** | `string` | | [Defaults to `undefined`] |
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
[**AgencyPeekViewResponse**](AgencyPeekViewResponse.md)
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
[keycloak accessCode](../README.md#keycloak-accessCode)
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: Not defined
|
|
140
|
+
- **Accept**: `*/*`
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### HTTP response details
|
|
144
|
+
| Status code | Description | Response headers |
|
|
145
|
+
|-------------|-------------|------------------|
|
|
146
|
+
| **200** | OK | - |
|
|
147
|
+
|
|
148
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
## getAllAgencies
|
|
152
|
+
|
|
153
|
+
> PagedModelAgencyPeekViewResponse getAllAgencies(pageable, status)
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
### Example
|
|
158
|
+
|
|
159
|
+
```ts
|
|
160
|
+
import {
|
|
161
|
+
Configuration,
|
|
162
|
+
AgencyQueryControllerApi,
|
|
163
|
+
} from '@homespot-sdk/api';
|
|
164
|
+
import type { GetAllAgenciesRequest } from '@homespot-sdk/api';
|
|
165
|
+
|
|
166
|
+
async function example() {
|
|
167
|
+
console.log("🚀 Testing @homespot-sdk/api SDK...");
|
|
168
|
+
const config = new Configuration({
|
|
169
|
+
// To configure OAuth2 access token for authorization: keycloak accessCode
|
|
170
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
171
|
+
});
|
|
172
|
+
const api = new AgencyQueryControllerApi(config);
|
|
173
|
+
|
|
174
|
+
const body = {
|
|
175
|
+
// Pageable
|
|
176
|
+
pageable: ...,
|
|
177
|
+
// 'NEW' | 'ACTIVE' | 'PAYMENT_FAILED' | 'INACTIVE' (optional)
|
|
178
|
+
status: status_example,
|
|
179
|
+
} satisfies GetAllAgenciesRequest;
|
|
180
|
+
|
|
181
|
+
try {
|
|
182
|
+
const data = await api.getAllAgencies(body);
|
|
183
|
+
console.log(data);
|
|
184
|
+
} catch (error) {
|
|
185
|
+
console.error(error);
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
// Run the test
|
|
190
|
+
example().catch(console.error);
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Parameters
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
| Name | Type | Description | Notes |
|
|
197
|
+
|------------- | ------------- | ------------- | -------------|
|
|
198
|
+
| **pageable** | [](.md) | | [Defaults to `undefined`] |
|
|
199
|
+
| **status** | `NEW`, `ACTIVE`, `PAYMENT_FAILED`, `INACTIVE` | | [Optional] [Defaults to `undefined`] [Enum: NEW, ACTIVE, PAYMENT_FAILED, INACTIVE] |
|
|
200
|
+
|
|
201
|
+
### Return type
|
|
202
|
+
|
|
203
|
+
[**PagedModelAgencyPeekViewResponse**](PagedModelAgencyPeekViewResponse.md)
|
|
204
|
+
|
|
205
|
+
### Authorization
|
|
206
|
+
|
|
207
|
+
[keycloak accessCode](../README.md#keycloak-accessCode)
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: Not defined
|
|
212
|
+
- **Accept**: `*/*`
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
### HTTP response details
|
|
216
|
+
| Status code | Description | Response headers |
|
|
217
|
+
|-------------|-------------|------------------|
|
|
218
|
+
| **200** | OK | - |
|
|
219
|
+
|
|
220
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
221
|
+
|
|
@@ -4,8 +4,8 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**inviteAccepted**](InvitationControllerApi.md#inviteaccepted) | **POST** /
|
|
8
|
-
| [**inviteMember**](InvitationControllerApi.md#invitememberoperation) | **POST** /
|
|
7
|
+
| [**inviteAccepted**](InvitationControllerApi.md#inviteaccepted) | **POST** /invitation/{invitationId} | |
|
|
8
|
+
| [**inviteMember**](InvitationControllerApi.md#invitememberoperation) | **POST** /invitation | |
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
|
|
@@ -83,7 +83,7 @@ example().catch(console.error);
|
|
|
83
83
|
|
|
84
84
|
## inviteMember
|
|
85
85
|
|
|
86
|
-
> inviteMember(
|
|
86
|
+
> inviteMember(inviteMemberRequest)
|
|
87
87
|
|
|
88
88
|
|
|
89
89
|
|
|
@@ -105,8 +105,6 @@ async function example() {
|
|
|
105
105
|
const api = new InvitationControllerApi(config);
|
|
106
106
|
|
|
107
107
|
const body = {
|
|
108
|
-
// string
|
|
109
|
-
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
110
108
|
// InviteMemberRequest
|
|
111
109
|
inviteMemberRequest: ...,
|
|
112
110
|
} satisfies InviteMemberOperationRequest;
|
|
@@ -128,7 +126,6 @@ example().catch(console.error);
|
|
|
128
126
|
|
|
129
127
|
| Name | Type | Description | Notes |
|
|
130
128
|
|------------- | ------------- | ------------- | -------------|
|
|
131
|
-
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
132
129
|
| **inviteMemberRequest** | [InviteMemberRequest](InviteMemberRequest.md) | | |
|
|
133
130
|
|
|
134
131
|
### Return type
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# InvitationDetailsRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`email` | string
|
|
10
|
+
`roleId` | number
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { InvitationDetailsRequest } from '@homespot-sdk/api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"email": null,
|
|
20
|
+
"roleId": null,
|
|
21
|
+
} satisfies InvitationDetailsRequest
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as InvitationDetailsRequest
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# InvitationDetailsResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`invitationId` | string
|
|
10
|
+
`agencyId` | string
|
|
11
|
+
`email` | string
|
|
12
|
+
`status` | string
|
|
13
|
+
`agencyName` | string
|
|
14
|
+
`agencyLogo` | string
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { InvitationDetailsResponse } from '@homespot-sdk/api'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"invitationId": null,
|
|
24
|
+
"agencyId": null,
|
|
25
|
+
"email": null,
|
|
26
|
+
"status": null,
|
|
27
|
+
"agencyName": null,
|
|
28
|
+
"agencyLogo": null,
|
|
29
|
+
} satisfies InvitationDetailsResponse
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as InvitationDetailsResponse
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
|
@@ -4,13 +4,14 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**getAllInvitations**](InvitationQueryControllerApi.md#getallinvitations) | **GET** /
|
|
7
|
+
| [**getAllInvitations**](InvitationQueryControllerApi.md#getallinvitations) | **GET** /invitation | |
|
|
8
|
+
| [**getInvitationDetails**](InvitationQueryControllerApi.md#getinvitationdetails) | **GET** /invitation/{invitationId} | |
|
|
8
9
|
|
|
9
10
|
|
|
10
11
|
|
|
11
12
|
## getAllInvitations
|
|
12
13
|
|
|
13
|
-
>
|
|
14
|
+
> PagedModelInvitationViewResponse getAllInvitations(pageable)
|
|
14
15
|
|
|
15
16
|
|
|
16
17
|
|
|
@@ -32,8 +33,8 @@ async function example() {
|
|
|
32
33
|
const api = new InvitationQueryControllerApi(config);
|
|
33
34
|
|
|
34
35
|
const body = {
|
|
35
|
-
//
|
|
36
|
-
|
|
36
|
+
// Pageable
|
|
37
|
+
pageable: ...,
|
|
37
38
|
} satisfies GetAllInvitationsRequest;
|
|
38
39
|
|
|
39
40
|
try {
|
|
@@ -53,11 +54,83 @@ example().catch(console.error);
|
|
|
53
54
|
|
|
54
55
|
| Name | Type | Description | Notes |
|
|
55
56
|
|------------- | ------------- | ------------- | -------------|
|
|
57
|
+
| **pageable** | [](.md) | | [Defaults to `undefined`] |
|
|
58
|
+
|
|
59
|
+
### Return type
|
|
60
|
+
|
|
61
|
+
[**PagedModelInvitationViewResponse**](PagedModelInvitationViewResponse.md)
|
|
62
|
+
|
|
63
|
+
### Authorization
|
|
64
|
+
|
|
65
|
+
[keycloak accessCode](../README.md#keycloak-accessCode)
|
|
66
|
+
|
|
67
|
+
### HTTP request headers
|
|
68
|
+
|
|
69
|
+
- **Content-Type**: Not defined
|
|
70
|
+
- **Accept**: `*/*`
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
### HTTP response details
|
|
74
|
+
| Status code | Description | Response headers |
|
|
75
|
+
|-------------|-------------|------------------|
|
|
76
|
+
| **200** | OK | - |
|
|
77
|
+
|
|
78
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
## getInvitationDetails
|
|
82
|
+
|
|
83
|
+
> InvitationDetailsResponse getInvitationDetails(invitationId, agencyId)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
### Example
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
import {
|
|
91
|
+
Configuration,
|
|
92
|
+
InvitationQueryControllerApi,
|
|
93
|
+
} from '@homespot-sdk/api';
|
|
94
|
+
import type { GetInvitationDetailsRequest } from '@homespot-sdk/api';
|
|
95
|
+
|
|
96
|
+
async function example() {
|
|
97
|
+
console.log("🚀 Testing @homespot-sdk/api SDK...");
|
|
98
|
+
const config = new Configuration({
|
|
99
|
+
// To configure OAuth2 access token for authorization: keycloak accessCode
|
|
100
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
101
|
+
});
|
|
102
|
+
const api = new InvitationQueryControllerApi(config);
|
|
103
|
+
|
|
104
|
+
const body = {
|
|
105
|
+
// string
|
|
106
|
+
invitationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
107
|
+
// string
|
|
108
|
+
agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
109
|
+
} satisfies GetInvitationDetailsRequest;
|
|
110
|
+
|
|
111
|
+
try {
|
|
112
|
+
const data = await api.getInvitationDetails(body);
|
|
113
|
+
console.log(data);
|
|
114
|
+
} catch (error) {
|
|
115
|
+
console.error(error);
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
// Run the test
|
|
120
|
+
example().catch(console.error);
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
| Name | Type | Description | Notes |
|
|
127
|
+
|------------- | ------------- | ------------- | -------------|
|
|
128
|
+
| **invitationId** | `string` | | [Defaults to `undefined`] |
|
|
56
129
|
| **agencyId** | `string` | | [Defaults to `undefined`] |
|
|
57
130
|
|
|
58
131
|
### Return type
|
|
59
132
|
|
|
60
|
-
[**
|
|
133
|
+
[**InvitationDetailsResponse**](InvitationDetailsResponse.md)
|
|
61
134
|
|
|
62
135
|
### Authorization
|
|
63
136
|
|