@seekora-ai/admin-api 1.1.59 → 1.1.60
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -2
- package/api.ts +992 -11
- package/dist/api.d.ts +645 -8
- package/dist/api.js +701 -16
- package/dist/esm/api.d.ts +645 -8
- package/dist/esm/api.js +692 -11
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.60.tgz +0 -0
- package/seekora-ai-admin-api-1.1.59.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -11013,6 +11013,31 @@ export interface DataTypesGenericResponseDataTypesNotification {
|
|
|
11013
11013
|
*/
|
|
11014
11014
|
'status'?: number;
|
|
11015
11015
|
}
|
|
11016
|
+
/**
|
|
11017
|
+
*
|
|
11018
|
+
* @export
|
|
11019
|
+
* @interface DataTypesGenericResponseDataTypesNotificationAttachmentURLData
|
|
11020
|
+
*/
|
|
11021
|
+
export interface DataTypesGenericResponseDataTypesNotificationAttachmentURLData {
|
|
11022
|
+
/**
|
|
11023
|
+
*
|
|
11024
|
+
* @type {DataTypesNotificationAttachmentURLData}
|
|
11025
|
+
* @memberof DataTypesGenericResponseDataTypesNotificationAttachmentURLData
|
|
11026
|
+
*/
|
|
11027
|
+
'data'?: DataTypesNotificationAttachmentURLData;
|
|
11028
|
+
/**
|
|
11029
|
+
*
|
|
11030
|
+
* @type {string}
|
|
11031
|
+
* @memberof DataTypesGenericResponseDataTypesNotificationAttachmentURLData
|
|
11032
|
+
*/
|
|
11033
|
+
'message'?: string;
|
|
11034
|
+
/**
|
|
11035
|
+
*
|
|
11036
|
+
* @type {number}
|
|
11037
|
+
* @memberof DataTypesGenericResponseDataTypesNotificationAttachmentURLData
|
|
11038
|
+
*/
|
|
11039
|
+
'status'?: number;
|
|
11040
|
+
}
|
|
11016
11041
|
/**
|
|
11017
11042
|
*
|
|
11018
11043
|
* @export
|
|
@@ -14489,6 +14514,43 @@ export interface DataTypesNotificationActionResponse {
|
|
|
14489
14514
|
*/
|
|
14490
14515
|
'status'?: number;
|
|
14491
14516
|
}
|
|
14517
|
+
/**
|
|
14518
|
+
*
|
|
14519
|
+
* @export
|
|
14520
|
+
* @interface DataTypesNotificationAttachmentURLData
|
|
14521
|
+
*/
|
|
14522
|
+
export interface DataTypesNotificationAttachmentURLData {
|
|
14523
|
+
/**
|
|
14524
|
+
* \"invoice\" or \"receipt\"
|
|
14525
|
+
* @type {string}
|
|
14526
|
+
* @memberof DataTypesNotificationAttachmentURLData
|
|
14527
|
+
*/
|
|
14528
|
+
'attachment_type'?: string;
|
|
14529
|
+
/**
|
|
14530
|
+
* seconds until expiry
|
|
14531
|
+
* @type {number}
|
|
14532
|
+
* @memberof DataTypesNotificationAttachmentURLData
|
|
14533
|
+
*/
|
|
14534
|
+
'expires_in'?: number;
|
|
14535
|
+
/**
|
|
14536
|
+
*
|
|
14537
|
+
* @type {number}
|
|
14538
|
+
* @memberof DataTypesNotificationAttachmentURLData
|
|
14539
|
+
*/
|
|
14540
|
+
'notification_id'?: number;
|
|
14541
|
+
/**
|
|
14542
|
+
* invoice_id or receipt_id
|
|
14543
|
+
* @type {string}
|
|
14544
|
+
* @memberof DataTypesNotificationAttachmentURLData
|
|
14545
|
+
*/
|
|
14546
|
+
'resource_id'?: string;
|
|
14547
|
+
/**
|
|
14548
|
+
*
|
|
14549
|
+
* @type {string}
|
|
14550
|
+
* @memberof DataTypesNotificationAttachmentURLData
|
|
14551
|
+
*/
|
|
14552
|
+
'url'?: string;
|
|
14553
|
+
}
|
|
14492
14554
|
/**
|
|
14493
14555
|
*
|
|
14494
14556
|
* @export
|
|
@@ -25178,6 +25240,43 @@ export interface QuerySuggestionsServiceDeleteManualSuggestionsRequest {
|
|
|
25178
25240
|
*/
|
|
25179
25241
|
'suggestion_ids': Array<string>;
|
|
25180
25242
|
}
|
|
25243
|
+
/**
|
|
25244
|
+
*
|
|
25245
|
+
* @export
|
|
25246
|
+
* @interface QuerySuggestionsServiceDropdownRecommendations
|
|
25247
|
+
*/
|
|
25248
|
+
export interface QuerySuggestionsServiceDropdownRecommendations {
|
|
25249
|
+
/**
|
|
25250
|
+
* When this data was cached
|
|
25251
|
+
* @type {string}
|
|
25252
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25253
|
+
*/
|
|
25254
|
+
'cached_at'?: string;
|
|
25255
|
+
/**
|
|
25256
|
+
* Popular brands
|
|
25257
|
+
* @type {Array<QuerySuggestionsServicePopularBrand>}
|
|
25258
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25259
|
+
*/
|
|
25260
|
+
'popular_brands'?: Array<QuerySuggestionsServicePopularBrand>;
|
|
25261
|
+
/**
|
|
25262
|
+
* Processing time for recommendations
|
|
25263
|
+
* @type {number}
|
|
25264
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25265
|
+
*/
|
|
25266
|
+
'processing_time_ms'?: number;
|
|
25267
|
+
/**
|
|
25268
|
+
* Trending products
|
|
25269
|
+
* @type {Array<QuerySuggestionsServiceTrendingProduct>}
|
|
25270
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25271
|
+
*/
|
|
25272
|
+
'trending_products'?: Array<QuerySuggestionsServiceTrendingProduct>;
|
|
25273
|
+
/**
|
|
25274
|
+
* Trending search categories
|
|
25275
|
+
* @type {Array<QuerySuggestionsServiceTrendingSearch>}
|
|
25276
|
+
* @memberof QuerySuggestionsServiceDropdownRecommendations
|
|
25277
|
+
*/
|
|
25278
|
+
'trending_searches'?: Array<QuerySuggestionsServiceTrendingSearch>;
|
|
25279
|
+
}
|
|
25181
25280
|
/**
|
|
25182
25281
|
*
|
|
25183
25282
|
* @export
|
|
@@ -25403,6 +25502,51 @@ export interface QuerySuggestionsServiceManualQuerySuggestionRequest {
|
|
|
25403
25502
|
*/
|
|
25404
25503
|
'tags'?: Array<string>;
|
|
25405
25504
|
}
|
|
25505
|
+
/**
|
|
25506
|
+
*
|
|
25507
|
+
* @export
|
|
25508
|
+
* @interface QuerySuggestionsServicePopularBrand
|
|
25509
|
+
*/
|
|
25510
|
+
export interface QuerySuggestionsServicePopularBrand {
|
|
25511
|
+
/**
|
|
25512
|
+
* Number of clicks (optional)
|
|
25513
|
+
* @type {number}
|
|
25514
|
+
* @memberof QuerySuggestionsServicePopularBrand
|
|
25515
|
+
*/
|
|
25516
|
+
'clicks'?: number;
|
|
25517
|
+
/**
|
|
25518
|
+
* Number of conversions (optional)
|
|
25519
|
+
* @type {number}
|
|
25520
|
+
* @memberof QuerySuggestionsServicePopularBrand
|
|
25521
|
+
*/
|
|
25522
|
+
'conversions'?: number;
|
|
25523
|
+
/**
|
|
25524
|
+
* Brand logo URL (mapped from config)
|
|
25525
|
+
* @type {string}
|
|
25526
|
+
* @memberof QuerySuggestionsServicePopularBrand
|
|
25527
|
+
*/
|
|
25528
|
+
'logo'?: string;
|
|
25529
|
+
/**
|
|
25530
|
+
* Additional brand data
|
|
25531
|
+
* @type {{ [key: string]: any; }}
|
|
25532
|
+
* @memberof QuerySuggestionsServicePopularBrand
|
|
25533
|
+
*/
|
|
25534
|
+
'metadata'?: {
|
|
25535
|
+
[key: string]: any;
|
|
25536
|
+
};
|
|
25537
|
+
/**
|
|
25538
|
+
* Brand name (mapped from config)
|
|
25539
|
+
* @type {string}
|
|
25540
|
+
* @memberof QuerySuggestionsServicePopularBrand
|
|
25541
|
+
*/
|
|
25542
|
+
'name'?: string;
|
|
25543
|
+
/**
|
|
25544
|
+
* Number of searches
|
|
25545
|
+
* @type {number}
|
|
25546
|
+
* @memberof QuerySuggestionsServicePopularBrand
|
|
25547
|
+
*/
|
|
25548
|
+
'searches'?: number;
|
|
25549
|
+
}
|
|
25406
25550
|
/**
|
|
25407
25551
|
*
|
|
25408
25552
|
* @export
|
|
@@ -26093,6 +26237,12 @@ export interface QuerySuggestionsServiceQuerySuggestionsConfig {
|
|
|
26093
26237
|
* @interface QuerySuggestionsServiceQuerySuggestionsResponse
|
|
26094
26238
|
*/
|
|
26095
26239
|
export interface QuerySuggestionsServiceQuerySuggestionsResponse {
|
|
26240
|
+
/**
|
|
26241
|
+
* Rich dropdown recommendations (optional, only when include_dropdown_recommendations=true)
|
|
26242
|
+
* @type {QuerySuggestionsServiceDropdownRecommendations}
|
|
26243
|
+
* @memberof QuerySuggestionsServiceQuerySuggestionsResponse
|
|
26244
|
+
*/
|
|
26245
|
+
'dropdown_recommendations'?: QuerySuggestionsServiceDropdownRecommendations;
|
|
26096
26246
|
/**
|
|
26097
26247
|
* Whether the count is exact
|
|
26098
26248
|
* @type {boolean}
|
|
@@ -26274,6 +26424,120 @@ export interface QuerySuggestionsServiceToggleQuerySuggestionsRequest {
|
|
|
26274
26424
|
*/
|
|
26275
26425
|
'enabled': boolean;
|
|
26276
26426
|
}
|
|
26427
|
+
/**
|
|
26428
|
+
*
|
|
26429
|
+
* @export
|
|
26430
|
+
* @interface QuerySuggestionsServiceTrendingProduct
|
|
26431
|
+
*/
|
|
26432
|
+
export interface QuerySuggestionsServiceTrendingProduct {
|
|
26433
|
+
/**
|
|
26434
|
+
* Number of clicks
|
|
26435
|
+
* @type {number}
|
|
26436
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26437
|
+
*/
|
|
26438
|
+
'clicks'?: number;
|
|
26439
|
+
/**
|
|
26440
|
+
* Number of conversions (optional)
|
|
26441
|
+
* @type {number}
|
|
26442
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26443
|
+
*/
|
|
26444
|
+
'conversions'?: number;
|
|
26445
|
+
/**
|
|
26446
|
+
* Currency code (optional)
|
|
26447
|
+
* @type {string}
|
|
26448
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26449
|
+
*/
|
|
26450
|
+
'currency'?: string;
|
|
26451
|
+
/**
|
|
26452
|
+
* Product ID (mapped from config)
|
|
26453
|
+
* @type {string}
|
|
26454
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26455
|
+
*/
|
|
26456
|
+
'id'?: string;
|
|
26457
|
+
/**
|
|
26458
|
+
* Product image URL (mapped from config)
|
|
26459
|
+
* @type {string}
|
|
26460
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26461
|
+
*/
|
|
26462
|
+
'image'?: string;
|
|
26463
|
+
/**
|
|
26464
|
+
* Additional product data
|
|
26465
|
+
* @type {{ [key: string]: any; }}
|
|
26466
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26467
|
+
*/
|
|
26468
|
+
'metadata'?: {
|
|
26469
|
+
[key: string]: any;
|
|
26470
|
+
};
|
|
26471
|
+
/**
|
|
26472
|
+
* Product price (mapped from config, can be string or number)
|
|
26473
|
+
* @type {any}
|
|
26474
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26475
|
+
*/
|
|
26476
|
+
'price'?: any;
|
|
26477
|
+
/**
|
|
26478
|
+
* Revenue generated (optional)
|
|
26479
|
+
* @type {number}
|
|
26480
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26481
|
+
*/
|
|
26482
|
+
'revenue'?: number;
|
|
26483
|
+
/**
|
|
26484
|
+
* Product title (mapped from config)
|
|
26485
|
+
* @type {string}
|
|
26486
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26487
|
+
*/
|
|
26488
|
+
'title'?: string;
|
|
26489
|
+
/**
|
|
26490
|
+
* Calculated trend score
|
|
26491
|
+
* @type {number}
|
|
26492
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26493
|
+
*/
|
|
26494
|
+
'trend_score'?: number;
|
|
26495
|
+
/**
|
|
26496
|
+
* Product URL (optional)
|
|
26497
|
+
* @type {string}
|
|
26498
|
+
* @memberof QuerySuggestionsServiceTrendingProduct
|
|
26499
|
+
*/
|
|
26500
|
+
'url'?: string;
|
|
26501
|
+
}
|
|
26502
|
+
/**
|
|
26503
|
+
*
|
|
26504
|
+
* @export
|
|
26505
|
+
* @interface QuerySuggestionsServiceTrendingSearch
|
|
26506
|
+
*/
|
|
26507
|
+
export interface QuerySuggestionsServiceTrendingSearch {
|
|
26508
|
+
/**
|
|
26509
|
+
* Category if applicable
|
|
26510
|
+
* @type {string}
|
|
26511
|
+
* @memberof QuerySuggestionsServiceTrendingSearch
|
|
26512
|
+
*/
|
|
26513
|
+
'category'?: string;
|
|
26514
|
+
/**
|
|
26515
|
+
* Additional data
|
|
26516
|
+
* @type {{ [key: string]: any; }}
|
|
26517
|
+
* @memberof QuerySuggestionsServiceTrendingSearch
|
|
26518
|
+
*/
|
|
26519
|
+
'metadata'?: {
|
|
26520
|
+
[key: string]: any;
|
|
26521
|
+
};
|
|
26522
|
+
/**
|
|
26523
|
+
* The trending query
|
|
26524
|
+
* @type {string}
|
|
26525
|
+
* @memberof QuerySuggestionsServiceTrendingSearch
|
|
26526
|
+
*/
|
|
26527
|
+
'query'?: string;
|
|
26528
|
+
/**
|
|
26529
|
+
* Number of searches
|
|
26530
|
+
* @type {number}
|
|
26531
|
+
* @memberof QuerySuggestionsServiceTrendingSearch
|
|
26532
|
+
*/
|
|
26533
|
+
'searches'?: number;
|
|
26534
|
+
/**
|
|
26535
|
+
* Trend score (optional)
|
|
26536
|
+
* @type {number}
|
|
26537
|
+
* @memberof QuerySuggestionsServiceTrendingSearch
|
|
26538
|
+
*/
|
|
26539
|
+
'trend_score'?: number;
|
|
26540
|
+
}
|
|
26277
26541
|
/**
|
|
26278
26542
|
*
|
|
26279
26543
|
* @export
|
|
@@ -34295,6 +34559,14 @@ export declare class CompanyConfigApi extends BaseAPI {
|
|
|
34295
34559
|
* @export
|
|
34296
34560
|
*/
|
|
34297
34561
|
export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34562
|
+
/**
|
|
34563
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
34564
|
+
* @summary Get validation errors for a job
|
|
34565
|
+
* @param {string} jobid Job ID
|
|
34566
|
+
* @param {*} [options] Override http request option.
|
|
34567
|
+
* @throws {RequiredError}
|
|
34568
|
+
*/
|
|
34569
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34298
34570
|
/**
|
|
34299
34571
|
* Test search
|
|
34300
34572
|
* @summary Test search
|
|
@@ -34377,6 +34649,14 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
34377
34649
|
* @export
|
|
34378
34650
|
*/
|
|
34379
34651
|
export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
34652
|
+
/**
|
|
34653
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
34654
|
+
* @summary Get validation errors for a job
|
|
34655
|
+
* @param {string} jobid Job ID
|
|
34656
|
+
* @param {*} [options] Override http request option.
|
|
34657
|
+
* @throws {RequiredError}
|
|
34658
|
+
*/
|
|
34659
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
|
|
34380
34660
|
/**
|
|
34381
34661
|
* Test search
|
|
34382
34662
|
* @summary Test search
|
|
@@ -34459,6 +34739,14 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
34459
34739
|
* @export
|
|
34460
34740
|
*/
|
|
34461
34741
|
export declare const ConnectorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
34742
|
+
/**
|
|
34743
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
34744
|
+
* @summary Get validation errors for a job
|
|
34745
|
+
* @param {string} jobid Job ID
|
|
34746
|
+
* @param {*} [options] Override http request option.
|
|
34747
|
+
* @throws {RequiredError}
|
|
34748
|
+
*/
|
|
34749
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
|
|
34462
34750
|
/**
|
|
34463
34751
|
* Test search
|
|
34464
34752
|
* @summary Test search
|
|
@@ -34543,6 +34831,15 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
34543
34831
|
* @extends {BaseAPI}
|
|
34544
34832
|
*/
|
|
34545
34833
|
export declare class ConnectorsApi extends BaseAPI {
|
|
34834
|
+
/**
|
|
34835
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
34836
|
+
* @summary Get validation errors for a job
|
|
34837
|
+
* @param {string} jobid Job ID
|
|
34838
|
+
* @param {*} [options] Override http request option.
|
|
34839
|
+
* @throws {RequiredError}
|
|
34840
|
+
* @memberof ConnectorsApi
|
|
34841
|
+
*/
|
|
34842
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
|
|
34546
34843
|
/**
|
|
34547
34844
|
* Test search
|
|
34548
34845
|
* @summary Test search
|
|
@@ -35393,6 +35690,235 @@ export declare class DefaultMenuManagementApi extends BaseAPI {
|
|
|
35393
35690
|
*/
|
|
35394
35691
|
adminDefaultMenusVisibilityPut(defaultMenuRoutesUpdateMenuVisibilityRequest: DefaultMenuRoutesUpdateMenuVisibilityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDefaultMenuRoutesUpdateMenuVisibilityResponse, any, {}>>;
|
|
35395
35692
|
}
|
|
35693
|
+
/**
|
|
35694
|
+
* DocumentationApi - axios parameter creator
|
|
35695
|
+
* @export
|
|
35696
|
+
*/
|
|
35697
|
+
export declare const DocumentationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35698
|
+
/**
|
|
35699
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35700
|
+
* @summary Clear all indexed documentation
|
|
35701
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35702
|
+
* @param {*} [options] Override http request option.
|
|
35703
|
+
* @throws {RequiredError}
|
|
35704
|
+
*/
|
|
35705
|
+
v1DocsClearDelete: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35706
|
+
/**
|
|
35707
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35708
|
+
* @summary Scrape and index documentation
|
|
35709
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35710
|
+
* @param {*} [options] Override http request option.
|
|
35711
|
+
* @throws {RequiredError}
|
|
35712
|
+
*/
|
|
35713
|
+
v1DocsScrapePost: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35714
|
+
/**
|
|
35715
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
35716
|
+
* @summary Search documentation
|
|
35717
|
+
* @param {string} query Search query
|
|
35718
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
35719
|
+
* @param {*} [options] Override http request option.
|
|
35720
|
+
* @throws {RequiredError}
|
|
35721
|
+
*/
|
|
35722
|
+
v1DocsSearchPost: (query: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35723
|
+
/**
|
|
35724
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
35725
|
+
* @summary Get search suggestions
|
|
35726
|
+
* @param {string} query Search query
|
|
35727
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
35728
|
+
* @param {*} [options] Override http request option.
|
|
35729
|
+
* @throws {RequiredError}
|
|
35730
|
+
*/
|
|
35731
|
+
v1DocsSuggestionsGet: (query: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35732
|
+
/**
|
|
35733
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35734
|
+
* @summary Update documentation
|
|
35735
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35736
|
+
* @param {*} [options] Override http request option.
|
|
35737
|
+
* @throws {RequiredError}
|
|
35738
|
+
*/
|
|
35739
|
+
v1DocsUpdatePut: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35740
|
+
};
|
|
35741
|
+
/**
|
|
35742
|
+
* DocumentationApi - functional programming interface
|
|
35743
|
+
* @export
|
|
35744
|
+
*/
|
|
35745
|
+
export declare const DocumentationApiFp: (configuration?: Configuration) => {
|
|
35746
|
+
/**
|
|
35747
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35748
|
+
* @summary Clear all indexed documentation
|
|
35749
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35750
|
+
* @param {*} [options] Override http request option.
|
|
35751
|
+
* @throws {RequiredError}
|
|
35752
|
+
*/
|
|
35753
|
+
v1DocsClearDelete(xDocsAPIKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
35754
|
+
[key: string]: any;
|
|
35755
|
+
}>>;
|
|
35756
|
+
/**
|
|
35757
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35758
|
+
* @summary Scrape and index documentation
|
|
35759
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35760
|
+
* @param {*} [options] Override http request option.
|
|
35761
|
+
* @throws {RequiredError}
|
|
35762
|
+
*/
|
|
35763
|
+
v1DocsScrapePost(xDocsAPIKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
35764
|
+
[key: string]: any;
|
|
35765
|
+
}>>;
|
|
35766
|
+
/**
|
|
35767
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
35768
|
+
* @summary Search documentation
|
|
35769
|
+
* @param {string} query Search query
|
|
35770
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
35771
|
+
* @param {*} [options] Override http request option.
|
|
35772
|
+
* @throws {RequiredError}
|
|
35773
|
+
*/
|
|
35774
|
+
v1DocsSearchPost(query: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
35775
|
+
[key: string]: any;
|
|
35776
|
+
}>>;
|
|
35777
|
+
/**
|
|
35778
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
35779
|
+
* @summary Get search suggestions
|
|
35780
|
+
* @param {string} query Search query
|
|
35781
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
35782
|
+
* @param {*} [options] Override http request option.
|
|
35783
|
+
* @throws {RequiredError}
|
|
35784
|
+
*/
|
|
35785
|
+
v1DocsSuggestionsGet(query: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
35786
|
+
[key: string]: any;
|
|
35787
|
+
}>>;
|
|
35788
|
+
/**
|
|
35789
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35790
|
+
* @summary Update documentation
|
|
35791
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35792
|
+
* @param {*} [options] Override http request option.
|
|
35793
|
+
* @throws {RequiredError}
|
|
35794
|
+
*/
|
|
35795
|
+
v1DocsUpdatePut(xDocsAPIKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
35796
|
+
[key: string]: any;
|
|
35797
|
+
}>>;
|
|
35798
|
+
};
|
|
35799
|
+
/**
|
|
35800
|
+
* DocumentationApi - factory interface
|
|
35801
|
+
* @export
|
|
35802
|
+
*/
|
|
35803
|
+
export declare const DocumentationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
35804
|
+
/**
|
|
35805
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35806
|
+
* @summary Clear all indexed documentation
|
|
35807
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35808
|
+
* @param {*} [options] Override http request option.
|
|
35809
|
+
* @throws {RequiredError}
|
|
35810
|
+
*/
|
|
35811
|
+
v1DocsClearDelete(xDocsAPIKey: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
35812
|
+
[key: string]: any;
|
|
35813
|
+
}>;
|
|
35814
|
+
/**
|
|
35815
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35816
|
+
* @summary Scrape and index documentation
|
|
35817
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35818
|
+
* @param {*} [options] Override http request option.
|
|
35819
|
+
* @throws {RequiredError}
|
|
35820
|
+
*/
|
|
35821
|
+
v1DocsScrapePost(xDocsAPIKey: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
35822
|
+
[key: string]: any;
|
|
35823
|
+
}>;
|
|
35824
|
+
/**
|
|
35825
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
35826
|
+
* @summary Search documentation
|
|
35827
|
+
* @param {string} query Search query
|
|
35828
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
35829
|
+
* @param {*} [options] Override http request option.
|
|
35830
|
+
* @throws {RequiredError}
|
|
35831
|
+
*/
|
|
35832
|
+
v1DocsSearchPost(query: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
35833
|
+
[key: string]: any;
|
|
35834
|
+
}>;
|
|
35835
|
+
/**
|
|
35836
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
35837
|
+
* @summary Get search suggestions
|
|
35838
|
+
* @param {string} query Search query
|
|
35839
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
35840
|
+
* @param {*} [options] Override http request option.
|
|
35841
|
+
* @throws {RequiredError}
|
|
35842
|
+
*/
|
|
35843
|
+
v1DocsSuggestionsGet(query: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
35844
|
+
[key: string]: any;
|
|
35845
|
+
}>;
|
|
35846
|
+
/**
|
|
35847
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35848
|
+
* @summary Update documentation
|
|
35849
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35850
|
+
* @param {*} [options] Override http request option.
|
|
35851
|
+
* @throws {RequiredError}
|
|
35852
|
+
*/
|
|
35853
|
+
v1DocsUpdatePut(xDocsAPIKey: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
35854
|
+
[key: string]: any;
|
|
35855
|
+
}>;
|
|
35856
|
+
};
|
|
35857
|
+
/**
|
|
35858
|
+
* DocumentationApi - object-oriented interface
|
|
35859
|
+
* @export
|
|
35860
|
+
* @class DocumentationApi
|
|
35861
|
+
* @extends {BaseAPI}
|
|
35862
|
+
*/
|
|
35863
|
+
export declare class DocumentationApi extends BaseAPI {
|
|
35864
|
+
/**
|
|
35865
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35866
|
+
* @summary Clear all indexed documentation
|
|
35867
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35868
|
+
* @param {*} [options] Override http request option.
|
|
35869
|
+
* @throws {RequiredError}
|
|
35870
|
+
* @memberof DocumentationApi
|
|
35871
|
+
*/
|
|
35872
|
+
v1DocsClearDelete(xDocsAPIKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
35873
|
+
[key: string]: any;
|
|
35874
|
+
}, any, {}>>;
|
|
35875
|
+
/**
|
|
35876
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35877
|
+
* @summary Scrape and index documentation
|
|
35878
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35879
|
+
* @param {*} [options] Override http request option.
|
|
35880
|
+
* @throws {RequiredError}
|
|
35881
|
+
* @memberof DocumentationApi
|
|
35882
|
+
*/
|
|
35883
|
+
v1DocsScrapePost(xDocsAPIKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
35884
|
+
[key: string]: any;
|
|
35885
|
+
}, any, {}>>;
|
|
35886
|
+
/**
|
|
35887
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
35888
|
+
* @summary Search documentation
|
|
35889
|
+
* @param {string} query Search query
|
|
35890
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
35891
|
+
* @param {*} [options] Override http request option.
|
|
35892
|
+
* @throws {RequiredError}
|
|
35893
|
+
* @memberof DocumentationApi
|
|
35894
|
+
*/
|
|
35895
|
+
v1DocsSearchPost(query: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
35896
|
+
[key: string]: any;
|
|
35897
|
+
}, any, {}>>;
|
|
35898
|
+
/**
|
|
35899
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
35900
|
+
* @summary Get search suggestions
|
|
35901
|
+
* @param {string} query Search query
|
|
35902
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
35903
|
+
* @param {*} [options] Override http request option.
|
|
35904
|
+
* @throws {RequiredError}
|
|
35905
|
+
* @memberof DocumentationApi
|
|
35906
|
+
*/
|
|
35907
|
+
v1DocsSuggestionsGet(query: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
35908
|
+
[key: string]: any;
|
|
35909
|
+
}, any, {}>>;
|
|
35910
|
+
/**
|
|
35911
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
35912
|
+
* @summary Update documentation
|
|
35913
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
35914
|
+
* @param {*} [options] Override http request option.
|
|
35915
|
+
* @throws {RequiredError}
|
|
35916
|
+
* @memberof DocumentationApi
|
|
35917
|
+
*/
|
|
35918
|
+
v1DocsUpdatePut(xDocsAPIKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
35919
|
+
[key: string]: any;
|
|
35920
|
+
}, any, {}>>;
|
|
35921
|
+
}
|
|
35396
35922
|
/**
|
|
35397
35923
|
* DocumentsApi - axios parameter creator
|
|
35398
35924
|
* @export
|
|
@@ -35481,16 +36007,18 @@ export declare const DropdownRecommendationsApiAxiosParamCreator: (configuration
|
|
|
35481
36007
|
*/
|
|
35482
36008
|
v1DropdownRecommendationsConfigPut: (xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35483
36009
|
/**
|
|
35484
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
36010
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
35485
36011
|
* @summary Get Dropdown Recommendations
|
|
35486
36012
|
* @param {string} xStoreid Store ID
|
|
35487
36013
|
* @param {string} xStoresecret Store Secret
|
|
35488
36014
|
* @param {string} [xUserId] User ID for personalization
|
|
35489
36015
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36016
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36017
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
35490
36018
|
* @param {*} [options] Override http request option.
|
|
35491
36019
|
* @throws {RequiredError}
|
|
35492
36020
|
*/
|
|
35493
|
-
v1DropdownRecommendationsGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36021
|
+
v1DropdownRecommendationsGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35494
36022
|
};
|
|
35495
36023
|
/**
|
|
35496
36024
|
* DropdownRecommendationsApi - functional programming interface
|
|
@@ -35517,16 +36045,18 @@ export declare const DropdownRecommendationsApiFp: (configuration?: Configuratio
|
|
|
35517
36045
|
*/
|
|
35518
36046
|
v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>>;
|
|
35519
36047
|
/**
|
|
35520
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
36048
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
35521
36049
|
* @summary Get Dropdown Recommendations
|
|
35522
36050
|
* @param {string} xStoreid Store ID
|
|
35523
36051
|
* @param {string} xStoresecret Store Secret
|
|
35524
36052
|
* @param {string} [xUserId] User ID for personalization
|
|
35525
36053
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36054
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36055
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
35526
36056
|
* @param {*} [options] Override http request option.
|
|
35527
36057
|
* @throws {RequiredError}
|
|
35528
36058
|
*/
|
|
35529
|
-
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse>>;
|
|
36059
|
+
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse>>;
|
|
35530
36060
|
};
|
|
35531
36061
|
/**
|
|
35532
36062
|
* DropdownRecommendationsApi - factory interface
|
|
@@ -35553,16 +36083,18 @@ export declare const DropdownRecommendationsApiFactory: (configuration?: Configu
|
|
|
35553
36083
|
*/
|
|
35554
36084
|
v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownConfigResponse>;
|
|
35555
36085
|
/**
|
|
35556
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
36086
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
35557
36087
|
* @summary Get Dropdown Recommendations
|
|
35558
36088
|
* @param {string} xStoreid Store ID
|
|
35559
36089
|
* @param {string} xStoresecret Store Secret
|
|
35560
36090
|
* @param {string} [xUserId] User ID for personalization
|
|
35561
36091
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36092
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36093
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
35562
36094
|
* @param {*} [options] Override http request option.
|
|
35563
36095
|
* @throws {RequiredError}
|
|
35564
36096
|
*/
|
|
35565
|
-
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse>;
|
|
36097
|
+
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): AxiosPromise<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse>;
|
|
35566
36098
|
};
|
|
35567
36099
|
/**
|
|
35568
36100
|
* DropdownRecommendationsApi - object-oriented interface
|
|
@@ -35593,17 +36125,19 @@ export declare class DropdownRecommendationsApi extends BaseAPI {
|
|
|
35593
36125
|
*/
|
|
35594
36126
|
v1DropdownRecommendationsConfigPut(xStoreid: string, xStoresecret: string, dropdownRecommendationsServiceUpdateDropdownConfigRequest: DropdownRecommendationsServiceUpdateDropdownConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DropdownRecommendationsServiceDropdownConfigResponse, any, {}>>;
|
|
35595
36127
|
/**
|
|
35596
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
36128
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
35597
36129
|
* @summary Get Dropdown Recommendations
|
|
35598
36130
|
* @param {string} xStoreid Store ID
|
|
35599
36131
|
* @param {string} xStoresecret Store Secret
|
|
35600
36132
|
* @param {string} [xUserId] User ID for personalization
|
|
35601
36133
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
36134
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
36135
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
35602
36136
|
* @param {*} [options] Override http request option.
|
|
35603
36137
|
* @throws {RequiredError}
|
|
35604
36138
|
* @memberof DropdownRecommendationsApi
|
|
35605
36139
|
*/
|
|
35606
|
-
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse, any, {}>>;
|
|
36140
|
+
v1DropdownRecommendationsGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, q?: string, query?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DropdownRecommendationsServiceDropdownRecommendationsAPIResponse, any, {}>>;
|
|
35607
36141
|
}
|
|
35608
36142
|
/**
|
|
35609
36143
|
* ExternalAPINotificationsApi - axios parameter creator
|
|
@@ -38689,6 +39223,15 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
38689
39223
|
* @throws {RequiredError}
|
|
38690
39224
|
*/
|
|
38691
39225
|
v1NotificationsGet: (page?: number, pageSize?: number, limit?: number, offset?: number, search?: string, type?: V1NotificationsGetTypeEnum, isRead?: V1NotificationsGetIsReadEnum, priority?: V1NotificationsGetPriorityEnum, sortBy?: V1NotificationsGetSortByEnum, sortOrder?: V1NotificationsGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39226
|
+
/**
|
|
39227
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
39228
|
+
* @summary Get notification attachment URL
|
|
39229
|
+
* @param {number} id Notification ID
|
|
39230
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
39231
|
+
* @param {*} [options] Override http request option.
|
|
39232
|
+
* @throws {RequiredError}
|
|
39233
|
+
*/
|
|
39234
|
+
v1NotificationsIdAttachmentsTypeUrlGet: (id: number, type: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38692
39235
|
/**
|
|
38693
39236
|
* Deletes a specific notification for the authenticated user
|
|
38694
39237
|
* @summary Delete notification
|
|
@@ -38758,6 +39301,15 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
38758
39301
|
* @throws {RequiredError}
|
|
38759
39302
|
*/
|
|
38760
39303
|
v1NotificationsGet(page?: number, pageSize?: number, limit?: number, offset?: number, search?: string, type?: V1NotificationsGetTypeEnum, isRead?: V1NotificationsGetIsReadEnum, priority?: V1NotificationsGetPriorityEnum, sortBy?: V1NotificationsGetSortByEnum, sortOrder?: V1NotificationsGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesNotificationListResponse>>;
|
|
39304
|
+
/**
|
|
39305
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
39306
|
+
* @summary Get notification attachment URL
|
|
39307
|
+
* @param {number} id Notification ID
|
|
39308
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
39309
|
+
* @param {*} [options] Override http request option.
|
|
39310
|
+
* @throws {RequiredError}
|
|
39311
|
+
*/
|
|
39312
|
+
v1NotificationsIdAttachmentsTypeUrlGet(id: number, type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesNotificationAttachmentURLData>>;
|
|
38761
39313
|
/**
|
|
38762
39314
|
* Deletes a specific notification for the authenticated user
|
|
38763
39315
|
* @summary Delete notification
|
|
@@ -38827,6 +39379,15 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
38827
39379
|
* @throws {RequiredError}
|
|
38828
39380
|
*/
|
|
38829
39381
|
v1NotificationsGet(page?: number, pageSize?: number, limit?: number, offset?: number, search?: string, type?: V1NotificationsGetTypeEnum, isRead?: V1NotificationsGetIsReadEnum, priority?: V1NotificationsGetPriorityEnum, sortBy?: V1NotificationsGetSortByEnum, sortOrder?: V1NotificationsGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesNotificationListResponse>;
|
|
39382
|
+
/**
|
|
39383
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
39384
|
+
* @summary Get notification attachment URL
|
|
39385
|
+
* @param {number} id Notification ID
|
|
39386
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
39387
|
+
* @param {*} [options] Override http request option.
|
|
39388
|
+
* @throws {RequiredError}
|
|
39389
|
+
*/
|
|
39390
|
+
v1NotificationsIdAttachmentsTypeUrlGet(id: number, type: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesNotificationAttachmentURLData>;
|
|
38830
39391
|
/**
|
|
38831
39392
|
* Deletes a specific notification for the authenticated user
|
|
38832
39393
|
* @summary Delete notification
|
|
@@ -38900,6 +39461,16 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
38900
39461
|
* @memberof NotificationsApi
|
|
38901
39462
|
*/
|
|
38902
39463
|
v1NotificationsGet(page?: number, pageSize?: number, limit?: number, offset?: number, search?: string, type?: V1NotificationsGetTypeEnum, isRead?: V1NotificationsGetIsReadEnum, priority?: V1NotificationsGetPriorityEnum, sortBy?: V1NotificationsGetSortByEnum, sortOrder?: V1NotificationsGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesNotificationListResponse, any, {}>>;
|
|
39464
|
+
/**
|
|
39465
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
39466
|
+
* @summary Get notification attachment URL
|
|
39467
|
+
* @param {number} id Notification ID
|
|
39468
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
39469
|
+
* @param {*} [options] Override http request option.
|
|
39470
|
+
* @throws {RequiredError}
|
|
39471
|
+
* @memberof NotificationsApi
|
|
39472
|
+
*/
|
|
39473
|
+
v1NotificationsIdAttachmentsTypeUrlGet(id: number, type: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesNotificationAttachmentURLData, any, {}>>;
|
|
38903
39474
|
/**
|
|
38904
39475
|
* Deletes a specific notification for the authenticated user
|
|
38905
39476
|
* @summary Delete notification
|
|
@@ -39022,6 +39593,14 @@ export declare const OnboardingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
39022
39593
|
* @throws {RequiredError}
|
|
39023
39594
|
*/
|
|
39024
39595
|
adminV1UsersOnboardingJobstatusJobidGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39596
|
+
/**
|
|
39597
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
39598
|
+
* @summary Get validation errors for a job
|
|
39599
|
+
* @param {string} jobid Job ID
|
|
39600
|
+
* @param {*} [options] Override http request option.
|
|
39601
|
+
* @throws {RequiredError}
|
|
39602
|
+
*/
|
|
39603
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39025
39604
|
/**
|
|
39026
39605
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
39027
39606
|
* @summary Update user onboarding step
|
|
@@ -39096,6 +39675,14 @@ export declare const OnboardingApiFp: (configuration?: Configuration) => {
|
|
|
39096
39675
|
* @throws {RequiredError}
|
|
39097
39676
|
*/
|
|
39098
39677
|
adminV1UsersOnboardingJobstatusJobidGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesJobStatusResponseWrapper>>;
|
|
39678
|
+
/**
|
|
39679
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
39680
|
+
* @summary Get validation errors for a job
|
|
39681
|
+
* @param {string} jobid Job ID
|
|
39682
|
+
* @param {*} [options] Override http request option.
|
|
39683
|
+
* @throws {RequiredError}
|
|
39684
|
+
*/
|
|
39685
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
|
|
39099
39686
|
/**
|
|
39100
39687
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
39101
39688
|
* @summary Update user onboarding step
|
|
@@ -39170,6 +39757,14 @@ export declare const OnboardingApiFactory: (configuration?: Configuration, baseP
|
|
|
39170
39757
|
* @throws {RequiredError}
|
|
39171
39758
|
*/
|
|
39172
39759
|
adminV1UsersOnboardingJobstatusJobidGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesJobStatusResponseWrapper>;
|
|
39760
|
+
/**
|
|
39761
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
39762
|
+
* @summary Get validation errors for a job
|
|
39763
|
+
* @param {string} jobid Job ID
|
|
39764
|
+
* @param {*} [options] Override http request option.
|
|
39765
|
+
* @throws {RequiredError}
|
|
39766
|
+
*/
|
|
39767
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
|
|
39173
39768
|
/**
|
|
39174
39769
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
39175
39770
|
* @summary Update user onboarding step
|
|
@@ -39248,6 +39843,15 @@ export declare class OnboardingApi extends BaseAPI {
|
|
|
39248
39843
|
* @memberof OnboardingApi
|
|
39249
39844
|
*/
|
|
39250
39845
|
adminV1UsersOnboardingJobstatusJobidGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesJobStatusResponseWrapper, any, {}>>;
|
|
39846
|
+
/**
|
|
39847
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
39848
|
+
* @summary Get validation errors for a job
|
|
39849
|
+
* @param {string} jobid Job ID
|
|
39850
|
+
* @param {*} [options] Override http request option.
|
|
39851
|
+
* @throws {RequiredError}
|
|
39852
|
+
* @memberof OnboardingApi
|
|
39853
|
+
*/
|
|
39854
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
|
|
39251
39855
|
/**
|
|
39252
39856
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
39253
39857
|
* @summary Update user onboarding step
|
|
@@ -44608,6 +45212,14 @@ export declare class StopwordsApi extends BaseAPI {
|
|
|
44608
45212
|
* @export
|
|
44609
45213
|
*/
|
|
44610
45214
|
export declare const StoreCreationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
45215
|
+
/**
|
|
45216
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
45217
|
+
* @summary Get validation errors for a job
|
|
45218
|
+
* @param {string} jobid Job ID
|
|
45219
|
+
* @param {*} [options] Override http request option.
|
|
45220
|
+
* @throws {RequiredError}
|
|
45221
|
+
*/
|
|
45222
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44611
45223
|
/**
|
|
44612
45224
|
* Deletes (soft delete) the current store creation progress
|
|
44613
45225
|
* @summary Delete store creation progress
|
|
@@ -44678,6 +45290,14 @@ export declare const StoreCreationApiAxiosParamCreator: (configuration?: Configu
|
|
|
44678
45290
|
* @export
|
|
44679
45291
|
*/
|
|
44680
45292
|
export declare const StoreCreationApiFp: (configuration?: Configuration) => {
|
|
45293
|
+
/**
|
|
45294
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
45295
|
+
* @summary Get validation errors for a job
|
|
45296
|
+
* @param {string} jobid Job ID
|
|
45297
|
+
* @param {*} [options] Override http request option.
|
|
45298
|
+
* @throws {RequiredError}
|
|
45299
|
+
*/
|
|
45300
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
|
|
44681
45301
|
/**
|
|
44682
45302
|
* Deletes (soft delete) the current store creation progress
|
|
44683
45303
|
* @summary Delete store creation progress
|
|
@@ -44748,6 +45368,14 @@ export declare const StoreCreationApiFp: (configuration?: Configuration) => {
|
|
|
44748
45368
|
* @export
|
|
44749
45369
|
*/
|
|
44750
45370
|
export declare const StoreCreationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
45371
|
+
/**
|
|
45372
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
45373
|
+
* @summary Get validation errors for a job
|
|
45374
|
+
* @param {string} jobid Job ID
|
|
45375
|
+
* @param {*} [options] Override http request option.
|
|
45376
|
+
* @throws {RequiredError}
|
|
45377
|
+
*/
|
|
45378
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
|
|
44751
45379
|
/**
|
|
44752
45380
|
* Deletes (soft delete) the current store creation progress
|
|
44753
45381
|
* @summary Delete store creation progress
|
|
@@ -44820,6 +45448,15 @@ export declare const StoreCreationApiFactory: (configuration?: Configuration, ba
|
|
|
44820
45448
|
* @extends {BaseAPI}
|
|
44821
45449
|
*/
|
|
44822
45450
|
export declare class StoreCreationApi extends BaseAPI {
|
|
45451
|
+
/**
|
|
45452
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
45453
|
+
* @summary Get validation errors for a job
|
|
45454
|
+
* @param {string} jobid Job ID
|
|
45455
|
+
* @param {*} [options] Override http request option.
|
|
45456
|
+
* @throws {RequiredError}
|
|
45457
|
+
* @memberof StoreCreationApi
|
|
45458
|
+
*/
|
|
45459
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
|
|
44823
45460
|
/**
|
|
44824
45461
|
* Deletes (soft delete) the current store creation progress
|
|
44825
45462
|
* @summary Delete store creation progress
|