@handsondigital/idplugger-admin 2.0.1 → 2.0.2
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 +3 -0
- package/README.md +6 -2
- package/api.ts +156 -0
- package/dist/api.d.ts +115 -0
- package/dist/api.js +92 -0
- package/docs/AdminPromotionCacheClear200Response.md +26 -0
- package/docs/AdminPromotionCacheClear200ResponseContent.md +20 -0
- package/docs/AdminPromotionCacheClear500Response.md +24 -0
- package/docs/PromotionApi.md +53 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -7,6 +7,9 @@ common.ts
|
|
|
7
7
|
configuration.ts
|
|
8
8
|
docs/AdminAuthRequestToken200Response.md
|
|
9
9
|
docs/AdminAuthRequestTokenRequest.md
|
|
10
|
+
docs/AdminPromotionCacheClear200Response.md
|
|
11
|
+
docs/AdminPromotionCacheClear200ResponseContent.md
|
|
12
|
+
docs/AdminPromotionCacheClear500Response.md
|
|
10
13
|
docs/AuthApi.md
|
|
11
14
|
docs/AuthLogin200Response.md
|
|
12
15
|
docs/AuthLogin401Response.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @handsondigital/idplugger-admin@2.0.
|
|
1
|
+
## @handsondigital/idplugger-admin@2.0.2
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @handsondigital/idplugger-admin@2.0.
|
|
39
|
+
npm install @handsondigital/idplugger-admin@2.0.2 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -57,6 +57,7 @@ Class | Method | HTTP request | Description
|
|
|
57
57
|
*AuthApi* | [**authMe**](docs/AuthApi.md#authme) | **GET** /v3/me | Dados na API
|
|
58
58
|
*AuthApi* | [**authRefreshToken**](docs/AuthApi.md#authrefreshtoken) | **POST** /admin/auth/refresh | Renova o do token de autenticação
|
|
59
59
|
*MetricsApi* | [**metrics**](docs/MetricsApi.md#metrics) | **GET** /v3/metrics | Devolve as métricas da promoção
|
|
60
|
+
*PromotionApi* | [**adminPromotionCacheClear**](docs/PromotionApi.md#adminpromotioncacheclear) | **POST** /v3/admin/promotion/{promotion_id}/cache/clear | Renova o cache de uma promoção na API
|
|
60
61
|
*PromotionApi* | [**promotionPullConfiguration**](docs/PromotionApi.md#promotionpullconfiguration) | **POST** /v3/admin/pullconfiguration | Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
61
62
|
*PromotionApi* | [**promotionStart**](docs/PromotionApi.md#promotionstart) | **POST** /v3/admin/promotion/start | Iniciar uma promoção na API
|
|
62
63
|
*RolesApi* | [**rolesAttachPermissions**](docs/RolesApi.md#rolesattachpermissions) | **POST** /v3/admin/roles/{id}/permissions | Atualizar permissões de uma role
|
|
@@ -79,6 +80,9 @@ Class | Method | HTTP request | Description
|
|
|
79
80
|
|
|
80
81
|
- [AdminAuthRequestToken200Response](docs/AdminAuthRequestToken200Response.md)
|
|
81
82
|
- [AdminAuthRequestTokenRequest](docs/AdminAuthRequestTokenRequest.md)
|
|
83
|
+
- [AdminPromotionCacheClear200Response](docs/AdminPromotionCacheClear200Response.md)
|
|
84
|
+
- [AdminPromotionCacheClear200ResponseContent](docs/AdminPromotionCacheClear200ResponseContent.md)
|
|
85
|
+
- [AdminPromotionCacheClear500Response](docs/AdminPromotionCacheClear500Response.md)
|
|
82
86
|
- [AuthLogin200Response](docs/AuthLogin200Response.md)
|
|
83
87
|
- [AuthLogin401Response](docs/AuthLogin401Response.md)
|
|
84
88
|
- [AuthLoginByToken200Response](docs/AuthLoginByToken200Response.md)
|
package/api.ts
CHANGED
|
@@ -61,6 +61,75 @@ export interface AdminAuthRequestTokenRequest {
|
|
|
61
61
|
*/
|
|
62
62
|
'email'?: string;
|
|
63
63
|
}
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @export
|
|
67
|
+
* @interface AdminPromotionCacheClear200Response
|
|
68
|
+
*/
|
|
69
|
+
export interface AdminPromotionCacheClear200Response {
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @type {string}
|
|
73
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
74
|
+
*/
|
|
75
|
+
'action'?: string;
|
|
76
|
+
/**
|
|
77
|
+
*
|
|
78
|
+
* @type {string}
|
|
79
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
80
|
+
*/
|
|
81
|
+
'result'?: string;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {string}
|
|
85
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
86
|
+
*/
|
|
87
|
+
'message'?: string;
|
|
88
|
+
/**
|
|
89
|
+
*
|
|
90
|
+
* @type {AdminPromotionCacheClear200ResponseContent}
|
|
91
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
92
|
+
*/
|
|
93
|
+
'content'?: AdminPromotionCacheClear200ResponseContent;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @export
|
|
98
|
+
* @interface AdminPromotionCacheClear200ResponseContent
|
|
99
|
+
*/
|
|
100
|
+
export interface AdminPromotionCacheClear200ResponseContent {
|
|
101
|
+
/**
|
|
102
|
+
*
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof AdminPromotionCacheClear200ResponseContent
|
|
105
|
+
*/
|
|
106
|
+
'promotion_id'?: string;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @export
|
|
111
|
+
* @interface AdminPromotionCacheClear500Response
|
|
112
|
+
*/
|
|
113
|
+
export interface AdminPromotionCacheClear500Response {
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @type {string}
|
|
117
|
+
* @memberof AdminPromotionCacheClear500Response
|
|
118
|
+
*/
|
|
119
|
+
'action'?: string;
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @type {string}
|
|
123
|
+
* @memberof AdminPromotionCacheClear500Response
|
|
124
|
+
*/
|
|
125
|
+
'result'?: string;
|
|
126
|
+
/**
|
|
127
|
+
*
|
|
128
|
+
* @type {string}
|
|
129
|
+
* @memberof AdminPromotionCacheClear500Response
|
|
130
|
+
*/
|
|
131
|
+
'message'?: string;
|
|
132
|
+
}
|
|
64
133
|
/**
|
|
65
134
|
*
|
|
66
135
|
* @export
|
|
@@ -2408,6 +2477,44 @@ export class MetricsApi extends BaseAPI {
|
|
|
2408
2477
|
*/
|
|
2409
2478
|
export const PromotionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2410
2479
|
return {
|
|
2480
|
+
/**
|
|
2481
|
+
*
|
|
2482
|
+
* @summary Renova o cache de uma promoção na API
|
|
2483
|
+
* @param {string} promotionId UUID da promoção
|
|
2484
|
+
* @param {*} [options] Override http request option.
|
|
2485
|
+
* @throws {RequiredError}
|
|
2486
|
+
*/
|
|
2487
|
+
adminPromotionCacheClear: async (promotionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2488
|
+
// verify required parameter 'promotionId' is not null or undefined
|
|
2489
|
+
assertParamExists('adminPromotionCacheClear', 'promotionId', promotionId)
|
|
2490
|
+
const localVarPath = `/v3/admin/promotion/{promotion_id}/cache/clear`
|
|
2491
|
+
.replace(`{${"promotion_id"}}`, encodeURIComponent(String(promotionId)));
|
|
2492
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2493
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2494
|
+
let baseOptions;
|
|
2495
|
+
if (configuration) {
|
|
2496
|
+
baseOptions = configuration.baseOptions;
|
|
2497
|
+
}
|
|
2498
|
+
|
|
2499
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2500
|
+
const localVarHeaderParameter = {} as any;
|
|
2501
|
+
const localVarQueryParameter = {} as any;
|
|
2502
|
+
|
|
2503
|
+
// authentication bearerAuth required
|
|
2504
|
+
// http bearer authentication required
|
|
2505
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
|
|
2509
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2510
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2511
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2512
|
+
|
|
2513
|
+
return {
|
|
2514
|
+
url: toPathString(localVarUrlObj),
|
|
2515
|
+
options: localVarRequestOptions,
|
|
2516
|
+
};
|
|
2517
|
+
},
|
|
2411
2518
|
/**
|
|
2412
2519
|
*
|
|
2413
2520
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -2494,6 +2601,19 @@ export const PromotionApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2494
2601
|
export const PromotionApiFp = function(configuration?: Configuration) {
|
|
2495
2602
|
const localVarAxiosParamCreator = PromotionApiAxiosParamCreator(configuration)
|
|
2496
2603
|
return {
|
|
2604
|
+
/**
|
|
2605
|
+
*
|
|
2606
|
+
* @summary Renova o cache de uma promoção na API
|
|
2607
|
+
* @param {string} promotionId UUID da promoção
|
|
2608
|
+
* @param {*} [options] Override http request option.
|
|
2609
|
+
* @throws {RequiredError}
|
|
2610
|
+
*/
|
|
2611
|
+
async adminPromotionCacheClear(promotionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminPromotionCacheClear200Response>> {
|
|
2612
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminPromotionCacheClear(promotionId, options);
|
|
2613
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2614
|
+
const localVarOperationServerBasePath = operationServerMap['PromotionApi.adminPromotionCacheClear']?.[localVarOperationServerIndex]?.url;
|
|
2615
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2616
|
+
},
|
|
2497
2617
|
/**
|
|
2498
2618
|
*
|
|
2499
2619
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -2530,6 +2650,16 @@ export const PromotionApiFp = function(configuration?: Configuration) {
|
|
|
2530
2650
|
export const PromotionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2531
2651
|
const localVarFp = PromotionApiFp(configuration)
|
|
2532
2652
|
return {
|
|
2653
|
+
/**
|
|
2654
|
+
*
|
|
2655
|
+
* @summary Renova o cache de uma promoção na API
|
|
2656
|
+
* @param {PromotionApiAdminPromotionCacheClearRequest} requestParameters Request parameters.
|
|
2657
|
+
* @param {*} [options] Override http request option.
|
|
2658
|
+
* @throws {RequiredError}
|
|
2659
|
+
*/
|
|
2660
|
+
adminPromotionCacheClear(requestParameters: PromotionApiAdminPromotionCacheClearRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminPromotionCacheClear200Response> {
|
|
2661
|
+
return localVarFp.adminPromotionCacheClear(requestParameters.promotionId, options).then((request) => request(axios, basePath));
|
|
2662
|
+
},
|
|
2533
2663
|
/**
|
|
2534
2664
|
*
|
|
2535
2665
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -2553,6 +2683,20 @@ export const PromotionApiFactory = function (configuration?: Configuration, base
|
|
|
2553
2683
|
};
|
|
2554
2684
|
};
|
|
2555
2685
|
|
|
2686
|
+
/**
|
|
2687
|
+
* Request parameters for adminPromotionCacheClear operation in PromotionApi.
|
|
2688
|
+
* @export
|
|
2689
|
+
* @interface PromotionApiAdminPromotionCacheClearRequest
|
|
2690
|
+
*/
|
|
2691
|
+
export interface PromotionApiAdminPromotionCacheClearRequest {
|
|
2692
|
+
/**
|
|
2693
|
+
* UUID da promoção
|
|
2694
|
+
* @type {string}
|
|
2695
|
+
* @memberof PromotionApiAdminPromotionCacheClear
|
|
2696
|
+
*/
|
|
2697
|
+
readonly promotionId: string
|
|
2698
|
+
}
|
|
2699
|
+
|
|
2556
2700
|
/**
|
|
2557
2701
|
* Request parameters for promotionPullConfiguration operation in PromotionApi.
|
|
2558
2702
|
* @export
|
|
@@ -2588,6 +2732,18 @@ export interface PromotionApiPromotionStartRequest {
|
|
|
2588
2732
|
* @extends {BaseAPI}
|
|
2589
2733
|
*/
|
|
2590
2734
|
export class PromotionApi extends BaseAPI {
|
|
2735
|
+
/**
|
|
2736
|
+
*
|
|
2737
|
+
* @summary Renova o cache de uma promoção na API
|
|
2738
|
+
* @param {PromotionApiAdminPromotionCacheClearRequest} requestParameters Request parameters.
|
|
2739
|
+
* @param {*} [options] Override http request option.
|
|
2740
|
+
* @throws {RequiredError}
|
|
2741
|
+
* @memberof PromotionApi
|
|
2742
|
+
*/
|
|
2743
|
+
public adminPromotionCacheClear(requestParameters: PromotionApiAdminPromotionCacheClearRequest, options?: RawAxiosRequestConfig) {
|
|
2744
|
+
return PromotionApiFp(this.configuration).adminPromotionCacheClear(requestParameters.promotionId, options).then((request) => request(this.axios, this.basePath));
|
|
2745
|
+
}
|
|
2746
|
+
|
|
2591
2747
|
/**
|
|
2592
2748
|
*
|
|
2593
2749
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
package/dist/api.d.ts
CHANGED
|
@@ -51,6 +51,75 @@ export interface AdminAuthRequestTokenRequest {
|
|
|
51
51
|
*/
|
|
52
52
|
'email'?: string;
|
|
53
53
|
}
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @export
|
|
57
|
+
* @interface AdminPromotionCacheClear200Response
|
|
58
|
+
*/
|
|
59
|
+
export interface AdminPromotionCacheClear200Response {
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
64
|
+
*/
|
|
65
|
+
'action'?: string;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
70
|
+
*/
|
|
71
|
+
'result'?: string;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
76
|
+
*/
|
|
77
|
+
'message'?: string;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @type {AdminPromotionCacheClear200ResponseContent}
|
|
81
|
+
* @memberof AdminPromotionCacheClear200Response
|
|
82
|
+
*/
|
|
83
|
+
'content'?: AdminPromotionCacheClear200ResponseContent;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
*
|
|
87
|
+
* @export
|
|
88
|
+
* @interface AdminPromotionCacheClear200ResponseContent
|
|
89
|
+
*/
|
|
90
|
+
export interface AdminPromotionCacheClear200ResponseContent {
|
|
91
|
+
/**
|
|
92
|
+
*
|
|
93
|
+
* @type {string}
|
|
94
|
+
* @memberof AdminPromotionCacheClear200ResponseContent
|
|
95
|
+
*/
|
|
96
|
+
'promotion_id'?: string;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @export
|
|
101
|
+
* @interface AdminPromotionCacheClear500Response
|
|
102
|
+
*/
|
|
103
|
+
export interface AdminPromotionCacheClear500Response {
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {string}
|
|
107
|
+
* @memberof AdminPromotionCacheClear500Response
|
|
108
|
+
*/
|
|
109
|
+
'action'?: string;
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof AdminPromotionCacheClear500Response
|
|
114
|
+
*/
|
|
115
|
+
'result'?: string;
|
|
116
|
+
/**
|
|
117
|
+
*
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof AdminPromotionCacheClear500Response
|
|
120
|
+
*/
|
|
121
|
+
'message'?: string;
|
|
122
|
+
}
|
|
54
123
|
/**
|
|
55
124
|
*
|
|
56
125
|
* @export
|
|
@@ -2112,6 +2181,14 @@ export declare class MetricsApi extends BaseAPI {
|
|
|
2112
2181
|
* @export
|
|
2113
2182
|
*/
|
|
2114
2183
|
export declare const PromotionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2184
|
+
/**
|
|
2185
|
+
*
|
|
2186
|
+
* @summary Renova o cache de uma promoção na API
|
|
2187
|
+
* @param {string} promotionId UUID da promoção
|
|
2188
|
+
* @param {*} [options] Override http request option.
|
|
2189
|
+
* @throws {RequiredError}
|
|
2190
|
+
*/
|
|
2191
|
+
adminPromotionCacheClear: (promotionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2115
2192
|
/**
|
|
2116
2193
|
*
|
|
2117
2194
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -2134,6 +2211,14 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2134
2211
|
* @export
|
|
2135
2212
|
*/
|
|
2136
2213
|
export declare const PromotionApiFp: (configuration?: Configuration) => {
|
|
2214
|
+
/**
|
|
2215
|
+
*
|
|
2216
|
+
* @summary Renova o cache de uma promoção na API
|
|
2217
|
+
* @param {string} promotionId UUID da promoção
|
|
2218
|
+
* @param {*} [options] Override http request option.
|
|
2219
|
+
* @throws {RequiredError}
|
|
2220
|
+
*/
|
|
2221
|
+
adminPromotionCacheClear(promotionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminPromotionCacheClear200Response>>;
|
|
2137
2222
|
/**
|
|
2138
2223
|
*
|
|
2139
2224
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -2156,6 +2241,14 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
|
|
|
2156
2241
|
* @export
|
|
2157
2242
|
*/
|
|
2158
2243
|
export declare const PromotionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2244
|
+
/**
|
|
2245
|
+
*
|
|
2246
|
+
* @summary Renova o cache de uma promoção na API
|
|
2247
|
+
* @param {PromotionApiAdminPromotionCacheClearRequest} requestParameters Request parameters.
|
|
2248
|
+
* @param {*} [options] Override http request option.
|
|
2249
|
+
* @throws {RequiredError}
|
|
2250
|
+
*/
|
|
2251
|
+
adminPromotionCacheClear(requestParameters: PromotionApiAdminPromotionCacheClearRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminPromotionCacheClear200Response>;
|
|
2159
2252
|
/**
|
|
2160
2253
|
*
|
|
2161
2254
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -2173,6 +2266,19 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
|
|
|
2173
2266
|
*/
|
|
2174
2267
|
promotionStart(requestParameters?: PromotionApiPromotionStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<PromotionStart200Response>;
|
|
2175
2268
|
};
|
|
2269
|
+
/**
|
|
2270
|
+
* Request parameters for adminPromotionCacheClear operation in PromotionApi.
|
|
2271
|
+
* @export
|
|
2272
|
+
* @interface PromotionApiAdminPromotionCacheClearRequest
|
|
2273
|
+
*/
|
|
2274
|
+
export interface PromotionApiAdminPromotionCacheClearRequest {
|
|
2275
|
+
/**
|
|
2276
|
+
* UUID da promoção
|
|
2277
|
+
* @type {string}
|
|
2278
|
+
* @memberof PromotionApiAdminPromotionCacheClear
|
|
2279
|
+
*/
|
|
2280
|
+
readonly promotionId: string;
|
|
2281
|
+
}
|
|
2176
2282
|
/**
|
|
2177
2283
|
* Request parameters for promotionPullConfiguration operation in PromotionApi.
|
|
2178
2284
|
* @export
|
|
@@ -2206,6 +2312,15 @@ export interface PromotionApiPromotionStartRequest {
|
|
|
2206
2312
|
* @extends {BaseAPI}
|
|
2207
2313
|
*/
|
|
2208
2314
|
export declare class PromotionApi extends BaseAPI {
|
|
2315
|
+
/**
|
|
2316
|
+
*
|
|
2317
|
+
* @summary Renova o cache de uma promoção na API
|
|
2318
|
+
* @param {PromotionApiAdminPromotionCacheClearRequest} requestParameters Request parameters.
|
|
2319
|
+
* @param {*} [options] Override http request option.
|
|
2320
|
+
* @throws {RequiredError}
|
|
2321
|
+
* @memberof PromotionApi
|
|
2322
|
+
*/
|
|
2323
|
+
adminPromotionCacheClear(requestParameters: PromotionApiAdminPromotionCacheClearRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminPromotionCacheClear200Response, any, {}>>;
|
|
2209
2324
|
/**
|
|
2210
2325
|
*
|
|
2211
2326
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
package/dist/api.js
CHANGED
|
@@ -814,6 +814,53 @@ exports.MetricsApi = MetricsApi;
|
|
|
814
814
|
var PromotionApiAxiosParamCreator = function (configuration) {
|
|
815
815
|
var _this = this;
|
|
816
816
|
return {
|
|
817
|
+
/**
|
|
818
|
+
*
|
|
819
|
+
* @summary Renova o cache de uma promoção na API
|
|
820
|
+
* @param {string} promotionId UUID da promoção
|
|
821
|
+
* @param {*} [options] Override http request option.
|
|
822
|
+
* @throws {RequiredError}
|
|
823
|
+
*/
|
|
824
|
+
adminPromotionCacheClear: function (promotionId_1) {
|
|
825
|
+
var args_1 = [];
|
|
826
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
827
|
+
args_1[_i - 1] = arguments[_i];
|
|
828
|
+
}
|
|
829
|
+
return __awaiter(_this, __spreadArray([promotionId_1], args_1, true), void 0, function (promotionId, options) {
|
|
830
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
831
|
+
if (options === void 0) { options = {}; }
|
|
832
|
+
return __generator(this, function (_a) {
|
|
833
|
+
switch (_a.label) {
|
|
834
|
+
case 0:
|
|
835
|
+
// verify required parameter 'promotionId' is not null or undefined
|
|
836
|
+
(0, common_1.assertParamExists)('adminPromotionCacheClear', 'promotionId', promotionId);
|
|
837
|
+
localVarPath = "/v3/admin/promotion/{promotion_id}/cache/clear"
|
|
838
|
+
.replace("{".concat("promotion_id", "}"), encodeURIComponent(String(promotionId)));
|
|
839
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
840
|
+
if (configuration) {
|
|
841
|
+
baseOptions = configuration.baseOptions;
|
|
842
|
+
}
|
|
843
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
844
|
+
localVarHeaderParameter = {};
|
|
845
|
+
localVarQueryParameter = {};
|
|
846
|
+
// authentication bearerAuth required
|
|
847
|
+
// http bearer authentication required
|
|
848
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
849
|
+
case 1:
|
|
850
|
+
// authentication bearerAuth required
|
|
851
|
+
// http bearer authentication required
|
|
852
|
+
_a.sent();
|
|
853
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
854
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
855
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
856
|
+
return [2 /*return*/, {
|
|
857
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
858
|
+
options: localVarRequestOptions,
|
|
859
|
+
}];
|
|
860
|
+
}
|
|
861
|
+
});
|
|
862
|
+
});
|
|
863
|
+
},
|
|
817
864
|
/**
|
|
818
865
|
*
|
|
819
866
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -916,6 +963,29 @@ exports.PromotionApiAxiosParamCreator = PromotionApiAxiosParamCreator;
|
|
|
916
963
|
var PromotionApiFp = function (configuration) {
|
|
917
964
|
var localVarAxiosParamCreator = (0, exports.PromotionApiAxiosParamCreator)(configuration);
|
|
918
965
|
return {
|
|
966
|
+
/**
|
|
967
|
+
*
|
|
968
|
+
* @summary Renova o cache de uma promoção na API
|
|
969
|
+
* @param {string} promotionId UUID da promoção
|
|
970
|
+
* @param {*} [options] Override http request option.
|
|
971
|
+
* @throws {RequiredError}
|
|
972
|
+
*/
|
|
973
|
+
adminPromotionCacheClear: function (promotionId, options) {
|
|
974
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
975
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
976
|
+
var _a, _b, _c;
|
|
977
|
+
return __generator(this, function (_d) {
|
|
978
|
+
switch (_d.label) {
|
|
979
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.adminPromotionCacheClear(promotionId, options)];
|
|
980
|
+
case 1:
|
|
981
|
+
localVarAxiosArgs = _d.sent();
|
|
982
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
983
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PromotionApi.adminPromotionCacheClear']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
984
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
985
|
+
}
|
|
986
|
+
});
|
|
987
|
+
});
|
|
988
|
+
},
|
|
919
989
|
/**
|
|
920
990
|
*
|
|
921
991
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -972,6 +1042,16 @@ exports.PromotionApiFp = PromotionApiFp;
|
|
|
972
1042
|
var PromotionApiFactory = function (configuration, basePath, axios) {
|
|
973
1043
|
var localVarFp = (0, exports.PromotionApiFp)(configuration);
|
|
974
1044
|
return {
|
|
1045
|
+
/**
|
|
1046
|
+
*
|
|
1047
|
+
* @summary Renova o cache de uma promoção na API
|
|
1048
|
+
* @param {PromotionApiAdminPromotionCacheClearRequest} requestParameters Request parameters.
|
|
1049
|
+
* @param {*} [options] Override http request option.
|
|
1050
|
+
* @throws {RequiredError}
|
|
1051
|
+
*/
|
|
1052
|
+
adminPromotionCacheClear: function (requestParameters, options) {
|
|
1053
|
+
return localVarFp.adminPromotionCacheClear(requestParameters.promotionId, options).then(function (request) { return request(axios, basePath); });
|
|
1054
|
+
},
|
|
975
1055
|
/**
|
|
976
1056
|
*
|
|
977
1057
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -1008,6 +1088,18 @@ var PromotionApi = /** @class */ (function (_super) {
|
|
|
1008
1088
|
function PromotionApi() {
|
|
1009
1089
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
1010
1090
|
}
|
|
1091
|
+
/**
|
|
1092
|
+
*
|
|
1093
|
+
* @summary Renova o cache de uma promoção na API
|
|
1094
|
+
* @param {PromotionApiAdminPromotionCacheClearRequest} requestParameters Request parameters.
|
|
1095
|
+
* @param {*} [options] Override http request option.
|
|
1096
|
+
* @throws {RequiredError}
|
|
1097
|
+
* @memberof PromotionApi
|
|
1098
|
+
*/
|
|
1099
|
+
PromotionApi.prototype.adminPromotionCacheClear = function (requestParameters, options) {
|
|
1100
|
+
var _this = this;
|
|
1101
|
+
return (0, exports.PromotionApiFp)(this.configuration).adminPromotionCacheClear(requestParameters.promotionId, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1102
|
+
};
|
|
1011
1103
|
/**
|
|
1012
1104
|
*
|
|
1013
1105
|
* @summary Adicionar/Atualizar configurações de uma promoção ao orquestrador
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# AdminPromotionCacheClear200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**action** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**result** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**content** | [**AdminPromotionCacheClear200ResponseContent**](AdminPromotionCacheClear200ResponseContent.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminPromotionCacheClear200Response } from '@handsondigital/idplugger-admin';
|
|
17
|
+
|
|
18
|
+
const instance: AdminPromotionCacheClear200Response = {
|
|
19
|
+
action,
|
|
20
|
+
result,
|
|
21
|
+
message,
|
|
22
|
+
content,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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
|
+
# AdminPromotionCacheClear200ResponseContent
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**promotion_id** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AdminPromotionCacheClear200ResponseContent } from '@handsondigital/idplugger-admin';
|
|
14
|
+
|
|
15
|
+
const instance: AdminPromotionCacheClear200ResponseContent = {
|
|
16
|
+
promotion_id,
|
|
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,24 @@
|
|
|
1
|
+
# AdminPromotionCacheClear500Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**action** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**result** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AdminPromotionCacheClear500Response } from '@handsondigital/idplugger-admin';
|
|
16
|
+
|
|
17
|
+
const instance: AdminPromotionCacheClear500Response = {
|
|
18
|
+
action,
|
|
19
|
+
result,
|
|
20
|
+
message,
|
|
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)
|
package/docs/PromotionApi.md
CHANGED
|
@@ -4,9 +4,62 @@ All URIs are relative to *https://api.idplugger.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**adminPromotionCacheClear**](#adminpromotioncacheclear) | **POST** /v3/admin/promotion/{promotion_id}/cache/clear | Renova o cache de uma promoção na API|
|
|
7
8
|
|[**promotionPullConfiguration**](#promotionpullconfiguration) | **POST** /v3/admin/pullconfiguration | Adicionar/Atualizar configurações de uma promoção ao orquestrador|
|
|
8
9
|
|[**promotionStart**](#promotionstart) | **POST** /v3/admin/promotion/start | Iniciar uma promoção na API|
|
|
9
10
|
|
|
11
|
+
# **adminPromotionCacheClear**
|
|
12
|
+
> AdminPromotionCacheClear200Response adminPromotionCacheClear()
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
PromotionApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@handsondigital/idplugger-admin';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new PromotionApi(configuration);
|
|
25
|
+
|
|
26
|
+
let promotionId: string; //UUID da promoção (default to undefined)
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.adminPromotionCacheClear(
|
|
29
|
+
promotionId
|
|
30
|
+
);
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|Name | Type | Description | Notes|
|
|
36
|
+
|------------- | ------------- | ------------- | -------------|
|
|
37
|
+
| **promotionId** | [**string**] | UUID da promoção | defaults to undefined|
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**AdminPromotionCacheClear200Response**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: Not defined
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### HTTP response details
|
|
55
|
+
| Status code | Description | Response headers |
|
|
56
|
+
|-------------|-------------|------------------|
|
|
57
|
+
|**200** | success | - |
|
|
58
|
+
|**401** | failed | - |
|
|
59
|
+
|**500** | failed | - |
|
|
60
|
+
|
|
61
|
+
[[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)
|
|
62
|
+
|
|
10
63
|
# **promotionPullConfiguration**
|
|
11
64
|
> PromotionPullConfiguration200Response promotionPullConfiguration()
|
|
12
65
|
|