@searchspring/snapi-types 0.1.31 → 0.1.33
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 +1 -1
- package/models/AutocompleteRequestModel.d.ts +1 -1
- package/models/AutocompleteRequestModelAllOf.d.ts +1 -1
- package/models/AutocompleteRequestModelSuggestions.d.ts +1 -1
- package/models/AutocompleteResponseModel.d.ts +1 -1
- package/models/AutocompleteResponseModelAllOf.d.ts +1 -1
- package/models/AutocompleteResponseModelAllOfAutocomplete.d.ts +1 -1
- package/models/AutocompleteResponseModelAllOfAutocompleteAlternatives.d.ts +1 -1
- package/models/AutocompleteResponseModelAllOfAutocompleteSuggested.d.ts +1 -1
- package/models/MetaRequestModel.d.ts +1 -1
- package/models/MetaResponseModel.d.ts +8 -1
- package/models/MetaResponseModelBadgeLocation.d.ts +36 -0
- package/models/MetaResponseModelBadgeTag.d.ts +48 -0
- package/models/MetaResponseModelBadges.d.ts +35 -0
- package/models/MetaResponseModelBadgesLocations.d.ts +35 -0
- package/models/MetaResponseModelBadgesLocationsOverlay.d.ts +34 -0
- package/models/MetaResponseModelFacet.d.ts +1 -1
- package/models/MetaResponseModelFacetDefaults.d.ts +1 -1
- package/models/MetaResponseModelFacetGrid.d.ts +1 -1
- package/models/MetaResponseModelFacetHierarchy.d.ts +1 -1
- package/models/MetaResponseModelFacetHierarchyAllOf.d.ts +1 -1
- package/models/MetaResponseModelFacetList.d.ts +1 -1
- package/models/MetaResponseModelFacetPalette.d.ts +1 -1
- package/models/MetaResponseModelFacetSlider.d.ts +1 -1
- package/models/MetaResponseModelFacetSliderAllOf.d.ts +1 -1
- package/models/MetaResponseModelFacetValue.d.ts +1 -1
- package/models/MetaResponseModelPagination.d.ts +1 -1
- package/models/MetaResponseModelSortOption.d.ts +1 -1
- package/models/SearchRequestModel.d.ts +1 -1
- package/models/SearchRequestModelFacets.d.ts +1 -1
- package/models/SearchRequestModelFilter.d.ts +1 -1
- package/models/SearchRequestModelFilterRange.d.ts +1 -1
- package/models/SearchRequestModelFilterRangeAllOf.d.ts +1 -1
- package/models/SearchRequestModelFilterRangeAllOfValue.d.ts +1 -1
- package/models/SearchRequestModelFilterValue.d.ts +1 -1
- package/models/SearchRequestModelFilterValueAllOf.d.ts +1 -1
- package/models/SearchRequestModelMerchandising.d.ts +1 -1
- package/models/SearchRequestModelPagination.d.ts +1 -1
- package/models/SearchRequestModelPersonalization.d.ts +1 -1
- package/models/SearchRequestModelSearch.d.ts +1 -1
- package/models/SearchRequestModelSearchQuery.d.ts +2 -2
- package/models/SearchRequestModelSorts.d.ts +1 -1
- package/models/SearchRequestModelTracking.d.ts +1 -1
- package/models/SearchResponseModel.d.ts +1 -1
- package/models/SearchResponseModelFacet.d.ts +1 -1
- package/models/SearchResponseModelFacetRange.d.ts +1 -1
- package/models/SearchResponseModelFacetRangeAllOf.d.ts +1 -1
- package/models/SearchResponseModelFacetRangeBuckets.d.ts +1 -1
- package/models/SearchResponseModelFacetRangeBucketsAllOf.d.ts +1 -1
- package/models/SearchResponseModelFacetRangeBucketsAllOfValues.d.ts +1 -1
- package/models/SearchResponseModelFacetValue.d.ts +1 -1
- package/models/SearchResponseModelFacetValueAllOf.d.ts +1 -1
- package/models/SearchResponseModelFacetValueAllOfValues.d.ts +1 -1
- package/models/SearchResponseModelFilter.d.ts +1 -1
- package/models/SearchResponseModelFilterRange.d.ts +1 -1
- package/models/SearchResponseModelFilterValue.d.ts +1 -1
- package/models/SearchResponseModelMerchandising.d.ts +7 -1
- package/models/SearchResponseModelMerchandisingCampaigns.d.ts +1 -1
- package/models/SearchResponseModelMerchandisingContent.d.ts +1 -1
- package/models/SearchResponseModelMerchandisingContentConfig.d.ts +1 -1
- package/models/SearchResponseModelMerchandisingContentConfigPosition.d.ts +1 -1
- package/models/SearchResponseModelMerchandisingContentInline.d.ts +1 -1
- package/models/SearchResponseModelPagination.d.ts +1 -1
- package/models/SearchResponseModelResult.d.ts +1 -1
- package/models/SearchResponseModelResultChildren.d.ts +1 -1
- package/models/SearchResponseModelResultCoreMappings.d.ts +1 -1
- package/models/SearchResponseModelResultMappings.d.ts +7 -1
- package/models/SearchResponseModelSearch.d.ts +1 -1
- package/models/SearchResponseModelSorting.d.ts +1 -1
- package/models/index.d.ts +5 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,10 +5,11 @@
|
|
|
5
5
|
* snAPI
|
|
6
6
|
* Searchspring Snap Search API
|
|
7
7
|
*
|
|
8
|
-
* Built from snAPI spec v0.1.
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
9
|
*
|
|
10
10
|
*/
|
|
11
11
|
import {
|
|
12
|
+
MetaResponseModelBadges,
|
|
12
13
|
MetaResponseModelFacet,
|
|
13
14
|
MetaResponseModelPagination,
|
|
14
15
|
MetaResponseModelSortOption,
|
|
@@ -39,4 +40,10 @@ export interface MetaResponseModel {
|
|
|
39
40
|
* @memberof MetaResponseModel
|
|
40
41
|
*/
|
|
41
42
|
pagination?: MetaResponseModelPagination;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {MetaResponseModelBadges}
|
|
46
|
+
* @memberof MetaResponseModel
|
|
47
|
+
*/
|
|
48
|
+
badges?: MetaResponseModelBadges;
|
|
42
49
|
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* snAPI
|
|
6
|
+
* Searchspring Snap Search API
|
|
7
|
+
*
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface MetaResponseModelBadgeLocation
|
|
16
|
+
*/
|
|
17
|
+
export interface MetaResponseModelBadgeLocation {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof MetaResponseModelBadgeLocation
|
|
22
|
+
*/
|
|
23
|
+
name?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof MetaResponseModelBadgeLocation
|
|
28
|
+
*/
|
|
29
|
+
label?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof MetaResponseModelBadgeLocation
|
|
34
|
+
*/
|
|
35
|
+
description?: string;
|
|
36
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* snAPI
|
|
6
|
+
* Searchspring Snap Search API
|
|
7
|
+
*
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface MetaResponseModelBadgeTag
|
|
16
|
+
*/
|
|
17
|
+
export interface MetaResponseModelBadgeTag {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof MetaResponseModelBadgeTag
|
|
22
|
+
*/
|
|
23
|
+
location?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof MetaResponseModelBadgeTag
|
|
28
|
+
*/
|
|
29
|
+
component?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof MetaResponseModelBadgeTag
|
|
34
|
+
*/
|
|
35
|
+
priority?: number;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {boolean}
|
|
39
|
+
* @memberof MetaResponseModelBadgeTag
|
|
40
|
+
*/
|
|
41
|
+
enabled?: boolean;
|
|
42
|
+
/**
|
|
43
|
+
* Additional badge parameters - these are template specific fields which can have various value types
|
|
44
|
+
* @type {{ [key: string]: object; }}
|
|
45
|
+
* @memberof MetaResponseModelBadgeTag
|
|
46
|
+
*/
|
|
47
|
+
parameters?: { [key: string]: object; };
|
|
48
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* snAPI
|
|
6
|
+
* Searchspring Snap Search API
|
|
7
|
+
*
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
import {
|
|
12
|
+
MetaResponseModelBadgeTag,
|
|
13
|
+
MetaResponseModelBadgesLocations,
|
|
14
|
+
} from './';
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface MetaResponseModelBadges
|
|
21
|
+
*/
|
|
22
|
+
export interface MetaResponseModelBadges {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {MetaResponseModelBadgesLocations}
|
|
26
|
+
* @memberof MetaResponseModelBadges
|
|
27
|
+
*/
|
|
28
|
+
locations?: MetaResponseModelBadgesLocations;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {{ [key: string]: MetaResponseModelBadgeTag; }}
|
|
32
|
+
* @memberof MetaResponseModelBadges
|
|
33
|
+
*/
|
|
34
|
+
tags?: { [key: string]: MetaResponseModelBadgeTag; };
|
|
35
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* snAPI
|
|
6
|
+
* Searchspring Snap Search API
|
|
7
|
+
*
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
import {
|
|
12
|
+
MetaResponseModelBadgeLocation,
|
|
13
|
+
MetaResponseModelBadgesLocationsOverlay,
|
|
14
|
+
} from './';
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface MetaResponseModelBadgesLocations
|
|
21
|
+
*/
|
|
22
|
+
export interface MetaResponseModelBadgesLocations {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @type {MetaResponseModelBadgesLocationsOverlay}
|
|
26
|
+
* @memberof MetaResponseModelBadgesLocations
|
|
27
|
+
*/
|
|
28
|
+
overlay?: MetaResponseModelBadgesLocationsOverlay;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @type {Array<MetaResponseModelBadgeLocation>}
|
|
32
|
+
* @memberof MetaResponseModelBadgesLocations
|
|
33
|
+
*/
|
|
34
|
+
callouts?: Array<MetaResponseModelBadgeLocation>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
* snAPI
|
|
6
|
+
* Searchspring Snap Search API
|
|
7
|
+
*
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
import {
|
|
12
|
+
MetaResponseModelBadgeLocation,
|
|
13
|
+
} from './';
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface MetaResponseModelBadgesLocationsOverlay
|
|
20
|
+
*/
|
|
21
|
+
export interface MetaResponseModelBadgesLocationsOverlay {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {Array<MetaResponseModelBadgeLocation>}
|
|
25
|
+
* @memberof MetaResponseModelBadgesLocationsOverlay
|
|
26
|
+
*/
|
|
27
|
+
left?: Array<MetaResponseModelBadgeLocation>;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {Array<MetaResponseModelBadgeLocation>}
|
|
31
|
+
* @memberof MetaResponseModelBadgesLocationsOverlay
|
|
32
|
+
*/
|
|
33
|
+
right?: Array<MetaResponseModelBadgeLocation>;
|
|
34
|
+
}
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* snAPI
|
|
6
6
|
* Searchspring Snap Search API
|
|
7
7
|
*
|
|
8
|
-
* Built from snAPI spec v0.1.
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
9
|
*
|
|
10
10
|
*/
|
|
11
11
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface SearchRequestModelSearchQuery {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Query value will search the index for terms that match the query. Will support up to 256 characters.
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof SearchRequestModelSearchQuery
|
|
22
22
|
*/
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* snAPI
|
|
6
6
|
* Searchspring Snap Search API
|
|
7
7
|
*
|
|
8
|
-
* Built from snAPI spec v0.1.
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
9
|
*
|
|
10
10
|
*/
|
|
11
11
|
import {
|
|
@@ -32,6 +32,12 @@ export interface SearchResponseModelMerchandising {
|
|
|
32
32
|
* @memberof SearchResponseModelMerchandising
|
|
33
33
|
*/
|
|
34
34
|
campaigns?: Array<SearchResponseModelMerchandisingCampaigns>;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {boolean}
|
|
38
|
+
* @memberof SearchResponseModelMerchandising
|
|
39
|
+
*/
|
|
40
|
+
personalized?: boolean;
|
|
35
41
|
/**
|
|
36
42
|
*
|
|
37
43
|
* @type {SearchResponseModelMerchandisingContent}
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* snAPI
|
|
6
6
|
* Searchspring Snap Search API
|
|
7
7
|
*
|
|
8
|
-
* Built from snAPI spec v0.1.
|
|
8
|
+
* Built from snAPI spec v0.1.33
|
|
9
9
|
*
|
|
10
10
|
*/
|
|
11
11
|
import {
|
|
@@ -25,4 +25,10 @@ export interface SearchResponseModelResultMappings {
|
|
|
25
25
|
* @memberof SearchResponseModelResultMappings
|
|
26
26
|
*/
|
|
27
27
|
core?: SearchResponseModelResultCoreMappings;
|
|
28
|
+
/**
|
|
29
|
+
* List of matching badges for the result
|
|
30
|
+
* @type {Array<object>}
|
|
31
|
+
* @memberof SearchResponseModelResultMappings
|
|
32
|
+
*/
|
|
33
|
+
badges?: Array<object>;
|
|
28
34
|
}
|
package/models/index.d.ts
CHANGED
|
@@ -8,6 +8,11 @@ export * from './AutocompleteResponseModelAllOfAutocompleteAlternatives';
|
|
|
8
8
|
export * from './AutocompleteResponseModelAllOfAutocompleteSuggested';
|
|
9
9
|
export * from './MetaRequestModel';
|
|
10
10
|
export * from './MetaResponseModel';
|
|
11
|
+
export * from './MetaResponseModelBadgeLocation';
|
|
12
|
+
export * from './MetaResponseModelBadgeTag';
|
|
13
|
+
export * from './MetaResponseModelBadges';
|
|
14
|
+
export * from './MetaResponseModelBadgesLocations';
|
|
15
|
+
export * from './MetaResponseModelBadgesLocationsOverlay';
|
|
11
16
|
export * from './MetaResponseModelFacet';
|
|
12
17
|
export * from './MetaResponseModelFacetDefaults';
|
|
13
18
|
export * from './MetaResponseModelFacetGrid';
|