yellowgrid-api-ts 3.2.41 → 3.2.42
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/README.md +1 -0
- package/api.ts +94 -22
- package/dist/api.d.ts +55 -22
- package/dist/api.js +95 -11
- package/docs/EdTechProSchoolModel.md +0 -2
- package/docs/EventUpdateDTO.md +2 -2
- package/docs/EventUpdateRequestDTO.md +2 -0
- package/docs/ServiceStatusDTO.md +1 -1
- package/docs/ServicesApi.md +63 -5
- package/getEnums.php +27 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -192,6 +192,7 @@ Class | Method | HTTP request | Description
|
|
|
192
192
|
*ServicesApi* | [**deleteUnsubscribe**](docs/ServicesApi.md#deleteunsubscribe) | **DELETE** /services/events/unsubscribe |
|
|
193
193
|
*ServicesApi* | [**getGetServiceHealth**](docs/ServicesApi.md#getgetservicehealth) | **GET** /services/health |
|
|
194
194
|
*ServicesApi* | [**patchArchiveEvent**](docs/ServicesApi.md#patcharchiveevent) | **PATCH** /services/events/{id}/archive |
|
|
195
|
+
*ServicesApi* | [**patchUpdateEvent**](docs/ServicesApi.md#patchupdateevent) | **PATCH** /services/events/{id} |
|
|
195
196
|
*ServicesApi* | [**postCreateEvent**](docs/ServicesApi.md#postcreateevent) | **POST** /services/events |
|
|
196
197
|
*ServicesApi* | [**postCreateEventUpdate**](docs/ServicesApi.md#postcreateeventupdate) | **POST** /services/events/{id}/updates |
|
|
197
198
|
*ServicesApi* | [**postSubscribe**](docs/ServicesApi.md#postsubscribe) | **POST** /services/events/subscribe |
|
package/api.ts
CHANGED
|
@@ -2264,12 +2264,6 @@ export interface EdTechProSchoolModel {
|
|
|
2264
2264
|
* @memberof EdTechProSchoolModel
|
|
2265
2265
|
*/
|
|
2266
2266
|
'creationDate'?: string;
|
|
2267
|
-
/**
|
|
2268
|
-
* Template URL
|
|
2269
|
-
* @type {string}
|
|
2270
|
-
* @memberof EdTechProSchoolModel
|
|
2271
|
-
*/
|
|
2272
|
-
''?: string;
|
|
2273
2267
|
/**
|
|
2274
2268
|
* School Annual Price
|
|
2275
2269
|
* @type {number}
|
|
@@ -2502,17 +2496,17 @@ export interface EventUpdateDTO {
|
|
|
2502
2496
|
*/
|
|
2503
2497
|
'type'?: number;
|
|
2504
2498
|
/**
|
|
2505
|
-
*
|
|
2499
|
+
* Date Time
|
|
2506
2500
|
* @type {string}
|
|
2507
2501
|
* @memberof EventUpdateDTO
|
|
2508
2502
|
*/
|
|
2509
|
-
'
|
|
2503
|
+
'createdAt'?: string;
|
|
2510
2504
|
/**
|
|
2511
|
-
*
|
|
2505
|
+
* Service Event Update Type Description
|
|
2512
2506
|
* @type {string}
|
|
2513
2507
|
* @memberof EventUpdateDTO
|
|
2514
2508
|
*/
|
|
2515
|
-
'
|
|
2509
|
+
'typeName'?: string;
|
|
2516
2510
|
}
|
|
2517
2511
|
/**
|
|
2518
2512
|
* Event Update Entity
|
|
@@ -2569,6 +2563,12 @@ export interface EventUpdateRequestDTO {
|
|
|
2569
2563
|
* @memberof EventUpdateRequestDTO
|
|
2570
2564
|
*/
|
|
2571
2565
|
'type'?: number;
|
|
2566
|
+
/**
|
|
2567
|
+
* Date Time
|
|
2568
|
+
* @type {string}
|
|
2569
|
+
* @memberof EventUpdateRequestDTO
|
|
2570
|
+
*/
|
|
2571
|
+
'createdAt'?: string;
|
|
2572
2572
|
}
|
|
2573
2573
|
/**
|
|
2574
2574
|
* Fraud Management
|
|
@@ -5539,7 +5539,7 @@ export interface ServiceStatusDTO {
|
|
|
5539
5539
|
'name'?: string;
|
|
5540
5540
|
/**
|
|
5541
5541
|
* Service Status
|
|
5542
|
-
* @type {
|
|
5542
|
+
* @type {string}
|
|
5543
5543
|
* @memberof ServiceStatusDTO
|
|
5544
5544
|
*/
|
|
5545
5545
|
'status'?: ServiceStatusDTOStatusEnum;
|
|
@@ -5552,9 +5552,9 @@ export interface ServiceStatusDTO {
|
|
|
5552
5552
|
}
|
|
5553
5553
|
|
|
5554
5554
|
export const ServiceStatusDTOStatusEnum = {
|
|
5555
|
-
|
|
5556
|
-
|
|
5557
|
-
|
|
5555
|
+
_0: '0',
|
|
5556
|
+
_1: '1',
|
|
5557
|
+
_2: '2'
|
|
5558
5558
|
} as const;
|
|
5559
5559
|
|
|
5560
5560
|
export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];
|
|
@@ -21182,7 +21182,7 @@ export const ServicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
21182
21182
|
},
|
|
21183
21183
|
/**
|
|
21184
21184
|
*
|
|
21185
|
-
* @param {number} id
|
|
21185
|
+
* @param {number} id Event ID
|
|
21186
21186
|
* @param {*} [options] Override http request option.
|
|
21187
21187
|
* @throws {RequiredError}
|
|
21188
21188
|
*/
|
|
@@ -21213,6 +21213,43 @@ export const ServicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
21213
21213
|
options: localVarRequestOptions,
|
|
21214
21214
|
};
|
|
21215
21215
|
},
|
|
21216
|
+
/**
|
|
21217
|
+
*
|
|
21218
|
+
* @param {number} id Event ID
|
|
21219
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
21220
|
+
* @param {*} [options] Override http request option.
|
|
21221
|
+
* @throws {RequiredError}
|
|
21222
|
+
*/
|
|
21223
|
+
patchUpdateEvent: async (id: number, eventRequestDTO?: EventRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
21224
|
+
// verify required parameter 'id' is not null or undefined
|
|
21225
|
+
assertParamExists('patchUpdateEvent', 'id', id)
|
|
21226
|
+
const localVarPath = `/services/events/{id}`
|
|
21227
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
21228
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21229
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21230
|
+
let baseOptions;
|
|
21231
|
+
if (configuration) {
|
|
21232
|
+
baseOptions = configuration.baseOptions;
|
|
21233
|
+
}
|
|
21234
|
+
|
|
21235
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
21236
|
+
const localVarHeaderParameter = {} as any;
|
|
21237
|
+
const localVarQueryParameter = {} as any;
|
|
21238
|
+
|
|
21239
|
+
|
|
21240
|
+
|
|
21241
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
21242
|
+
|
|
21243
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21244
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21245
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
21246
|
+
localVarRequestOptions.data = serializeDataIfNeeded(eventRequestDTO, localVarRequestOptions, configuration)
|
|
21247
|
+
|
|
21248
|
+
return {
|
|
21249
|
+
url: toPathString(localVarUrlObj),
|
|
21250
|
+
options: localVarRequestOptions,
|
|
21251
|
+
};
|
|
21252
|
+
},
|
|
21216
21253
|
/**
|
|
21217
21254
|
*
|
|
21218
21255
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -21248,7 +21285,7 @@ export const ServicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
21248
21285
|
},
|
|
21249
21286
|
/**
|
|
21250
21287
|
*
|
|
21251
|
-
* @param {number} id
|
|
21288
|
+
* @param {number} id Event ID
|
|
21252
21289
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
21253
21290
|
* @param {*} [options] Override http request option.
|
|
21254
21291
|
* @throws {RequiredError}
|
|
@@ -21353,7 +21390,7 @@ export const ServicesApiFp = function(configuration?: Configuration) {
|
|
|
21353
21390
|
},
|
|
21354
21391
|
/**
|
|
21355
21392
|
*
|
|
21356
|
-
* @param {number} id
|
|
21393
|
+
* @param {number} id Event ID
|
|
21357
21394
|
* @param {*} [options] Override http request option.
|
|
21358
21395
|
* @throws {RequiredError}
|
|
21359
21396
|
*/
|
|
@@ -21363,6 +21400,19 @@ export const ServicesApiFp = function(configuration?: Configuration) {
|
|
|
21363
21400
|
const localVarOperationServerBasePath = operationServerMap['ServicesApi.patchArchiveEvent']?.[localVarOperationServerIndex]?.url;
|
|
21364
21401
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21365
21402
|
},
|
|
21403
|
+
/**
|
|
21404
|
+
*
|
|
21405
|
+
* @param {number} id Event ID
|
|
21406
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
21407
|
+
* @param {*} [options] Override http request option.
|
|
21408
|
+
* @throws {RequiredError}
|
|
21409
|
+
*/
|
|
21410
|
+
async patchUpdateEvent(id: number, eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>> {
|
|
21411
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchUpdateEvent(id, eventRequestDTO, options);
|
|
21412
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21413
|
+
const localVarOperationServerBasePath = operationServerMap['ServicesApi.patchUpdateEvent']?.[localVarOperationServerIndex]?.url;
|
|
21414
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21415
|
+
},
|
|
21366
21416
|
/**
|
|
21367
21417
|
*
|
|
21368
21418
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -21377,7 +21427,7 @@ export const ServicesApiFp = function(configuration?: Configuration) {
|
|
|
21377
21427
|
},
|
|
21378
21428
|
/**
|
|
21379
21429
|
*
|
|
21380
|
-
* @param {number} id
|
|
21430
|
+
* @param {number} id Event ID
|
|
21381
21431
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
21382
21432
|
* @param {*} [options] Override http request option.
|
|
21383
21433
|
* @throws {RequiredError}
|
|
@@ -21430,13 +21480,23 @@ export const ServicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
21430
21480
|
},
|
|
21431
21481
|
/**
|
|
21432
21482
|
*
|
|
21433
|
-
* @param {number} id
|
|
21483
|
+
* @param {number} id Event ID
|
|
21434
21484
|
* @param {*} [options] Override http request option.
|
|
21435
21485
|
* @throws {RequiredError}
|
|
21436
21486
|
*/
|
|
21437
21487
|
patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
|
|
21438
21488
|
return localVarFp.patchArchiveEvent(id, options).then((request) => request(axios, basePath));
|
|
21439
21489
|
},
|
|
21490
|
+
/**
|
|
21491
|
+
*
|
|
21492
|
+
* @param {number} id Event ID
|
|
21493
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
21494
|
+
* @param {*} [options] Override http request option.
|
|
21495
|
+
* @throws {RequiredError}
|
|
21496
|
+
*/
|
|
21497
|
+
patchUpdateEvent(id: number, eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO> {
|
|
21498
|
+
return localVarFp.patchUpdateEvent(id, eventRequestDTO, options).then((request) => request(axios, basePath));
|
|
21499
|
+
},
|
|
21440
21500
|
/**
|
|
21441
21501
|
*
|
|
21442
21502
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -21448,7 +21508,7 @@ export const ServicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
21448
21508
|
},
|
|
21449
21509
|
/**
|
|
21450
21510
|
*
|
|
21451
|
-
* @param {number} id
|
|
21511
|
+
* @param {number} id Event ID
|
|
21452
21512
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
21453
21513
|
* @param {*} [options] Override http request option.
|
|
21454
21514
|
* @throws {RequiredError}
|
|
@@ -21499,7 +21559,7 @@ export class ServicesApi extends BaseAPI {
|
|
|
21499
21559
|
|
|
21500
21560
|
/**
|
|
21501
21561
|
*
|
|
21502
|
-
* @param {number} id
|
|
21562
|
+
* @param {number} id Event ID
|
|
21503
21563
|
* @param {*} [options] Override http request option.
|
|
21504
21564
|
* @throws {RequiredError}
|
|
21505
21565
|
* @memberof ServicesApi
|
|
@@ -21508,6 +21568,18 @@ export class ServicesApi extends BaseAPI {
|
|
|
21508
21568
|
return ServicesApiFp(this.configuration).patchArchiveEvent(id, options).then((request) => request(this.axios, this.basePath));
|
|
21509
21569
|
}
|
|
21510
21570
|
|
|
21571
|
+
/**
|
|
21572
|
+
*
|
|
21573
|
+
* @param {number} id Event ID
|
|
21574
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
21575
|
+
* @param {*} [options] Override http request option.
|
|
21576
|
+
* @throws {RequiredError}
|
|
21577
|
+
* @memberof ServicesApi
|
|
21578
|
+
*/
|
|
21579
|
+
public patchUpdateEvent(id: number, eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig) {
|
|
21580
|
+
return ServicesApiFp(this.configuration).patchUpdateEvent(id, eventRequestDTO, options).then((request) => request(this.axios, this.basePath));
|
|
21581
|
+
}
|
|
21582
|
+
|
|
21511
21583
|
/**
|
|
21512
21584
|
*
|
|
21513
21585
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -21521,7 +21593,7 @@ export class ServicesApi extends BaseAPI {
|
|
|
21521
21593
|
|
|
21522
21594
|
/**
|
|
21523
21595
|
*
|
|
21524
|
-
* @param {number} id
|
|
21596
|
+
* @param {number} id Event ID
|
|
21525
21597
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
21526
21598
|
* @param {*} [options] Override http request option.
|
|
21527
21599
|
* @throws {RequiredError}
|
package/dist/api.d.ts
CHANGED
|
@@ -2248,12 +2248,6 @@ export interface EdTechProSchoolModel {
|
|
|
2248
2248
|
* @memberof EdTechProSchoolModel
|
|
2249
2249
|
*/
|
|
2250
2250
|
'creationDate'?: string;
|
|
2251
|
-
/**
|
|
2252
|
-
* Template URL
|
|
2253
|
-
* @type {string}
|
|
2254
|
-
* @memberof EdTechProSchoolModel
|
|
2255
|
-
*/
|
|
2256
|
-
''?: string;
|
|
2257
2251
|
/**
|
|
2258
2252
|
* School Annual Price
|
|
2259
2253
|
* @type {number}
|
|
@@ -2483,17 +2477,17 @@ export interface EventUpdateDTO {
|
|
|
2483
2477
|
*/
|
|
2484
2478
|
'type'?: number;
|
|
2485
2479
|
/**
|
|
2486
|
-
*
|
|
2480
|
+
* Date Time
|
|
2487
2481
|
* @type {string}
|
|
2488
2482
|
* @memberof EventUpdateDTO
|
|
2489
2483
|
*/
|
|
2490
|
-
'
|
|
2484
|
+
'createdAt'?: string;
|
|
2491
2485
|
/**
|
|
2492
|
-
*
|
|
2486
|
+
* Service Event Update Type Description
|
|
2493
2487
|
* @type {string}
|
|
2494
2488
|
* @memberof EventUpdateDTO
|
|
2495
2489
|
*/
|
|
2496
|
-
'
|
|
2490
|
+
'typeName'?: string;
|
|
2497
2491
|
}
|
|
2498
2492
|
/**
|
|
2499
2493
|
* Event Update Entity
|
|
@@ -2550,6 +2544,12 @@ export interface EventUpdateRequestDTO {
|
|
|
2550
2544
|
* @memberof EventUpdateRequestDTO
|
|
2551
2545
|
*/
|
|
2552
2546
|
'type'?: number;
|
|
2547
|
+
/**
|
|
2548
|
+
* Date Time
|
|
2549
|
+
* @type {string}
|
|
2550
|
+
* @memberof EventUpdateRequestDTO
|
|
2551
|
+
*/
|
|
2552
|
+
'createdAt'?: string;
|
|
2553
2553
|
}
|
|
2554
2554
|
/**
|
|
2555
2555
|
* Fraud Management
|
|
@@ -5498,7 +5498,7 @@ export interface ServiceStatusDTO {
|
|
|
5498
5498
|
'name'?: string;
|
|
5499
5499
|
/**
|
|
5500
5500
|
* Service Status
|
|
5501
|
-
* @type {
|
|
5501
|
+
* @type {string}
|
|
5502
5502
|
* @memberof ServiceStatusDTO
|
|
5503
5503
|
*/
|
|
5504
5504
|
'status'?: ServiceStatusDTOStatusEnum;
|
|
@@ -5510,9 +5510,9 @@ export interface ServiceStatusDTO {
|
|
|
5510
5510
|
'events'?: Array<EventDTO>;
|
|
5511
5511
|
}
|
|
5512
5512
|
export declare const ServiceStatusDTOStatusEnum: {
|
|
5513
|
-
readonly
|
|
5514
|
-
readonly
|
|
5515
|
-
readonly
|
|
5513
|
+
readonly _0: "0";
|
|
5514
|
+
readonly _1: "1";
|
|
5515
|
+
readonly _2: "2";
|
|
5516
5516
|
};
|
|
5517
5517
|
export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];
|
|
5518
5518
|
/**
|
|
@@ -15418,11 +15418,19 @@ export declare const ServicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
15418
15418
|
getGetServiceHealth: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15419
15419
|
/**
|
|
15420
15420
|
*
|
|
15421
|
-
* @param {number} id
|
|
15421
|
+
* @param {number} id Event ID
|
|
15422
15422
|
* @param {*} [options] Override http request option.
|
|
15423
15423
|
* @throws {RequiredError}
|
|
15424
15424
|
*/
|
|
15425
15425
|
patchArchiveEvent: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15426
|
+
/**
|
|
15427
|
+
*
|
|
15428
|
+
* @param {number} id Event ID
|
|
15429
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
15430
|
+
* @param {*} [options] Override http request option.
|
|
15431
|
+
* @throws {RequiredError}
|
|
15432
|
+
*/
|
|
15433
|
+
patchUpdateEvent: (id: number, eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15426
15434
|
/**
|
|
15427
15435
|
*
|
|
15428
15436
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -15432,7 +15440,7 @@ export declare const ServicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
15432
15440
|
postCreateEvent: (eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15433
15441
|
/**
|
|
15434
15442
|
*
|
|
15435
|
-
* @param {number} id
|
|
15443
|
+
* @param {number} id Event ID
|
|
15436
15444
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
15437
15445
|
* @param {*} [options] Override http request option.
|
|
15438
15446
|
* @throws {RequiredError}
|
|
@@ -15467,11 +15475,19 @@ export declare const ServicesApiFp: (configuration?: Configuration) => {
|
|
|
15467
15475
|
getGetServiceHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceHealthDTO>>;
|
|
15468
15476
|
/**
|
|
15469
15477
|
*
|
|
15470
|
-
* @param {number} id
|
|
15478
|
+
* @param {number} id Event ID
|
|
15471
15479
|
* @param {*} [options] Override http request option.
|
|
15472
15480
|
* @throws {RequiredError}
|
|
15473
15481
|
*/
|
|
15474
15482
|
patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
|
|
15483
|
+
/**
|
|
15484
|
+
*
|
|
15485
|
+
* @param {number} id Event ID
|
|
15486
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
15487
|
+
* @param {*} [options] Override http request option.
|
|
15488
|
+
* @throws {RequiredError}
|
|
15489
|
+
*/
|
|
15490
|
+
patchUpdateEvent(id: number, eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
|
|
15475
15491
|
/**
|
|
15476
15492
|
*
|
|
15477
15493
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -15481,7 +15497,7 @@ export declare const ServicesApiFp: (configuration?: Configuration) => {
|
|
|
15481
15497
|
postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
|
|
15482
15498
|
/**
|
|
15483
15499
|
*
|
|
15484
|
-
* @param {number} id
|
|
15500
|
+
* @param {number} id Event ID
|
|
15485
15501
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
15486
15502
|
* @param {*} [options] Override http request option.
|
|
15487
15503
|
* @throws {RequiredError}
|
|
@@ -15516,11 +15532,19 @@ export declare const ServicesApiFactory: (configuration?: Configuration, basePat
|
|
|
15516
15532
|
getGetServiceHealth(options?: RawAxiosRequestConfig): AxiosPromise<ServiceHealthDTO>;
|
|
15517
15533
|
/**
|
|
15518
15534
|
*
|
|
15519
|
-
* @param {number} id
|
|
15535
|
+
* @param {number} id Event ID
|
|
15520
15536
|
* @param {*} [options] Override http request option.
|
|
15521
15537
|
* @throws {RequiredError}
|
|
15522
15538
|
*/
|
|
15523
15539
|
patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
|
|
15540
|
+
/**
|
|
15541
|
+
*
|
|
15542
|
+
* @param {number} id Event ID
|
|
15543
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
15544
|
+
* @param {*} [options] Override http request option.
|
|
15545
|
+
* @throws {RequiredError}
|
|
15546
|
+
*/
|
|
15547
|
+
patchUpdateEvent(id: number, eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
|
|
15524
15548
|
/**
|
|
15525
15549
|
*
|
|
15526
15550
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -15530,7 +15554,7 @@ export declare const ServicesApiFactory: (configuration?: Configuration, basePat
|
|
|
15530
15554
|
postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
|
|
15531
15555
|
/**
|
|
15532
15556
|
*
|
|
15533
|
-
* @param {number} id
|
|
15557
|
+
* @param {number} id Event ID
|
|
15534
15558
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
15535
15559
|
* @param {*} [options] Override http request option.
|
|
15536
15560
|
* @throws {RequiredError}
|
|
@@ -15569,12 +15593,21 @@ export declare class ServicesApi extends BaseAPI {
|
|
|
15569
15593
|
getGetServiceHealth(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceHealthDTO, any, {}>>;
|
|
15570
15594
|
/**
|
|
15571
15595
|
*
|
|
15572
|
-
* @param {number} id
|
|
15596
|
+
* @param {number} id Event ID
|
|
15573
15597
|
* @param {*} [options] Override http request option.
|
|
15574
15598
|
* @throws {RequiredError}
|
|
15575
15599
|
* @memberof ServicesApi
|
|
15576
15600
|
*/
|
|
15577
15601
|
patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
|
|
15602
|
+
/**
|
|
15603
|
+
*
|
|
15604
|
+
* @param {number} id Event ID
|
|
15605
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
15606
|
+
* @param {*} [options] Override http request option.
|
|
15607
|
+
* @throws {RequiredError}
|
|
15608
|
+
* @memberof ServicesApi
|
|
15609
|
+
*/
|
|
15610
|
+
patchUpdateEvent(id: number, eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
|
|
15578
15611
|
/**
|
|
15579
15612
|
*
|
|
15580
15613
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -15585,7 +15618,7 @@ export declare class ServicesApi extends BaseAPI {
|
|
|
15585
15618
|
postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
|
|
15586
15619
|
/**
|
|
15587
15620
|
*
|
|
15588
|
-
* @param {number} id
|
|
15621
|
+
* @param {number} id Event ID
|
|
15589
15622
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
15590
15623
|
* @param {*} [options] Override http request option.
|
|
15591
15624
|
* @throws {RequiredError}
|
package/dist/api.js
CHANGED
|
@@ -192,9 +192,9 @@ exports.ServiceHealthDTOGlobalStatusEnum = {
|
|
|
192
192
|
NUMBER_2: 2
|
|
193
193
|
};
|
|
194
194
|
exports.ServiceStatusDTOStatusEnum = {
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
195
|
+
_0: '0',
|
|
196
|
+
_1: '1',
|
|
197
|
+
_2: '2'
|
|
198
198
|
};
|
|
199
199
|
exports.ShippingServiceDTOCourierEnum = {
|
|
200
200
|
Dpd: 'DPD',
|
|
@@ -13216,7 +13216,7 @@ var ServicesApiAxiosParamCreator = function (configuration) {
|
|
|
13216
13216
|
},
|
|
13217
13217
|
/**
|
|
13218
13218
|
*
|
|
13219
|
-
* @param {number} id
|
|
13219
|
+
* @param {number} id Event ID
|
|
13220
13220
|
* @param {*} [options] Override http request option.
|
|
13221
13221
|
* @throws {RequiredError}
|
|
13222
13222
|
*/
|
|
@@ -13250,6 +13250,45 @@ var ServicesApiAxiosParamCreator = function (configuration) {
|
|
|
13250
13250
|
});
|
|
13251
13251
|
});
|
|
13252
13252
|
},
|
|
13253
|
+
/**
|
|
13254
|
+
*
|
|
13255
|
+
* @param {number} id Event ID
|
|
13256
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
13257
|
+
* @param {*} [options] Override http request option.
|
|
13258
|
+
* @throws {RequiredError}
|
|
13259
|
+
*/
|
|
13260
|
+
patchUpdateEvent: function (id_1, eventRequestDTO_1) {
|
|
13261
|
+
var args_1 = [];
|
|
13262
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
13263
|
+
args_1[_i - 2] = arguments[_i];
|
|
13264
|
+
}
|
|
13265
|
+
return __awaiter(_this, __spreadArray([id_1, eventRequestDTO_1], args_1, true), void 0, function (id, eventRequestDTO, options) {
|
|
13266
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
13267
|
+
if (options === void 0) { options = {}; }
|
|
13268
|
+
return __generator(this, function (_a) {
|
|
13269
|
+
// verify required parameter 'id' is not null or undefined
|
|
13270
|
+
(0, common_1.assertParamExists)('patchUpdateEvent', 'id', id);
|
|
13271
|
+
localVarPath = "/services/events/{id}"
|
|
13272
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
13273
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
13274
|
+
if (configuration) {
|
|
13275
|
+
baseOptions = configuration.baseOptions;
|
|
13276
|
+
}
|
|
13277
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
13278
|
+
localVarHeaderParameter = {};
|
|
13279
|
+
localVarQueryParameter = {};
|
|
13280
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13281
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
13282
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13283
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
13284
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(eventRequestDTO, localVarRequestOptions, configuration);
|
|
13285
|
+
return [2 /*return*/, {
|
|
13286
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
13287
|
+
options: localVarRequestOptions,
|
|
13288
|
+
}];
|
|
13289
|
+
});
|
|
13290
|
+
});
|
|
13291
|
+
},
|
|
13253
13292
|
/**
|
|
13254
13293
|
*
|
|
13255
13294
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -13287,7 +13326,7 @@ var ServicesApiAxiosParamCreator = function (configuration) {
|
|
|
13287
13326
|
},
|
|
13288
13327
|
/**
|
|
13289
13328
|
*
|
|
13290
|
-
* @param {number} id
|
|
13329
|
+
* @param {number} id Event ID
|
|
13291
13330
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
13292
13331
|
* @param {*} [options] Override http request option.
|
|
13293
13332
|
* @throws {RequiredError}
|
|
@@ -13416,7 +13455,7 @@ var ServicesApiFp = function (configuration) {
|
|
|
13416
13455
|
},
|
|
13417
13456
|
/**
|
|
13418
13457
|
*
|
|
13419
|
-
* @param {number} id
|
|
13458
|
+
* @param {number} id Event ID
|
|
13420
13459
|
* @param {*} [options] Override http request option.
|
|
13421
13460
|
* @throws {RequiredError}
|
|
13422
13461
|
*/
|
|
@@ -13436,6 +13475,29 @@ var ServicesApiFp = function (configuration) {
|
|
|
13436
13475
|
});
|
|
13437
13476
|
});
|
|
13438
13477
|
},
|
|
13478
|
+
/**
|
|
13479
|
+
*
|
|
13480
|
+
* @param {number} id Event ID
|
|
13481
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
13482
|
+
* @param {*} [options] Override http request option.
|
|
13483
|
+
* @throws {RequiredError}
|
|
13484
|
+
*/
|
|
13485
|
+
patchUpdateEvent: function (id, eventRequestDTO, options) {
|
|
13486
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
13487
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
13488
|
+
var _a, _b, _c;
|
|
13489
|
+
return __generator(this, function (_d) {
|
|
13490
|
+
switch (_d.label) {
|
|
13491
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchUpdateEvent(id, eventRequestDTO, options)];
|
|
13492
|
+
case 1:
|
|
13493
|
+
localVarAxiosArgs = _d.sent();
|
|
13494
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
13495
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ServicesApi.patchUpdateEvent']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
13496
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
13497
|
+
}
|
|
13498
|
+
});
|
|
13499
|
+
});
|
|
13500
|
+
},
|
|
13439
13501
|
/**
|
|
13440
13502
|
*
|
|
13441
13503
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -13460,7 +13522,7 @@ var ServicesApiFp = function (configuration) {
|
|
|
13460
13522
|
},
|
|
13461
13523
|
/**
|
|
13462
13524
|
*
|
|
13463
|
-
* @param {number} id
|
|
13525
|
+
* @param {number} id Event ID
|
|
13464
13526
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
13465
13527
|
* @param {*} [options] Override http request option.
|
|
13466
13528
|
* @throws {RequiredError}
|
|
@@ -13533,13 +13595,23 @@ var ServicesApiFactory = function (configuration, basePath, axios) {
|
|
|
13533
13595
|
},
|
|
13534
13596
|
/**
|
|
13535
13597
|
*
|
|
13536
|
-
* @param {number} id
|
|
13598
|
+
* @param {number} id Event ID
|
|
13537
13599
|
* @param {*} [options] Override http request option.
|
|
13538
13600
|
* @throws {RequiredError}
|
|
13539
13601
|
*/
|
|
13540
13602
|
patchArchiveEvent: function (id, options) {
|
|
13541
13603
|
return localVarFp.patchArchiveEvent(id, options).then(function (request) { return request(axios, basePath); });
|
|
13542
13604
|
},
|
|
13605
|
+
/**
|
|
13606
|
+
*
|
|
13607
|
+
* @param {number} id Event ID
|
|
13608
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
13609
|
+
* @param {*} [options] Override http request option.
|
|
13610
|
+
* @throws {RequiredError}
|
|
13611
|
+
*/
|
|
13612
|
+
patchUpdateEvent: function (id, eventRequestDTO, options) {
|
|
13613
|
+
return localVarFp.patchUpdateEvent(id, eventRequestDTO, options).then(function (request) { return request(axios, basePath); });
|
|
13614
|
+
},
|
|
13543
13615
|
/**
|
|
13544
13616
|
*
|
|
13545
13617
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -13551,7 +13623,7 @@ var ServicesApiFactory = function (configuration, basePath, axios) {
|
|
|
13551
13623
|
},
|
|
13552
13624
|
/**
|
|
13553
13625
|
*
|
|
13554
|
-
* @param {number} id
|
|
13626
|
+
* @param {number} id Event ID
|
|
13555
13627
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
13556
13628
|
* @param {*} [options] Override http request option.
|
|
13557
13629
|
* @throws {RequiredError}
|
|
@@ -13606,7 +13678,7 @@ var ServicesApi = /** @class */ (function (_super) {
|
|
|
13606
13678
|
};
|
|
13607
13679
|
/**
|
|
13608
13680
|
*
|
|
13609
|
-
* @param {number} id
|
|
13681
|
+
* @param {number} id Event ID
|
|
13610
13682
|
* @param {*} [options] Override http request option.
|
|
13611
13683
|
* @throws {RequiredError}
|
|
13612
13684
|
* @memberof ServicesApi
|
|
@@ -13615,6 +13687,18 @@ var ServicesApi = /** @class */ (function (_super) {
|
|
|
13615
13687
|
var _this = this;
|
|
13616
13688
|
return (0, exports.ServicesApiFp)(this.configuration).patchArchiveEvent(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
13617
13689
|
};
|
|
13690
|
+
/**
|
|
13691
|
+
*
|
|
13692
|
+
* @param {number} id Event ID
|
|
13693
|
+
* @param {EventRequestDTO} [eventRequestDTO]
|
|
13694
|
+
* @param {*} [options] Override http request option.
|
|
13695
|
+
* @throws {RequiredError}
|
|
13696
|
+
* @memberof ServicesApi
|
|
13697
|
+
*/
|
|
13698
|
+
ServicesApi.prototype.patchUpdateEvent = function (id, eventRequestDTO, options) {
|
|
13699
|
+
var _this = this;
|
|
13700
|
+
return (0, exports.ServicesApiFp)(this.configuration).patchUpdateEvent(id, eventRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
13701
|
+
};
|
|
13618
13702
|
/**
|
|
13619
13703
|
*
|
|
13620
13704
|
* @param {EventRequestDTO} [eventRequestDTO]
|
|
@@ -13628,7 +13712,7 @@ var ServicesApi = /** @class */ (function (_super) {
|
|
|
13628
13712
|
};
|
|
13629
13713
|
/**
|
|
13630
13714
|
*
|
|
13631
|
-
* @param {number} id
|
|
13715
|
+
* @param {number} id Event ID
|
|
13632
13716
|
* @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
|
|
13633
13717
|
* @param {*} [options] Override http request option.
|
|
13634
13718
|
* @throws {RequiredError}
|
|
@@ -13,7 +13,6 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**sku** | **string** | Product Sku | [optional] [default to undefined]
|
|
14
14
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
15
15
|
**creationDate** | **string** | Creation Date | [optional] [default to undefined]
|
|
16
|
-
**** | **string** | Template URL | [optional] [default to undefined]
|
|
17
16
|
**price** | **number** | School Annual Price | [optional] [default to undefined]
|
|
18
17
|
**rrp** | **number** | School Annual Price (RRP) | [optional] [default to undefined]
|
|
19
18
|
**templateUrl** | **string** | Integration Template URL | [optional] [default to undefined]
|
|
@@ -34,7 +33,6 @@ const instance: EdTechProSchoolModel = {
|
|
|
34
33
|
sku,
|
|
35
34
|
orderReference,
|
|
36
35
|
creationDate,
|
|
37
|
-
,
|
|
38
36
|
price,
|
|
39
37
|
rrp,
|
|
40
38
|
templateUrl,
|
package/docs/EventUpdateDTO.md
CHANGED
|
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**message** | **string** | Service Event Update Message | [optional] [default to undefined]
|
|
10
10
|
**type** | **number** | Service Event Update Type | [optional] [default to undefined]
|
|
11
|
-
**typeName** | **string** | Service Event Update Type Description | [optional] [default to undefined]
|
|
12
11
|
**createdAt** | **string** | Date Time | [optional] [default to undefined]
|
|
12
|
+
**typeName** | **string** | Service Event Update Type Description | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -19,8 +19,8 @@ import { EventUpdateDTO } from 'yellowgrid-api-ts';
|
|
|
19
19
|
const instance: EventUpdateDTO = {
|
|
20
20
|
message,
|
|
21
21
|
type,
|
|
22
|
-
typeName,
|
|
23
22
|
createdAt,
|
|
23
|
+
typeName,
|
|
24
24
|
};
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**message** | **string** | Service Event Update Message | [optional] [default to undefined]
|
|
10
10
|
**type** | **number** | Service Event Update Type | [optional] [default to undefined]
|
|
11
|
+
**createdAt** | **string** | Date Time | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -17,6 +18,7 @@ import { EventUpdateRequestDTO } from 'yellowgrid-api-ts';
|
|
|
17
18
|
const instance: EventUpdateRequestDTO = {
|
|
18
19
|
message,
|
|
19
20
|
type,
|
|
21
|
+
createdAt,
|
|
20
22
|
};
|
|
21
23
|
```
|
|
22
24
|
|
package/docs/ServiceStatusDTO.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**statusName** | **string** | Service Status Description | [optional] [default to undefined]
|
|
10
10
|
**name** | **string** | Service Name | [optional] [default to undefined]
|
|
11
|
-
**status** | **
|
|
11
|
+
**status** | **string** | Service Status | [optional] [default to undefined]
|
|
12
12
|
**events** | [**Array<EventDTO>**](EventDTO.md) | Service Events | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
package/docs/ServicesApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *http://api.yellowgrid.local*
|
|
|
7
7
|
|[**deleteUnsubscribe**](#deleteunsubscribe) | **DELETE** /services/events/unsubscribe | |
|
|
8
8
|
|[**getGetServiceHealth**](#getgetservicehealth) | **GET** /services/health | |
|
|
9
9
|
|[**patchArchiveEvent**](#patcharchiveevent) | **PATCH** /services/events/{id}/archive | |
|
|
10
|
+
|[**patchUpdateEvent**](#patchupdateevent) | **PATCH** /services/events/{id} | |
|
|
10
11
|
|[**postCreateEvent**](#postcreateevent) | **POST** /services/events | |
|
|
11
12
|
|[**postCreateEventUpdate**](#postcreateeventupdate) | **POST** /services/events/{id}/updates | |
|
|
12
13
|
|[**postSubscribe**](#postsubscribe) | **POST** /services/events/subscribe | |
|
|
@@ -126,7 +127,7 @@ import {
|
|
|
126
127
|
const configuration = new Configuration();
|
|
127
128
|
const apiInstance = new ServicesApi(configuration);
|
|
128
129
|
|
|
129
|
-
let id: number; //
|
|
130
|
+
let id: number; //Event ID (default to undefined)
|
|
130
131
|
|
|
131
132
|
const { status, data } = await apiInstance.patchArchiveEvent(
|
|
132
133
|
id
|
|
@@ -137,7 +138,7 @@ const { status, data } = await apiInstance.patchArchiveEvent(
|
|
|
137
138
|
|
|
138
139
|
|Name | Type | Description | Notes|
|
|
139
140
|
|------------- | ------------- | ------------- | -------------|
|
|
140
|
-
| **id** | [**number**] |
|
|
141
|
+
| **id** | [**number**] | Event ID | defaults to undefined|
|
|
141
142
|
|
|
142
143
|
|
|
143
144
|
### Return type
|
|
@@ -154,6 +155,63 @@ No authorization required
|
|
|
154
155
|
- **Accept**: application/json
|
|
155
156
|
|
|
156
157
|
|
|
158
|
+
### HTTP response details
|
|
159
|
+
| Status code | Description | Response headers |
|
|
160
|
+
|-------------|-------------|------------------|
|
|
161
|
+
|**200** | Service Event DTO | - |
|
|
162
|
+
|**400** | Bad Request | - |
|
|
163
|
+
|**401** | Unauthorised | - |
|
|
164
|
+
|**403** | Access Denied | - |
|
|
165
|
+
|
|
166
|
+
[[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)
|
|
167
|
+
|
|
168
|
+
# **patchUpdateEvent**
|
|
169
|
+
> EventDTO patchUpdateEvent()
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
import {
|
|
176
|
+
ServicesApi,
|
|
177
|
+
Configuration,
|
|
178
|
+
EventRequestDTO
|
|
179
|
+
} from 'yellowgrid-api-ts';
|
|
180
|
+
|
|
181
|
+
const configuration = new Configuration();
|
|
182
|
+
const apiInstance = new ServicesApi(configuration);
|
|
183
|
+
|
|
184
|
+
let id: number; //Event ID (default to undefined)
|
|
185
|
+
let eventRequestDTO: EventRequestDTO; // (optional)
|
|
186
|
+
|
|
187
|
+
const { status, data } = await apiInstance.patchUpdateEvent(
|
|
188
|
+
id,
|
|
189
|
+
eventRequestDTO
|
|
190
|
+
);
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Parameters
|
|
194
|
+
|
|
195
|
+
|Name | Type | Description | Notes|
|
|
196
|
+
|------------- | ------------- | ------------- | -------------|
|
|
197
|
+
| **eventRequestDTO** | **EventRequestDTO**| | |
|
|
198
|
+
| **id** | [**number**] | Event ID | defaults to undefined|
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
### Return type
|
|
202
|
+
|
|
203
|
+
**EventDTO**
|
|
204
|
+
|
|
205
|
+
### Authorization
|
|
206
|
+
|
|
207
|
+
No authorization required
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: application/json
|
|
212
|
+
- **Accept**: application/json
|
|
213
|
+
|
|
214
|
+
|
|
157
215
|
### HTTP response details
|
|
158
216
|
| Status code | Description | Response headers |
|
|
159
217
|
|-------------|-------------|------------------|
|
|
@@ -211,7 +269,7 @@ No authorization required
|
|
|
211
269
|
### HTTP response details
|
|
212
270
|
| Status code | Description | Response headers |
|
|
213
271
|
|-------------|-------------|------------------|
|
|
214
|
-
|**
|
|
272
|
+
|**201** | Service Event DTO | - |
|
|
215
273
|
|**400** | Bad Request | - |
|
|
216
274
|
|**401** | Unauthorised | - |
|
|
217
275
|
|**403** | Access Denied | - |
|
|
@@ -234,7 +292,7 @@ import {
|
|
|
234
292
|
const configuration = new Configuration();
|
|
235
293
|
const apiInstance = new ServicesApi(configuration);
|
|
236
294
|
|
|
237
|
-
let id: number; //
|
|
295
|
+
let id: number; //Event ID (default to undefined)
|
|
238
296
|
let eventUpdateRequestDTO: EventUpdateRequestDTO; // (optional)
|
|
239
297
|
|
|
240
298
|
const { status, data } = await apiInstance.postCreateEventUpdate(
|
|
@@ -248,7 +306,7 @@ const { status, data } = await apiInstance.postCreateEventUpdate(
|
|
|
248
306
|
|Name | Type | Description | Notes|
|
|
249
307
|
|------------- | ------------- | ------------- | -------------|
|
|
250
308
|
| **eventUpdateRequestDTO** | **EventUpdateRequestDTO**| | |
|
|
251
|
-
| **id** | [**number**] |
|
|
309
|
+
| **id** | [**number**] | Event ID | defaults to undefined|
|
|
252
310
|
|
|
253
311
|
|
|
254
312
|
### Return type
|
package/getEnums.php
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
|
|
3
|
+
use App\Contracts\Enums\PublicEnumInterface;
|
|
4
|
+
|
|
5
|
+
require_once __DIR__."/../../../../vendor/autoload.php";
|
|
6
|
+
|
|
7
|
+
foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
|
|
8
|
+
$ref = new ReflectionEnum($publicEnum->value);
|
|
9
|
+
$cases = [];
|
|
10
|
+
foreach ($ref->getCases() as $c) {
|
|
11
|
+
/** @var BackedEnum $enum */
|
|
12
|
+
$enum = $c->getEnum()->getName();
|
|
13
|
+
$value = $c->getBackingValue();
|
|
14
|
+
/** @var PublicEnumInterface $case */
|
|
15
|
+
$case = $enum::from($value);
|
|
16
|
+
$cases[$c->getName()] = [
|
|
17
|
+
"name" => $case->name,
|
|
18
|
+
"value" => $case->value,
|
|
19
|
+
"publicValue" => $case->getPublicValue()
|
|
20
|
+
];
|
|
21
|
+
}
|
|
22
|
+
$enumName = $ref->getShortName();
|
|
23
|
+
$enumString = json_encode($cases, JSON_PRETTY_PRINT);
|
|
24
|
+
$content = "export const $enumName = $enumString as const;".
|
|
25
|
+
"\n\n export type $enumName = typeof $enumName;";
|
|
26
|
+
file_put_contents(__DIR__."/src/models/$enumName.ts", $content);
|
|
27
|
+
}
|