@teemill/website 0.31.4 → 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.
@@ -27,6 +27,9 @@ 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/KeyphraseOpportunity.md
30
33
  docs/ListDomains200Response.md
31
34
  docs/ListRoutesResponse.md
32
35
  docs/Menu.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/website@0.31.4
1
+ ## @teemill/website@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/website@0.31.4 --save
39
+ npm install @teemill/website@0.32.0 --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,8 @@ 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
+ - [KeyphraseOpportunity](docs/KeyphraseOpportunity.md)
117
121
  - [ListDomains200Response](docs/ListDomains200Response.md)
118
122
  - [ListRoutesResponse](docs/ListRoutesResponse.md)
119
123
  - [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.31.4
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).
@@ -197,13 +197,31 @@ export interface Image {
197
197
  'createdAt'?: string;
198
198
  'updatedAt'?: string;
199
199
  }
200
+ export interface KeyphraseOpportunitiesResponse {
201
+ 'keyphraseOpportunities': Array<KeyphraseOpportunity>;
202
+ /**
203
+ * The token referencing the next page number
204
+ */
205
+ 'nextPageToken': number | null;
206
+ }
207
+ export interface KeyphraseOpportunity {
208
+ 'id': string;
209
+ 'phrase': string;
210
+ 'monthlyVolume': number | null;
211
+ }
200
212
  export interface ListDomains200Response {
201
213
  'domains': Array<Domain>;
202
- 'nextPageToken': number;
214
+ /**
215
+ * The token referencing the next page number
216
+ */
217
+ 'nextPageToken': number | null;
203
218
  }
204
219
  export interface ListRoutesResponse {
205
220
  'routes': Array<Route>;
206
- 'nextPageToken': number;
221
+ /**
222
+ * The token referencing the next page number
223
+ */
224
+ 'nextPageToken': number | null;
207
225
  }
208
226
  export interface Menu {
209
227
  'items': Array<MenuItem>;
@@ -2421,6 +2439,258 @@ export class FooterApi extends BaseAPI {
2421
2439
 
2422
2440
 
2423
2441
 
2442
+ /**
2443
+ * KeyphraseOpportunitiesApi - axios parameter creator
2444
+ */
2445
+ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration?: Configuration) {
2446
+ return {
2447
+ /**
2448
+ * Remove a key phrase opportunity from the store.
2449
+ * @summary Delete key phrase opportunity
2450
+ * @param {string} project What project it is
2451
+ * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
2452
+ * @param {*} [options] Override http request option.
2453
+ * @throws {RequiredError}
2454
+ */
2455
+ deleteKeyphraseOpportunity: async (project: string, keyphraseOpportunityId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2456
+ // verify required parameter 'project' is not null or undefined
2457
+ assertParamExists('deleteKeyphraseOpportunity', 'project', project)
2458
+ // verify required parameter 'keyphraseOpportunityId' is not null or undefined
2459
+ assertParamExists('deleteKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId)
2460
+ const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}`
2461
+ .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
2462
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2463
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2464
+ let baseOptions;
2465
+ if (configuration) {
2466
+ baseOptions = configuration.baseOptions;
2467
+ }
2468
+
2469
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
2470
+ const localVarHeaderParameter = {} as any;
2471
+ const localVarQueryParameter = {} as any;
2472
+
2473
+ // authentication session-oauth required
2474
+ // oauth required
2475
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
2476
+
2477
+ // authentication api-key required
2478
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2479
+
2480
+ if (project !== undefined) {
2481
+ localVarQueryParameter['project'] = project;
2482
+ }
2483
+
2484
+ localVarHeaderParameter['Accept'] = 'application/json';
2485
+
2486
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2487
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2488
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2489
+
2490
+ return {
2491
+ url: toPathString(localVarUrlObj),
2492
+ options: localVarRequestOptions,
2493
+ };
2494
+ },
2495
+ /**
2496
+ * List the key phrases saved as opportunities for a store that are not attached to content.
2497
+ * @summary List key phrase opportunities
2498
+ * @param {string} project What project it is
2499
+ * @param {number} [pageToken] Page reference token
2500
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2501
+ * @param {string} [search] Search term to filter results
2502
+ * @param {*} [options] Override http request option.
2503
+ * @throws {RequiredError}
2504
+ */
2505
+ listKeyphraseOpportunities: async (project: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2506
+ // verify required parameter 'project' is not null or undefined
2507
+ assertParamExists('listKeyphraseOpportunities', 'project', project)
2508
+ const localVarPath = `/v1/website/keyphrase-opportunities`;
2509
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2510
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2511
+ let baseOptions;
2512
+ if (configuration) {
2513
+ baseOptions = configuration.baseOptions;
2514
+ }
2515
+
2516
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2517
+ const localVarHeaderParameter = {} as any;
2518
+ const localVarQueryParameter = {} as any;
2519
+
2520
+ // authentication session-oauth required
2521
+ // oauth required
2522
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
2523
+
2524
+ // authentication api-key required
2525
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2526
+
2527
+ if (project !== undefined) {
2528
+ localVarQueryParameter['project'] = project;
2529
+ }
2530
+
2531
+ if (pageToken !== undefined) {
2532
+ localVarQueryParameter['pageToken'] = pageToken;
2533
+ }
2534
+
2535
+ if (pageSize !== undefined) {
2536
+ localVarQueryParameter['pageSize'] = pageSize;
2537
+ }
2538
+
2539
+ if (search !== undefined) {
2540
+ localVarQueryParameter['search'] = search;
2541
+ }
2542
+
2543
+ localVarHeaderParameter['Accept'] = 'application/json';
2544
+
2545
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2546
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2547
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2548
+
2549
+ return {
2550
+ url: toPathString(localVarUrlObj),
2551
+ options: localVarRequestOptions,
2552
+ };
2553
+ },
2554
+ }
2555
+ };
2556
+
2557
+ /**
2558
+ * KeyphraseOpportunitiesApi - functional programming interface
2559
+ */
2560
+ export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuration) {
2561
+ const localVarAxiosParamCreator = KeyphraseOpportunitiesApiAxiosParamCreator(configuration)
2562
+ return {
2563
+ /**
2564
+ * Remove a key phrase opportunity from the store.
2565
+ * @summary Delete key phrase opportunity
2566
+ * @param {string} project What project it is
2567
+ * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
2568
+ * @param {*} [options] Override http request option.
2569
+ * @throws {RequiredError}
2570
+ */
2571
+ async deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
2572
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteKeyphraseOpportunity(project, keyphraseOpportunityId, options);
2573
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2574
+ const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.deleteKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
2575
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2576
+ },
2577
+ /**
2578
+ * List the key phrases saved as opportunities for a store that are not attached to content.
2579
+ * @summary List key phrase opportunities
2580
+ * @param {string} project What project it is
2581
+ * @param {number} [pageToken] Page reference token
2582
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2583
+ * @param {string} [search] Search term to filter results
2584
+ * @param {*} [options] Override http request option.
2585
+ * @throws {RequiredError}
2586
+ */
2587
+ async listKeyphraseOpportunities(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KeyphraseOpportunitiesResponse>> {
2588
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listKeyphraseOpportunities(project, pageToken, pageSize, search, options);
2589
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2590
+ const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.listKeyphraseOpportunities']?.[localVarOperationServerIndex]?.url;
2591
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2592
+ },
2593
+ }
2594
+ };
2595
+
2596
+ /**
2597
+ * KeyphraseOpportunitiesApi - factory interface
2598
+ */
2599
+ export const KeyphraseOpportunitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2600
+ const localVarFp = KeyphraseOpportunitiesApiFp(configuration)
2601
+ return {
2602
+ /**
2603
+ * Remove a key phrase opportunity from the store.
2604
+ * @summary Delete key phrase opportunity
2605
+ * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
2606
+ * @param {*} [options] Override http request option.
2607
+ * @throws {RequiredError}
2608
+ */
2609
+ deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
2610
+ return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2611
+ },
2612
+ /**
2613
+ * List the key phrases saved as opportunities for a store that are not attached to content.
2614
+ * @summary List key phrase opportunities
2615
+ * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
2616
+ * @param {*} [options] Override http request option.
2617
+ * @throws {RequiredError}
2618
+ */
2619
+ listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<KeyphraseOpportunitiesResponse> {
2620
+ return localVarFp.listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
2621
+ },
2622
+ };
2623
+ };
2624
+
2625
+ /**
2626
+ * Request parameters for deleteKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
2627
+ */
2628
+ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
2629
+ /**
2630
+ * What project it is
2631
+ */
2632
+ readonly project: string
2633
+
2634
+ /**
2635
+ * Key phrase opportunity\&#39;s unique identifier
2636
+ */
2637
+ readonly keyphraseOpportunityId: string
2638
+ }
2639
+
2640
+ /**
2641
+ * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
2642
+ */
2643
+ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
2644
+ /**
2645
+ * What project it is
2646
+ */
2647
+ readonly project: string
2648
+
2649
+ /**
2650
+ * Page reference token
2651
+ */
2652
+ readonly pageToken?: number
2653
+
2654
+ /**
2655
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2656
+ */
2657
+ readonly pageSize?: number
2658
+
2659
+ /**
2660
+ * Search term to filter results
2661
+ */
2662
+ readonly search?: string
2663
+ }
2664
+
2665
+ /**
2666
+ * KeyphraseOpportunitiesApi - object-oriented interface
2667
+ */
2668
+ export class KeyphraseOpportunitiesApi extends BaseAPI {
2669
+ /**
2670
+ * Remove a key phrase opportunity from the store.
2671
+ * @summary Delete key phrase opportunity
2672
+ * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
2673
+ * @param {*} [options] Override http request option.
2674
+ * @throws {RequiredError}
2675
+ */
2676
+ public deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig) {
2677
+ return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
2678
+ }
2679
+
2680
+ /**
2681
+ * List the key phrases saved as opportunities for a store that are not attached to content.
2682
+ * @summary List key phrase opportunities
2683
+ * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
2684
+ * @param {*} [options] Override http request option.
2685
+ * @throws {RequiredError}
2686
+ */
2687
+ public listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig) {
2688
+ return KeyphraseOpportunitiesApiFp(this.configuration).listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
2689
+ }
2690
+ }
2691
+
2692
+
2693
+
2424
2694
  /**
2425
2695
  * MenuApi - axios parameter creator
2426
2696
  */
package/base.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.31.4
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).
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.31.4
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).
@@ -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 {
@@ -112,7 +112,19 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
112
112
  export const setSearchParams = function (url: URL, ...objects: any[]) {
113
113
  const searchParams = new URLSearchParams(url.search);
114
114
  setFlattenedQueryParams(searchParams, objects);
115
- url.search = decodeURIComponent(searchParams.toString());
115
+ url.search = searchParams.toString();
116
+ }
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;
116
128
  }
117
129
 
118
130
  /**
@@ -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
@@ -3,7 +3,7 @@
3
3
  * Website
4
4
  * Manage your PodOS Website
5
5
  *
6
- * The version of the OpenAPI document: 0.31.4
6
+ * The version of the OpenAPI document: 0.32.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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.31.4
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).
@@ -180,13 +180,31 @@ export interface Image {
180
180
  'createdAt'?: string;
181
181
  'updatedAt'?: string;
182
182
  }
183
+ export interface KeyphraseOpportunitiesResponse {
184
+ 'keyphraseOpportunities': Array<KeyphraseOpportunity>;
185
+ /**
186
+ * The token referencing the next page number
187
+ */
188
+ 'nextPageToken': number | null;
189
+ }
190
+ export interface KeyphraseOpportunity {
191
+ 'id': string;
192
+ 'phrase': string;
193
+ 'monthlyVolume': number | null;
194
+ }
183
195
  export interface ListDomains200Response {
184
196
  'domains': Array<Domain>;
185
- 'nextPageToken': number;
197
+ /**
198
+ * The token referencing the next page number
199
+ */
200
+ 'nextPageToken': number | null;
186
201
  }
187
202
  export interface ListRoutesResponse {
188
203
  'routes': Array<Route>;
189
- 'nextPageToken': number;
204
+ /**
205
+ * The token referencing the next page number
206
+ */
207
+ 'nextPageToken': number | null;
190
208
  }
191
209
  export interface Menu {
192
210
  'items': Array<MenuItem>;
@@ -1674,6 +1692,132 @@ export declare class FooterApi extends BaseAPI {
1674
1692
  */
1675
1693
  updateFooter(requestParameters: FooterApiUpdateFooterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Footer, any, {}>>;
1676
1694
  }
1695
+ /**
1696
+ * KeyphraseOpportunitiesApi - axios parameter creator
1697
+ */
1698
+ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?: Configuration) => {
1699
+ /**
1700
+ * Remove a key phrase opportunity from the store.
1701
+ * @summary Delete key phrase opportunity
1702
+ * @param {string} project What project it is
1703
+ * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
1704
+ * @param {*} [options] Override http request option.
1705
+ * @throws {RequiredError}
1706
+ */
1707
+ deleteKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1708
+ /**
1709
+ * List the key phrases saved as opportunities for a store that are not attached to content.
1710
+ * @summary List key phrase opportunities
1711
+ * @param {string} project What project it is
1712
+ * @param {number} [pageToken] Page reference token
1713
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1714
+ * @param {string} [search] Search term to filter results
1715
+ * @param {*} [options] Override http request option.
1716
+ * @throws {RequiredError}
1717
+ */
1718
+ listKeyphraseOpportunities: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1719
+ };
1720
+ /**
1721
+ * KeyphraseOpportunitiesApi - functional programming interface
1722
+ */
1723
+ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration) => {
1724
+ /**
1725
+ * Remove a key phrase opportunity from the store.
1726
+ * @summary Delete key phrase opportunity
1727
+ * @param {string} project What project it is
1728
+ * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
1729
+ * @param {*} [options] Override http request option.
1730
+ * @throws {RequiredError}
1731
+ */
1732
+ deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1733
+ /**
1734
+ * List the key phrases saved as opportunities for a store that are not attached to content.
1735
+ * @summary List key phrase opportunities
1736
+ * @param {string} project What project it is
1737
+ * @param {number} [pageToken] Page reference token
1738
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1739
+ * @param {string} [search] Search term to filter results
1740
+ * @param {*} [options] Override http request option.
1741
+ * @throws {RequiredError}
1742
+ */
1743
+ listKeyphraseOpportunities(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KeyphraseOpportunitiesResponse>>;
1744
+ };
1745
+ /**
1746
+ * KeyphraseOpportunitiesApi - factory interface
1747
+ */
1748
+ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1749
+ /**
1750
+ * Remove a key phrase opportunity from the store.
1751
+ * @summary Delete key phrase opportunity
1752
+ * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
1753
+ * @param {*} [options] Override http request option.
1754
+ * @throws {RequiredError}
1755
+ */
1756
+ deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1757
+ /**
1758
+ * List the key phrases saved as opportunities for a store that are not attached to content.
1759
+ * @summary List key phrase opportunities
1760
+ * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1761
+ * @param {*} [options] Override http request option.
1762
+ * @throws {RequiredError}
1763
+ */
1764
+ listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<KeyphraseOpportunitiesResponse>;
1765
+ };
1766
+ /**
1767
+ * Request parameters for deleteKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
1768
+ */
1769
+ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
1770
+ /**
1771
+ * What project it is
1772
+ */
1773
+ readonly project: string;
1774
+ /**
1775
+ * Key phrase opportunity\&#39;s unique identifier
1776
+ */
1777
+ readonly keyphraseOpportunityId: string;
1778
+ }
1779
+ /**
1780
+ * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
1781
+ */
1782
+ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
1783
+ /**
1784
+ * What project it is
1785
+ */
1786
+ readonly project: string;
1787
+ /**
1788
+ * Page reference token
1789
+ */
1790
+ readonly pageToken?: number;
1791
+ /**
1792
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1793
+ */
1794
+ readonly pageSize?: number;
1795
+ /**
1796
+ * Search term to filter results
1797
+ */
1798
+ readonly search?: string;
1799
+ }
1800
+ /**
1801
+ * KeyphraseOpportunitiesApi - object-oriented interface
1802
+ */
1803
+ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
1804
+ /**
1805
+ * Remove a key phrase opportunity from the store.
1806
+ * @summary Delete key phrase opportunity
1807
+ * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
1808
+ * @param {*} [options] Override http request option.
1809
+ * @throws {RequiredError}
1810
+ */
1811
+ deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1812
+ /**
1813
+ * List the key phrases saved as opportunities for a store that are not attached to content.
1814
+ * @summary List key phrase opportunities
1815
+ * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1816
+ * @param {*} [options] Override http request option.
1817
+ * @throws {RequiredError}
1818
+ */
1819
+ listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<KeyphraseOpportunitiesResponse, any, {}>>;
1820
+ }
1677
1821
  /**
1678
1822
  * MenuApi - axios parameter creator
1679
1823
  */