happyco_json 2.0.0

data/docs/V1CreateAccountsResponse.md

@@ -0,0 +1,8 @@
+# HappyCo::V1CreateAccountsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id_with_admin_ids** | [**Array<CreateAccountsResponseAccountIDWithAdminID>**](CreateAccountsResponseAccountIDWithAdminID.md) |  | [optional] 
+
+

data/docs/V1CreateAssetsRequest.md

@@ -0,0 +1,10 @@
+# HappyCo::V1CreateAssetsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**folder_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**assets** | [**Array<V1Asset>**](V1Asset.md) |  | [optional] 
+
+

data/docs/V1CreateAssetsResponse.md

@@ -0,0 +1,8 @@
+# HappyCo::V1CreateAssetsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**asset_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+
+

data/docs/V1CreateDelegatedInspectionLinkRequest.md

@@ -0,0 +1,12 @@
+# HappyCo::V1CreateDelegatedInspectionLinkRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**inspection_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**expiry** | [**V1DateTime**](V1DateTime.md) |  | [optional] 
+
+

data/docs/V1CreateDelegatedInspectionLinkResponse.md

@@ -0,0 +1,9 @@
+# HappyCo::V1CreateDelegatedInspectionLinkResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link** | **String** |  | [optional] 
+**error** | **String** |  | [optional] 
+
+

data/docs/V1CreateDelegatedInspectionLinksRequest.md

@@ -0,0 +1,13 @@
+# HappyCo::V1CreateDelegatedInspectionLinksRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**requests** | [**Array<V1CreateDelegatedInspectionLinkRequest>**](V1CreateDelegatedInspectionLinkRequest.md) |  | [optional] 
+**send_email** | **BOOLEAN** |  | [optional] 
+**email_subject_template** | **String** |  | [optional] 
+**email_template_html** | **String** |  | [optional] 
+**email_template_text** | **String** |  | [optional] 
+
+

data/docs/V1CreateDelegatedInspectionLinksResponse.md

@@ -0,0 +1,8 @@
+# HappyCo::V1CreateDelegatedInspectionLinksResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**responses** | [**Array<V1CreateDelegatedInspectionLinkResponse>**](V1CreateDelegatedInspectionLinkResponse.md) |  | [optional] 
+
+

data/docs/V1CreateFoldersRequest.md

@@ -0,0 +1,9 @@
+# HappyCo::V1CreateFoldersRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**folders** | [**Array<V1Folder>**](V1Folder.md) |  | [optional] 
+
+

data/docs/V1CreateFoldersResponse.md

@@ -0,0 +1,8 @@
+# HappyCo::V1CreateFoldersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folder_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+
+

data/docs/V1CreateInspectionsRequest.md

@@ -0,0 +1,9 @@
+# HappyCo::V1CreateInspectionsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) | * Account ID that the request applies to. For custom integrations (i.e. not integration partners) it can be omitted. | [optional] 
+**inspections** | [**Array<V1Inspection>**](V1Inspection.md) | * Inspections to be created. | [optional] 
+
+

data/docs/V1CreateInspectionsResponse.md

@@ -0,0 +1,8 @@
+# HappyCo::V1CreateInspectionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inspection_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+
+

data/docs/V1CreateTemplatesRequest.md

@@ -0,0 +1,10 @@
+# HappyCo::V1CreateTemplatesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**folder_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**templates** | [**Array<V1Template>**](V1Template.md) |  | [optional] 
+
+

data/docs/V1CreateTemplatesResponse.md

@@ -0,0 +1,8 @@
+# HappyCo::V1CreateTemplatesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+
+

data/docs/V1DateTime.md

@@ -0,0 +1,13 @@
+# HappyCo::V1DateTime
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**year** | **Integer** |  | [optional] 
+**month** | **Integer** |  | [optional] 
+**day** | **Integer** |  | [optional] 
+**hour24** | **Integer** |  | [optional] 
+**minute** | **Integer** |  | [optional] 
+**second** | **Integer** |  | [optional] 
+
+

data/docs/V1Event.md

@@ -0,0 +1,8 @@
+# HappyCo::V1Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+
+

data/docs/V1EventAck.md

@@ -0,0 +1,10 @@
+# HappyCo::V1EventAck
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_ids** | **Array<Integer>** |  | [optional] 
+**ack** | **BOOLEAN** |  | [optional] 
+**extend_timeout_seconds** | **Integer** |  | [optional] 
+
+

data/docs/V1EventHandlerOptions.md

@@ -0,0 +1,8 @@
+# HappyCo::V1EventHandlerOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ack_timeout_seconds** | **Integer** |  | [optional] 
+
+

data/docs/V1FloatArray.md

@@ -0,0 +1,8 @@
+# HappyCo::V1FloatArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**values** | **Array<Float>** |  | [optional] 
+
+

data/docs/V1Folder.md

@@ -0,0 +1,11 @@
+# HappyCo::V1Folder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**inactive** | **BOOLEAN** |  | [optional] 
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] [default to "MULTI_FAMILY"]
+
+

data/docs/V1FolderType.md

@@ -0,0 +1,7 @@
+# HappyCo::V1FolderType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/V1FooterField.md

@@ -0,0 +1,10 @@
+# HappyCo::V1FooterField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | * Label is required and is shown on both the inspection and reports. Example values include: File #, Key Number, etc. | [optional] 
+**type** | **String** | * Type is required an must be set to 'text'. | [optional] 
+**value** | **String** | * Value is optional and is shown on both the inspection and reports. It can be changed during the inspection. | [optional] 
+
+

data/docs/V1HeaderField.md

@@ -0,0 +1,10 @@
+# HappyCo::V1HeaderField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | * Label is required and is shown on both the inspection and reports. Example values include: File #, Key Number, etc. | [optional] 
+**type** | **String** | * Type is required an must be set to 'text'. | [optional] 
+**value** | **String** | Value is optional and is shown on both the inspection and reports. It can be changed during the inspection. | [optional] 
+
+

data/docs/V1Inspection.md

@@ -0,0 +1,16 @@
+# HappyCo::V1Inspection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**V1IntegrationID**](V1IntegrationID.md) | * ID of inspection. | [optional] 
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) | * Account ID that the inspection belongs to. | [optional] 
+**folder_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**asset_id** | [**V1IntegrationID**](V1IntegrationID.md) | * Asset is the parent that inspection is attached to. This field must reference a non archived asset in the same folder as the template referenced below. | [optional] 
+**template_id** | [**V1IntegrationID**](V1IntegrationID.md) | * Template is the prototype of an inspection thats allow it to be configured on the fly. This field must reference a non archived template in the same folder as the parent asset referenced above. | [optional] 
+**template_outline** | **String** | * Template outline when set on a scheduled inspection forces a different outline prototype to be used when the inspection moves from scheduled to in_progress. | [optional] 
+**scheduled** | [**V1ScheduledInspection**](V1ScheduledInspection.md) |  | [optional] 
+**in_progress** | [**V1InspectionData**](V1InspectionData.md) |  | [optional] 
+**completed** | [**V1InspectionData**](V1InspectionData.md) |  | [optional] 
+
+

data/docs/V1InspectionData.md

@@ -0,0 +1,15 @@
+# HappyCo::V1InspectionData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**started_at** | [**V1DateTime**](V1DateTime.md) | * Started at is a non optional field that is set to the actual time that an inspection transitions from scheduled to in_progress. This time comes from the device where the transition occurs on as the user may be offline. | [optional] 
+**ended_at** | [**V1DateTime**](V1DateTime.md) | * Ended at is an optional field for in_progress inspections but required for completed inspections. It is set to the actual time that an inspection transtions from in_progress to complete. This time comes from the device where the transition occurs as the suer may be offline. | [optional] 
+**user_started_at** | [**V1DateTime**](V1DateTime.md) | * User started at is an optional field that can appear on reports. This can be updated by the user to a specific time. When an inspection transitions from scheduled to in_progress the schedule_date becomes this field. | [optional] 
+**user_ended_at** | [**V1DateTime**](V1DateTime.md) | * User ended at is an optional field that can appear on reports. This can be updated by the user to a specific time. | [optional] 
+**header_fields** | [**Array<V1HeaderField>**](V1HeaderField.md) | * HeaderFields are shown on the top of an inspection and reports generated from it. | [optional] 
+**sections** | [**Array<V1Section>**](V1Section.md) | * Sections and their items hold most of the inspection data; selected ratings, notes, and photos. | [optional] 
+**footer_fields** | [**Array<V1FooterField>**](V1FooterField.md) | * FooterFields are shown at the end of an inspection and reports generated from it. | [optional] 
+**rating_groups** | [**Hash<String, V1RatingGroups>**](V1RatingGroups.md) | * Rating groups is a map of unique keys within an inspection to rating groups. Each item within this inspection must reference a rating group with a key in this map. | [optional] 
+
+

data/docs/V1InspectionStatusChangesEvent.md

@@ -0,0 +1,9 @@
+# HappyCo::V1InspectionStatusChangesEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | [**V1Event**](V1Event.md) |  | [optional] 
+**changes** | [**Array<InspectionStatusChangesEventInspectionStatusChange>**](InspectionStatusChangesEventInspectionStatusChange.md) |  | [optional] 
+
+

data/docs/V1InspectionStatusChangesEventAck.md

@@ -0,0 +1,8 @@
+# HappyCo::V1InspectionStatusChangesEventAck
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ack** | [**V1EventAck**](V1EventAck.md) | * See EventAck for more details. | [optional] 
+
+

data/docs/V1InspectionStatusChangesEventAckResponse.md

@@ -0,0 +1,7 @@
+# HappyCo::V1InspectionStatusChangesEventAckResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/V1InspectionStatusChangesEventRequest.md

@@ -0,0 +1,9 @@
+# HappyCo::V1InspectionStatusChangesEventRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) | * Account ID that the request applies to. For custom integrations (i.e. not integration partners) it can be omitted. | [optional] 
+**options** | [**V1EventHandlerOptions**](V1EventHandlerOptions.md) | * Options the client can set to configure the returned event stream. See EventHandlerOptions for more details. | [optional] 
+
+

data/docs/V1IntegrationID.md

@@ -0,0 +1,10 @@
+# HappyCo::V1IntegrationID
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**sync_token** | **Integer** |  | [optional] 
+
+

data/docs/V1Item.md

@@ -0,0 +1,14 @@
+# HappyCo::V1Item
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | * Name is an optional field but should be set to something that makes sense in context of the parent section. For example; 'Kitchen': 'Sink', 'Floor 1': 'Water Heater'. | [optional] 
+**notes** | **String** | * Notes is an optional field where inspectors can type custom notes (optionally using SnapText) that pertain to this item. | [optional] 
+**info** | **String** | * Info is an optional field that can be used to provide helpful information to the inspector. It is not shown on the report and is primarily used to help training. | [optional] 
+**photos** | [**Array<V1Photo>**](V1Photo.md) | * Photos data can be added with the AddInspectionPhotos api. | [optional] 
+**rating_group_key** | **String** | * Rating group key is a string that can be used to access a rating group from the parent inspection. A rating group must exist for this key within the inspection for the value to be valid. | [optional] 
+**values** | [**Hash<String, V1RatingValues>**](V1RatingValues.md) | * Values are a map of rating keys and the selected value(s). That can be referenced using the item's associated rating group. | [optional] 
+**scores** | [**Hash<String, V1FloatArray>**](V1FloatArray.md) | * Scores are a map of rating keys and the selected score(s). That can be referenced using the item's associated rating group. | [optional] 
+
+

data/docs/V1ListAccountsRequest.md

@@ -0,0 +1,10 @@
+# HappyCo::V1ListAccountsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+**include_inactive** | **BOOLEAN** |  | [optional] 
+**paging** | [**V1Paging**](V1Paging.md) |  | [optional] 
+
+

data/docs/V1ListAccountsResponse.md

@@ -0,0 +1,9 @@
+# HappyCo::V1ListAccountsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounts** | [**Array<V1Account>**](V1Account.md) |  | [optional] 
+**paging** | [**V1PagingResponse**](V1PagingResponse.md) |  | [optional] 
+
+

data/docs/V1ListAssetsRequest.md

@@ -0,0 +1,12 @@
+# HappyCo::V1ListAssetsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**folder_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**asset_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+**include_archived** | **BOOLEAN** |  | [optional] 
+**paging** | [**V1Paging**](V1Paging.md) |  | [optional] 
+
+

data/docs/V1ListAssetsResponse.md

@@ -0,0 +1,9 @@
+# HappyCo::V1ListAssetsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assets** | [**Array<V1Asset>**](V1Asset.md) |  | [optional] 
+**paging** | [**V1PagingResponse**](V1PagingResponse.md) |  | [optional] 
+
+

data/docs/V1ListFoldersRequest.md

@@ -0,0 +1,11 @@
+# HappyCo::V1ListFoldersRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**folder_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+**include_inactive** | **BOOLEAN** |  | [optional] 
+**paging** | [**V1Paging**](V1Paging.md) |  | [optional] 
+
+

data/docs/V1ListFoldersResponse.md

@@ -0,0 +1,9 @@
+# HappyCo::V1ListFoldersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folders** | [**Array<V1Folder>**](V1Folder.md) |  | [optional] 
+**paging** | [**V1PagingResponse**](V1PagingResponse.md) |  | [optional] 
+
+

data/docs/V1ListInspectionsRequest.md

@@ -0,0 +1,13 @@
+# HappyCo::V1ListInspectionsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) | * Account ID that the request applies to. For custom integrations (i.e. not integration partners) it can be omitted. | [optional] 
+**folder_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) | * Folder IDs is an optional filter that lists inspections only for specific folders. | [optional] 
+**asset_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) | * Asset IDs is an optional filter that lists inspections only for specific assets. | [optional] 
+**inspection_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) | * Inspection IDs  is an optional filter that lists only specific inspections. This is commonly used to get a single inspection. | [optional] 
+**archived** | **BOOLEAN** | * Archived when set to true returns archived inspections only. | [optional] 
+**paging** | [**V1Paging**](V1Paging.md) | * Paging message that contains information about the page being requested. This message is usually copied from a previous list request's response. | [optional] 
+
+

data/docs/V1ListInspectionsResponse.md

@@ -0,0 +1,10 @@
+# HappyCo::V1ListInspectionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inspections** | [**Array<V1Inspection>**](V1Inspection.md) | * Inspections contains the results for this page. | [optional] 
+**previous_page** | [**V1Paging**](V1Paging.md) | * Previous page is an token that will be present for all pages after the first. | [optional] 
+**next_page** | [**V1Paging**](V1Paging.md) | * Next page is an token that will be present for all pages except the last. | [optional] 
+
+

data/docs/V1ListTemplatesRequest.md

@@ -0,0 +1,12 @@
+# HappyCo::V1ListTemplatesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**folder_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+**template_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+**archived** | **BOOLEAN** |  | [optional] 
+**paging** | [**V1Paging**](V1Paging.md) |  | [optional] 
+
+

data/docs/V1ListTemplatesResponse.md

@@ -0,0 +1,10 @@
+# HappyCo::V1ListTemplatesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**templates** | [**Array<V1Template>**](V1Template.md) |  | [optional] 
+**previous_page** | [**V1Paging**](V1Paging.md) |  | [optional] 
+**next_page** | [**V1Paging**](V1Paging.md) |  | [optional] 
+
+

data/docs/V1ListUsersRequest.md

@@ -0,0 +1,11 @@
+# HappyCo::V1ListUsersRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**user_ids** | [**Array<V1IntegrationID>**](V1IntegrationID.md) |  | [optional] 
+**include_inactive** | **BOOLEAN** |  | [optional] 
+**paging** | [**V1Paging**](V1Paging.md) |  | [optional] 
+
+

data/docs/V1ListUsersResponse.md

@@ -0,0 +1,9 @@
+# HappyCo::V1ListUsersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | [**Array<V1User>**](V1User.md) |  | [optional] 
+**paging** | [**V1PagingResponse**](V1PagingResponse.md) |  | [optional] 
+
+

data/docs/V1Paging.md

@@ -0,0 +1,7 @@
+# HappyCo::V1Paging
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/V1PagingResponse.md

@@ -0,0 +1,7 @@
+# HappyCo::V1PagingResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/V1Photo.md

@@ -0,0 +1,9 @@
+# HappyCo::V1Photo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/V1Property.md

@@ -0,0 +1,8 @@
+# HappyCo::V1Property
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key_number** | **String** |  | [optional] 
+
+

data/docs/V1RatingCheckbox.md

@@ -0,0 +1,12 @@
+# HappyCo::V1RatingCheckbox
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | * Label is an optional field that will override key as the user to be displayed. This is useful for localization of inspections. | [optional] 
+**value** | **String** | * Value is a required field that will be inserted into the item and shown on reports if the checkbox is toggled on. | [optional] 
+**score** | **Float** | * Score is an optional field that will be inserted into the item and can be shown on reports if the checkbox is toggled on. | [optional] 
+**color** | **String** |  | [optional] 
+**image** | **String** |  | [optional] [default to "UNDEFINED"]
+
+

data/docs/V1RatingControl.md

@@ -0,0 +1,11 @@
+# HappyCo::V1RatingControl
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | * Key is a required field. It is used when a control has a selected value. The key and its selected value(s) will be inserted into an item's values map field and the key and the selected score(s) will be inserted into the item's scores map field. It is also the default string displayed to the user unless custom label(s) are set (see each control type). | [optional] 
+**checkbox** | [**V1RatingCheckbox**](V1RatingCheckbox.md) |  | [optional] 
+**radio_group** | [**V1RatingRadioGroup**](V1RatingRadioGroup.md) |  | [optional] 
+**drop_down** | [**V1RatingDropDown**](V1RatingDropDown.md) |  | [optional] 
+
+

data/docs/V1RatingDropDown.md

@@ -0,0 +1,9 @@
+# HappyCo::V1RatingDropDown
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | * Label is an optional field that will override key as the user to be displayed. This is useful for localization of inspections. | [optional] 
+**options** | [**Array<V1RatingDropDownOption>**](V1RatingDropDownOption.md) |  | [optional] 
+
+

data/docs/V1RatingDropDownOption.md

@@ -0,0 +1,12 @@
+# HappyCo::V1RatingDropDownOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | * Label is an optional field that will override the value as the defaul option to be displayed to the user for this option. This is useful for localization of inspections. | [optional] 
+**value** | **String** | * Value is a required field that will be inserted into the item and shown on reports if this radio option is selected. No two options in the same drop down can have the same value. | [optional] 
+**score** | **Float** | * Score is an optional field that will be inserted into the item and can be shown on reports if this drop down option is selected. | [optional] 
+**color** | **String** |  | [optional] 
+**image** | **String** |  | [optional] [default to "UNDEFINED"]
+
+

data/docs/V1RatingGroups.md

@@ -0,0 +1,9 @@
+# HappyCo::V1RatingGroups
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | * Label is an optional field that can help users that need to update inspections on the fly. | [optional] 
+**ratings** | [**Array<V1RatingControl>**](V1RatingControl.md) | * Ratings are the ordered set of rating controls an inspector sees for an item that references this rating group. | [optional] 
+
+

data/docs/V1RatingImage.md

@@ -0,0 +1,7 @@
+# HappyCo::V1RatingImage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/V1RatingRadioGroup.md

@@ -0,0 +1,9 @@
+# HappyCo::V1RatingRadioGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | * Label is an optional field that will override key as the user to be displayed. This is useful for localization of inspections. | [optional] 
+**options** | [**Array<V1RatingRadioGroupOption>**](V1RatingRadioGroupOption.md) |  | [optional] 
+
+

data/docs/V1RatingRadioGroupOption.md

@@ -0,0 +1,11 @@
+# HappyCo::V1RatingRadioGroupOption
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | * Value is a required field that will be inserted into the item and shown on reports if this radio option is selected. No two options in the same radio group can have the same value. | [optional] 
+**score** | **Float** | * Score is an optional field that will be inserted into the item and can be shown on reports if this radio option is selected. | [optional] 
+**color** | **String** |  | [optional] 
+**image** | **String** |  | [optional] [default to "UNDEFINED"]
+
+