happyco_json 2.0.0

data/docs/InspectionServiceApi.md

@@ -0,0 +1,329 @@
+# HappyCo::InspectionServiceApi
+
+All URIs are relative to *http://test.com/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_inspection_photos**](InspectionServiceApi.md#add_inspection_photos) | **POST** /api/v1/inspect/inspection/photos/add | * Adds photos to inspections. The returned photo IDs must be inserted into the inspection for them to be displayed. This inspection does not occur in a transaction and you will receive a response for each photo.
+[**archive_inspections**](InspectionServiceApi.md#archive_inspections) | **PUT** /api/v1/inspect/inspections/archive | * Archive inspections should be used to delete inspections that are no longer wanted. No method for purging archived inspections is available via the API.
+[**create_delegated_inspection_links**](InspectionServiceApi.md#create_delegated_inspection_links) | **POST** /api/v1/inspect/inspection/links/create | 
+[**create_inspections**](InspectionServiceApi.md#create_inspections) | **POST** /api/v1/inspect/inspections/create | * Create inspections can create inspections with any status (normally scheduled).
+[**list_inspections**](InspectionServiceApi.md#list_inspections) | **POST** /api/v1/inspect/inspections/list | * List inspections gets a paginated and optionally filtered list of inspections from one or more folders.
+[**unarchive_inspections**](InspectionServiceApi.md#unarchive_inspections) | **PUT** /api/v1/inspect/inspections/unarchive | * Unarchive inspections should be used if previously archived inspections need to be restored.
+[**update_inspections**](InspectionServiceApi.md#update_inspections) | **PUT** /api/v1/inspect/inspections/update | * Update inspections can change the contents of inspections. Currently an inspection cannot have its asset_id or template_id updated.
+
+
+# **add_inspection_photos**
+> V1AddInspectionPhotosResponse add_inspection_photos(body)
+
+* Adds photos to inspections. The returned photo IDs must be inserted into the inspection for them to be displayed. This inspection does not occur in a transaction and you will receive a response for each photo.
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::InspectionServiceApi.new
+
+body = HappyCo::V1AddInspectionPhotosRequest.new # V1AddInspectionPhotosRequest | 
+
+
+begin
+  #* Adds photos to inspections. The returned photo IDs must be inserted into the inspection for them to be displayed. This inspection does not occur in a transaction and you will receive a response for each photo.
+  result = api_instance.add_inspection_photos(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling InspectionServiceApi->add_inspection_photos: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1AddInspectionPhotosRequest**](V1AddInspectionPhotosRequest.md)|  | 
+
+### Return type
+
+[**V1AddInspectionPhotosResponse**](V1AddInspectionPhotosResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **archive_inspections**
+> V1SetInspectionsArchivedResponse archive_inspections(body)
+
+* Archive inspections should be used to delete inspections that are no longer wanted. No method for purging archived inspections is available via the API.
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::InspectionServiceApi.new
+
+body = HappyCo::V1SetInspectionsArchivedRequest.new # V1SetInspectionsArchivedRequest | 
+
+
+begin
+  #* Archive inspections should be used to delete inspections that are no longer wanted. No method for purging archived inspections is available via the API.
+  result = api_instance.archive_inspections(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling InspectionServiceApi->archive_inspections: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1SetInspectionsArchivedRequest**](V1SetInspectionsArchivedRequest.md)|  | 
+
+### Return type
+
+[**V1SetInspectionsArchivedResponse**](V1SetInspectionsArchivedResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_delegated_inspection_links**
+> V1CreateDelegatedInspectionLinksResponse create_delegated_inspection_links(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::InspectionServiceApi.new
+
+body = HappyCo::V1CreateDelegatedInspectionLinksRequest.new # V1CreateDelegatedInspectionLinksRequest | 
+
+
+begin
+  result = api_instance.create_delegated_inspection_links(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling InspectionServiceApi->create_delegated_inspection_links: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1CreateDelegatedInspectionLinksRequest**](V1CreateDelegatedInspectionLinksRequest.md)|  | 
+
+### Return type
+
+[**V1CreateDelegatedInspectionLinksResponse**](V1CreateDelegatedInspectionLinksResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_inspections**
+> V1CreateInspectionsResponse create_inspections(body)
+
+* Create inspections can create inspections with any status (normally scheduled).
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::InspectionServiceApi.new
+
+body = HappyCo::V1CreateInspectionsRequest.new # V1CreateInspectionsRequest | 
+
+
+begin
+  #* Create inspections can create inspections with any status (normally scheduled).
+  result = api_instance.create_inspections(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling InspectionServiceApi->create_inspections: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1CreateInspectionsRequest**](V1CreateInspectionsRequest.md)|  | 
+
+### Return type
+
+[**V1CreateInspectionsResponse**](V1CreateInspectionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_inspections**
+> V1ListInspectionsResponse list_inspections(body)
+
+* List inspections gets a paginated and optionally filtered list of inspections from one or more folders.
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::InspectionServiceApi.new
+
+body = HappyCo::V1ListInspectionsRequest.new # V1ListInspectionsRequest | 
+
+
+begin
+  #* List inspections gets a paginated and optionally filtered list of inspections from one or more folders.
+  result = api_instance.list_inspections(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling InspectionServiceApi->list_inspections: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1ListInspectionsRequest**](V1ListInspectionsRequest.md)|  | 
+
+### Return type
+
+[**V1ListInspectionsResponse**](V1ListInspectionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **unarchive_inspections**
+> V1SetInspectionsArchivedResponse unarchive_inspections(body)
+
+* Unarchive inspections should be used if previously archived inspections need to be restored.
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::InspectionServiceApi.new
+
+body = HappyCo::V1SetInspectionsArchivedRequest.new # V1SetInspectionsArchivedRequest | 
+
+
+begin
+  #* Unarchive inspections should be used if previously archived inspections need to be restored.
+  result = api_instance.unarchive_inspections(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling InspectionServiceApi->unarchive_inspections: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1SetInspectionsArchivedRequest**](V1SetInspectionsArchivedRequest.md)|  | 
+
+### Return type
+
+[**V1SetInspectionsArchivedResponse**](V1SetInspectionsArchivedResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_inspections**
+> V1UpdateInspectionsResponse update_inspections(body)
+
+* Update inspections can change the contents of inspections. Currently an inspection cannot have its asset_id or template_id updated.
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::InspectionServiceApi.new
+
+body = HappyCo::V1UpdateInspectionsRequest.new # V1UpdateInspectionsRequest | 
+
+
+begin
+  #* Update inspections can change the contents of inspections. Currently an inspection cannot have its asset_id or template_id updated.
+  result = api_instance.update_inspections(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling InspectionServiceApi->update_inspections: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1UpdateInspectionsRequest**](V1UpdateInspectionsRequest.md)|  | 
+
+### Return type
+
+[**V1UpdateInspectionsResponse**](V1UpdateInspectionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/InspectionStatusChangeStatus.md

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

data/docs/InspectionStatusChangesEventInspectionStatusChange.md

@@ -0,0 +1,10 @@
+# HappyCo::InspectionStatusChangesEventInspectionStatusChange
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inspection_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**from_status** | **String** | * From status is the status prior to the change event. | [optional] [default to "SCHEDULED"]
+**to_status** | **String** | * To status is the status post the change event. | [optional] [default to "SCHEDULED"]
+
+

data/docs/TemplateServiceApi.md

@@ -0,0 +1,233 @@
+# HappyCo::TemplateServiceApi
+
+All URIs are relative to *http://test.com/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**archive_templates**](TemplateServiceApi.md#archive_templates) | **PUT** /api/v1/inspect/templates/archive | 
+[**create_templates**](TemplateServiceApi.md#create_templates) | **POST** /api/v1/inspect/templates/create | 
+[**list_templates**](TemplateServiceApi.md#list_templates) | **POST** /api/v1/inspect/templates/list | 
+[**unarchive_templates**](TemplateServiceApi.md#unarchive_templates) | **PUT** /api/v1/inspect/templates/unarchive | 
+[**update_templates**](TemplateServiceApi.md#update_templates) | **PUT** /api/v1/inspect/templates/update | 
+
+
+# **archive_templates**
+> V1SetTemplatesArchivedResponse archive_templates(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::TemplateServiceApi.new
+
+body = HappyCo::V1SetTemplatesArchivedRequest.new # V1SetTemplatesArchivedRequest | 
+
+
+begin
+  result = api_instance.archive_templates(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling TemplateServiceApi->archive_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1SetTemplatesArchivedRequest**](V1SetTemplatesArchivedRequest.md)|  | 
+
+### Return type
+
+[**V1SetTemplatesArchivedResponse**](V1SetTemplatesArchivedResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_templates**
+> V1CreateTemplatesResponse create_templates(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::TemplateServiceApi.new
+
+body = HappyCo::V1CreateTemplatesRequest.new # V1CreateTemplatesRequest | 
+
+
+begin
+  result = api_instance.create_templates(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling TemplateServiceApi->create_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1CreateTemplatesRequest**](V1CreateTemplatesRequest.md)|  | 
+
+### Return type
+
+[**V1CreateTemplatesResponse**](V1CreateTemplatesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_templates**
+> V1ListTemplatesResponse list_templates(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::TemplateServiceApi.new
+
+body = HappyCo::V1ListTemplatesRequest.new # V1ListTemplatesRequest | 
+
+
+begin
+  result = api_instance.list_templates(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling TemplateServiceApi->list_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1ListTemplatesRequest**](V1ListTemplatesRequest.md)|  | 
+
+### Return type
+
+[**V1ListTemplatesResponse**](V1ListTemplatesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **unarchive_templates**
+> V1SetTemplatesArchivedResponse unarchive_templates(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::TemplateServiceApi.new
+
+body = HappyCo::V1SetTemplatesArchivedRequest.new # V1SetTemplatesArchivedRequest | 
+
+
+begin
+  result = api_instance.unarchive_templates(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling TemplateServiceApi->unarchive_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1SetTemplatesArchivedRequest**](V1SetTemplatesArchivedRequest.md)|  | 
+
+### Return type
+
+[**V1SetTemplatesArchivedResponse**](V1SetTemplatesArchivedResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_templates**
+> V1UpdateTemplatesResponse update_templates(body)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'happyco_json'
+
+api_instance = HappyCo::TemplateServiceApi.new
+
+body = HappyCo::V1UpdateTemplatesRequest.new # V1UpdateTemplatesRequest | 
+
+
+begin
+  result = api_instance.update_templates(body)
+  p result
+rescue HappyCo::ApiError => e
+  puts "Exception when calling TemplateServiceApi->update_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**V1UpdateTemplatesRequest**](V1UpdateTemplatesRequest.md)|  | 
+
+### Return type
+
+[**V1UpdateTemplatesResponse**](V1UpdateTemplatesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UpdateAccountsRequestAccountWithAdminId.md

@@ -0,0 +1,9 @@
+# HappyCo::UpdateAccountsRequestAccountWithAdminId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | [**V1Account**](V1Account.md) |  | [optional] 
+**admin_user_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+
+

data/docs/V1Account.md

@@ -0,0 +1,17 @@
+# HappyCo::V1Account
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**inactive** | **BOOLEAN** |  | [optional] 
+**name** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**address_line_1** | **String** |  | [optional] 
+**address_line_2** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**postal_code** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+
+

data/docs/V1AddInspectionPhotoRequest.md

@@ -0,0 +1,11 @@
+# HappyCo::V1AddInspectionPhotoRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folder_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**inspection_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**file_name** | **String** | * File name must include a valid image extension. | [optional] 
+**data** | **String** | * Data should contain the image data. | [optional] 
+
+

data/docs/V1AddInspectionPhotoResponse.md

@@ -0,0 +1,9 @@
+# HappyCo::V1AddInspectionPhotoResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**photo_id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**error** | **String** | * Error contains an error response for a request or an empty string. | [optional] 
+
+

data/docs/V1AddInspectionPhotosRequest.md

@@ -0,0 +1,9 @@
+# HappyCo::V1AddInspectionPhotosRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | [**V1IntegrationID**](V1IntegrationID.md) | * Account ID that the request applies to. | [optional] 
+**requests** | [**Array<V1AddInspectionPhotoRequest>**](V1AddInspectionPhotoRequest.md) | * Requests to be performed. The responses will be an array of the same length and order. | [optional] 
+
+

data/docs/V1AddInspectionPhotosResponse.md

@@ -0,0 +1,8 @@
+# HappyCo::V1AddInspectionPhotosResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**responses** | [**Array<V1AddInspectionPhotoResponse>**](V1AddInspectionPhotoResponse.md) | * Responses is an array of the same length and order as the requests. | [optional] 
+
+

data/docs/V1AddUsersRequest.md

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

data/docs/V1AddUsersResponse.md

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

data/docs/V1Asset.md

@@ -0,0 +1,17 @@
+# HappyCo::V1Asset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [**V1IntegrationID**](V1IntegrationID.md) |  | [optional] 
+**archived** | **BOOLEAN** |  | [optional] 
+**address_line_1** | **String** |  | [optional] 
+**address_line_2** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**postal_code** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**unit** | [**V1Unit**](V1Unit.md) |  | [optional] 
+**property** | [**V1Property**](V1Property.md) |  | [optional] 
+
+

data/docs/V1CreateAccountsRequest.md

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