@teemill/website 0.31.5 → 0.33.1
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 +4 -0
- package/README.md +7 -2
- package/api.ts +285 -1
- package/base.ts +1 -1
- package/common.ts +15 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +159 -1
- package/dist/api.js +201 -3
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +6 -1
- package/dist/common.js +15 -4
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +159 -1
- package/dist/esm/api.js +195 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +6 -1
- package/dist/esm/common.js +13 -3
- 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/KeyphraseOpportunitiesApi.md +130 -0
- package/docs/KeyphraseOpportunitiesResponse.md +24 -0
- package/docs/KeyphraseOpportunitiesResponseMeta.md +23 -0
- package/docs/KeyphraseOpportunity.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -27,6 +27,10 @@ docs/Footer.md
|
|
|
27
27
|
docs/FooterApi.md
|
|
28
28
|
docs/FooterItem.md
|
|
29
29
|
docs/Image.md
|
|
30
|
+
docs/KeyphraseOpportunitiesApi.md
|
|
31
|
+
docs/KeyphraseOpportunitiesResponse.md
|
|
32
|
+
docs/KeyphraseOpportunitiesResponseMeta.md
|
|
33
|
+
docs/KeyphraseOpportunity.md
|
|
30
34
|
docs/ListDomains200Response.md
|
|
31
35
|
docs/ListRoutesResponse.md
|
|
32
36
|
docs/Menu.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/website@0.
|
|
1
|
+
## @teemill/website@0.33.1
|
|
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/website@0.
|
|
39
|
+
npm install @teemill/website@0.33.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -63,6 +63,8 @@ Class | Method | HTTP request | Description
|
|
|
63
63
|
*DefaultApi* | [**updateBrand**](docs/DefaultApi.md#updatebrand) | **PATCH** /v1/website/brand | Update brand
|
|
64
64
|
*FooterApi* | [**getFooter**](docs/FooterApi.md#getfooter) | **GET** /v1/website/footer | Get footer
|
|
65
65
|
*FooterApi* | [**updateFooter**](docs/FooterApi.md#updatefooter) | **PUT** /v1/website/footer | Update footer
|
|
66
|
+
*KeyphraseOpportunitiesApi* | [**deleteKeyphraseOpportunity**](docs/KeyphraseOpportunitiesApi.md#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete key phrase opportunity
|
|
67
|
+
*KeyphraseOpportunitiesApi* | [**listKeyphraseOpportunities**](docs/KeyphraseOpportunitiesApi.md#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List key phrase opportunities
|
|
66
68
|
*MenuApi* | [**getMenu**](docs/MenuApi.md#getmenu) | **GET** /v1/website/menu | Get menu
|
|
67
69
|
*MenuApi* | [**updateMenu**](docs/MenuApi.md#updatemenu) | **PUT** /v1/website/menu | Update menu
|
|
68
70
|
*PagesApi* | [**exportPages**](docs/PagesApi.md#exportpages) | **GET** /v1/website/pages/export | Export pages
|
|
@@ -114,6 +116,9 @@ Class | Method | HTTP request | Description
|
|
|
114
116
|
- [Footer](docs/Footer.md)
|
|
115
117
|
- [FooterItem](docs/FooterItem.md)
|
|
116
118
|
- [Image](docs/Image.md)
|
|
119
|
+
- [KeyphraseOpportunitiesResponse](docs/KeyphraseOpportunitiesResponse.md)
|
|
120
|
+
- [KeyphraseOpportunitiesResponseMeta](docs/KeyphraseOpportunitiesResponseMeta.md)
|
|
121
|
+
- [KeyphraseOpportunity](docs/KeyphraseOpportunity.md)
|
|
117
122
|
- [ListDomains200Response](docs/ListDomains200Response.md)
|
|
118
123
|
- [ListRoutesResponse](docs/ListRoutesResponse.md)
|
|
119
124
|
- [Menu](docs/Menu.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Website
|
|
5
5
|
* Manage your PodOS Website
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.33.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -197,6 +197,38 @@ export interface Image {
|
|
|
197
197
|
'createdAt'?: string;
|
|
198
198
|
'updatedAt'?: string;
|
|
199
199
|
}
|
|
200
|
+
export interface KeyphraseOpportunitiesResponse {
|
|
201
|
+
'keyphraseOpportunities': Array<KeyphraseOpportunity>;
|
|
202
|
+
'meta': KeyphraseOpportunitiesResponseMeta;
|
|
203
|
+
/**
|
|
204
|
+
* The token referencing the next page number
|
|
205
|
+
*/
|
|
206
|
+
'nextPageToken': number | null;
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Object containing metadata about the keyphrase opportunities list.
|
|
210
|
+
*/
|
|
211
|
+
export interface KeyphraseOpportunitiesResponseMeta {
|
|
212
|
+
/**
|
|
213
|
+
* Total number of unique keyphrases stored against the project.
|
|
214
|
+
*/
|
|
215
|
+
'totalPhrases': number;
|
|
216
|
+
/**
|
|
217
|
+
* Combined monthly volume of all keyphrases stored against the project.
|
|
218
|
+
*/
|
|
219
|
+
'totalMonthlyVolume': number;
|
|
220
|
+
}
|
|
221
|
+
export interface KeyphraseOpportunity {
|
|
222
|
+
'id': string;
|
|
223
|
+
/**
|
|
224
|
+
* The keyphrase that has been identified as an opportunity
|
|
225
|
+
*/
|
|
226
|
+
'phrase': string;
|
|
227
|
+
/**
|
|
228
|
+
* Monthly search volume for the keyphrase
|
|
229
|
+
*/
|
|
230
|
+
'monthlyVolume': number | null;
|
|
231
|
+
}
|
|
200
232
|
export interface ListDomains200Response {
|
|
201
233
|
'domains': Array<Domain>;
|
|
202
234
|
/**
|
|
@@ -2427,6 +2459,258 @@ export class FooterApi extends BaseAPI {
|
|
|
2427
2459
|
|
|
2428
2460
|
|
|
2429
2461
|
|
|
2462
|
+
/**
|
|
2463
|
+
* KeyphraseOpportunitiesApi - axios parameter creator
|
|
2464
|
+
*/
|
|
2465
|
+
export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2466
|
+
return {
|
|
2467
|
+
/**
|
|
2468
|
+
* Remove a key phrase opportunity from the store.
|
|
2469
|
+
* @summary Delete key phrase opportunity
|
|
2470
|
+
* @param {string} project What project it is
|
|
2471
|
+
* @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
|
|
2472
|
+
* @param {*} [options] Override http request option.
|
|
2473
|
+
* @throws {RequiredError}
|
|
2474
|
+
*/
|
|
2475
|
+
deleteKeyphraseOpportunity: async (project: string, keyphraseOpportunityId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2476
|
+
// verify required parameter 'project' is not null or undefined
|
|
2477
|
+
assertParamExists('deleteKeyphraseOpportunity', 'project', project)
|
|
2478
|
+
// verify required parameter 'keyphraseOpportunityId' is not null or undefined
|
|
2479
|
+
assertParamExists('deleteKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId)
|
|
2480
|
+
const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}`
|
|
2481
|
+
.replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
|
|
2482
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2483
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2484
|
+
let baseOptions;
|
|
2485
|
+
if (configuration) {
|
|
2486
|
+
baseOptions = configuration.baseOptions;
|
|
2487
|
+
}
|
|
2488
|
+
|
|
2489
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
2490
|
+
const localVarHeaderParameter = {} as any;
|
|
2491
|
+
const localVarQueryParameter = {} as any;
|
|
2492
|
+
|
|
2493
|
+
// authentication session-oauth required
|
|
2494
|
+
// oauth required
|
|
2495
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2496
|
+
|
|
2497
|
+
// authentication api-key required
|
|
2498
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2499
|
+
|
|
2500
|
+
if (project !== undefined) {
|
|
2501
|
+
localVarQueryParameter['project'] = project;
|
|
2502
|
+
}
|
|
2503
|
+
|
|
2504
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2505
|
+
|
|
2506
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2507
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2508
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2509
|
+
|
|
2510
|
+
return {
|
|
2511
|
+
url: toPathString(localVarUrlObj),
|
|
2512
|
+
options: localVarRequestOptions,
|
|
2513
|
+
};
|
|
2514
|
+
},
|
|
2515
|
+
/**
|
|
2516
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
2517
|
+
* @summary List key phrase opportunities
|
|
2518
|
+
* @param {string} project What project it is
|
|
2519
|
+
* @param {number} [pageToken] Page reference token
|
|
2520
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2521
|
+
* @param {string} [search] Search term to filter results
|
|
2522
|
+
* @param {*} [options] Override http request option.
|
|
2523
|
+
* @throws {RequiredError}
|
|
2524
|
+
*/
|
|
2525
|
+
listKeyphraseOpportunities: async (project: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2526
|
+
// verify required parameter 'project' is not null or undefined
|
|
2527
|
+
assertParamExists('listKeyphraseOpportunities', 'project', project)
|
|
2528
|
+
const localVarPath = `/v1/website/keyphrase-opportunities`;
|
|
2529
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2530
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2531
|
+
let baseOptions;
|
|
2532
|
+
if (configuration) {
|
|
2533
|
+
baseOptions = configuration.baseOptions;
|
|
2534
|
+
}
|
|
2535
|
+
|
|
2536
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2537
|
+
const localVarHeaderParameter = {} as any;
|
|
2538
|
+
const localVarQueryParameter = {} as any;
|
|
2539
|
+
|
|
2540
|
+
// authentication session-oauth required
|
|
2541
|
+
// oauth required
|
|
2542
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2543
|
+
|
|
2544
|
+
// authentication api-key required
|
|
2545
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2546
|
+
|
|
2547
|
+
if (project !== undefined) {
|
|
2548
|
+
localVarQueryParameter['project'] = project;
|
|
2549
|
+
}
|
|
2550
|
+
|
|
2551
|
+
if (pageToken !== undefined) {
|
|
2552
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
2553
|
+
}
|
|
2554
|
+
|
|
2555
|
+
if (pageSize !== undefined) {
|
|
2556
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
2557
|
+
}
|
|
2558
|
+
|
|
2559
|
+
if (search !== undefined) {
|
|
2560
|
+
localVarQueryParameter['search'] = search;
|
|
2561
|
+
}
|
|
2562
|
+
|
|
2563
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2564
|
+
|
|
2565
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2566
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2567
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2568
|
+
|
|
2569
|
+
return {
|
|
2570
|
+
url: toPathString(localVarUrlObj),
|
|
2571
|
+
options: localVarRequestOptions,
|
|
2572
|
+
};
|
|
2573
|
+
},
|
|
2574
|
+
}
|
|
2575
|
+
};
|
|
2576
|
+
|
|
2577
|
+
/**
|
|
2578
|
+
* KeyphraseOpportunitiesApi - functional programming interface
|
|
2579
|
+
*/
|
|
2580
|
+
export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuration) {
|
|
2581
|
+
const localVarAxiosParamCreator = KeyphraseOpportunitiesApiAxiosParamCreator(configuration)
|
|
2582
|
+
return {
|
|
2583
|
+
/**
|
|
2584
|
+
* Remove a key phrase opportunity from the store.
|
|
2585
|
+
* @summary Delete key phrase opportunity
|
|
2586
|
+
* @param {string} project What project it is
|
|
2587
|
+
* @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
|
|
2588
|
+
* @param {*} [options] Override http request option.
|
|
2589
|
+
* @throws {RequiredError}
|
|
2590
|
+
*/
|
|
2591
|
+
async deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
2592
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteKeyphraseOpportunity(project, keyphraseOpportunityId, options);
|
|
2593
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2594
|
+
const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.deleteKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
|
|
2595
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2596
|
+
},
|
|
2597
|
+
/**
|
|
2598
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
2599
|
+
* @summary List key phrase opportunities
|
|
2600
|
+
* @param {string} project What project it is
|
|
2601
|
+
* @param {number} [pageToken] Page reference token
|
|
2602
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2603
|
+
* @param {string} [search] Search term to filter results
|
|
2604
|
+
* @param {*} [options] Override http request option.
|
|
2605
|
+
* @throws {RequiredError}
|
|
2606
|
+
*/
|
|
2607
|
+
async listKeyphraseOpportunities(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KeyphraseOpportunitiesResponse>> {
|
|
2608
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listKeyphraseOpportunities(project, pageToken, pageSize, search, options);
|
|
2609
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2610
|
+
const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.listKeyphraseOpportunities']?.[localVarOperationServerIndex]?.url;
|
|
2611
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2612
|
+
},
|
|
2613
|
+
}
|
|
2614
|
+
};
|
|
2615
|
+
|
|
2616
|
+
/**
|
|
2617
|
+
* KeyphraseOpportunitiesApi - factory interface
|
|
2618
|
+
*/
|
|
2619
|
+
export const KeyphraseOpportunitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2620
|
+
const localVarFp = KeyphraseOpportunitiesApiFp(configuration)
|
|
2621
|
+
return {
|
|
2622
|
+
/**
|
|
2623
|
+
* Remove a key phrase opportunity from the store.
|
|
2624
|
+
* @summary Delete key phrase opportunity
|
|
2625
|
+
* @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
2626
|
+
* @param {*} [options] Override http request option.
|
|
2627
|
+
* @throws {RequiredError}
|
|
2628
|
+
*/
|
|
2629
|
+
deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
2630
|
+
return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
2631
|
+
},
|
|
2632
|
+
/**
|
|
2633
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
2634
|
+
* @summary List key phrase opportunities
|
|
2635
|
+
* @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
|
|
2636
|
+
* @param {*} [options] Override http request option.
|
|
2637
|
+
* @throws {RequiredError}
|
|
2638
|
+
*/
|
|
2639
|
+
listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<KeyphraseOpportunitiesResponse> {
|
|
2640
|
+
return localVarFp.listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
2641
|
+
},
|
|
2642
|
+
};
|
|
2643
|
+
};
|
|
2644
|
+
|
|
2645
|
+
/**
|
|
2646
|
+
* Request parameters for deleteKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
|
|
2647
|
+
*/
|
|
2648
|
+
export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
|
|
2649
|
+
/**
|
|
2650
|
+
* What project it is
|
|
2651
|
+
*/
|
|
2652
|
+
readonly project: string
|
|
2653
|
+
|
|
2654
|
+
/**
|
|
2655
|
+
* Key phrase opportunity\'s unique identifier
|
|
2656
|
+
*/
|
|
2657
|
+
readonly keyphraseOpportunityId: string
|
|
2658
|
+
}
|
|
2659
|
+
|
|
2660
|
+
/**
|
|
2661
|
+
* Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
|
|
2662
|
+
*/
|
|
2663
|
+
export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
|
|
2664
|
+
/**
|
|
2665
|
+
* What project it is
|
|
2666
|
+
*/
|
|
2667
|
+
readonly project: string
|
|
2668
|
+
|
|
2669
|
+
/**
|
|
2670
|
+
* Page reference token
|
|
2671
|
+
*/
|
|
2672
|
+
readonly pageToken?: number
|
|
2673
|
+
|
|
2674
|
+
/**
|
|
2675
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2676
|
+
*/
|
|
2677
|
+
readonly pageSize?: number
|
|
2678
|
+
|
|
2679
|
+
/**
|
|
2680
|
+
* Search term to filter results
|
|
2681
|
+
*/
|
|
2682
|
+
readonly search?: string
|
|
2683
|
+
}
|
|
2684
|
+
|
|
2685
|
+
/**
|
|
2686
|
+
* KeyphraseOpportunitiesApi - object-oriented interface
|
|
2687
|
+
*/
|
|
2688
|
+
export class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
2689
|
+
/**
|
|
2690
|
+
* Remove a key phrase opportunity from the store.
|
|
2691
|
+
* @summary Delete key phrase opportunity
|
|
2692
|
+
* @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
2693
|
+
* @param {*} [options] Override http request option.
|
|
2694
|
+
* @throws {RequiredError}
|
|
2695
|
+
*/
|
|
2696
|
+
public deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig) {
|
|
2697
|
+
return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
2698
|
+
}
|
|
2699
|
+
|
|
2700
|
+
/**
|
|
2701
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
2702
|
+
* @summary List key phrase opportunities
|
|
2703
|
+
* @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
|
|
2704
|
+
* @param {*} [options] Override http request option.
|
|
2705
|
+
* @throws {RequiredError}
|
|
2706
|
+
*/
|
|
2707
|
+
public listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig) {
|
|
2708
|
+
return KeyphraseOpportunitiesApiFp(this.configuration).listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
2709
|
+
}
|
|
2710
|
+
}
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
|
|
2430
2714
|
/**
|
|
2431
2715
|
* MenuApi - axios parameter creator
|
|
2432
2716
|
*/
|
package/base.ts
CHANGED
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Website
|
|
5
5
|
* Manage your PodOS Website
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.33.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -86,7 +86,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope
|
|
|
86
86
|
function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
|
|
87
87
|
if (parameter == null) return;
|
|
88
88
|
if (typeof parameter === "object") {
|
|
89
|
-
if (Array.isArray(parameter)) {
|
|
89
|
+
if (Array.isArray(parameter) || parameter instanceof Set) {
|
|
90
90
|
(parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
|
|
91
91
|
}
|
|
92
92
|
else {
|
|
@@ -115,6 +115,18 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
|
|
|
115
115
|
url.search = searchParams.toString();
|
|
116
116
|
}
|
|
117
117
|
|
|
118
|
+
/**
|
|
119
|
+
* JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
|
|
120
|
+
* @export
|
|
121
|
+
*/
|
|
122
|
+
export const replaceWithSerializableTypeIfNeeded = function (_key: string, value: unknown) {
|
|
123
|
+
if (value instanceof Set) {
|
|
124
|
+
return Array.from(value);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
return value;
|
|
128
|
+
}
|
|
129
|
+
|
|
118
130
|
/**
|
|
119
131
|
*
|
|
120
132
|
* @export
|
|
@@ -125,7 +137,7 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any,
|
|
|
125
137
|
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
126
138
|
: nonString;
|
|
127
139
|
return needsSerialization
|
|
128
|
-
? JSON.stringify(value !== undefined ? value : {})
|
|
140
|
+
? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
|
|
129
141
|
: (value || "");
|
|
130
142
|
}
|
|
131
143
|
|
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Website
|
|
3
3
|
* Manage your PodOS Website
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.33.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -180,6 +180,38 @@ export interface Image {
|
|
|
180
180
|
'createdAt'?: string;
|
|
181
181
|
'updatedAt'?: string;
|
|
182
182
|
}
|
|
183
|
+
export interface KeyphraseOpportunitiesResponse {
|
|
184
|
+
'keyphraseOpportunities': Array<KeyphraseOpportunity>;
|
|
185
|
+
'meta': KeyphraseOpportunitiesResponseMeta;
|
|
186
|
+
/**
|
|
187
|
+
* The token referencing the next page number
|
|
188
|
+
*/
|
|
189
|
+
'nextPageToken': number | null;
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Object containing metadata about the keyphrase opportunities list.
|
|
193
|
+
*/
|
|
194
|
+
export interface KeyphraseOpportunitiesResponseMeta {
|
|
195
|
+
/**
|
|
196
|
+
* Total number of unique keyphrases stored against the project.
|
|
197
|
+
*/
|
|
198
|
+
'totalPhrases': number;
|
|
199
|
+
/**
|
|
200
|
+
* Combined monthly volume of all keyphrases stored against the project.
|
|
201
|
+
*/
|
|
202
|
+
'totalMonthlyVolume': number;
|
|
203
|
+
}
|
|
204
|
+
export interface KeyphraseOpportunity {
|
|
205
|
+
'id': string;
|
|
206
|
+
/**
|
|
207
|
+
* The keyphrase that has been identified as an opportunity
|
|
208
|
+
*/
|
|
209
|
+
'phrase': string;
|
|
210
|
+
/**
|
|
211
|
+
* Monthly search volume for the keyphrase
|
|
212
|
+
*/
|
|
213
|
+
'monthlyVolume': number | null;
|
|
214
|
+
}
|
|
183
215
|
export interface ListDomains200Response {
|
|
184
216
|
'domains': Array<Domain>;
|
|
185
217
|
/**
|
|
@@ -1680,6 +1712,132 @@ export declare class FooterApi extends BaseAPI {
|
|
|
1680
1712
|
*/
|
|
1681
1713
|
updateFooter(requestParameters: FooterApiUpdateFooterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Footer, any, {}>>;
|
|
1682
1714
|
}
|
|
1715
|
+
/**
|
|
1716
|
+
* KeyphraseOpportunitiesApi - axios parameter creator
|
|
1717
|
+
*/
|
|
1718
|
+
export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1719
|
+
/**
|
|
1720
|
+
* Remove a key phrase opportunity from the store.
|
|
1721
|
+
* @summary Delete key phrase opportunity
|
|
1722
|
+
* @param {string} project What project it is
|
|
1723
|
+
* @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
|
|
1724
|
+
* @param {*} [options] Override http request option.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
*/
|
|
1727
|
+
deleteKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1728
|
+
/**
|
|
1729
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
1730
|
+
* @summary List key phrase opportunities
|
|
1731
|
+
* @param {string} project What project it is
|
|
1732
|
+
* @param {number} [pageToken] Page reference token
|
|
1733
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1734
|
+
* @param {string} [search] Search term to filter results
|
|
1735
|
+
* @param {*} [options] Override http request option.
|
|
1736
|
+
* @throws {RequiredError}
|
|
1737
|
+
*/
|
|
1738
|
+
listKeyphraseOpportunities: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1739
|
+
};
|
|
1740
|
+
/**
|
|
1741
|
+
* KeyphraseOpportunitiesApi - functional programming interface
|
|
1742
|
+
*/
|
|
1743
|
+
export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration) => {
|
|
1744
|
+
/**
|
|
1745
|
+
* Remove a key phrase opportunity from the store.
|
|
1746
|
+
* @summary Delete key phrase opportunity
|
|
1747
|
+
* @param {string} project What project it is
|
|
1748
|
+
* @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
|
|
1749
|
+
* @param {*} [options] Override http request option.
|
|
1750
|
+
* @throws {RequiredError}
|
|
1751
|
+
*/
|
|
1752
|
+
deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1753
|
+
/**
|
|
1754
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
1755
|
+
* @summary List key phrase opportunities
|
|
1756
|
+
* @param {string} project What project it is
|
|
1757
|
+
* @param {number} [pageToken] Page reference token
|
|
1758
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1759
|
+
* @param {string} [search] Search term to filter results
|
|
1760
|
+
* @param {*} [options] Override http request option.
|
|
1761
|
+
* @throws {RequiredError}
|
|
1762
|
+
*/
|
|
1763
|
+
listKeyphraseOpportunities(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KeyphraseOpportunitiesResponse>>;
|
|
1764
|
+
};
|
|
1765
|
+
/**
|
|
1766
|
+
* KeyphraseOpportunitiesApi - factory interface
|
|
1767
|
+
*/
|
|
1768
|
+
export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1769
|
+
/**
|
|
1770
|
+
* Remove a key phrase opportunity from the store.
|
|
1771
|
+
* @summary Delete key phrase opportunity
|
|
1772
|
+
* @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1773
|
+
* @param {*} [options] Override http request option.
|
|
1774
|
+
* @throws {RequiredError}
|
|
1775
|
+
*/
|
|
1776
|
+
deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1777
|
+
/**
|
|
1778
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
1779
|
+
* @summary List key phrase opportunities
|
|
1780
|
+
* @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
|
|
1781
|
+
* @param {*} [options] Override http request option.
|
|
1782
|
+
* @throws {RequiredError}
|
|
1783
|
+
*/
|
|
1784
|
+
listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<KeyphraseOpportunitiesResponse>;
|
|
1785
|
+
};
|
|
1786
|
+
/**
|
|
1787
|
+
* Request parameters for deleteKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
|
|
1788
|
+
*/
|
|
1789
|
+
export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
|
|
1790
|
+
/**
|
|
1791
|
+
* What project it is
|
|
1792
|
+
*/
|
|
1793
|
+
readonly project: string;
|
|
1794
|
+
/**
|
|
1795
|
+
* Key phrase opportunity\'s unique identifier
|
|
1796
|
+
*/
|
|
1797
|
+
readonly keyphraseOpportunityId: string;
|
|
1798
|
+
}
|
|
1799
|
+
/**
|
|
1800
|
+
* Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
|
|
1801
|
+
*/
|
|
1802
|
+
export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
|
|
1803
|
+
/**
|
|
1804
|
+
* What project it is
|
|
1805
|
+
*/
|
|
1806
|
+
readonly project: string;
|
|
1807
|
+
/**
|
|
1808
|
+
* Page reference token
|
|
1809
|
+
*/
|
|
1810
|
+
readonly pageToken?: number;
|
|
1811
|
+
/**
|
|
1812
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1813
|
+
*/
|
|
1814
|
+
readonly pageSize?: number;
|
|
1815
|
+
/**
|
|
1816
|
+
* Search term to filter results
|
|
1817
|
+
*/
|
|
1818
|
+
readonly search?: string;
|
|
1819
|
+
}
|
|
1820
|
+
/**
|
|
1821
|
+
* KeyphraseOpportunitiesApi - object-oriented interface
|
|
1822
|
+
*/
|
|
1823
|
+
export declare class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
1824
|
+
/**
|
|
1825
|
+
* Remove a key phrase opportunity from the store.
|
|
1826
|
+
* @summary Delete key phrase opportunity
|
|
1827
|
+
* @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1828
|
+
* @param {*} [options] Override http request option.
|
|
1829
|
+
* @throws {RequiredError}
|
|
1830
|
+
*/
|
|
1831
|
+
deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1832
|
+
/**
|
|
1833
|
+
* List the key phrases saved as opportunities for a store that are not attached to content.
|
|
1834
|
+
* @summary List key phrase opportunities
|
|
1835
|
+
* @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
|
|
1836
|
+
* @param {*} [options] Override http request option.
|
|
1837
|
+
* @throws {RequiredError}
|
|
1838
|
+
*/
|
|
1839
|
+
listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<KeyphraseOpportunitiesResponse, any, {}>>;
|
|
1840
|
+
}
|
|
1683
1841
|
/**
|
|
1684
1842
|
* MenuApi - axios parameter creator
|
|
1685
1843
|
*/
|