@teemill/platform 0.31.0 → 0.32.0
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 +7 -2
- package/api.ts +333 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +214 -1
- package/dist/api.js +202 -2
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +214 -1
- package/dist/esm/api.js +197 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DashboardApi.md +127 -0
- package/docs/DashboardItem.md +30 -0
- package/docs/GetDashboardResponse.md +20 -0
- package/docs/SaveDashboardRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.32.0
|
|
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 @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.32.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Class | Method | HTTP request | Description
|
|
|
54
54
|
*CustomersApi* | [**exportCustomers**](docs/CustomersApi.md#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers
|
|
55
55
|
*CustomersApi* | [**getCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer
|
|
56
56
|
*CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers
|
|
57
|
+
*DashboardApi* | [**getDashboard**](docs/DashboardApi.md#getdashboard) | **GET** /v1/platform/{platformId}/dashboard | Get the platform\'s dashboard
|
|
58
|
+
*DashboardApi* | [**saveDashboard**](docs/DashboardApi.md#savedashboard) | **PUT** /v1/platform/{platformId}/dashboard | Save the platform\'s dashboard
|
|
57
59
|
*EnquiriesApi* | [**createChatChannel**](docs/EnquiriesApi.md#createchatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel
|
|
58
60
|
*EnquiriesApi* | [**getCustomerEnquiry**](docs/EnquiriesApi.md#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry
|
|
59
61
|
*EnquiriesApi* | [**listCustomerEnquiries**](docs/EnquiriesApi.md#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries
|
|
@@ -118,6 +120,7 @@ Class | Method | HTTP request | Description
|
|
|
118
120
|
- [Customer](docs/Customer.md)
|
|
119
121
|
- [CustomersResponse](docs/CustomersResponse.md)
|
|
120
122
|
- [CustomsInformation](docs/CustomsInformation.md)
|
|
123
|
+
- [DashboardItem](docs/DashboardItem.md)
|
|
121
124
|
- [DeliveryEstimates](docs/DeliveryEstimates.md)
|
|
122
125
|
- [Domain](docs/Domain.md)
|
|
123
126
|
- [Enquiry](docs/Enquiry.md)
|
|
@@ -129,6 +132,7 @@ Class | Method | HTTP request | Description
|
|
|
129
132
|
- [FulfillersResponse](docs/FulfillersResponse.md)
|
|
130
133
|
- [Fulfillment](docs/Fulfillment.md)
|
|
131
134
|
- [FulfillmentItem](docs/FulfillmentItem.md)
|
|
135
|
+
- [GetDashboardResponse](docs/GetDashboardResponse.md)
|
|
132
136
|
- [Image](docs/Image.md)
|
|
133
137
|
- [InlineObject](docs/InlineObject.md)
|
|
134
138
|
- [InlineObject1](docs/InlineObject1.md)
|
|
@@ -160,6 +164,7 @@ Class | Method | HTTP request | Description
|
|
|
160
164
|
- [ReviewReply](docs/ReviewReply.md)
|
|
161
165
|
- [ReviewReplyAuthor](docs/ReviewReplyAuthor.md)
|
|
162
166
|
- [ReviewsResponse](docs/ReviewsResponse.md)
|
|
167
|
+
- [SaveDashboardRequest](docs/SaveDashboardRequest.md)
|
|
163
168
|
- [SaveTermsRequest](docs/SaveTermsRequest.md)
|
|
164
169
|
- [ShippingMethod](docs/ShippingMethod.md)
|
|
165
170
|
- [Statistics](docs/Statistics.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.32.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -626,6 +626,49 @@ export const CustomsInformationPreRegistrationTypeEnum = {
|
|
|
626
626
|
|
|
627
627
|
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
628
628
|
|
|
629
|
+
/**
|
|
630
|
+
*
|
|
631
|
+
* @export
|
|
632
|
+
* @interface DashboardItem
|
|
633
|
+
*/
|
|
634
|
+
export interface DashboardItem {
|
|
635
|
+
/**
|
|
636
|
+
*
|
|
637
|
+
* @type {string}
|
|
638
|
+
* @memberof DashboardItem
|
|
639
|
+
*/
|
|
640
|
+
'id': string;
|
|
641
|
+
/**
|
|
642
|
+
*
|
|
643
|
+
* @type {string}
|
|
644
|
+
* @memberof DashboardItem
|
|
645
|
+
*/
|
|
646
|
+
'type': string;
|
|
647
|
+
/**
|
|
648
|
+
*
|
|
649
|
+
* @type {{ [key: string]: any; }}
|
|
650
|
+
* @memberof DashboardItem
|
|
651
|
+
*/
|
|
652
|
+
'properties': { [key: string]: any; } | null;
|
|
653
|
+
/**
|
|
654
|
+
*
|
|
655
|
+
* @type {boolean}
|
|
656
|
+
* @memberof DashboardItem
|
|
657
|
+
*/
|
|
658
|
+
'published': boolean;
|
|
659
|
+
/**
|
|
660
|
+
*
|
|
661
|
+
* @type {number}
|
|
662
|
+
* @memberof DashboardItem
|
|
663
|
+
*/
|
|
664
|
+
'sortOrder': number;
|
|
665
|
+
/**
|
|
666
|
+
*
|
|
667
|
+
* @type {Array<DashboardItem>}
|
|
668
|
+
* @memberof DashboardItem
|
|
669
|
+
*/
|
|
670
|
+
'items'?: Array<DashboardItem> | null;
|
|
671
|
+
}
|
|
629
672
|
/**
|
|
630
673
|
*
|
|
631
674
|
* @export
|
|
@@ -959,6 +1002,19 @@ export interface FulfillmentItem {
|
|
|
959
1002
|
*/
|
|
960
1003
|
'quantity'?: number;
|
|
961
1004
|
}
|
|
1005
|
+
/**
|
|
1006
|
+
*
|
|
1007
|
+
* @export
|
|
1008
|
+
* @interface GetDashboardResponse
|
|
1009
|
+
*/
|
|
1010
|
+
export interface GetDashboardResponse {
|
|
1011
|
+
/**
|
|
1012
|
+
*
|
|
1013
|
+
* @type {Array<DashboardItem>}
|
|
1014
|
+
* @memberof GetDashboardResponse
|
|
1015
|
+
*/
|
|
1016
|
+
'items'?: Array<DashboardItem>;
|
|
1017
|
+
}
|
|
962
1018
|
/**
|
|
963
1019
|
* Image description
|
|
964
1020
|
* @export
|
|
@@ -1903,6 +1959,19 @@ export interface ReviewsResponse {
|
|
|
1903
1959
|
*/
|
|
1904
1960
|
'nextPageToken'?: number | null;
|
|
1905
1961
|
}
|
|
1962
|
+
/**
|
|
1963
|
+
*
|
|
1964
|
+
* @export
|
|
1965
|
+
* @interface SaveDashboardRequest
|
|
1966
|
+
*/
|
|
1967
|
+
export interface SaveDashboardRequest {
|
|
1968
|
+
/**
|
|
1969
|
+
*
|
|
1970
|
+
* @type {Array<DashboardItem>}
|
|
1971
|
+
* @memberof SaveDashboardRequest
|
|
1972
|
+
*/
|
|
1973
|
+
'items'?: Array<DashboardItem>;
|
|
1974
|
+
}
|
|
1906
1975
|
/**
|
|
1907
1976
|
*
|
|
1908
1977
|
* @export
|
|
@@ -3037,6 +3106,269 @@ export const ListCustomersGenderEnum = {
|
|
|
3037
3106
|
export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
|
|
3038
3107
|
|
|
3039
3108
|
|
|
3109
|
+
/**
|
|
3110
|
+
* DashboardApi - axios parameter creator
|
|
3111
|
+
* @export
|
|
3112
|
+
*/
|
|
3113
|
+
export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3114
|
+
return {
|
|
3115
|
+
/**
|
|
3116
|
+
*
|
|
3117
|
+
* @summary Get the platform\'s dashboard
|
|
3118
|
+
* @param {string} project Project unique identifier
|
|
3119
|
+
* @param {string} platformId The platform identifier
|
|
3120
|
+
* @param {*} [options] Override http request option.
|
|
3121
|
+
* @throws {RequiredError}
|
|
3122
|
+
*/
|
|
3123
|
+
getDashboard: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3124
|
+
// verify required parameter 'project' is not null or undefined
|
|
3125
|
+
assertParamExists('getDashboard', 'project', project)
|
|
3126
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3127
|
+
assertParamExists('getDashboard', 'platformId', platformId)
|
|
3128
|
+
const localVarPath = `/v1/platform/{platformId}/dashboard`
|
|
3129
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3130
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3131
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3132
|
+
let baseOptions;
|
|
3133
|
+
if (configuration) {
|
|
3134
|
+
baseOptions = configuration.baseOptions;
|
|
3135
|
+
}
|
|
3136
|
+
|
|
3137
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3138
|
+
const localVarHeaderParameter = {} as any;
|
|
3139
|
+
const localVarQueryParameter = {} as any;
|
|
3140
|
+
|
|
3141
|
+
// authentication session-oauth required
|
|
3142
|
+
// oauth required
|
|
3143
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3144
|
+
|
|
3145
|
+
// authentication api-key required
|
|
3146
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3147
|
+
|
|
3148
|
+
if (project !== undefined) {
|
|
3149
|
+
localVarQueryParameter['project'] = project;
|
|
3150
|
+
}
|
|
3151
|
+
|
|
3152
|
+
|
|
3153
|
+
|
|
3154
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3155
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3156
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3157
|
+
|
|
3158
|
+
return {
|
|
3159
|
+
url: toPathString(localVarUrlObj),
|
|
3160
|
+
options: localVarRequestOptions,
|
|
3161
|
+
};
|
|
3162
|
+
},
|
|
3163
|
+
/**
|
|
3164
|
+
*
|
|
3165
|
+
* @summary Save the platform\'s dashboard
|
|
3166
|
+
* @param {string} project Project unique identifier
|
|
3167
|
+
* @param {string} platformId The platform identifier
|
|
3168
|
+
* @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
|
|
3169
|
+
* @param {*} [options] Override http request option.
|
|
3170
|
+
* @throws {RequiredError}
|
|
3171
|
+
*/
|
|
3172
|
+
saveDashboard: async (project: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3173
|
+
// verify required parameter 'project' is not null or undefined
|
|
3174
|
+
assertParamExists('saveDashboard', 'project', project)
|
|
3175
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3176
|
+
assertParamExists('saveDashboard', 'platformId', platformId)
|
|
3177
|
+
// verify required parameter 'saveDashboardRequest' is not null or undefined
|
|
3178
|
+
assertParamExists('saveDashboard', 'saveDashboardRequest', saveDashboardRequest)
|
|
3179
|
+
const localVarPath = `/v1/platform/{platformId}/dashboard`
|
|
3180
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3181
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3182
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3183
|
+
let baseOptions;
|
|
3184
|
+
if (configuration) {
|
|
3185
|
+
baseOptions = configuration.baseOptions;
|
|
3186
|
+
}
|
|
3187
|
+
|
|
3188
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
3189
|
+
const localVarHeaderParameter = {} as any;
|
|
3190
|
+
const localVarQueryParameter = {} as any;
|
|
3191
|
+
|
|
3192
|
+
// authentication session-oauth required
|
|
3193
|
+
// oauth required
|
|
3194
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3195
|
+
|
|
3196
|
+
// authentication api-key required
|
|
3197
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3198
|
+
|
|
3199
|
+
if (project !== undefined) {
|
|
3200
|
+
localVarQueryParameter['project'] = project;
|
|
3201
|
+
}
|
|
3202
|
+
|
|
3203
|
+
|
|
3204
|
+
|
|
3205
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3206
|
+
|
|
3207
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3208
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3209
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3210
|
+
localVarRequestOptions.data = serializeDataIfNeeded(saveDashboardRequest, localVarRequestOptions, configuration)
|
|
3211
|
+
|
|
3212
|
+
return {
|
|
3213
|
+
url: toPathString(localVarUrlObj),
|
|
3214
|
+
options: localVarRequestOptions,
|
|
3215
|
+
};
|
|
3216
|
+
},
|
|
3217
|
+
}
|
|
3218
|
+
};
|
|
3219
|
+
|
|
3220
|
+
/**
|
|
3221
|
+
* DashboardApi - functional programming interface
|
|
3222
|
+
* @export
|
|
3223
|
+
*/
|
|
3224
|
+
export const DashboardApiFp = function(configuration?: Configuration) {
|
|
3225
|
+
const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration)
|
|
3226
|
+
return {
|
|
3227
|
+
/**
|
|
3228
|
+
*
|
|
3229
|
+
* @summary Get the platform\'s dashboard
|
|
3230
|
+
* @param {string} project Project unique identifier
|
|
3231
|
+
* @param {string} platformId The platform identifier
|
|
3232
|
+
* @param {*} [options] Override http request option.
|
|
3233
|
+
* @throws {RequiredError}
|
|
3234
|
+
*/
|
|
3235
|
+
async getDashboard(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>> {
|
|
3236
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDashboard(project, platformId, options);
|
|
3237
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3238
|
+
const localVarOperationServerBasePath = operationServerMap['DashboardApi.getDashboard']?.[localVarOperationServerIndex]?.url;
|
|
3239
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3240
|
+
},
|
|
3241
|
+
/**
|
|
3242
|
+
*
|
|
3243
|
+
* @summary Save the platform\'s dashboard
|
|
3244
|
+
* @param {string} project Project unique identifier
|
|
3245
|
+
* @param {string} platformId The platform identifier
|
|
3246
|
+
* @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
|
|
3247
|
+
* @param {*} [options] Override http request option.
|
|
3248
|
+
* @throws {RequiredError}
|
|
3249
|
+
*/
|
|
3250
|
+
async saveDashboard(project: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>> {
|
|
3251
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.saveDashboard(project, platformId, saveDashboardRequest, options);
|
|
3252
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3253
|
+
const localVarOperationServerBasePath = operationServerMap['DashboardApi.saveDashboard']?.[localVarOperationServerIndex]?.url;
|
|
3254
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3255
|
+
},
|
|
3256
|
+
}
|
|
3257
|
+
};
|
|
3258
|
+
|
|
3259
|
+
/**
|
|
3260
|
+
* DashboardApi - factory interface
|
|
3261
|
+
* @export
|
|
3262
|
+
*/
|
|
3263
|
+
export const DashboardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3264
|
+
const localVarFp = DashboardApiFp(configuration)
|
|
3265
|
+
return {
|
|
3266
|
+
/**
|
|
3267
|
+
*
|
|
3268
|
+
* @summary Get the platform\'s dashboard
|
|
3269
|
+
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
3270
|
+
* @param {*} [options] Override http request option.
|
|
3271
|
+
* @throws {RequiredError}
|
|
3272
|
+
*/
|
|
3273
|
+
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse> {
|
|
3274
|
+
return localVarFp.getDashboard(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
3275
|
+
},
|
|
3276
|
+
/**
|
|
3277
|
+
*
|
|
3278
|
+
* @summary Save the platform\'s dashboard
|
|
3279
|
+
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
3280
|
+
* @param {*} [options] Override http request option.
|
|
3281
|
+
* @throws {RequiredError}
|
|
3282
|
+
*/
|
|
3283
|
+
saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse> {
|
|
3284
|
+
return localVarFp.saveDashboard(requestParameters.project, requestParameters.platformId, requestParameters.saveDashboardRequest, options).then((request) => request(axios, basePath));
|
|
3285
|
+
},
|
|
3286
|
+
};
|
|
3287
|
+
};
|
|
3288
|
+
|
|
3289
|
+
/**
|
|
3290
|
+
* Request parameters for getDashboard operation in DashboardApi.
|
|
3291
|
+
* @export
|
|
3292
|
+
* @interface DashboardApiGetDashboardRequest
|
|
3293
|
+
*/
|
|
3294
|
+
export interface DashboardApiGetDashboardRequest {
|
|
3295
|
+
/**
|
|
3296
|
+
* Project unique identifier
|
|
3297
|
+
* @type {string}
|
|
3298
|
+
* @memberof DashboardApiGetDashboard
|
|
3299
|
+
*/
|
|
3300
|
+
readonly project: string
|
|
3301
|
+
|
|
3302
|
+
/**
|
|
3303
|
+
* The platform identifier
|
|
3304
|
+
* @type {string}
|
|
3305
|
+
* @memberof DashboardApiGetDashboard
|
|
3306
|
+
*/
|
|
3307
|
+
readonly platformId: string
|
|
3308
|
+
}
|
|
3309
|
+
|
|
3310
|
+
/**
|
|
3311
|
+
* Request parameters for saveDashboard operation in DashboardApi.
|
|
3312
|
+
* @export
|
|
3313
|
+
* @interface DashboardApiSaveDashboardRequest
|
|
3314
|
+
*/
|
|
3315
|
+
export interface DashboardApiSaveDashboardRequest {
|
|
3316
|
+
/**
|
|
3317
|
+
* Project unique identifier
|
|
3318
|
+
* @type {string}
|
|
3319
|
+
* @memberof DashboardApiSaveDashboard
|
|
3320
|
+
*/
|
|
3321
|
+
readonly project: string
|
|
3322
|
+
|
|
3323
|
+
/**
|
|
3324
|
+
* The platform identifier
|
|
3325
|
+
* @type {string}
|
|
3326
|
+
* @memberof DashboardApiSaveDashboard
|
|
3327
|
+
*/
|
|
3328
|
+
readonly platformId: string
|
|
3329
|
+
|
|
3330
|
+
/**
|
|
3331
|
+
* Save dashboard
|
|
3332
|
+
* @type {SaveDashboardRequest}
|
|
3333
|
+
* @memberof DashboardApiSaveDashboard
|
|
3334
|
+
*/
|
|
3335
|
+
readonly saveDashboardRequest: SaveDashboardRequest
|
|
3336
|
+
}
|
|
3337
|
+
|
|
3338
|
+
/**
|
|
3339
|
+
* DashboardApi - object-oriented interface
|
|
3340
|
+
* @export
|
|
3341
|
+
* @class DashboardApi
|
|
3342
|
+
* @extends {BaseAPI}
|
|
3343
|
+
*/
|
|
3344
|
+
export class DashboardApi extends BaseAPI {
|
|
3345
|
+
/**
|
|
3346
|
+
*
|
|
3347
|
+
* @summary Get the platform\'s dashboard
|
|
3348
|
+
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
3349
|
+
* @param {*} [options] Override http request option.
|
|
3350
|
+
* @throws {RequiredError}
|
|
3351
|
+
* @memberof DashboardApi
|
|
3352
|
+
*/
|
|
3353
|
+
public getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig) {
|
|
3354
|
+
return DashboardApiFp(this.configuration).getDashboard(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
3355
|
+
}
|
|
3356
|
+
|
|
3357
|
+
/**
|
|
3358
|
+
*
|
|
3359
|
+
* @summary Save the platform\'s dashboard
|
|
3360
|
+
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
3361
|
+
* @param {*} [options] Override http request option.
|
|
3362
|
+
* @throws {RequiredError}
|
|
3363
|
+
* @memberof DashboardApi
|
|
3364
|
+
*/
|
|
3365
|
+
public saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig) {
|
|
3366
|
+
return DashboardApiFp(this.configuration).saveDashboard(requestParameters.project, requestParameters.platformId, requestParameters.saveDashboardRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3367
|
+
}
|
|
3368
|
+
}
|
|
3369
|
+
|
|
3370
|
+
|
|
3371
|
+
|
|
3040
3372
|
/**
|
|
3041
3373
|
* EnquiriesApi - axios parameter creator
|
|
3042
3374
|
* @export
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.32.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -605,6 +605,51 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
|
|
|
605
605
|
readonly Ioss: "IOSS";
|
|
606
606
|
};
|
|
607
607
|
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
608
|
+
/**
|
|
609
|
+
*
|
|
610
|
+
* @export
|
|
611
|
+
* @interface DashboardItem
|
|
612
|
+
*/
|
|
613
|
+
export interface DashboardItem {
|
|
614
|
+
/**
|
|
615
|
+
*
|
|
616
|
+
* @type {string}
|
|
617
|
+
* @memberof DashboardItem
|
|
618
|
+
*/
|
|
619
|
+
'id': string;
|
|
620
|
+
/**
|
|
621
|
+
*
|
|
622
|
+
* @type {string}
|
|
623
|
+
* @memberof DashboardItem
|
|
624
|
+
*/
|
|
625
|
+
'type': string;
|
|
626
|
+
/**
|
|
627
|
+
*
|
|
628
|
+
* @type {{ [key: string]: any; }}
|
|
629
|
+
* @memberof DashboardItem
|
|
630
|
+
*/
|
|
631
|
+
'properties': {
|
|
632
|
+
[key: string]: any;
|
|
633
|
+
} | null;
|
|
634
|
+
/**
|
|
635
|
+
*
|
|
636
|
+
* @type {boolean}
|
|
637
|
+
* @memberof DashboardItem
|
|
638
|
+
*/
|
|
639
|
+
'published': boolean;
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @type {number}
|
|
643
|
+
* @memberof DashboardItem
|
|
644
|
+
*/
|
|
645
|
+
'sortOrder': number;
|
|
646
|
+
/**
|
|
647
|
+
*
|
|
648
|
+
* @type {Array<DashboardItem>}
|
|
649
|
+
* @memberof DashboardItem
|
|
650
|
+
*/
|
|
651
|
+
'items'?: Array<DashboardItem> | null;
|
|
652
|
+
}
|
|
608
653
|
/**
|
|
609
654
|
*
|
|
610
655
|
* @export
|
|
@@ -932,6 +977,19 @@ export interface FulfillmentItem {
|
|
|
932
977
|
*/
|
|
933
978
|
'quantity'?: number;
|
|
934
979
|
}
|
|
980
|
+
/**
|
|
981
|
+
*
|
|
982
|
+
* @export
|
|
983
|
+
* @interface GetDashboardResponse
|
|
984
|
+
*/
|
|
985
|
+
export interface GetDashboardResponse {
|
|
986
|
+
/**
|
|
987
|
+
*
|
|
988
|
+
* @type {Array<DashboardItem>}
|
|
989
|
+
* @memberof GetDashboardResponse
|
|
990
|
+
*/
|
|
991
|
+
'items'?: Array<DashboardItem>;
|
|
992
|
+
}
|
|
935
993
|
/**
|
|
936
994
|
* Image description
|
|
937
995
|
* @export
|
|
@@ -1867,6 +1925,19 @@ export interface ReviewsResponse {
|
|
|
1867
1925
|
*/
|
|
1868
1926
|
'nextPageToken'?: number | null;
|
|
1869
1927
|
}
|
|
1928
|
+
/**
|
|
1929
|
+
*
|
|
1930
|
+
* @export
|
|
1931
|
+
* @interface SaveDashboardRequest
|
|
1932
|
+
*/
|
|
1933
|
+
export interface SaveDashboardRequest {
|
|
1934
|
+
/**
|
|
1935
|
+
*
|
|
1936
|
+
* @type {Array<DashboardItem>}
|
|
1937
|
+
* @memberof SaveDashboardRequest
|
|
1938
|
+
*/
|
|
1939
|
+
'items'?: Array<DashboardItem>;
|
|
1940
|
+
}
|
|
1870
1941
|
/**
|
|
1871
1942
|
*
|
|
1872
1943
|
* @export
|
|
@@ -2669,6 +2740,148 @@ export declare const ListCustomersGenderEnum: {
|
|
|
2669
2740
|
readonly Female: "female";
|
|
2670
2741
|
};
|
|
2671
2742
|
export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
|
|
2743
|
+
/**
|
|
2744
|
+
* DashboardApi - axios parameter creator
|
|
2745
|
+
* @export
|
|
2746
|
+
*/
|
|
2747
|
+
export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2748
|
+
/**
|
|
2749
|
+
*
|
|
2750
|
+
* @summary Get the platform\'s dashboard
|
|
2751
|
+
* @param {string} project Project unique identifier
|
|
2752
|
+
* @param {string} platformId The platform identifier
|
|
2753
|
+
* @param {*} [options] Override http request option.
|
|
2754
|
+
* @throws {RequiredError}
|
|
2755
|
+
*/
|
|
2756
|
+
getDashboard: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2757
|
+
/**
|
|
2758
|
+
*
|
|
2759
|
+
* @summary Save the platform\'s dashboard
|
|
2760
|
+
* @param {string} project Project unique identifier
|
|
2761
|
+
* @param {string} platformId The platform identifier
|
|
2762
|
+
* @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
|
|
2763
|
+
* @param {*} [options] Override http request option.
|
|
2764
|
+
* @throws {RequiredError}
|
|
2765
|
+
*/
|
|
2766
|
+
saveDashboard: (project: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2767
|
+
};
|
|
2768
|
+
/**
|
|
2769
|
+
* DashboardApi - functional programming interface
|
|
2770
|
+
* @export
|
|
2771
|
+
*/
|
|
2772
|
+
export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
2773
|
+
/**
|
|
2774
|
+
*
|
|
2775
|
+
* @summary Get the platform\'s dashboard
|
|
2776
|
+
* @param {string} project Project unique identifier
|
|
2777
|
+
* @param {string} platformId The platform identifier
|
|
2778
|
+
* @param {*} [options] Override http request option.
|
|
2779
|
+
* @throws {RequiredError}
|
|
2780
|
+
*/
|
|
2781
|
+
getDashboard(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>>;
|
|
2782
|
+
/**
|
|
2783
|
+
*
|
|
2784
|
+
* @summary Save the platform\'s dashboard
|
|
2785
|
+
* @param {string} project Project unique identifier
|
|
2786
|
+
* @param {string} platformId The platform identifier
|
|
2787
|
+
* @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
|
|
2788
|
+
* @param {*} [options] Override http request option.
|
|
2789
|
+
* @throws {RequiredError}
|
|
2790
|
+
*/
|
|
2791
|
+
saveDashboard(project: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>>;
|
|
2792
|
+
};
|
|
2793
|
+
/**
|
|
2794
|
+
* DashboardApi - factory interface
|
|
2795
|
+
* @export
|
|
2796
|
+
*/
|
|
2797
|
+
export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2798
|
+
/**
|
|
2799
|
+
*
|
|
2800
|
+
* @summary Get the platform\'s dashboard
|
|
2801
|
+
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
2802
|
+
* @param {*} [options] Override http request option.
|
|
2803
|
+
* @throws {RequiredError}
|
|
2804
|
+
*/
|
|
2805
|
+
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse>;
|
|
2806
|
+
/**
|
|
2807
|
+
*
|
|
2808
|
+
* @summary Save the platform\'s dashboard
|
|
2809
|
+
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
2810
|
+
* @param {*} [options] Override http request option.
|
|
2811
|
+
* @throws {RequiredError}
|
|
2812
|
+
*/
|
|
2813
|
+
saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse>;
|
|
2814
|
+
};
|
|
2815
|
+
/**
|
|
2816
|
+
* Request parameters for getDashboard operation in DashboardApi.
|
|
2817
|
+
* @export
|
|
2818
|
+
* @interface DashboardApiGetDashboardRequest
|
|
2819
|
+
*/
|
|
2820
|
+
export interface DashboardApiGetDashboardRequest {
|
|
2821
|
+
/**
|
|
2822
|
+
* Project unique identifier
|
|
2823
|
+
* @type {string}
|
|
2824
|
+
* @memberof DashboardApiGetDashboard
|
|
2825
|
+
*/
|
|
2826
|
+
readonly project: string;
|
|
2827
|
+
/**
|
|
2828
|
+
* The platform identifier
|
|
2829
|
+
* @type {string}
|
|
2830
|
+
* @memberof DashboardApiGetDashboard
|
|
2831
|
+
*/
|
|
2832
|
+
readonly platformId: string;
|
|
2833
|
+
}
|
|
2834
|
+
/**
|
|
2835
|
+
* Request parameters for saveDashboard operation in DashboardApi.
|
|
2836
|
+
* @export
|
|
2837
|
+
* @interface DashboardApiSaveDashboardRequest
|
|
2838
|
+
*/
|
|
2839
|
+
export interface DashboardApiSaveDashboardRequest {
|
|
2840
|
+
/**
|
|
2841
|
+
* Project unique identifier
|
|
2842
|
+
* @type {string}
|
|
2843
|
+
* @memberof DashboardApiSaveDashboard
|
|
2844
|
+
*/
|
|
2845
|
+
readonly project: string;
|
|
2846
|
+
/**
|
|
2847
|
+
* The platform identifier
|
|
2848
|
+
* @type {string}
|
|
2849
|
+
* @memberof DashboardApiSaveDashboard
|
|
2850
|
+
*/
|
|
2851
|
+
readonly platformId: string;
|
|
2852
|
+
/**
|
|
2853
|
+
* Save dashboard
|
|
2854
|
+
* @type {SaveDashboardRequest}
|
|
2855
|
+
* @memberof DashboardApiSaveDashboard
|
|
2856
|
+
*/
|
|
2857
|
+
readonly saveDashboardRequest: SaveDashboardRequest;
|
|
2858
|
+
}
|
|
2859
|
+
/**
|
|
2860
|
+
* DashboardApi - object-oriented interface
|
|
2861
|
+
* @export
|
|
2862
|
+
* @class DashboardApi
|
|
2863
|
+
* @extends {BaseAPI}
|
|
2864
|
+
*/
|
|
2865
|
+
export declare class DashboardApi extends BaseAPI {
|
|
2866
|
+
/**
|
|
2867
|
+
*
|
|
2868
|
+
* @summary Get the platform\'s dashboard
|
|
2869
|
+
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
2870
|
+
* @param {*} [options] Override http request option.
|
|
2871
|
+
* @throws {RequiredError}
|
|
2872
|
+
* @memberof DashboardApi
|
|
2873
|
+
*/
|
|
2874
|
+
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
2875
|
+
/**
|
|
2876
|
+
*
|
|
2877
|
+
* @summary Save the platform\'s dashboard
|
|
2878
|
+
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
2879
|
+
* @param {*} [options] Override http request option.
|
|
2880
|
+
* @throws {RequiredError}
|
|
2881
|
+
* @memberof DashboardApi
|
|
2882
|
+
*/
|
|
2883
|
+
saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
2884
|
+
}
|
|
2672
2885
|
/**
|
|
2673
2886
|
* EnquiriesApi - axios parameter creator
|
|
2674
2887
|
* @export
|