@gooday_corp/gooday-api-client 2.3.1 → 3.3.3

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 (12) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/api.ts +6310 -25
  4. package/base.ts +24 -0
  5. package/common.ts +37 -0
  6. package/configuration.ts +17 -0
  7. package/docs/BookingApi.md +8 -8
  8. package/docs/CreateBookingPayload.md +2 -2
  9. package/docs/CreateWalkInBookingPayload.md +42 -0
  10. package/docs/RescheduleBookingPayload.md +1 -1
  11. package/docs/WaitlistPayloadDTO.md +2 -2
  12. package/package.json +1 -1
package/base.ts CHANGED
@@ -21,6 +21,10 @@ import globalAxios from 'axios';
21
21
 
22
22
  export const BASE_PATH = "http://localhost:8080".replace(/\/+$/, "");
23
23
 
24
+ /**
25
+ *
26
+ * @export
27
+ */
24
28
  export const COLLECTION_FORMATS = {
25
29
  csv: ",",
26
30
  ssv: " ",
@@ -28,11 +32,21 @@ export const COLLECTION_FORMATS = {
28
32
  pipes: "|",
29
33
  };
30
34
 
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface RequestArgs
39
+ */
31
40
  export interface RequestArgs {
32
41
  url: string;
33
42
  options: RawAxiosRequestConfig;
34
43
  }
35
44
 
45
+ /**
46
+ *
47
+ * @export
48
+ * @class BaseAPI
49
+ */
36
50
  export class BaseAPI {
37
51
  protected configuration: Configuration | undefined;
38
52
 
@@ -44,6 +58,12 @@ export class BaseAPI {
44
58
  }
45
59
  };
46
60
 
61
+ /**
62
+ *
63
+ * @export
64
+ * @class RequiredError
65
+ * @extends {Error}
66
+ */
47
67
  export class RequiredError extends Error {
48
68
  constructor(public field: string, msg?: string) {
49
69
  super(msg);
@@ -58,5 +78,9 @@ interface ServerMap {
58
78
  }[];
59
79
  }
60
80
 
81
+ /**
82
+ *
83
+ * @export
84
+ */
61
85
  export const operationServerMap: ServerMap = {
62
86
  }
package/common.ts CHANGED
@@ -18,11 +18,16 @@ import type { RequestArgs } from "./base";
18
18
  import type { AxiosInstance, AxiosResponse } from 'axios';
19
19
  import { RequiredError } from "./base";
20
20
 
21
+ /**
22
+ *
23
+ * @export
24
+ */
21
25
  export const DUMMY_BASE_URL = 'https://example.com'
22
26
 
23
27
  /**
24
28
  *
25
29
  * @throws {RequiredError}
30
+ * @export
26
31
  */
27
32
  export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
28
33
  if (paramValue === null || paramValue === undefined) {
@@ -30,6 +35,10 @@ export const assertParamExists = function (functionName: string, paramName: stri
30
35
  }
31
36
  }
32
37
 
38
+ /**
39
+ *
40
+ * @export
41
+ */
33
42
  export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
34
43
  if (configuration && configuration.apiKey) {
35
44
  const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -39,12 +48,20 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri
39
48
  }
40
49
  }
41
50
 
51
+ /**
52
+ *
53
+ * @export
54
+ */
42
55
  export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
43
56
  if (configuration && (configuration.username || configuration.password)) {
44
57
  object["auth"] = { username: configuration.username, password: configuration.password };
45
58
  }
46
59
  }
47
60
 
61
+ /**
62
+ *
63
+ * @export
64
+ */
48
65
  export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
49
66
  if (configuration && configuration.accessToken) {
50
67
  const accessToken = typeof configuration.accessToken === 'function'
@@ -54,6 +71,10 @@ export const setBearerAuthToObject = async function (object: any, configuration?
54
71
  }
55
72
  }
56
73
 
74
+ /**
75
+ *
76
+ * @export
77
+ */
57
78
  export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
58
79
  if (configuration && configuration.accessToken) {
59
80
  const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -85,12 +106,20 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
85
106
  }
86
107
  }
87
108
 
109
+ /**
110
+ *
111
+ * @export
112
+ */
88
113
  export const setSearchParams = function (url: URL, ...objects: any[]) {
89
114
  const searchParams = new URLSearchParams(url.search);
90
115
  setFlattenedQueryParams(searchParams, objects);
91
116
  url.search = searchParams.toString();
92
117
  }
93
118
 
119
+ /**
120
+ *
121
+ * @export
122
+ */
94
123
  export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
95
124
  const nonString = typeof value !== 'string';
96
125
  const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -101,10 +130,18 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any,
101
130
  : (value || "");
102
131
  }
103
132
 
133
+ /**
134
+ *
135
+ * @export
136
+ */
104
137
  export const toPathString = function (url: URL) {
105
138
  return url.pathname + url.search + url.hash
106
139
  }
107
140
 
141
+ /**
142
+ *
143
+ * @export
144
+ */
108
145
  export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
109
146
  return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
110
147
  const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
package/configuration.ts CHANGED
@@ -28,32 +28,49 @@ export class Configuration {
28
28
  /**
29
29
  * parameter for apiKey security
30
30
  * @param name security name
31
+ * @memberof Configuration
31
32
  */
32
33
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
33
34
  /**
34
35
  * parameter for basic security
36
+ *
37
+ * @type {string}
38
+ * @memberof Configuration
35
39
  */
36
40
  username?: string;
37
41
  /**
38
42
  * parameter for basic security
43
+ *
44
+ * @type {string}
45
+ * @memberof Configuration
39
46
  */
40
47
  password?: string;
41
48
  /**
42
49
  * parameter for oauth2 security
43
50
  * @param name security name
44
51
  * @param scopes oauth2 scope
52
+ * @memberof Configuration
45
53
  */
46
54
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
47
55
  /**
48
56
  * override base path
57
+ *
58
+ * @type {string}
59
+ * @memberof Configuration
49
60
  */
50
61
  basePath?: string;
51
62
  /**
52
63
  * override server index
64
+ *
65
+ * @type {number}
66
+ * @memberof Configuration
53
67
  */
54
68
  serverIndex?: number;
55
69
  /**
56
70
  * base options for axios calls
71
+ *
72
+ * @type {any}
73
+ * @memberof Configuration
57
74
  */
58
75
  baseOptions?: any;
59
76
  /**
package/docs/BookingApi.md CHANGED
@@ -9,7 +9,7 @@ All URIs are relative to *http://localhost:8080*
9
9
  |[**bookingControllerBookingConfirmation**](#bookingcontrollerbookingconfirmation) | **POST** /v1/booking/confirmation | |
10
10
  |[**bookingControllerCalendarInvites**](#bookingcontrollercalendarinvites) | **POST** /v1/booking/calendar-shared | |
11
11
  |[**bookingControllerCancelBooking**](#bookingcontrollercancelbooking) | **POST** /v1/booking/cancel-booking | |
12
- |[**bookingControllerCreateBooking**](#bookingcontrollercreatebooking) | **POST** /v1/booking | |
12
+ |[**bookingControllerCreateWalkInBooking**](#bookingcontrollercreatewalkinbooking) | **POST** /v1/booking | |
13
13
  |[**bookingControllerGetBooking**](#bookingcontrollergetbooking) | **GET** /v1/booking/{id} | |
14
14
  |[**bookingControllerLeaveBooking**](#bookingcontrollerleavebooking) | **POST** /v1/booking/leave-booking | |
15
15
  |[**bookingControllerListBookings**](#bookingcontrollerlistbookings) | **POST** /v1/booking/list | |
@@ -276,8 +276,8 @@ const { status, data } = await apiInstance.bookingControllerCancelBooking(
276
276
 
277
277
  [[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)
278
278
 
279
- # **bookingControllerCreateBooking**
280
- > BookingResponseDTO bookingControllerCreateBooking(createBookingPayload)
279
+ # **bookingControllerCreateWalkInBooking**
280
+ > BookingResponseDTO bookingControllerCreateWalkInBooking(createWalkInBookingPayload)
281
281
 
282
282
 
283
283
  ### Example
@@ -286,16 +286,16 @@ const { status, data } = await apiInstance.bookingControllerCancelBooking(
286
286
  import {
287
287
  BookingApi,
288
288
  Configuration,
289
- CreateBookingPayload
289
+ CreateWalkInBookingPayload
290
290
  } from './api';
291
291
 
292
292
  const configuration = new Configuration();
293
293
  const apiInstance = new BookingApi(configuration);
294
294
 
295
- let createBookingPayload: CreateBookingPayload; //
295
+ let createWalkInBookingPayload: CreateWalkInBookingPayload; //
296
296
 
297
- const { status, data } = await apiInstance.bookingControllerCreateBooking(
298
- createBookingPayload
297
+ const { status, data } = await apiInstance.bookingControllerCreateWalkInBooking(
298
+ createWalkInBookingPayload
299
299
  );
300
300
  ```
301
301
 
@@ -303,7 +303,7 @@ const { status, data } = await apiInstance.bookingControllerCreateBooking(
303
303
 
304
304
  |Name | Type | Description | Notes|
305
305
  |------------- | ------------- | ------------- | -------------|
306
- | **createBookingPayload** | **CreateBookingPayload**| | |
306
+ | **createWalkInBookingPayload** | **CreateWalkInBookingPayload**| | |
307
307
 
308
308
 
309
309
  ### Return type
package/docs/CreateBookingPayload.md CHANGED
@@ -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-19T14:54:53+05:30]
10
- **recurrenceEndDate** | **string** | The start date of the booking | [optional] [default to 2025-09-19T14:54:53+05:30]
9
+ **date** | **string** | The start date of the booking | [default to 2025-09-19T15:12:09+05:30]
10
+ **recurrenceEndDate** | **string** | The start date of the booking | [optional] [default to 2025-09-19T15:12:09+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]
package/docs/CreateWalkInBookingPayload.md ADDED
@@ -0,0 +1,42 @@
1
+ # CreateWalkInBookingPayload
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
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-19T15:12:09+05:30]
10
+ **endDate** | **string** | The start date of the booking | [default to 2025-09-19T15:12:09+05:30]
11
+ **note** | **string** | Notes attached with booking | [optional] [default to undefined]
12
+ **occasion** | **string** | Occasion id | [optional] [default to undefined]
13
+ **calendar** | **Array&lt;string&gt;** | Calendar attached with booking | [optional] [default to undefined]
14
+ **collaborators** | [**Array&lt;CreateBookingCollaboratorPayload&gt;**](CreateBookingCollaboratorPayload.md) | The list of collaborators associated with the booking | [default to undefined]
15
+ **customers** | **Array&lt;string&gt;** | The list of customers associated with the booking | [default to undefined]
16
+ **method** | **string** | Booking method | [default to 'WALK_IN']
17
+ **tags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
18
+ **quantity** | **number** | | [default to undefined]
19
+ **walking** | **object** | | [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { CreateWalkInBookingPayload } from './api';
25
+
26
+ const instance: CreateWalkInBookingPayload = {
27
+ title,
28
+ startDate,
29
+ endDate,
30
+ note,
31
+ occasion,
32
+ calendar,
33
+ collaborators,
34
+ customers,
35
+ method,
36
+ tags,
37
+ quantity,
38
+ walking,
39
+ };
40
+ ```
41
+
42
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/RescheduleBookingPayload.md CHANGED
@@ -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-19T14:54:53+05:30]
8
+ **date** | **string** | The start date of the booking | [default to 2025-09-19T15:12:09+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]
package/docs/WaitlistPayloadDTO.md CHANGED
@@ -5,8 +5,8 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **startDate** | **string** | The start date of the waitlist | [default to 2025-09-19T14:54:53+05:30]
9
- **endDate** | **string** | The end date of the waitlist | [default to 2025-09-19T15:54:53+05:30]
8
+ **startDate** | **string** | The start date of the waitlist | [default to 2025-09-19T15:12:09+05:30]
9
+ **endDate** | **string** | The end date of the waitlist | [default to 2025-09-19T16:12:09+05:30]
10
10
  **venue** | **string** | The venue of the waitlist | [default to undefined]
11
11
  **business** | **string** | The business associated with the waitlist | [default to undefined]
12
12
  **collaborators** | [**Array&lt;CreateWaitlistBookingCollaboratorPayload&gt;**](CreateWaitlistBookingCollaboratorPayload.md) | The list of collaborators associated with the waitlist | [default to undefined]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gooday_corp/gooday-api-client",
3
- "version": "2.3.1",
3
+ "version": "3.3.3",
4
4
  "description": "API client for Gooday",
5
5
  "main": "index.ts",
6
6
  "scripts": {},