@teemill/website 0.13.0 → 0.15.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/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website API
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.13.0
7
+ * The version of the OpenAPI document: 0.15.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -299,6 +299,12 @@ export interface Collection {
299
299
  * @memberof Collection
300
300
  */
301
301
  'slug'?: string;
302
+ /**
303
+ *
304
+ * @type {string}
305
+ * @memberof Collection
306
+ */
307
+ 'longDescription'?: string;
302
308
  /**
303
309
  *
304
310
  * @type {SeoMetadata}
@@ -311,6 +317,12 @@ export interface Collection {
311
317
  * @memberof Collection
312
318
  */
313
319
  'targetSearchPhraseData'?: TargetSearchPhraseData;
320
+ /**
321
+ * History of AI optimisations performed on the collection
322
+ * @type {Array<OptimisationHistoryItem>}
323
+ * @memberof Collection
324
+ */
325
+ 'optimisationHistory'?: Array<OptimisationHistoryItem>;
314
326
  }
315
327
  /**
316
328
  *
@@ -331,6 +343,25 @@ export interface CollectionsResponse {
331
343
  */
332
344
  'nextPageToken'?: number | null;
333
345
  }
346
+ /**
347
+ *
348
+ * @export
349
+ * @interface CreateSearchRedirectRequest
350
+ */
351
+ export interface CreateSearchRedirectRequest {
352
+ /**
353
+ *
354
+ * @type {string}
355
+ * @memberof CreateSearchRedirectRequest
356
+ */
357
+ 'searchTerm': string;
358
+ /**
359
+ *
360
+ * @type {string}
361
+ * @memberof CreateSearchRedirectRequest
362
+ */
363
+ 'destinationUrl': string;
364
+ }
334
365
  /**
335
366
  * Image description
336
367
  * @export
@@ -474,6 +505,25 @@ export interface MetaField {
474
505
  */
475
506
  'value': string;
476
507
  }
508
+ /**
509
+ *
510
+ * @export
511
+ * @interface OptimisationHistoryItem
512
+ */
513
+ export interface OptimisationHistoryItem {
514
+ /**
515
+ * Unique object identifier
516
+ * @type {string}
517
+ * @memberof OptimisationHistoryItem
518
+ */
519
+ 'id'?: string;
520
+ /**
521
+ *
522
+ * @type {string}
523
+ * @memberof OptimisationHistoryItem
524
+ */
525
+ 'createdAt'?: string;
526
+ }
477
527
  /**
478
528
  *
479
529
  * @export
@@ -510,6 +560,12 @@ export interface Page {
510
560
  * @memberof Page
511
561
  */
512
562
  'targetSearchPhraseData'?: TargetSearchPhraseData;
563
+ /**
564
+ * History of AI optimisations performed on the page
565
+ * @type {Array<OptimisationHistoryItem>}
566
+ * @memberof Page
567
+ */
568
+ 'optimisationHistory'?: Array<OptimisationHistoryItem>;
513
569
  }
514
570
  /**
515
571
  *
@@ -840,6 +896,56 @@ export interface Route {
840
896
  */
841
897
  'published': boolean;
842
898
  }
899
+ /**
900
+ *
901
+ * @export
902
+ * @interface SearchRedirect
903
+ */
904
+ export interface SearchRedirect {
905
+ /**
906
+ * Unique object identifier
907
+ * @type {string}
908
+ * @memberof SearchRedirect
909
+ */
910
+ 'id': string;
911
+ /**
912
+ *
913
+ * @type {string}
914
+ * @memberof SearchRedirect
915
+ */
916
+ 'searchTerm': string;
917
+ /**
918
+ *
919
+ * @type {string}
920
+ * @memberof SearchRedirect
921
+ */
922
+ 'destinationUrl': string;
923
+ /**
924
+ *
925
+ * @type {string}
926
+ * @memberof SearchRedirect
927
+ */
928
+ 'createdAt': string;
929
+ }
930
+ /**
931
+ *
932
+ * @export
933
+ * @interface SearchRedirectsResponse
934
+ */
935
+ export interface SearchRedirectsResponse {
936
+ /**
937
+ *
938
+ * @type {Array<SearchRedirect>}
939
+ * @memberof SearchRedirectsResponse
940
+ */
941
+ 'redirects': Array<SearchRedirect>;
942
+ /**
943
+ * The token referencing the next page number
944
+ * @type {number}
945
+ * @memberof SearchRedirectsResponse
946
+ */
947
+ 'nextPageToken': number | null;
948
+ }
843
949
  /**
844
950
  * SEO metadata for the product
845
951
  * @export
@@ -1338,6 +1444,12 @@ export interface UpdateCollectionRequest {
1338
1444
  * @memberof UpdateCollectionRequest
1339
1445
  */
1340
1446
  'slug'?: string;
1447
+ /**
1448
+ * Long-form description for the collection used for SEO.
1449
+ * @type {string}
1450
+ * @memberof UpdateCollectionRequest
1451
+ */
1452
+ 'longDescription'?: string;
1341
1453
  /**
1342
1454
  *
1343
1455
  * @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
@@ -1400,6 +1512,12 @@ export interface UpdateCollectionsRequestCollectionsInner {
1400
1512
  * @memberof UpdateCollectionsRequestCollectionsInner
1401
1513
  */
1402
1514
  'slug'?: string;
1515
+ /**
1516
+ * Long-form description for the collection used for SEO.
1517
+ * @type {string}
1518
+ * @memberof UpdateCollectionsRequestCollectionsInner
1519
+ */
1520
+ 'longDescription'?: string;
1403
1521
  /**
1404
1522
  *
1405
1523
  * @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
@@ -1831,6 +1949,25 @@ export interface UpdatePagesRequestPagesInner {
1831
1949
  */
1832
1950
  'targetSearchPhraseSynonyms'?: Array<string>;
1833
1951
  }
1952
+ /**
1953
+ *
1954
+ * @export
1955
+ * @interface UpdateSearchRedirectRequest
1956
+ */
1957
+ export interface UpdateSearchRedirectRequest {
1958
+ /**
1959
+ *
1960
+ * @type {string}
1961
+ * @memberof UpdateSearchRedirectRequest
1962
+ */
1963
+ 'searchTerm'?: string;
1964
+ /**
1965
+ *
1966
+ * @type {string}
1967
+ * @memberof UpdateSearchRedirectRequest
1968
+ */
1969
+ 'destinationUrl'?: string;
1970
+ }
1834
1971
  /**
1835
1972
  *
1836
1973
  * @export
@@ -4496,3 +4633,645 @@ export class RoutesApi extends BaseAPI {
4496
4633
 
4497
4634
 
4498
4635
 
4636
+ /**
4637
+ * SearchApi - axios parameter creator
4638
+ * @export
4639
+ */
4640
+ export const SearchApiAxiosParamCreator = function (configuration?: Configuration) {
4641
+ return {
4642
+ /**
4643
+ *
4644
+ * @summary Create search redirect
4645
+ * @param {string} project What project it is
4646
+ * @param {number} [pageToken] Page reference token
4647
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4648
+ * @param {string} [search] Search term to filter results
4649
+ * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
4650
+ * @param {*} [options] Override http request option.
4651
+ * @throws {RequiredError}
4652
+ */
4653
+ createSearchRedirect: async (project: string, pageToken?: number, pageSize?: number, search?: string, createSearchRedirectRequest?: CreateSearchRedirectRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4654
+ // verify required parameter 'project' is not null or undefined
4655
+ assertParamExists('createSearchRedirect', 'project', project)
4656
+ const localVarPath = `/v1/website/search/redirects`;
4657
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4658
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4659
+ let baseOptions;
4660
+ if (configuration) {
4661
+ baseOptions = configuration.baseOptions;
4662
+ }
4663
+
4664
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
4665
+ const localVarHeaderParameter = {} as any;
4666
+ const localVarQueryParameter = {} as any;
4667
+
4668
+ // authentication session-oauth required
4669
+ // oauth required
4670
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4671
+
4672
+ // authentication api-key required
4673
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4674
+
4675
+ if (project !== undefined) {
4676
+ localVarQueryParameter['project'] = project;
4677
+ }
4678
+
4679
+ if (pageToken !== undefined) {
4680
+ localVarQueryParameter['pageToken'] = pageToken;
4681
+ }
4682
+
4683
+ if (pageSize !== undefined) {
4684
+ localVarQueryParameter['pageSize'] = pageSize;
4685
+ }
4686
+
4687
+ if (search !== undefined) {
4688
+ localVarQueryParameter['search'] = search;
4689
+ }
4690
+
4691
+
4692
+
4693
+ localVarHeaderParameter['Content-Type'] = 'application/json';
4694
+
4695
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4696
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4697
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4698
+ localVarRequestOptions.data = serializeDataIfNeeded(createSearchRedirectRequest, localVarRequestOptions, configuration)
4699
+
4700
+ return {
4701
+ url: toPathString(localVarUrlObj),
4702
+ options: localVarRequestOptions,
4703
+ };
4704
+ },
4705
+ /**
4706
+ *
4707
+ * @summary Delete search redirect
4708
+ * @param {string} project What project it is
4709
+ * @param {string} redirectId Redirect\&#39;s unique identifier
4710
+ * @param {*} [options] Override http request option.
4711
+ * @throws {RequiredError}
4712
+ */
4713
+ deleteSearchRedirect: async (project: string, redirectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4714
+ // verify required parameter 'project' is not null or undefined
4715
+ assertParamExists('deleteSearchRedirect', 'project', project)
4716
+ // verify required parameter 'redirectId' is not null or undefined
4717
+ assertParamExists('deleteSearchRedirect', 'redirectId', redirectId)
4718
+ const localVarPath = `/v1/website/search/redirects/{redirectId}`
4719
+ .replace(`{${"redirectId"}}`, encodeURIComponent(String(redirectId)));
4720
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4721
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4722
+ let baseOptions;
4723
+ if (configuration) {
4724
+ baseOptions = configuration.baseOptions;
4725
+ }
4726
+
4727
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
4728
+ const localVarHeaderParameter = {} as any;
4729
+ const localVarQueryParameter = {} as any;
4730
+
4731
+ // authentication session-oauth required
4732
+ // oauth required
4733
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4734
+
4735
+ // authentication api-key required
4736
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4737
+
4738
+ if (project !== undefined) {
4739
+ localVarQueryParameter['project'] = project;
4740
+ }
4741
+
4742
+
4743
+
4744
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4745
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4746
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4747
+
4748
+ return {
4749
+ url: toPathString(localVarUrlObj),
4750
+ options: localVarRequestOptions,
4751
+ };
4752
+ },
4753
+ /**
4754
+ *
4755
+ * @summary Get search redirect
4756
+ * @param {string} project What project it is
4757
+ * @param {string} redirectId Redirect\&#39;s unique identifier
4758
+ * @param {*} [options] Override http request option.
4759
+ * @throws {RequiredError}
4760
+ */
4761
+ getSearchRedirect: async (project: string, redirectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4762
+ // verify required parameter 'project' is not null or undefined
4763
+ assertParamExists('getSearchRedirect', 'project', project)
4764
+ // verify required parameter 'redirectId' is not null or undefined
4765
+ assertParamExists('getSearchRedirect', 'redirectId', redirectId)
4766
+ const localVarPath = `/v1/website/search/redirects/{redirectId}`
4767
+ .replace(`{${"redirectId"}}`, encodeURIComponent(String(redirectId)));
4768
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4769
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4770
+ let baseOptions;
4771
+ if (configuration) {
4772
+ baseOptions = configuration.baseOptions;
4773
+ }
4774
+
4775
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
4776
+ const localVarHeaderParameter = {} as any;
4777
+ const localVarQueryParameter = {} as any;
4778
+
4779
+ // authentication session-oauth required
4780
+ // oauth required
4781
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4782
+
4783
+ // authentication api-key required
4784
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4785
+
4786
+ if (project !== undefined) {
4787
+ localVarQueryParameter['project'] = project;
4788
+ }
4789
+
4790
+
4791
+
4792
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4793
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4794
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4795
+
4796
+ return {
4797
+ url: toPathString(localVarUrlObj),
4798
+ options: localVarRequestOptions,
4799
+ };
4800
+ },
4801
+ /**
4802
+ *
4803
+ * @summary List search redirects
4804
+ * @param {string} project What project it is
4805
+ * @param {number} [pageToken] Page reference token
4806
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4807
+ * @param {string} [search] Search term to filter results
4808
+ * @param {*} [options] Override http request option.
4809
+ * @throws {RequiredError}
4810
+ */
4811
+ listSearchRedirects: async (project: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4812
+ // verify required parameter 'project' is not null or undefined
4813
+ assertParamExists('listSearchRedirects', 'project', project)
4814
+ const localVarPath = `/v1/website/search/redirects`;
4815
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4816
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4817
+ let baseOptions;
4818
+ if (configuration) {
4819
+ baseOptions = configuration.baseOptions;
4820
+ }
4821
+
4822
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
4823
+ const localVarHeaderParameter = {} as any;
4824
+ const localVarQueryParameter = {} as any;
4825
+
4826
+ // authentication session-oauth required
4827
+ // oauth required
4828
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4829
+
4830
+ // authentication api-key required
4831
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4832
+
4833
+ if (project !== undefined) {
4834
+ localVarQueryParameter['project'] = project;
4835
+ }
4836
+
4837
+ if (pageToken !== undefined) {
4838
+ localVarQueryParameter['pageToken'] = pageToken;
4839
+ }
4840
+
4841
+ if (pageSize !== undefined) {
4842
+ localVarQueryParameter['pageSize'] = pageSize;
4843
+ }
4844
+
4845
+ if (search !== undefined) {
4846
+ localVarQueryParameter['search'] = search;
4847
+ }
4848
+
4849
+
4850
+
4851
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4852
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4853
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4854
+
4855
+ return {
4856
+ url: toPathString(localVarUrlObj),
4857
+ options: localVarRequestOptions,
4858
+ };
4859
+ },
4860
+ /**
4861
+ *
4862
+ * @summary Update search redirect
4863
+ * @param {string} project What project it is
4864
+ * @param {string} redirectId Redirect\&#39;s unique identifier
4865
+ * @param {UpdateSearchRedirectRequest} [updateSearchRedirectRequest] Update search redirect
4866
+ * @param {*} [options] Override http request option.
4867
+ * @throws {RequiredError}
4868
+ */
4869
+ updateSearchRedirect: async (project: string, redirectId: string, updateSearchRedirectRequest?: UpdateSearchRedirectRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4870
+ // verify required parameter 'project' is not null or undefined
4871
+ assertParamExists('updateSearchRedirect', 'project', project)
4872
+ // verify required parameter 'redirectId' is not null or undefined
4873
+ assertParamExists('updateSearchRedirect', 'redirectId', redirectId)
4874
+ const localVarPath = `/v1/website/search/redirects/{redirectId}`
4875
+ .replace(`{${"redirectId"}}`, encodeURIComponent(String(redirectId)));
4876
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4877
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4878
+ let baseOptions;
4879
+ if (configuration) {
4880
+ baseOptions = configuration.baseOptions;
4881
+ }
4882
+
4883
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
4884
+ const localVarHeaderParameter = {} as any;
4885
+ const localVarQueryParameter = {} as any;
4886
+
4887
+ // authentication session-oauth required
4888
+ // oauth required
4889
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4890
+
4891
+ // authentication api-key required
4892
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4893
+
4894
+ if (project !== undefined) {
4895
+ localVarQueryParameter['project'] = project;
4896
+ }
4897
+
4898
+
4899
+
4900
+ localVarHeaderParameter['Content-Type'] = 'application/json';
4901
+
4902
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4903
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4904
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4905
+ localVarRequestOptions.data = serializeDataIfNeeded(updateSearchRedirectRequest, localVarRequestOptions, configuration)
4906
+
4907
+ return {
4908
+ url: toPathString(localVarUrlObj),
4909
+ options: localVarRequestOptions,
4910
+ };
4911
+ },
4912
+ }
4913
+ };
4914
+
4915
+ /**
4916
+ * SearchApi - functional programming interface
4917
+ * @export
4918
+ */
4919
+ export const SearchApiFp = function(configuration?: Configuration) {
4920
+ const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration)
4921
+ return {
4922
+ /**
4923
+ *
4924
+ * @summary Create search redirect
4925
+ * @param {string} project What project it is
4926
+ * @param {number} [pageToken] Page reference token
4927
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4928
+ * @param {string} [search] Search term to filter results
4929
+ * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
4930
+ * @param {*} [options] Override http request option.
4931
+ * @throws {RequiredError}
4932
+ */
4933
+ async createSearchRedirect(project: string, pageToken?: number, pageSize?: number, search?: string, createSearchRedirectRequest?: CreateSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirect>> {
4934
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createSearchRedirect(project, pageToken, pageSize, search, createSearchRedirectRequest, options);
4935
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4936
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.createSearchRedirect']?.[localVarOperationServerIndex]?.url;
4937
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4938
+ },
4939
+ /**
4940
+ *
4941
+ * @summary Delete search redirect
4942
+ * @param {string} project What project it is
4943
+ * @param {string} redirectId Redirect\&#39;s unique identifier
4944
+ * @param {*} [options] Override http request option.
4945
+ * @throws {RequiredError}
4946
+ */
4947
+ async deleteSearchRedirect(project: string, redirectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
4948
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSearchRedirect(project, redirectId, options);
4949
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4950
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.deleteSearchRedirect']?.[localVarOperationServerIndex]?.url;
4951
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4952
+ },
4953
+ /**
4954
+ *
4955
+ * @summary Get search redirect
4956
+ * @param {string} project What project it is
4957
+ * @param {string} redirectId Redirect\&#39;s unique identifier
4958
+ * @param {*} [options] Override http request option.
4959
+ * @throws {RequiredError}
4960
+ */
4961
+ async getSearchRedirect(project: string, redirectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirect>> {
4962
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchRedirect(project, redirectId, options);
4963
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4964
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.getSearchRedirect']?.[localVarOperationServerIndex]?.url;
4965
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4966
+ },
4967
+ /**
4968
+ *
4969
+ * @summary List search redirects
4970
+ * @param {string} project What project it is
4971
+ * @param {number} [pageToken] Page reference token
4972
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4973
+ * @param {string} [search] Search term to filter results
4974
+ * @param {*} [options] Override http request option.
4975
+ * @throws {RequiredError}
4976
+ */
4977
+ async listSearchRedirects(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirectsResponse>> {
4978
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchRedirects(project, pageToken, pageSize, search, options);
4979
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4980
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.listSearchRedirects']?.[localVarOperationServerIndex]?.url;
4981
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4982
+ },
4983
+ /**
4984
+ *
4985
+ * @summary Update search redirect
4986
+ * @param {string} project What project it is
4987
+ * @param {string} redirectId Redirect\&#39;s unique identifier
4988
+ * @param {UpdateSearchRedirectRequest} [updateSearchRedirectRequest] Update search redirect
4989
+ * @param {*} [options] Override http request option.
4990
+ * @throws {RequiredError}
4991
+ */
4992
+ async updateSearchRedirect(project: string, redirectId: string, updateSearchRedirectRequest?: UpdateSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirect>> {
4993
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateSearchRedirect(project, redirectId, updateSearchRedirectRequest, options);
4994
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4995
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.updateSearchRedirect']?.[localVarOperationServerIndex]?.url;
4996
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4997
+ },
4998
+ }
4999
+ };
5000
+
5001
+ /**
5002
+ * SearchApi - factory interface
5003
+ * @export
5004
+ */
5005
+ export const SearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
5006
+ const localVarFp = SearchApiFp(configuration)
5007
+ return {
5008
+ /**
5009
+ *
5010
+ * @summary Create search redirect
5011
+ * @param {SearchApiCreateSearchRedirectRequest} requestParameters Request parameters.
5012
+ * @param {*} [options] Override http request option.
5013
+ * @throws {RequiredError}
5014
+ */
5015
+ createSearchRedirect(requestParameters: SearchApiCreateSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirect> {
5016
+ return localVarFp.createSearchRedirect(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createSearchRedirectRequest, options).then((request) => request(axios, basePath));
5017
+ },
5018
+ /**
5019
+ *
5020
+ * @summary Delete search redirect
5021
+ * @param {SearchApiDeleteSearchRedirectRequest} requestParameters Request parameters.
5022
+ * @param {*} [options] Override http request option.
5023
+ * @throws {RequiredError}
5024
+ */
5025
+ deleteSearchRedirect(requestParameters: SearchApiDeleteSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
5026
+ return localVarFp.deleteSearchRedirect(requestParameters.project, requestParameters.redirectId, options).then((request) => request(axios, basePath));
5027
+ },
5028
+ /**
5029
+ *
5030
+ * @summary Get search redirect
5031
+ * @param {SearchApiGetSearchRedirectRequest} requestParameters Request parameters.
5032
+ * @param {*} [options] Override http request option.
5033
+ * @throws {RequiredError}
5034
+ */
5035
+ getSearchRedirect(requestParameters: SearchApiGetSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirect> {
5036
+ return localVarFp.getSearchRedirect(requestParameters.project, requestParameters.redirectId, options).then((request) => request(axios, basePath));
5037
+ },
5038
+ /**
5039
+ *
5040
+ * @summary List search redirects
5041
+ * @param {SearchApiListSearchRedirectsRequest} requestParameters Request parameters.
5042
+ * @param {*} [options] Override http request option.
5043
+ * @throws {RequiredError}
5044
+ */
5045
+ listSearchRedirects(requestParameters: SearchApiListSearchRedirectsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirectsResponse> {
5046
+ return localVarFp.listSearchRedirects(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
5047
+ },
5048
+ /**
5049
+ *
5050
+ * @summary Update search redirect
5051
+ * @param {SearchApiUpdateSearchRedirectRequest} requestParameters Request parameters.
5052
+ * @param {*} [options] Override http request option.
5053
+ * @throws {RequiredError}
5054
+ */
5055
+ updateSearchRedirect(requestParameters: SearchApiUpdateSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirect> {
5056
+ return localVarFp.updateSearchRedirect(requestParameters.project, requestParameters.redirectId, requestParameters.updateSearchRedirectRequest, options).then((request) => request(axios, basePath));
5057
+ },
5058
+ };
5059
+ };
5060
+
5061
+ /**
5062
+ * Request parameters for createSearchRedirect operation in SearchApi.
5063
+ * @export
5064
+ * @interface SearchApiCreateSearchRedirectRequest
5065
+ */
5066
+ export interface SearchApiCreateSearchRedirectRequest {
5067
+ /**
5068
+ * What project it is
5069
+ * @type {string}
5070
+ * @memberof SearchApiCreateSearchRedirect
5071
+ */
5072
+ readonly project: string
5073
+
5074
+ /**
5075
+ * Page reference token
5076
+ * @type {number}
5077
+ * @memberof SearchApiCreateSearchRedirect
5078
+ */
5079
+ readonly pageToken?: number
5080
+
5081
+ /**
5082
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
5083
+ * @type {number}
5084
+ * @memberof SearchApiCreateSearchRedirect
5085
+ */
5086
+ readonly pageSize?: number
5087
+
5088
+ /**
5089
+ * Search term to filter results
5090
+ * @type {string}
5091
+ * @memberof SearchApiCreateSearchRedirect
5092
+ */
5093
+ readonly search?: string
5094
+
5095
+ /**
5096
+ * Create search redirect
5097
+ * @type {CreateSearchRedirectRequest}
5098
+ * @memberof SearchApiCreateSearchRedirect
5099
+ */
5100
+ readonly createSearchRedirectRequest?: CreateSearchRedirectRequest
5101
+ }
5102
+
5103
+ /**
5104
+ * Request parameters for deleteSearchRedirect operation in SearchApi.
5105
+ * @export
5106
+ * @interface SearchApiDeleteSearchRedirectRequest
5107
+ */
5108
+ export interface SearchApiDeleteSearchRedirectRequest {
5109
+ /**
5110
+ * What project it is
5111
+ * @type {string}
5112
+ * @memberof SearchApiDeleteSearchRedirect
5113
+ */
5114
+ readonly project: string
5115
+
5116
+ /**
5117
+ * Redirect\&#39;s unique identifier
5118
+ * @type {string}
5119
+ * @memberof SearchApiDeleteSearchRedirect
5120
+ */
5121
+ readonly redirectId: string
5122
+ }
5123
+
5124
+ /**
5125
+ * Request parameters for getSearchRedirect operation in SearchApi.
5126
+ * @export
5127
+ * @interface SearchApiGetSearchRedirectRequest
5128
+ */
5129
+ export interface SearchApiGetSearchRedirectRequest {
5130
+ /**
5131
+ * What project it is
5132
+ * @type {string}
5133
+ * @memberof SearchApiGetSearchRedirect
5134
+ */
5135
+ readonly project: string
5136
+
5137
+ /**
5138
+ * Redirect\&#39;s unique identifier
5139
+ * @type {string}
5140
+ * @memberof SearchApiGetSearchRedirect
5141
+ */
5142
+ readonly redirectId: string
5143
+ }
5144
+
5145
+ /**
5146
+ * Request parameters for listSearchRedirects operation in SearchApi.
5147
+ * @export
5148
+ * @interface SearchApiListSearchRedirectsRequest
5149
+ */
5150
+ export interface SearchApiListSearchRedirectsRequest {
5151
+ /**
5152
+ * What project it is
5153
+ * @type {string}
5154
+ * @memberof SearchApiListSearchRedirects
5155
+ */
5156
+ readonly project: string
5157
+
5158
+ /**
5159
+ * Page reference token
5160
+ * @type {number}
5161
+ * @memberof SearchApiListSearchRedirects
5162
+ */
5163
+ readonly pageToken?: number
5164
+
5165
+ /**
5166
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
5167
+ * @type {number}
5168
+ * @memberof SearchApiListSearchRedirects
5169
+ */
5170
+ readonly pageSize?: number
5171
+
5172
+ /**
5173
+ * Search term to filter results
5174
+ * @type {string}
5175
+ * @memberof SearchApiListSearchRedirects
5176
+ */
5177
+ readonly search?: string
5178
+ }
5179
+
5180
+ /**
5181
+ * Request parameters for updateSearchRedirect operation in SearchApi.
5182
+ * @export
5183
+ * @interface SearchApiUpdateSearchRedirectRequest
5184
+ */
5185
+ export interface SearchApiUpdateSearchRedirectRequest {
5186
+ /**
5187
+ * What project it is
5188
+ * @type {string}
5189
+ * @memberof SearchApiUpdateSearchRedirect
5190
+ */
5191
+ readonly project: string
5192
+
5193
+ /**
5194
+ * Redirect\&#39;s unique identifier
5195
+ * @type {string}
5196
+ * @memberof SearchApiUpdateSearchRedirect
5197
+ */
5198
+ readonly redirectId: string
5199
+
5200
+ /**
5201
+ * Update search redirect
5202
+ * @type {UpdateSearchRedirectRequest}
5203
+ * @memberof SearchApiUpdateSearchRedirect
5204
+ */
5205
+ readonly updateSearchRedirectRequest?: UpdateSearchRedirectRequest
5206
+ }
5207
+
5208
+ /**
5209
+ * SearchApi - object-oriented interface
5210
+ * @export
5211
+ * @class SearchApi
5212
+ * @extends {BaseAPI}
5213
+ */
5214
+ export class SearchApi extends BaseAPI {
5215
+ /**
5216
+ *
5217
+ * @summary Create search redirect
5218
+ * @param {SearchApiCreateSearchRedirectRequest} requestParameters Request parameters.
5219
+ * @param {*} [options] Override http request option.
5220
+ * @throws {RequiredError}
5221
+ * @memberof SearchApi
5222
+ */
5223
+ public createSearchRedirect(requestParameters: SearchApiCreateSearchRedirectRequest, options?: RawAxiosRequestConfig) {
5224
+ return SearchApiFp(this.configuration).createSearchRedirect(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createSearchRedirectRequest, options).then((request) => request(this.axios, this.basePath));
5225
+ }
5226
+
5227
+ /**
5228
+ *
5229
+ * @summary Delete search redirect
5230
+ * @param {SearchApiDeleteSearchRedirectRequest} requestParameters Request parameters.
5231
+ * @param {*} [options] Override http request option.
5232
+ * @throws {RequiredError}
5233
+ * @memberof SearchApi
5234
+ */
5235
+ public deleteSearchRedirect(requestParameters: SearchApiDeleteSearchRedirectRequest, options?: RawAxiosRequestConfig) {
5236
+ return SearchApiFp(this.configuration).deleteSearchRedirect(requestParameters.project, requestParameters.redirectId, options).then((request) => request(this.axios, this.basePath));
5237
+ }
5238
+
5239
+ /**
5240
+ *
5241
+ * @summary Get search redirect
5242
+ * @param {SearchApiGetSearchRedirectRequest} requestParameters Request parameters.
5243
+ * @param {*} [options] Override http request option.
5244
+ * @throws {RequiredError}
5245
+ * @memberof SearchApi
5246
+ */
5247
+ public getSearchRedirect(requestParameters: SearchApiGetSearchRedirectRequest, options?: RawAxiosRequestConfig) {
5248
+ return SearchApiFp(this.configuration).getSearchRedirect(requestParameters.project, requestParameters.redirectId, options).then((request) => request(this.axios, this.basePath));
5249
+ }
5250
+
5251
+ /**
5252
+ *
5253
+ * @summary List search redirects
5254
+ * @param {SearchApiListSearchRedirectsRequest} requestParameters Request parameters.
5255
+ * @param {*} [options] Override http request option.
5256
+ * @throws {RequiredError}
5257
+ * @memberof SearchApi
5258
+ */
5259
+ public listSearchRedirects(requestParameters: SearchApiListSearchRedirectsRequest, options?: RawAxiosRequestConfig) {
5260
+ return SearchApiFp(this.configuration).listSearchRedirects(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
5261
+ }
5262
+
5263
+ /**
5264
+ *
5265
+ * @summary Update search redirect
5266
+ * @param {SearchApiUpdateSearchRedirectRequest} requestParameters Request parameters.
5267
+ * @param {*} [options] Override http request option.
5268
+ * @throws {RequiredError}
5269
+ * @memberof SearchApi
5270
+ */
5271
+ public updateSearchRedirect(requestParameters: SearchApiUpdateSearchRedirectRequest, options?: RawAxiosRequestConfig) {
5272
+ return SearchApiFp(this.configuration).updateSearchRedirect(requestParameters.project, requestParameters.redirectId, requestParameters.updateSearchRedirectRequest, options).then((request) => request(this.axios, this.basePath));
5273
+ }
5274
+ }
5275
+
5276
+
5277
+