Skip to content

Commit

Permalink
Automated update to repo's documentation from github action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 6, 2022
1 parent dfae40a commit 0d4fecf
Show file tree
Hide file tree
Showing 24 changed files with 335 additions and 3 deletions.
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [DayHour](./search-core.dayhour.md) &gt; [isClosed](./search-core.dayhour.isclosed.md)

## DayHour.isClosed property

<b>Signature:</b>

```typescript
isClosed?: boolean;
```
21 changes: 21 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [DayHour](./search-core.dayhour.md)

## DayHour interface

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

<b>Signature:</b>

```typescript
export interface DayHour
```

## Properties

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

11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [DayHour](./search-core.dayhour.md) &gt; [openIntervals](./search-core.dayhour.openintervals.md)

## DayHour.openIntervals property

<b>Signature:</b>

```typescript
openIntervals?: Interval[];
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [HolidayHours](./search-core.holidayhours.md) &gt; [date](./search-core.holidayhours.date.md)

## HolidayHours.date property

<b>Signature:</b>

```typescript
date: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [HolidayHours](./search-core.holidayhours.md) &gt; [isClosed](./search-core.holidayhours.isclosed.md)

## HolidayHours.isClosed property

<b>Signature:</b>

```typescript
isClosed?: boolean;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [HolidayHours](./search-core.holidayhours.md) &gt; [isRegularHours](./search-core.holidayhours.isregularhours.md)

## HolidayHours.isRegularHours property

<b>Signature:</b>

```typescript
isRegularHours?: boolean;
```
23 changes: 23 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [HolidayHours](./search-core.holidayhours.md)

## HolidayHours interface

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

<b>Signature:</b>

```typescript
export interface HolidayHours
```

## Properties

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

11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [HolidayHours](./search-core.holidayhours.md) &gt; [openIntervals](./search-core.holidayhours.openintervals.md)

## HolidayHours.openIntervals property

<b>Signature:</b>

```typescript
openIntervals?: Interval[];
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [friday](./search-core.hours.friday.md)

## Hours.friday property

<b>Signature:</b>

```typescript
friday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [holidayHours](./search-core.hours.holidayhours.md)

## Hours.holidayHours property

<b>Signature:</b>

```typescript
holidayHours?: HolidayHours[];
```
28 changes: 28 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md)

## Hours interface

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

<b>Signature:</b>

```typescript
export interface Hours
```

## Properties

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

11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [monday](./search-core.hours.monday.md)

## Hours.monday property

<b>Signature:</b>

```typescript
monday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [reopenDate](./search-core.hours.reopendate.md)

## Hours.reopenDate property

<b>Signature:</b>

```typescript
reopenDate?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [saturday](./search-core.hours.saturday.md)

## Hours.saturday property

<b>Signature:</b>

```typescript
saturday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [sunday](./search-core.hours.sunday.md)

## Hours.sunday property

<b>Signature:</b>

```typescript
sunday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [thursday](./search-core.hours.thursday.md)

## Hours.thursday property

<b>Signature:</b>

```typescript
thursday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [tuesday](./search-core.hours.tuesday.md)

## Hours.tuesday property

<b>Signature:</b>

```typescript
tuesday?: DayHour;
```
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Hours](./search-core.hours.md) &gt; [wednesday](./search-core.hours.wednesday.md)

## Hours.wednesday property

<b>Signature:</b>

```typescript
wednesday?: DayHour;
```
2 changes: 1 addition & 1 deletion docs/search-core.hoursdirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) inte
```typescript
export interface HoursDirectAnswer extends BaseFieldValueDirectAnswer<Hours | Hours[]>
```
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;Hours \| Hours\[\]&gt;
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;[Hours](./search-core.hours.md) \| [Hours](./search-core.hours.md)<!-- -->\[\]&gt;
## Properties
Expand Down
11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Interval](./search-core.interval.md) &gt; [end](./search-core.interval.end.md)

## Interval.end property

<b>Signature:</b>

```typescript
end?: string;
```
21 changes: 21 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Interval](./search-core.interval.md)

## Interval interface

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

<b>Signature:</b>

```typescript
export interface Interval
```

## Properties

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

11 changes: 11 additions & 0 deletions docs/search-core.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-core](./search-core.md) &gt; [Interval](./search-core.interval.md) &gt; [start](./search-core.interval.start.md)

## Interval.start property

<b>Signature:</b>

```typescript
start?: string;
```
4 changes: 4 additions & 0 deletions docs/search-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
| [ComplexURL](./search-core.complexurl.md) | The shape of a [BuiltInFieldType.ComplexURL](./search-core.builtinfieldtype.md) DirectAnswer value |
| [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md) | A direct answer for a complex url field. |
| [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) | A static filter composed by combining other static filters with the logical AND operator. |
| [DayHour](./search-core.dayhour.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [DecimalDirectAnswer](./search-core.decimaldirectanswer.md) | A direct answer for a decimal field, which is a number represented using a string. |
| [DirectAnswer](./search-core.directanswer.md) | A direct answer to a search. |
| [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) | A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. |
Expand All @@ -71,9 +72,12 @@
| [FilterSearchRequest](./search-core.filtersearchrequest.md) | Options for a filtersearch request. |
| [FilterSearchResponse](./search-core.filtersearchresponse.md) | The response of a filtersearch request. |
| [HighlightedValue](./search-core.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. |
| [HolidayHours](./search-core.holidayhours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [Hours](./search-core.hours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [HoursDirectAnswer](./search-core.hoursdirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'hours' field type. |
| [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md) | A direct answer for an instagram handle field. |
| [IntegerDirectAnswer](./search-core.integerdirectanswer.md) | A direct answer for an integer field. |
| [Interval](./search-core.interval.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
| [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md) | A direct answer for an iOS app url field. |
| [LatLong](./search-core.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. |
| [LocationBias](./search-core.locationbias.md) | Information about the user's location. |
Expand Down
Loading

0 comments on commit 0d4fecf

Please sign in to comment.