@gooday_corp/gooday-api-client 3.4.0 → 4.1.17

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/base.ts CHANGED
@@ -21,10 +21,6 @@ import globalAxios from 'axios';
21
21
 
22
22
  export const BASE_PATH = "http://localhost:8080".replace(/\/+$/, "");
23
23
 
24
- /**
25
- *
26
- * @export
27
- */
28
24
  export const COLLECTION_FORMATS = {
29
25
  csv: ",",
30
26
  ssv: " ",
@@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = {
32
28
  pipes: "|",
33
29
  };
34
30
 
35
- /**
36
- *
37
- * @export
38
- * @interface RequestArgs
39
- */
40
31
  export interface RequestArgs {
41
32
  url: string;
42
33
  options: RawAxiosRequestConfig;
43
34
  }
44
35
 
45
- /**
46
- *
47
- * @export
48
- * @class BaseAPI
49
- */
50
36
  export class BaseAPI {
51
37
  protected configuration: Configuration | undefined;
52
38
 
@@ -58,12 +44,6 @@ export class BaseAPI {
58
44
  }
59
45
  };
60
46
 
61
- /**
62
- *
63
- * @export
64
- * @class RequiredError
65
- * @extends {Error}
66
- */
67
47
  export class RequiredError extends Error {
68
48
  constructor(public field: string, msg?: string) {
69
49
  super(msg);
@@ -78,9 +58,5 @@ interface ServerMap {
78
58
  }[];
79
59
  }
80
60
 
81
- /**
82
- *
83
- * @export
84
- */
85
61
  export const operationServerMap: ServerMap = {
86
62
  }
package/common.ts CHANGED
@@ -12,22 +12,16 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
 
15
-
16
15
  import type { Configuration } from "./configuration";
17
16
  import type { RequestArgs } from "./base";
18
17
  import type { AxiosInstance, AxiosResponse } from 'axios';
19
18
  import { RequiredError } from "./base";
20
19
 
21
- /**
22
- *
23
- * @export
24
- */
25
20
  export const DUMMY_BASE_URL = 'https://example.com'
26
21
 
27
22
  /**
28
23
  *
29
24
  * @throws {RequiredError}
30
- * @export
31
25
  */
32
26
  export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
33
27
  if (paramValue === null || paramValue === undefined) {
@@ -35,10 +29,6 @@ export const assertParamExists = function (functionName: string, paramName: stri
35
29
  }
36
30
  }
37
31
 
38
- /**
39
- *
40
- * @export
41
- */
42
32
  export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
43
33
  if (configuration && configuration.apiKey) {
44
34
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -48,20 +38,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri
48
38
  }
49
39
  }
50
40
 
51
- /**
52
- *
53
- * @export
54
- */
55
41
  export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
56
42
  if (configuration && (configuration.username || configuration.password)) {
57
43
  object["auth"] = { username: configuration.username, password: configuration.password };
58
44
  }
59
45
  }
60
46
 
61
- /**
62
- *
63
- * @export
64
- */
65
47
  export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
66
48
  if (configuration && configuration.accessToken) {
67
49
  const accessToken = typeof configuration.accessToken === 'function'
@@ -71,10 +53,6 @@ export const setBearerAuthToObject = async function (object: any, configuration?
71
53
  }
72
54
  }
73
55
 
74
- /**
75
- *
76
- * @export
77
- */
78
56
  export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
79
57
  if (configuration && configuration.accessToken) {
80
58
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -84,6 +62,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope
84
62
  }
85
63
  }
86
64
 
65
+
87
66
  function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
88
67
  if (parameter == null) return;
89
68
  if (typeof parameter === "object") {
@@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
106
85
  }
107
86
  }
108
87
 
109
- /**
110
- *
111
- * @export
112
- */
113
88
  export const setSearchParams = function (url: URL, ...objects: any[]) {
114
89
  const searchParams = new URLSearchParams(url.search);
115
90
  setFlattenedQueryParams(searchParams, objects);
116
91
  url.search = searchParams.toString();
117
92
  }
118
93
 
119
- /**
120
- *
121
- * @export
122
- */
123
94
  export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
124
95
  const nonString = typeof value !== 'string';
125
96
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any,
130
101
  : (value || "");
131
102
  }
132
103
 
133
- /**
134
- *
135
- * @export
136
- */
137
104
  export const toPathString = function (url: URL) {
138
105
  return url.pathname + url.search + url.hash
139
106
  }
140
107
 
141
- /**
142
- *
143
- * @export
144
- */
145
108
  export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
146
109
  return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
147
110
  const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
package/configuration.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  /* tslint:disable */
2
- /* eslint-disable */
3
2
  /**
4
3
  * Gooday
5
4
  * Gooday API Documentation
@@ -12,12 +11,24 @@
12
11
  * Do not edit the class manually.
13
12
  */
14
13
 
14
+ interface AWSv4Configuration {
15
+ options?: {
16
+ region?: string
17
+ service?: string
18
+ }
19
+ credentials?: {
20
+ accessKeyId?: string
21
+ secretAccessKey?: string,
22
+ sessionToken?: string
23
+ }
24
+ }
15
25
 
16
26
  export interface ConfigurationParameters {
17
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
18
28
  username?: string;
19
29
  password?: string;
20
30
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
31
+ awsv4?: AWSv4Configuration;
21
32
  basePath?: string;
22
33
  serverIndex?: number;
23
34
  baseOptions?: any;
@@ -28,49 +39,43 @@ export class Configuration {
28
39
  /**
29
40
  * parameter for apiKey security
30
41
  * @param name security name
31
- * @memberof Configuration
32
42
  */
33
43
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
34
44
  /**
35
45
  * parameter for basic security
36
- *
37
- * @type {string}
38
- * @memberof Configuration
39
46
  */
40
47
  username?: string;
41
48
  /**
42
49
  * parameter for basic security
43
- *
44
- * @type {string}
45
- * @memberof Configuration
46
50
  */
47
51
  password?: string;
48
52
  /**
49
53
  * parameter for oauth2 security
50
54
  * @param name security name
51
55
  * @param scopes oauth2 scope
52
- * @memberof Configuration
53
56
  */
54
57
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
55
58
  /**
56
- * override base path
57
- *
58
- * @type {string}
59
+ * parameter for aws4 signature security
60
+ * @param {Object} AWS4Signature - AWS4 Signature security
61
+ * @param {string} options.region - aws region
62
+ * @param {string} options.service - name of the service.
63
+ * @param {string} credentials.accessKeyId - aws access key id
64
+ * @param {string} credentials.secretAccessKey - aws access key
65
+ * @param {string} credentials.sessionToken - aws session token
59
66
  * @memberof Configuration
60
67
  */
68
+ awsv4?: AWSv4Configuration;
69
+ /**
70
+ * override base path
71
+ */
61
72
  basePath?: string;
62
73
  /**
63
74
  * override server index
64
- *
65
- * @type {number}
66
- * @memberof Configuration
67
75
  */
68
76
  serverIndex?: number;
69
77
  /**
70
78
  * base options for axios calls
71
- *
72
- * @type {any}
73
- * @memberof Configuration
74
79
  */
75
80
  baseOptions?: any;
76
81
  /**
@@ -87,6 +92,7 @@ export class Configuration {
87
92
  this.username = param.username;
88
93
  this.password = param.password;
89
94
  this.accessToken = param.accessToken;
95
+ this.awsv4 = param.awsv4;
90
96
  this.basePath = param.basePath;
91
97
  this.serverIndex = param.serverIndex;
92
98
  this.baseOptions = {
@@ -31,7 +31,9 @@ Name | Type | Description | Notes
31
31
  **paymentMethod** | [**BookingPaymentCreateResponse**](BookingPaymentCreateResponse.md) | | [default to undefined]
32
32
  **tags** | [**Array&lt;TagsResponse&gt;**](TagsResponse.md) | | [default to undefined]
33
33
  **whatsOn** | [**WhatsOnEntity**](WhatsOnEntity.md) | | [default to undefined]
34
+ **walking** | **object** | | [default to undefined]
34
35
  **cancellationFee** | **object** | Cancellation fee | [optional] [default to undefined]
36
+ **images** | **Array&lt;string&gt;** | | [optional] [default to undefined]
35
37
 
36
38
  ## Example
37
39
 
@@ -65,7 +67,9 @@ const instance: BookingEntity = {
65
67
  paymentMethod,
66
68
  tags,
67
69
  whatsOn,
70
+ walking,
68
71
  cancellationFee,
72
+ images,
69
73
  };
70
74
  ```
71
75
 
@@ -26,7 +26,9 @@ Name | Type | Description | Notes
26
26
  **serviceId** | [**PrepaidServiceEntity**](PrepaidServiceEntity.md) | | [default to undefined]
27
27
  **paymentMethod** | [**BookingPaymentCreateResponse**](BookingPaymentCreateResponse.md) | | [default to undefined]
28
28
  **whatsOn** | **string** | | [default to undefined]
29
+ **walking** | **object** | | [default to undefined]
29
30
  **selectedStaff** | [**BusinessStaffEntity**](BusinessStaffEntity.md) | Staff members involved in the booking | [default to undefined]
31
+ **images** | **Array&lt;string&gt;** | | [optional] [default to undefined]
30
32
 
31
33
  ## Example
32
34
 
@@ -55,7 +57,9 @@ const instance: BookingResponse = {
55
57
  serviceId,
56
58
  paymentMethod,
57
59
  whatsOn,
60
+ walking,
58
61
  selectedStaff,
62
+ images,
59
63
  };
60
64
  ```
61
65
 
@@ -0,0 +1,24 @@
1
+ # ChannelCreateMultipleUsersPayload
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **userId** | **Array&lt;string&gt;** | | [default to undefined]
9
+ **profile** | **string** | | [optional] [default to undefined]
10
+ **name** | **string** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ChannelCreateMultipleUsersPayload } from './api';
16
+
17
+ const instance: ChannelCreateMultipleUsersPayload = {
18
+ userId,
19
+ profile,
20
+ name,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ChannelCreatePayload
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **userId** | **string** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ChannelCreatePayload } from './api';
14
+
15
+ const instance: ChannelCreatePayload = {
16
+ userId,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,111 @@
1
+ # ChatMessagingApi
2
+
3
+ All URIs are relative to *http://localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**chatControllerChannelCreate**](#chatcontrollerchannelcreate) | **POST** /v1/chat-messaging | |
8
+ |[**chatControllerChannelCreateMultipleUsers**](#chatcontrollerchannelcreatemultipleusers) | **POST** /v1/chat-messaging/multiple-members | |
9
+
10
+ # **chatControllerChannelCreate**
11
+ > ChatResponseDTO chatControllerChannelCreate(channelCreatePayload)
12
+
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ ChatMessagingApi,
19
+ Configuration,
20
+ ChannelCreatePayload
21
+ } from './api';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new ChatMessagingApi(configuration);
25
+
26
+ let channelCreatePayload: ChannelCreatePayload; //
27
+
28
+ const { status, data } = await apiInstance.chatControllerChannelCreate(
29
+ channelCreatePayload
30
+ );
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **channelCreatePayload** | **ChannelCreatePayload**| | |
38
+
39
+
40
+ ### Return type
41
+
42
+ **ChatResponseDTO**
43
+
44
+ ### Authorization
45
+
46
+ [bearer](../README.md#bearer)
47
+
48
+ ### HTTP request headers
49
+
50
+ - **Content-Type**: application/json
51
+ - **Accept**: application/json
52
+
53
+
54
+ ### HTTP response details
55
+ | Status code | Description | Response headers |
56
+ |-------------|-------------|------------------|
57
+ |**200** | | - |
58
+
59
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
60
+
61
+ # **chatControllerChannelCreateMultipleUsers**
62
+ > ChatResponseDTO chatControllerChannelCreateMultipleUsers(channelCreateMultipleUsersPayload)
63
+
64
+
65
+ ### Example
66
+
67
+ ```typescript
68
+ import {
69
+ ChatMessagingApi,
70
+ Configuration,
71
+ ChannelCreateMultipleUsersPayload
72
+ } from './api';
73
+
74
+ const configuration = new Configuration();
75
+ const apiInstance = new ChatMessagingApi(configuration);
76
+
77
+ let channelCreateMultipleUsersPayload: ChannelCreateMultipleUsersPayload; //
78
+
79
+ const { status, data } = await apiInstance.chatControllerChannelCreateMultipleUsers(
80
+ channelCreateMultipleUsersPayload
81
+ );
82
+ ```
83
+
84
+ ### Parameters
85
+
86
+ |Name | Type | Description | Notes|
87
+ |------------- | ------------- | ------------- | -------------|
88
+ | **channelCreateMultipleUsersPayload** | **ChannelCreateMultipleUsersPayload**| | |
89
+
90
+
91
+ ### Return type
92
+
93
+ **ChatResponseDTO**
94
+
95
+ ### Authorization
96
+
97
+ [bearer](../README.md#bearer)
98
+
99
+ ### HTTP request headers
100
+
101
+ - **Content-Type**: application/json
102
+ - **Accept**: application/json
103
+
104
+
105
+ ### HTTP response details
106
+ | Status code | Description | Response headers |
107
+ |-------------|-------------|------------------|
108
+ |**200** | | - |
109
+
110
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
111
+
@@ -0,0 +1,22 @@
1
+ # ChatResponseDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **statusCode** | **number** | statusCode | [default to undefined]
9
+ **success** | **boolean** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ChatResponseDTO } from './api';
15
+
16
+ const instance: ChatResponseDTO = {
17
+ statusCode,
18
+ success,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -6,8 +6,8 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **title** | **string** | The title of the booking | [default to 'Default Booking Title']
9
- **date** | **string** | The start date of the booking | [default to 2025-09-22T16:00:07+05:30]
10
- **recurrenceEndDate** | **string** | The start date of the booking | [optional] [default to 2025-09-22T16:00:07+05:30]
9
+ **date** | **string** | The start date of the booking | [default to 2025-11-18T12:27:32+05:30]
10
+ **recurrenceEndDate** | **string** | The start date of the booking | [optional] [default to 2025-11-18T12:27:32+05:30]
11
11
  **from** | **string** | | [optional] [default to undefined]
12
12
  **to** | **string** | | [optional] [default to undefined]
13
13
  **venue** | **string** | The venue of the booking | [default to undefined]
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
27
27
  **serviceId** | **string** | | [optional] [default to undefined]
28
28
  **paymentMethod** | [**BookingPaymentCreateResponse**](BookingPaymentCreateResponse.md) | | [optional] [default to undefined]
29
29
  **discountId** | **string** | | [optional] [default to undefined]
30
+ **images** | **Array&lt;string&gt;** | | [optional] [default to undefined]
30
31
 
31
32
  ## Example
32
33
 
@@ -56,6 +57,7 @@ const instance: CreateBookingPayload = {
56
57
  serviceId,
57
58
  paymentMethod,
58
59
  discountId,
60
+ images,
59
61
  };
60
62
  ```
61
63
 
@@ -6,8 +6,8 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **title** | **string** | The title of the booking | [default to 'Default Booking Title']
9
- **startDate** | **string** | The start date of the booking | [default to 2025-09-22T16:00:07+05:30]
10
- **endDate** | **string** | The start date of the booking | [default to 2025-09-22T16:00:07+05:30]
9
+ **startDate** | **string** | The start date of the booking | [default to 2025-11-18T12:27:32+05:30]
10
+ **endDate** | **string** | The start date of the booking | [default to 2025-11-18T12:27:32+05:30]
11
11
  **note** | **string** | Notes attached with booking | [optional] [default to undefined]
12
12
  **occasion** | **string** | Occasion id | [optional] [default to undefined]
13
13
  **calendar** | **Array&lt;string&gt;** | Calendar attached with booking | [optional] [default to undefined]
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **tags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
18
18
  **quantity** | **number** | | [default to undefined]
19
19
  **walking** | **object** | | [default to undefined]
20
+ **images** | **Array&lt;string&gt;** | | [default to undefined]
20
21
 
21
22
  ## Example
22
23
 
@@ -36,6 +37,7 @@ const instance: CreateWalkInBookingPayload = {
36
37
  tags,
37
38
  quantity,
38
39
  walking,
40
+ images,
39
41
  };
40
42
  ```
41
43
 
@@ -0,0 +1,22 @@
1
+ # FindUsersResponseDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **statusCode** | **number** | statusCode | [default to undefined]
9
+ **data** | [**Array&lt;UserEntity&gt;**](UserEntity.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { FindUsersResponseDTO } from './api';
15
+
16
+ const instance: FindUsersResponseDTO = {
17
+ statusCode,
18
+ data,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -6,7 +6,9 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **accessToken** | **string** | accessToken | [default to undefined]
9
+ **idToken** | **string** | accessToken | [optional] [default to undefined]
9
10
  **refreshToken** | **string** | refreshToken | [default to undefined]
11
+ **expiryTime** | **string** | refreshToken | [optional] [default to undefined]
10
12
 
11
13
  ## Example
12
14
 
@@ -15,7 +17,9 @@ import { MicrosoftCalendarAccessDTO } from './api';
15
17
 
16
18
  const instance: MicrosoftCalendarAccessDTO = {
17
19
  accessToken,
20
+ idToken,
18
21
  refreshToken,
22
+ expiryTime,
19
23
  };
20
24
  ```
21
25
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **date** | **string** | The start date of the booking | [default to 2025-09-22T16:00:07+05:30]
8
+ **date** | **string** | The start date of the booking | [default to 2025-11-18T12:27:32+05:30]
9
9
  **from** | **string** | | [optional] [default to undefined]
10
10
  **to** | **string** | | [optional] [default to undefined]
11
11
  **notes** | **string** | | [optional] [default to undefined]
@@ -36,6 +36,7 @@ Name | Type | Description | Notes
36
36
  **friends** | **Array&lt;string&gt;** | | [default to undefined]
37
37
  **isContactShow** | **boolean** | Contact popup show | [default to false]
38
38
  **timezone** | **string** | | [optional] [default to undefined]
39
+ **chatToken** | **string** | | [optional] [default to undefined]
39
40
 
40
41
  ## Example
41
42
 
@@ -74,6 +75,7 @@ const instance: UserEntity = {
74
75
  friends,
75
76
  isContactShow,
76
77
  timezone,
78
+ chatToken,
77
79
  };
78
80
  ```
79
81
 
package/docs/UsersApi.md CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8080*
8
8
  |[**usersControllerAddToWaitingList**](#userscontrolleraddtowaitinglist) | **POST** /v1/user/joining-list | |
9
9
  |[**usersControllerDeactivateAccount**](#userscontrollerdeactivateaccount) | **DELETE** /v1/user/deactivate | |
10
10
  |[**usersControllerFindFriendConfirmedVenueList**](#userscontrollerfindfriendconfirmedvenuelist) | **GET** /v1/user/venue/favorites/user | |
11
+ |[**usersControllerFindUsers**](#userscontrollerfindusers) | **GET** /v1/user/users | |
11
12
  |[**usersControllerGetMe**](#userscontrollergetme) | **GET** /v1/user/me | |
12
13
  |[**usersControllerGetUser**](#userscontrollergetuser) | **POST** /v1/user/get-user | |
13
14
  |[**usersControllerOnBoarded**](#userscontrolleronboarded) | **POST** /v1/user/onboarding | |
@@ -198,6 +199,62 @@ const { status, data } = await apiInstance.usersControllerFindFriendConfirmedVen
198
199
  - **Accept**: application/json
199
200
 
200
201
 
202
+ ### HTTP response details
203
+ | Status code | Description | Response headers |
204
+ |-------------|-------------|------------------|
205
+ |**200** | | - |
206
+
207
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
208
+
209
+ # **usersControllerFindUsers**
210
+ > FindUsersResponseDTO usersControllerFindUsers()
211
+
212
+
213
+ ### Example
214
+
215
+ ```typescript
216
+ import {
217
+ UsersApi,
218
+ Configuration
219
+ } from './api';
220
+
221
+ const configuration = new Configuration();
222
+ const apiInstance = new UsersApi(configuration);
223
+
224
+ let page: number; // (default to undefined)
225
+ let pageSize: number; // (default to undefined)
226
+ let query: string; // (optional) (default to undefined)
227
+
228
+ const { status, data } = await apiInstance.usersControllerFindUsers(
229
+ page,
230
+ pageSize,
231
+ query
232
+ );
233
+ ```
234
+
235
+ ### Parameters
236
+
237
+ |Name | Type | Description | Notes|
238
+ |------------- | ------------- | ------------- | -------------|
239
+ | **page** | [**number**] | | defaults to undefined|
240
+ | **pageSize** | [**number**] | | defaults to undefined|
241
+ | **query** | [**string**] | | (optional) defaults to undefined|
242
+
243
+
244
+ ### Return type
245
+
246
+ **FindUsersResponseDTO**
247
+
248
+ ### Authorization
249
+
250
+ [bearer](../README.md#bearer)
251
+
252
+ ### HTTP request headers
253
+
254
+ - **Content-Type**: Not defined
255
+ - **Accept**: application/json
256
+
257
+
201
258
  ### HTTP response details
202
259
  | Status code | Description | Response headers |
203
260
  |-------------|-------------|------------------|