Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

re-export HoursDirectAnswer interfaces #136

Merged
merged 2 commits into from
Sep 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ SOFTWARE.

The following NPM package may be included in this product:

- @yext/[email protected]beta.219
- @yext/[email protected]alpha.221

This package contains the following license and notice below:

Expand Down
1 change: 1 addition & 0 deletions docs/search-headless.builtinfieldtype.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export declare enum BuiltInFieldType
| Decimal | <code>&quot;decimal&quot;</code> | |
| Email | <code>&quot;email&quot;</code> | |
| FacebookURL | <code>&quot;facebook_url&quot;</code> | |
| Hours | <code>&quot;hours&quot;</code> | |
| InstagramHandle | <code>&quot;instagram_handle&quot;</code> | |
| Integer | <code>&quot;integer&quot;</code> | |
| IOSAppURL | <code>&quot;ios_app_url&quot;</code> | |
Expand Down
11 changes: 11 additions & 0 deletions docs/search-headless.dayhour.isclosed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [DayHour](./search-headless.dayhour.md) &gt; [isClosed](./search-headless.dayhour.isclosed.md)

## DayHour.isClosed property

<b>Signature:</b>

```typescript
isClosed?: boolean;
```
21 changes: 21 additions & 0 deletions docs/search-headless.dayhour.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [DayHour](./search-headless.dayhour.md)

## DayHour interface

An interface for a day's hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->.

<b>Signature:</b>

```typescript
export declare interface DayHour
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [isClosed?](./search-headless.dayhour.isclosed.md) | boolean | <i>(Optional)</i> |
| [openIntervals?](./search-headless.dayhour.openintervals.md) | [Interval](./search-headless.interval.md)<!-- -->\[\] | <i>(Optional)</i> |

11 changes: 11 additions & 0 deletions docs/search-headless.dayhour.openintervals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [DayHour](./search-headless.dayhour.md) &gt; [openIntervals](./search-headless.dayhour.openintervals.md)

## DayHour.openIntervals property

<b>Signature:</b>

```typescript
openIntervals?: Interval[];
```
4 changes: 2 additions & 2 deletions docs/search-headless.fieldvaluedirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Possible built-in and custom [BaseFieldValueDirectAnswer](./search-headless.base
<b>Signature:</b>

```typescript
export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer;
export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer | HoursDirectAnswer;
```
<b>References:</b> [UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-headless.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-headless.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-headless.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-headless.integerdirectanswer.md)<!-- -->, [PhoneDirectAnswer](./search-headless.phonedirectanswer.md)<!-- -->, [EmailDirectAnswer](./search-headless.emaildirectanswer.md)<!-- -->, [AddressDirectAnswer](./search-headless.addressdirectanswer.md)
<b>References:</b> [UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-headless.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-headless.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-headless.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-headless.integerdirectanswer.md)<!-- -->, [PhoneDirectAnswer](./search-headless.phonedirectanswer.md)<!-- -->, [EmailDirectAnswer](./search-headless.emaildirectanswer.md)<!-- -->, [AddressDirectAnswer](./search-headless.addressdirectanswer.md)<!-- -->, [HoursDirectAnswer](./search-headless.hoursdirectanswer.md)

11 changes: 11 additions & 0 deletions docs/search-headless.holidayhours.date.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [HolidayHours](./search-headless.holidayhours.md) &gt; [date](./search-headless.holidayhours.date.md)

## HolidayHours.date property

<b>Signature:</b>

```typescript
date: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.holidayhours.isclosed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [HolidayHours](./search-headless.holidayhours.md) &gt; [isClosed](./search-headless.holidayhours.isclosed.md)

## HolidayHours.isClosed property

<b>Signature:</b>

```typescript
isClosed?: boolean;
```
11 changes: 11 additions & 0 deletions docs/search-headless.holidayhours.isregularhours.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [HolidayHours](./search-headless.holidayhours.md) &gt; [isRegularHours](./search-headless.holidayhours.isregularhours.md)

## HolidayHours.isRegularHours property

<b>Signature:</b>

```typescript
isRegularHours?: boolean;
```
23 changes: 23 additions & 0 deletions docs/search-headless.holidayhours.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [HolidayHours](./search-headless.holidayhours.md)

## HolidayHours interface

An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->.

<b>Signature:</b>

```typescript
export declare interface HolidayHours
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [date](./search-headless.holidayhours.date.md) | string | |
| [isClosed?](./search-headless.holidayhours.isclosed.md) | boolean | <i>(Optional)</i> |
| [isRegularHours?](./search-headless.holidayhours.isregularhours.md) | boolean | <i>(Optional)</i> |
| [openIntervals?](./search-headless.holidayhours.openintervals.md) | [Interval](./search-headless.interval.md)<!-- -->\[\] | <i>(Optional)</i> |

11 changes: 11 additions & 0 deletions docs/search-headless.holidayhours.openintervals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [HolidayHours](./search-headless.holidayhours.md) &gt; [openIntervals](./search-headless.holidayhours.openintervals.md)

## HolidayHours.openIntervals property

<b>Signature:</b>

```typescript
openIntervals?: Interval[];
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.friday.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [friday](./search-headless.hours.friday.md)

## Hours.friday property

<b>Signature:</b>

```typescript
friday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.holidayhours.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [holidayHours](./search-headless.hours.holidayhours.md)

## Hours.holidayHours property

<b>Signature:</b>

```typescript
holidayHours?: HolidayHours[];
```
28 changes: 28 additions & 0 deletions docs/search-headless.hours.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md)

## Hours interface

An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->.

<b>Signature:</b>

```typescript
export declare interface Hours
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [friday?](./search-headless.hours.friday.md) | [DayHour](./search-headless.dayhour.md) | <i>(Optional)</i> |
| [holidayHours?](./search-headless.hours.holidayhours.md) | [HolidayHours](./search-headless.holidayhours.md)<!-- -->\[\] | <i>(Optional)</i> |
| [monday?](./search-headless.hours.monday.md) | [DayHour](./search-headless.dayhour.md) | <i>(Optional)</i> |
| [reopenDate?](./search-headless.hours.reopendate.md) | string | <i>(Optional)</i> |
| [saturday?](./search-headless.hours.saturday.md) | [DayHour](./search-headless.dayhour.md) | <i>(Optional)</i> |
| [sunday?](./search-headless.hours.sunday.md) | [DayHour](./search-headless.dayhour.md) | <i>(Optional)</i> |
| [thursday?](./search-headless.hours.thursday.md) | [DayHour](./search-headless.dayhour.md) | <i>(Optional)</i> |
| [tuesday?](./search-headless.hours.tuesday.md) | [DayHour](./search-headless.dayhour.md) | <i>(Optional)</i> |
| [wednesday?](./search-headless.hours.wednesday.md) | [DayHour](./search-headless.dayhour.md) | <i>(Optional)</i> |

11 changes: 11 additions & 0 deletions docs/search-headless.hours.monday.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [monday](./search-headless.hours.monday.md)

## Hours.monday property

<b>Signature:</b>

```typescript
monday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.reopendate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [reopenDate](./search-headless.hours.reopendate.md)

## Hours.reopenDate property

<b>Signature:</b>

```typescript
reopenDate?: string;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.saturday.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [saturday](./search-headless.hours.saturday.md)

## Hours.saturday property

<b>Signature:</b>

```typescript
saturday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.sunday.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [sunday](./search-headless.hours.sunday.md)

## Hours.sunday property

<b>Signature:</b>

```typescript
sunday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.thursday.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [thursday](./search-headless.hours.thursday.md)

## Hours.thursday property

<b>Signature:</b>

```typescript
thursday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.tuesday.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [tuesday](./search-headless.hours.tuesday.md)

## Hours.tuesday property

<b>Signature:</b>

```typescript
tuesday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hours.wednesday.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Hours](./search-headless.hours.md) &gt; [wednesday](./search-headless.hours.wednesday.md)

## Hours.wednesday property

<b>Signature:</b>

```typescript
wednesday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-headless.hoursdirectanswer.fieldtype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [HoursDirectAnswer](./search-headless.hoursdirectanswer.md) &gt; [fieldType](./search-headless.hoursdirectanswer.fieldtype.md)

## HoursDirectAnswer.fieldType property

<b>Signature:</b>

```typescript
fieldType: EnumOrLiteral<BuiltInFieldType.Hours>;
```
21 changes: 21 additions & 0 deletions docs/search-headless.hoursdirectanswer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [HoursDirectAnswer](./search-headless.hoursdirectanswer.md)

## HoursDirectAnswer interface

A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'hours' field type.

<b>Signature:</b>

```typescript
export declare interface HoursDirectAnswer extends BaseFieldValueDirectAnswer<Hours | Hours[]>
```
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- -->&lt;[Hours](./search-headless.hours.md) \| [Hours](./search-headless.hours.md)<!-- -->\[\]&gt;

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-headless.hoursdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.Hours](./search-headless.builtinfieldtype.md)<!-- -->&gt; | |

11 changes: 11 additions & 0 deletions docs/search-headless.interval.end.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Interval](./search-headless.interval.md) &gt; [end](./search-headless.interval.end.md)

## Interval.end property

<b>Signature:</b>

```typescript
end?: string;
```
21 changes: 21 additions & 0 deletions docs/search-headless.interval.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Interval](./search-headless.interval.md)

## Interval interface

An interface for a time interval to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->.

<b>Signature:</b>

```typescript
export declare interface Interval
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [end?](./search-headless.interval.end.md) | string | <i>(Optional)</i> |
| [start?](./search-headless.interval.start.md) | string | <i>(Optional)</i> |

11 changes: 11 additions & 0 deletions docs/search-headless.interval.start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [Interval](./search-headless.interval.md) &gt; [start](./search-headless.interval.start.md)

## Interval.start property

<b>Signature:</b>

```typescript
start?: string;
```
5 changes: 5 additions & 0 deletions docs/search-headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
| [ComplexURL](./search-headless.complexurl.md) | The shape of a [BuiltInFieldType.ComplexURL](./search-headless.builtinfieldtype.md) DirectAnswer value |
| [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) | A direct answer for a complex url field. |
| [ConjunctionStaticFilter](./search-headless.conjunctionstaticfilter.md) | A static filter composed by combining other static filters with the logical AND operator. |
| [DayHour](./search-headless.dayhour.md) | An interface for a day's hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) | A direct answer for a decimal field, which is a number represented using a string. |
| [DirectAnswer](./search-headless.directanswer.md) | A direct answer to a search. |
| [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. |
Expand All @@ -82,8 +83,12 @@
| [FilterSearchResponse](./search-headless.filtersearchresponse.md) | The response of a filtersearch request. |
| [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. |
| [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. |
| [HolidayHours](./search-headless.holidayhours.md) | An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [Hours](./search-headless.hours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [HoursDirectAnswer](./search-headless.hoursdirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'hours' field type. |
| [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md) | A direct answer for an instagram handle field. |
| [IntegerDirectAnswer](./search-headless.integerdirectanswer.md) | A direct answer for an integer field. |
| [Interval](./search-headless.interval.md) | An interface for a time interval to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md) | A direct answer for an iOS app url field. |
| [LatLong](./search-headless.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. |
| [LocationBias](./search-headless.locationbias.md) | Information about the user's location. |
Expand Down
Loading