happyco_json
HappyCo - the Ruby gem for the Merged swaggers
All happy services merged together
This SDK is automatically generated by the Swagger Codegen project:
- API version: 2.5.0
- Package version: 2.5.0
- Build date: 2020-08-19T15:24:39.728+09:30
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build happyco_json.gemspec
Then either install the gem locally:
gem install ./happyco_json-2.5.0.gem
(for development, run gem install --dev ./happyco_json-2.5.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'happyco_json', '~> 2.5.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'happyco_json', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'happyco_json'
api_instance = HappyCo::AccountProvisioningServiceApi.new
body = HappyCo::V1CreateAccountsRequest.new # V1CreateAccountsRequest |
begin
result = api_instance.create_accounts(body)
p result
rescue HappyCo::ApiError => e
puts "Exception when calling AccountProvisioningServiceApi->create_accounts: #{e}"
end
Documentation for API Endpoints
All URIs are relative to http://test.com/api
Class | Method | HTTP request | Description |
---|---|---|---|
HappyCo::AccountProvisioningServiceApi | create_accounts | POST /api/v1/manage/accounts/create | |
HappyCo::AccountProvisioningServiceApi | update_account_statuses | PUT /api/v1/manage/account/statuses/update | |
HappyCo::AccountServiceApi | list_accounts | POST /api/v1/manage/accounts/list | |
HappyCo::AccountServiceApi | update_accounts | POST /api/v1/manage/accounts/update | |
HappyCo::AccountUsersServiceApi | add_users | POST /api/v1/manage/account/users/add | |
HappyCo::AccountUsersServiceApi | list_users | POST /api/v1/manage/account/users/list | |
HappyCo::AccountUsersServiceApi | update_user_statuses | PUT /api/v1/manage/account/user/statuses/update | |
HappyCo::AccountUsersServiceApi | update_users | PUT /api/v1/manage/account/users/update | |
HappyCo::AssetServiceApi | add_asset_photo | POST /api/v1/manage/asset/photo/add | |
HappyCo::AssetServiceApi | archive_assets | PUT /api/v1/manage/assets/archive | |
HappyCo::AssetServiceApi | create_assets | POST /api/v1/manage/assets/create | |
HappyCo::AssetServiceApi | list_assets | POST /api/v1/manage/assets/list | |
HappyCo::AssetServiceApi | unarchive_assets | PUT /api/v1/manage/assets/unarchive | |
HappyCo::AssetServiceApi | update_assets | PUT /api/v1/manage/assets/update | |
HappyCo::FolderServiceApi | create_folders | POST /api/v1/manage/folders/create | |
HappyCo::FolderServiceApi | list_folders | POST /api/v1/manage/folders/list | |
HappyCo::FolderServiceApi | update_folder_statuses | PUT /api/v1/manage/folder/statuses/update | |
HappyCo::FolderServiceApi | update_folders | PUT /api/v1/manage/folders/update | |
HappyCo::InspectionServiceApi | 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. This is now deprecated and soon to be removed. |
HappyCo::InspectionServiceApi | archive_inspections | PUT /api/v1/inspect/inspections/archive | * Archive inspections should be used to archive inspections that are no longer wanted. No method for purging archived inspections is available via the API. All inspections must belong to the same folder. |
HappyCo::InspectionServiceApi | create_delegated_inspection_links | POST /api/v1/inspect/inspection/links/create | |
HappyCo::InspectionServiceApi | create_inspections | POST /api/v1/inspect/inspections/create | * Create inspections can create inspections with any status (normally scheduled). |
HappyCo::InspectionServiceApi | list_inspections | POST /api/v1/inspect/inspections/list | * List inspections gets a paginated and optionally filtered list of inspections from one or more folders. |
HappyCo::InspectionServiceApi | unarchive_inspections | PUT /api/v1/inspect/inspections/unarchive | * Unarchive inspections should be used if previously archived inspections need to be restored. All inspections must belong to the same folder. |
HappyCo::InspectionServiceApi | 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. |
HappyCo::ReportServiceApi | list_reports | POST /api/v1/inspect/reports/list | * List reports gets a paginated and optionally filtered list of reports from one or more folders. |
HappyCo::TemplateServiceApi | archive_templates | PUT /api/v1/inspect/templates/archive | |
HappyCo::TemplateServiceApi | create_templates | POST /api/v1/inspect/templates/create | |
HappyCo::TemplateServiceApi | list_templates | POST /api/v1/inspect/templates/list | |
HappyCo::TemplateServiceApi | unarchive_templates | PUT /api/v1/inspect/templates/unarchive | |
HappyCo::TemplateServiceApi | update_templates | PUT /api/v1/inspect/templates/update |
Documentation for Models
- HappyCo::CreateAccountsRequestAccountWithAdmin
- HappyCo::CreateAccountsResponseAccountIDWithAdminID
- HappyCo::InspectionStatusChangeStatus
- HappyCo::InspectionStatusChangesEventInspectionStatusChange
- HappyCo::ProtobufAny
- HappyCo::ReportsCreatedEventReportCreated
- HappyCo::RuntimeStreamError
- HappyCo::UpdateAccountsRequestAccountWithAdminId
- HappyCo::V1Account
- HappyCo::V1AddAssetPhotoRequest
- HappyCo::V1AddAssetPhotoResponse
- HappyCo::V1AddInspectionPhotoRequest
- HappyCo::V1AddInspectionPhotoResponse
- HappyCo::V1AddInspectionPhotosRequest
- HappyCo::V1AddInspectionPhotosResponse
- HappyCo::V1AddUsersRequest
- HappyCo::V1AddUsersResponse
- HappyCo::V1Asset
- HappyCo::V1CreateAccountsRequest
- HappyCo::V1CreateAccountsResponse
- HappyCo::V1CreateAssetsRequest
- HappyCo::V1CreateAssetsResponse
- HappyCo::V1CreateDelegatedInspectionLinkRequest
- HappyCo::V1CreateDelegatedInspectionLinkResponse
- HappyCo::V1CreateDelegatedInspectionLinksRequest
- HappyCo::V1CreateDelegatedInspectionLinksResponse
- HappyCo::V1CreateFoldersRequest
- HappyCo::V1CreateFoldersResponse
- HappyCo::V1CreateInspectionsRequest
- HappyCo::V1CreateInspectionsResponse
- HappyCo::V1CreateTemplatesRequest
- HappyCo::V1CreateTemplatesResponse
- HappyCo::V1DateTime
- HappyCo::V1Event
- HappyCo::V1EventAck
- HappyCo::V1EventHandlerOptions
- HappyCo::V1FloatArray
- HappyCo::V1Folder
- HappyCo::V1FolderType
- HappyCo::V1FooterField
- HappyCo::V1HeaderField
- HappyCo::V1Inspection
- HappyCo::V1InspectionData
- HappyCo::V1InspectionStatusChangesEvent
- HappyCo::V1InspectionStatusChangesEventAckResponse
- HappyCo::V1IntegrationID
- HappyCo::V1Item
- HappyCo::V1ListAccountsRequest
- HappyCo::V1ListAccountsResponse
- HappyCo::V1ListAssetsRequest
- HappyCo::V1ListAssetsResponse
- HappyCo::V1ListFoldersRequest
- HappyCo::V1ListFoldersResponse
- HappyCo::V1ListInspectionsRequest
- HappyCo::V1ListInspectionsResponse
- HappyCo::V1ListReportsRequest
- HappyCo::V1ListReportsResponse
- HappyCo::V1ListTemplatesRequest
- HappyCo::V1ListTemplatesResponse
- HappyCo::V1ListUsersRequest
- HappyCo::V1ListUsersResponse
- HappyCo::V1Paging
- HappyCo::V1PagingResponse
- HappyCo::V1Photo
- HappyCo::V1Property
- HappyCo::V1RatingCheckbox
- HappyCo::V1RatingControl
- HappyCo::V1RatingDropDown
- HappyCo::V1RatingDropDownOption
- HappyCo::V1RatingGroup
- HappyCo::V1RatingImage
- HappyCo::V1RatingRadioGroup
- HappyCo::V1RatingRadioGroupOption
- HappyCo::V1RatingValues
- HappyCo::V1Report
- HappyCo::V1ReportsCreatedEvent
- HappyCo::V1ReportsCreatedEventAckResponse
- HappyCo::V1ScheduledInspection
- HappyCo::V1Section
- HappyCo::V1SetAssetsArchivedRequest
- HappyCo::V1SetAssetsArchivedResponse
- HappyCo::V1SetInspectionsArchivedRequest
- HappyCo::V1SetInspectionsArchivedResponse
- HappyCo::V1SetTemplatesArchivedRequest
- HappyCo::V1SetTemplatesArchivedResponse
- HappyCo::V1Signatory
- HappyCo::V1StringArray
- HappyCo::V1Template
- HappyCo::V1Unit
- HappyCo::V1UpdateAccountStatusesRequest
- HappyCo::V1UpdateAccountStatusesResponse
- HappyCo::V1UpdateAccountsRequest
- HappyCo::V1UpdateAccountsResponse
- HappyCo::V1UpdateAssetsRequest
- HappyCo::V1UpdateAssetsResponse
- HappyCo::V1UpdateFolderStatusesRequest
- HappyCo::V1UpdateFolderStatusesResponse
- HappyCo::V1UpdateFoldersRequest
- HappyCo::V1UpdateFoldersResponse
- HappyCo::V1UpdateInspectionsRequest
- HappyCo::V1UpdateInspectionsResponse
- HappyCo::V1UpdateTemplatesRequest
- HappyCo::V1UpdateTemplatesResponse
- HappyCo::V1UpdateUserStatusesRequest
- HappyCo::V1UpdateUserStatusesResponse
- HappyCo::V1UpdateUsersRequest
- HappyCo::V1UpdateUsersResponse
- HappyCo::V1User
Documentation for Authorization
All endpoints do not require authorization.