@wix/auto_sdk_atlas_location 1.0.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.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/atlas-v2-search-result-location.context.d.ts +5 -0
  11. package/build/cjs/src/atlas-v2-search-result-location.context.js +11 -0
  12. package/build/cjs/src/atlas-v2-search-result-location.context.js.map +1 -0
  13. package/build/cjs/src/atlas-v2-search-result-location.http.d.ts +3 -0
  14. package/build/cjs/src/atlas-v2-search-result-location.http.js +144 -0
  15. package/build/cjs/src/atlas-v2-search-result-location.http.js.map +1 -0
  16. package/build/cjs/src/atlas-v2-search-result-location.meta.d.ts +13 -0
  17. package/build/cjs/src/atlas-v2-search-result-location.meta.js +47 -0
  18. package/build/cjs/src/atlas-v2-search-result-location.meta.js.map +1 -0
  19. package/build/cjs/src/atlas-v2-search-result-location.public.d.ts +13 -0
  20. package/build/cjs/src/atlas-v2-search-result-location.public.js +16 -0
  21. package/build/cjs/src/atlas-v2-search-result-location.public.js.map +1 -0
  22. package/build/cjs/src/atlas-v2-search-result-location.types.d.ts +134 -0
  23. package/build/cjs/src/atlas-v2-search-result-location.types.js +37 -0
  24. package/build/cjs/src/atlas-v2-search-result-location.types.js.map +1 -0
  25. package/build/cjs/src/atlas-v2-search-result-location.universal.d.ts +169 -0
  26. package/build/cjs/src/atlas-v2-search-result-location.universal.js +125 -0
  27. package/build/cjs/src/atlas-v2-search-result-location.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/atlas-v2-search-result-location.context.d.ts +5 -0
  39. package/build/es/src/atlas-v2-search-result-location.context.js +5 -0
  40. package/build/es/src/atlas-v2-search-result-location.context.js.map +1 -0
  41. package/build/es/src/atlas-v2-search-result-location.http.d.ts +3 -0
  42. package/build/es/src/atlas-v2-search-result-location.http.js +140 -0
  43. package/build/es/src/atlas-v2-search-result-location.http.js.map +1 -0
  44. package/build/es/src/atlas-v2-search-result-location.meta.d.ts +13 -0
  45. package/build/es/src/atlas-v2-search-result-location.meta.js +20 -0
  46. package/build/es/src/atlas-v2-search-result-location.meta.js.map +1 -0
  47. package/build/es/src/atlas-v2-search-result-location.public.d.ts +13 -0
  48. package/build/es/src/atlas-v2-search-result-location.public.js +9 -0
  49. package/build/es/src/atlas-v2-search-result-location.public.js.map +1 -0
  50. package/build/es/src/atlas-v2-search-result-location.types.d.ts +134 -0
  51. package/build/es/src/atlas-v2-search-result-location.types.js +34 -0
  52. package/build/es/src/atlas-v2-search-result-location.types.js.map +1 -0
  53. package/build/es/src/atlas-v2-search-result-location.universal.d.ts +169 -0
  54. package/build/es/src/atlas-v2-search-result-location.universal.js +98 -0
  55. package/build/es/src/atlas-v2-search-result-location.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/atlas-v2-search-result-location.context.d.ts +5 -0
  66. package/build/internal/cjs/src/atlas-v2-search-result-location.context.js +11 -0
  67. package/build/internal/cjs/src/atlas-v2-search-result-location.context.js.map +1 -0
  68. package/build/internal/cjs/src/atlas-v2-search-result-location.http.d.ts +3 -0
  69. package/build/internal/cjs/src/atlas-v2-search-result-location.http.js +144 -0
  70. package/build/internal/cjs/src/atlas-v2-search-result-location.http.js.map +1 -0
  71. package/build/internal/cjs/src/atlas-v2-search-result-location.meta.d.ts +13 -0
  72. package/build/internal/cjs/src/atlas-v2-search-result-location.meta.js +47 -0
  73. package/build/internal/cjs/src/atlas-v2-search-result-location.meta.js.map +1 -0
  74. package/build/internal/cjs/src/atlas-v2-search-result-location.public.d.ts +13 -0
  75. package/build/internal/cjs/src/atlas-v2-search-result-location.public.js +16 -0
  76. package/build/internal/cjs/src/atlas-v2-search-result-location.public.js.map +1 -0
  77. package/build/internal/cjs/src/atlas-v2-search-result-location.types.d.ts +134 -0
  78. package/build/internal/cjs/src/atlas-v2-search-result-location.types.js +37 -0
  79. package/build/internal/cjs/src/atlas-v2-search-result-location.types.js.map +1 -0
  80. package/build/internal/cjs/src/atlas-v2-search-result-location.universal.d.ts +169 -0
  81. package/build/internal/cjs/src/atlas-v2-search-result-location.universal.js +125 -0
  82. package/build/internal/cjs/src/atlas-v2-search-result-location.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/atlas-v2-search-result-location.context.d.ts +5 -0
  93. package/build/internal/es/src/atlas-v2-search-result-location.context.js +5 -0
  94. package/build/internal/es/src/atlas-v2-search-result-location.context.js.map +1 -0
  95. package/build/internal/es/src/atlas-v2-search-result-location.http.d.ts +3 -0
  96. package/build/internal/es/src/atlas-v2-search-result-location.http.js +140 -0
  97. package/build/internal/es/src/atlas-v2-search-result-location.http.js.map +1 -0
  98. package/build/internal/es/src/atlas-v2-search-result-location.meta.d.ts +13 -0
  99. package/build/internal/es/src/atlas-v2-search-result-location.meta.js +20 -0
  100. package/build/internal/es/src/atlas-v2-search-result-location.meta.js.map +1 -0
  101. package/build/internal/es/src/atlas-v2-search-result-location.public.d.ts +13 -0
  102. package/build/internal/es/src/atlas-v2-search-result-location.public.js +9 -0
  103. package/build/internal/es/src/atlas-v2-search-result-location.public.js.map +1 -0
  104. package/build/internal/es/src/atlas-v2-search-result-location.types.d.ts +134 -0
  105. package/build/internal/es/src/atlas-v2-search-result-location.types.js +34 -0
  106. package/build/internal/es/src/atlas-v2-search-result-location.types.js.map +1 -0
  107. package/build/internal/es/src/atlas-v2-search-result-location.universal.d.ts +169 -0
  108. package/build/internal/es/src/atlas-v2-search-result-location.universal.js +98 -0
  109. package/build/internal/es/src/atlas-v2-search-result-location.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,134 @@
1
+ export interface SearchResult {
2
+ /** The Address object */
3
+ address?: Address;
4
+ /** stores additional data about the proximity to the specified location */
5
+ proximity?: Proximity;
6
+ }
7
+ /** Physical address */
8
+ export interface Address extends AddressStreetOneOf {
9
+ /** Street name and number. */
10
+ streetAddress?: StreetAddress;
11
+ /** Main address line, usually street and number as free text. */
12
+ addressLine?: string | null;
13
+ /**
14
+ * Country code.
15
+ * @format COUNTRY
16
+ */
17
+ country?: string | null;
18
+ /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
19
+ subdivision?: string | null;
20
+ /** City name. */
21
+ city?: string | null;
22
+ /** Zip/postal code. */
23
+ postalCode?: string | null;
24
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
25
+ addressLine2?: string | null;
26
+ }
27
+ /** @oneof */
28
+ export interface AddressStreetOneOf {
29
+ /** Street name and number. */
30
+ streetAddress?: StreetAddress;
31
+ /** Main address line, usually street and number as free text. */
32
+ addressLine?: string | null;
33
+ }
34
+ export interface StreetAddress {
35
+ /** Street number. */
36
+ number?: string;
37
+ /** Street name. */
38
+ name?: string;
39
+ }
40
+ export interface AddressLocation {
41
+ /** Address latitude. */
42
+ latitude?: number | null;
43
+ /** Address longitude. */
44
+ longitude?: number | null;
45
+ }
46
+ export interface Subdivision {
47
+ /** Short subdivision code. */
48
+ code?: string;
49
+ /** Subdivision full name. */
50
+ name?: string;
51
+ }
52
+ export declare enum SubdivisionType {
53
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
54
+ /** State */
55
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
56
+ /** County */
57
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
58
+ /** City/town */
59
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
60
+ /** Neighborhood/quarter */
61
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
62
+ /** Street/block */
63
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
64
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
65
+ COUNTRY = "COUNTRY"
66
+ }
67
+ export declare enum Proximity {
68
+ UNKNOWN_PROXIMITY = "UNKNOWN_PROXIMITY",
69
+ /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */
70
+ PINPOINT = "PINPOINT",
71
+ /** indicates that the returned result is the geometric center of a result */
72
+ APPROXIMATE = "APPROXIMATE",
73
+ /** indicates that the returned result is around an area */
74
+ GENERAL_AREA = "GENERAL_AREA"
75
+ }
76
+ /** User must provide query or filter by parameters */
77
+ export interface SearchRequest {
78
+ /** Free text */
79
+ query?: string | null;
80
+ /**
81
+ * Deprecate! - Please use 'zipCode' and 'countryCodes' fields
82
+ * @deprecated
83
+ */
84
+ filterBy?: FilterBy[];
85
+ /** Zip code filter the user can add in order to get more accurate results */
86
+ zipCode?: string | null;
87
+ /** Country codes filter the user can add in order to get more accurate results */
88
+ countryCodes?: string[];
89
+ }
90
+ export interface FilterBy {
91
+ /** One of the filter types enum */
92
+ filterType?: FilterType;
93
+ /** Free text like "us" */
94
+ filterValue?: string;
95
+ }
96
+ export declare enum FilterType {
97
+ /** Filter by zip code */
98
+ zip_code = "zip_code",
99
+ /** Filter by 2-letters or 3-letters country code */
100
+ country_code = "country_code"
101
+ }
102
+ export interface SearchResponse {
103
+ /** List of 'Address' objects */
104
+ searchResults?: SearchResult[];
105
+ }
106
+ export interface ReverseGeocodingRequest {
107
+ /** The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address. */
108
+ addressLocation?: AddressLocation;
109
+ }
110
+ export interface ReverseGeocodingResponse {
111
+ searchResults?: SearchResult[];
112
+ }
113
+ interface StreetAddressNonNullableFields {
114
+ number: string;
115
+ name: string;
116
+ apt: string;
117
+ }
118
+ interface SubdivisionNonNullableFields {
119
+ code: string;
120
+ name: string;
121
+ type: SubdivisionType;
122
+ }
123
+ interface AddressNonNullableFields {
124
+ streetAddress?: StreetAddressNonNullableFields;
125
+ subdivisions: SubdivisionNonNullableFields[];
126
+ }
127
+ interface SearchResultNonNullableFields {
128
+ address?: AddressNonNullableFields;
129
+ proximity: Proximity;
130
+ }
131
+ export interface SearchResponseNonNullableFields {
132
+ searchResults: SearchResultNonNullableFields[];
133
+ }
134
+ export {};
@@ -0,0 +1,34 @@
1
+ export var SubdivisionType;
2
+ (function (SubdivisionType) {
3
+ SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
4
+ /** State */
5
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
6
+ /** County */
7
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
8
+ /** City/town */
9
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
10
+ /** Neighborhood/quarter */
11
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
12
+ /** Street/block */
13
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_5"] = "ADMINISTRATIVE_AREA_LEVEL_5";
14
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
15
+ SubdivisionType["COUNTRY"] = "COUNTRY";
16
+ })(SubdivisionType || (SubdivisionType = {}));
17
+ export var Proximity;
18
+ (function (Proximity) {
19
+ Proximity["UNKNOWN_PROXIMITY"] = "UNKNOWN_PROXIMITY";
20
+ /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */
21
+ Proximity["PINPOINT"] = "PINPOINT";
22
+ /** indicates that the returned result is the geometric center of a result */
23
+ Proximity["APPROXIMATE"] = "APPROXIMATE";
24
+ /** indicates that the returned result is around an area */
25
+ Proximity["GENERAL_AREA"] = "GENERAL_AREA";
26
+ })(Proximity || (Proximity = {}));
27
+ export var FilterType;
28
+ (function (FilterType) {
29
+ /** Filter by zip code */
30
+ FilterType["zip_code"] = "zip_code";
31
+ /** Filter by 2-letters or 3-letters country code */
32
+ FilterType["country_code"] = "country_code";
33
+ })(FilterType || (FilterType = {}));
34
+ //# sourceMappingURL=atlas-v2-search-result-location.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"atlas-v2-search-result-location.types.js","sourceRoot":"","sources":["../../../src/atlas-v2-search-result-location.types.ts"],"names":[],"mappings":"AAyDA,MAAM,CAAN,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,KAAf,eAAe,QAc1B;AAED,MAAM,CAAN,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,+IAA+I;IAC/I,kCAAqB,CAAA;IACrB,6EAA6E;IAC7E,wCAA2B,CAAA;IAC3B,2DAA2D;IAC3D,0CAA6B,CAAA;AAC/B,CAAC,EARW,SAAS,KAAT,SAAS,QAQpB;AAwBD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yBAAyB;IACzB,mCAAqB,CAAA;IACrB,oDAAoD;IACpD,2CAA6B,CAAA;AAC/B,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}
@@ -0,0 +1,169 @@
1
+ export interface SearchResult {
2
+ /** The Address object */
3
+ address?: Address;
4
+ /** stores additional data about the proximity to the specified location */
5
+ proximity?: Proximity;
6
+ }
7
+ /** Physical address */
8
+ export interface Address extends AddressStreetOneOf {
9
+ /** Street name and number. */
10
+ streetAddress?: StreetAddress;
11
+ /** Main address line, usually street and number as free text. */
12
+ addressLine1?: string | null;
13
+ /**
14
+ * Country code.
15
+ * @format COUNTRY
16
+ */
17
+ country?: string | null;
18
+ /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
19
+ subdivision?: string | null;
20
+ /** City name. */
21
+ city?: string | null;
22
+ /** Zip/postal code. */
23
+ postalCode?: string | null;
24
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
25
+ addressLine2?: string | null;
26
+ }
27
+ /** @oneof */
28
+ export interface AddressStreetOneOf {
29
+ /** Street name and number. */
30
+ streetAddress?: StreetAddress;
31
+ /** Main address line, usually street and number as free text. */
32
+ addressLine?: string | null;
33
+ }
34
+ export interface StreetAddress {
35
+ /** Street number. */
36
+ number?: string;
37
+ /** Street name. */
38
+ name?: string;
39
+ }
40
+ export interface AddressLocation {
41
+ /** Address latitude. */
42
+ latitude?: number | null;
43
+ /** Address longitude. */
44
+ longitude?: number | null;
45
+ }
46
+ export interface Subdivision {
47
+ /** Short subdivision code. */
48
+ code?: string;
49
+ /** Subdivision full name. */
50
+ name?: string;
51
+ }
52
+ export declare enum SubdivisionType {
53
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
54
+ /** State */
55
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
56
+ /** County */
57
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
58
+ /** City/town */
59
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
60
+ /** Neighborhood/quarter */
61
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
62
+ /** Street/block */
63
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
64
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
65
+ COUNTRY = "COUNTRY"
66
+ }
67
+ export declare enum Proximity {
68
+ UNKNOWN_PROXIMITY = "UNKNOWN_PROXIMITY",
69
+ /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */
70
+ PINPOINT = "PINPOINT",
71
+ /** indicates that the returned result is the geometric center of a result */
72
+ APPROXIMATE = "APPROXIMATE",
73
+ /** indicates that the returned result is around an area */
74
+ GENERAL_AREA = "GENERAL_AREA"
75
+ }
76
+ /** User must provide query or filter by parameters */
77
+ export interface SearchRequest {
78
+ /** Free text */
79
+ query?: string | null;
80
+ /**
81
+ * Deprecate! - Please use 'zipCode' and 'countryCodes' fields
82
+ * @deprecated
83
+ */
84
+ filterBy?: FilterBy[];
85
+ /** Zip code filter the user can add in order to get more accurate results */
86
+ zipCode?: string | null;
87
+ /** Country codes filter the user can add in order to get more accurate results */
88
+ countryCodes?: string[];
89
+ }
90
+ export interface FilterBy {
91
+ /** One of the filter types enum */
92
+ filterType?: FilterType;
93
+ /** Free text like "us" */
94
+ filterValue?: string;
95
+ }
96
+ export declare enum FilterType {
97
+ /** Filter by zip code */
98
+ zip_code = "zip_code",
99
+ /** Filter by 2-letters or 3-letters country code */
100
+ country_code = "country_code"
101
+ }
102
+ export interface SearchResponse {
103
+ /** List of 'Address' objects */
104
+ searchResults?: SearchResult[];
105
+ }
106
+ export interface ReverseGeocodingRequest {
107
+ /** The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address. */
108
+ addressLocation?: AddressLocation;
109
+ }
110
+ export interface ReverseGeocodingResponse {
111
+ searchResults?: SearchResult[];
112
+ }
113
+ interface StreetAddressNonNullableFields {
114
+ number: string;
115
+ name: string;
116
+ apt: string;
117
+ }
118
+ interface SubdivisionNonNullableFields {
119
+ name: string;
120
+ }
121
+ interface AddressNonNullableFields {
122
+ streetAddress?: StreetAddressNonNullableFields;
123
+ subdivisions: SubdivisionNonNullableFields[];
124
+ }
125
+ interface SearchResultNonNullableFields {
126
+ address?: AddressNonNullableFields;
127
+ proximity: Proximity;
128
+ }
129
+ export interface SearchResponseNonNullableFields {
130
+ searchResults: SearchResultNonNullableFields[];
131
+ }
132
+ /**
133
+ * A Search request takes a free text as an input and returns a list of 'Address' objects.
134
+ * @public
135
+ * @documentationMaturity preview
136
+ * @permissionId WIX_ATLAS.SEARCH
137
+ * @permissionScope Manage Bookings Services and Settings
138
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
139
+ * @permissionScope Manage Events
140
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
141
+ * @permissionScope Manage Challenges
142
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
143
+ * @permissionScope Manage Portfolio
144
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
145
+ * @permissionScope Access Verticals by Automations
146
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
147
+ * @permissionScope Manage Restaurants - all permissions
148
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
149
+ * @permissionScope Set Up Automations
150
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
151
+ * @applicableIdentity APP
152
+ * @applicableIdentity VISITOR
153
+ * @fqn com.wixpress.vi.atlas.service.v2.LocationServiceV2.Search
154
+ */
155
+ export declare function search(options?: SearchOptions): Promise<SearchResponse & SearchResponseNonNullableFields>;
156
+ export interface SearchOptions {
157
+ /** Free text */
158
+ query?: string | null;
159
+ /**
160
+ * Deprecate! - Please use 'zipCode' and 'countryCodes' fields
161
+ * @deprecated
162
+ */
163
+ filterBy?: FilterBy[];
164
+ /** Zip code filter the user can add in order to get more accurate results */
165
+ zipCode?: string | null;
166
+ /** Country codes filter the user can add in order to get more accurate results */
167
+ countryCodes?: string[];
168
+ }
169
+ export {};
@@ -0,0 +1,98 @@
1
+ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
+ import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
3
+ import * as ambassadorWixAtlasV2SearchResult from './atlas-v2-search-result-location.http.js';
4
+ import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
5
+ import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
6
+ export var SubdivisionType;
7
+ (function (SubdivisionType) {
8
+ SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
9
+ /** State */
10
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
11
+ /** County */
12
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
13
+ /** City/town */
14
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
15
+ /** Neighborhood/quarter */
16
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
17
+ /** Street/block */
18
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_5"] = "ADMINISTRATIVE_AREA_LEVEL_5";
19
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
20
+ SubdivisionType["COUNTRY"] = "COUNTRY";
21
+ })(SubdivisionType || (SubdivisionType = {}));
22
+ export var Proximity;
23
+ (function (Proximity) {
24
+ Proximity["UNKNOWN_PROXIMITY"] = "UNKNOWN_PROXIMITY";
25
+ /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */
26
+ Proximity["PINPOINT"] = "PINPOINT";
27
+ /** indicates that the returned result is the geometric center of a result */
28
+ Proximity["APPROXIMATE"] = "APPROXIMATE";
29
+ /** indicates that the returned result is around an area */
30
+ Proximity["GENERAL_AREA"] = "GENERAL_AREA";
31
+ })(Proximity || (Proximity = {}));
32
+ export var FilterType;
33
+ (function (FilterType) {
34
+ /** Filter by zip code */
35
+ FilterType["zip_code"] = "zip_code";
36
+ /** Filter by 2-letters or 3-letters country code */
37
+ FilterType["country_code"] = "country_code";
38
+ })(FilterType || (FilterType = {}));
39
+ /**
40
+ * A Search request takes a free text as an input and returns a list of 'Address' objects.
41
+ * @public
42
+ * @documentationMaturity preview
43
+ * @permissionId WIX_ATLAS.SEARCH
44
+ * @permissionScope Manage Bookings Services and Settings
45
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
46
+ * @permissionScope Manage Events
47
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
48
+ * @permissionScope Manage Challenges
49
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
50
+ * @permissionScope Manage Portfolio
51
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
52
+ * @permissionScope Access Verticals by Automations
53
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
54
+ * @permissionScope Manage Restaurants - all permissions
55
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
56
+ * @permissionScope Set Up Automations
57
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
58
+ * @applicableIdentity APP
59
+ * @applicableIdentity VISITOR
60
+ * @fqn com.wixpress.vi.atlas.service.v2.LocationServiceV2.Search
61
+ */
62
+ export async function search(options) {
63
+ // @ts-ignore
64
+ const { httpClient, sideEffects } = arguments[1];
65
+ const payload = renameKeysFromSDKRequestToRESTRequest({
66
+ query: options?.query,
67
+ filterBy: options?.filterBy,
68
+ zipCode: options?.zipCode,
69
+ countryCodes: options?.countryCodes,
70
+ });
71
+ const reqOpts = ambassadorWixAtlasV2SearchResult.search(payload);
72
+ sideEffects?.onSiteCall?.();
73
+ try {
74
+ const result = await httpClient.request(reqOpts);
75
+ sideEffects?.onSuccess?.(result);
76
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
77
+ {
78
+ transformFn: transformRESTAddressToSDKAddress,
79
+ paths: [{ path: 'searchResults.address' }],
80
+ },
81
+ ]));
82
+ }
83
+ catch (err) {
84
+ const transformedError = sdkTransformError(err, {
85
+ spreadPathsToArguments: {},
86
+ explicitPathsToArguments: {
87
+ query: '$[0].query',
88
+ filterBy: '$[0].filterBy',
89
+ zipCode: '$[0].zipCode',
90
+ countryCodes: '$[0].countryCodes',
91
+ },
92
+ singleArgumentUnchanged: false,
93
+ }, ['options']);
94
+ sideEffects?.onError?.(err);
95
+ throw transformedError;
96
+ }
97
+ }
98
+ //# sourceMappingURL=atlas-v2-search-result-location.universal.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"atlas-v2-search-result-location.universal.js","sourceRoot":"","sources":["../../../src/atlas-v2-search-result-location.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,gCAAgC,MAAM,2CAA2C,CAAC;AAC9F,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AA2DlF,MAAM,CAAN,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,KAAf,eAAe,QAc1B;AAED,MAAM,CAAN,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,+IAA+I;IAC/I,kCAAqB,CAAA;IACrB,6EAA6E;IAC7E,wCAA2B,CAAA;IAC3B,2DAA2D;IAC3D,0CAA6B,CAAA;AAC/B,CAAC,EARW,SAAS,KAAT,SAAS,QAQpB;AAwBD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yBAAyB;IACzB,mCAAqB,CAAA;IACrB,oDAAoD;IACpD,2CAA6B,CAAA;AAC/B,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAwCD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,OAAuB;IAEvB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,OAAO,EAAE,OAAO,EAAE,OAAO;QACzB,YAAY,EAAE,OAAO,EAAE,YAAY;KACpC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,gCAAgC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEjE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,gCAAgC;gBAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;aAC3C;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,eAAe;gBACzB,OAAO,EAAE,cAAc;gBACvB,YAAY,EAAE,mBAAmB;aAClC;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
@@ -0,0 +1 @@
1
+ export * from './src/atlas-v2-search-result-location.context.js';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./src/atlas-v2-search-result-location.context.js"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mFAAiE"}
@@ -0,0 +1 @@
1
+ export * from './src/atlas-v2-search-result-location.universal.js';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./src/atlas-v2-search-result-location.universal.js"), exports);
18
+ //# sourceMappingURL=index.typings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../../index.typings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qFAAmE"}
@@ -0,0 +1 @@
1
+ export * from './src/atlas-v2-search-result-location.meta.js';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./src/atlas-v2-search-result-location.meta.js"), exports);
18
+ //# sourceMappingURL=meta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gFAA8D"}
@@ -0,0 +1,5 @@
1
+ import { search as publicSearch } from './atlas-v2-search-result-location.public.js';
2
+ import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
3
+ export declare const search: MaybeContext<BuildRESTFunction<typeof publicSearch> & typeof publicSearch>;
4
+ export { SubdivisionType, Proximity, FilterType, } from './atlas-v2-search-result-location.universal.js';
5
+ export { SearchResult, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, SearchRequest, FilterBy, SearchResponse, ReverseGeocodingRequest, ReverseGeocodingResponse, SearchResponseNonNullableFields, SearchOptions, } from './atlas-v2-search-result-location.universal.js';
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FilterType = exports.Proximity = exports.SubdivisionType = exports.search = void 0;
4
+ const atlas_v2_search_result_location_public_js_1 = require("./atlas-v2-search-result-location.public.js");
5
+ const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
6
+ exports.search = (0, rest_modules_1.createRESTModule)(atlas_v2_search_result_location_public_js_1.search);
7
+ var atlas_v2_search_result_location_universal_js_1 = require("./atlas-v2-search-result-location.universal.js");
8
+ Object.defineProperty(exports, "SubdivisionType", { enumerable: true, get: function () { return atlas_v2_search_result_location_universal_js_1.SubdivisionType; } });
9
+ Object.defineProperty(exports, "Proximity", { enumerable: true, get: function () { return atlas_v2_search_result_location_universal_js_1.Proximity; } });
10
+ Object.defineProperty(exports, "FilterType", { enumerable: true, get: function () { return atlas_v2_search_result_location_universal_js_1.FilterType; } });
11
+ //# sourceMappingURL=atlas-v2-search-result-location.context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"atlas-v2-search-result-location.context.js","sourceRoot":"","sources":["../../../../src/atlas-v2-search-result-location.context.ts"],"names":[],"mappings":";;;AAAA,2GAAqF;AACrF,gEAAiE;AAGpD,QAAA,MAAM,GAED,IAAA,+BAAgB,EAAC,kDAAY,CAAC,CAAC;AAEjD,+GAIwD;AAHtD,+IAAA,eAAe,OAAA;AACf,yIAAA,SAAS,OAAA;AACT,0IAAA,UAAU,OAAA"}
@@ -0,0 +1,3 @@
1
+ import { RequestOptionsFactory } from '@wix/sdk-types';
2
+ /** A Search request takes a free text as an input and returns a list of 'Address' objects. */
3
+ export declare function search(payload: object): RequestOptionsFactory<any>;