Rust API client for ehelply

eHelply SDK for SuperStack Services

For more information, please visit https://superstack.ehelply.com/support

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 1.1.118
• Package version: 1.1.118
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named ehelply and add the following to Cargo.toml under [dependencies]:

ehelply = { path = "./ehelply" }

Documentation for API Endpoints

All URIs are relative to https://api.prod.ehelply.com

Class	Method	HTTP request	Description
AppointmentsApi	add_entity_to_appointment	POST /appointments/appointments/{appointment_uuid}/entities/{entity_uuid}	Addentitytoappointment
AppointmentsApi	create_appointment	POST /appointments/appointments	Createappointment
AppointmentsApi	delete_appointment	DELETE /appointments/appointments/{appointment_uuid}	Deleteappointment
AppointmentsApi	detach_entity_from_appointment	DELETE /appointments/appointments/{appointment_uuid}/entities/{entity_uuid}	Removeentityfromappointment
AppointmentsApi	get_appointment	GET /appointments/appointments/{appointment_uuid}	Getappointment
AppointmentsApi	search_appointment	GET /appointments/appointments	Searchappointments
AppointmentsApi	search_appointment_entities	GET /appointments/appointments/{appointment_uuid}/entities	Searchappointmententities
AppointmentsApi	search_entity_appointments	GET /appointments/appointments/entities/{entity_uuid}/appointments	Getentityappointments
AppointmentsApi	update_appointment	PUT /appointments/appointments/{appointment_uuid}	Updateappointment
BillingApi	create_billing_account	POST /sam/billing/projects/{project_uuid}/accounts	Createbillingaccount
BillingApi	get_client_secret	GET /sam/billing/projects/{project_uuid}/secrets	Getclientsecret
BillingApi	has_payment	GET /sam/billing/projects/{project_uuid}/payment-methods-exist	Haspayment
BillingApi	list_payment_methods	GET /sam/billing/projects/{project_uuid}/payment-methods	Listpaymentmethods
BillingApi	process_payment	POST /sam/billing/projects/{project_uuid}/payments	Processpayment
BillingApi	reconcile_payment_method	GET /sam/billing/projects/{project_uuid}/payment-methods-reconciliation	Reconcilepaymentmethod
BillingApi	remove_payment_method	DELETE /sam/billing/projects/{project_uuid}/payment-methods	Removepaymentmethod
CatalogsApi	attach_product_to_catalog	POST /products/catalogs/{catalog_uuid}/products/{product_uuid}	Addproducttocatalog
CatalogsApi	create_catalog	POST /products/catalogs	Createcatalog
CatalogsApi	delete_catalog	DELETE /products/catalogs/{catalog_uuid}	Deletecatalog
CatalogsApi	detach_product_from_catalog	DELETE /products/catalogs/{catalog_uuid}/products/{product_uuid}	Removeproductfromcatalog
CatalogsApi	get_catalog	GET /products/catalogs/{catalog_uuid}	Getcatalog
CatalogsApi	search_catalog_products	GET /products/catalogs/{catalog_uuid}/products	Searchcatalogproducts
CatalogsApi	search_catalogs	GET /products/catalogs	Searchcatalogs
CatalogsApi	update_catalog	PUT /products/catalogs/{catalog_uuid}	Updatecatalog
CategoryApi	create_category_places_categories_post	POST /places/categories	Create Category
CategoryApi	delete_category_places_categories_category_uuid_delete	DELETE /places/categories/{category_uuid}	Delete Category
CategoryApi	get_category_places_categories_category_uuid_get	GET /places/categories/{category_uuid}	Get Category
CategoryApi	search_categories_places_categories_get	GET /places/categories	Search Categories
CategoryApi	update_category_places_categories_category_uuid_put	PUT /places/categories/{category_uuid}	Update Category
CompaniesApi	create_company_places_companies_post	POST /places/companies	Create Company
CompaniesApi	delete_place_places_companies_company_uuid_delete	DELETE /places/companies/{company_uuid}	Delete Place
CompaniesApi	get_company_places_companies_company_uuid_get	GET /places/companies/{company_uuid}	Get Company
CompaniesApi	search_companies_places_companies_get	GET /places/companies	Search Companies
CompaniesApi	update_company_places_companies_company_uuid_put	PUT /places/companies/{company_uuid}	Update Company
ContentApi	create_file	POST /files/files	Createfile
ContentApi	delete_file	DELETE /files/files/{file_uuid}	Deletefile
ContentApi	get_file	GET /files/files/{file_uuid}	Getfile
ContentApi	update_file	PUT /files/files/{file_uuid}	Updatefile
FactsApi	delete_fact	POST /sam/facts/facts/{fact_name}	Deletefact
FactsApi	delete_fact_0	POST /sam/facts/facts/{fact_name}	Deletefact
FactsApi	get_fact	GET /sam/facts/facts/{fact_name}	Getfact
FactsApi	get_fact_0	GET /sam/facts/facts/{fact_name}	Getfact
FactsApi	get_facts	GET /sam/facts/facts	Getfacts
FactsApi	get_facts_0	GET /sam/facts/facts	Getfacts
FactsApi	save_fact	POST /sam/facts/facts	Savefact
FactsApi	save_fact_0	POST /sam/facts/facts	Savefact
FieldsApi	create_field	POST /fields/fields	Createfield
FieldsApi	delete_field	DELETE /fields/fields/{field_uuid}	Deletefield
FieldsApi	get_field	GET /fields/fields/{field_uuid}	Getfield
FieldsApi	update_field	PUT /fields/fields/{field_uuid}	Updatefield
LoggingApi	get_subject_logs	GET /sam/logging/logs/services/{service}/subjects/{subject}	Getsubjectlogs
MetaApi	create_meta	POST /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Createmeta
MetaApi	create_slug	POST /meta/slug	Createslug
MetaApi	delete_meta	DELETE /meta/meta/{meta_uuid}	Deletemeta
MetaApi	delete_meta_from_parts	DELETE /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Deletemetafromparts
MetaApi	get_meta	GET /meta/meta/{meta_uuid}	Getmeta
MetaApi	get_meta_from_parts	GET /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Getmetafromparts
MetaApi	touch_meta	POST /meta/meta/{meta_uuid}/touch	Touchmeta
MetaApi	update_meta	PUT /meta/meta/{meta_uuid}	Updatemeta
MetaApi	update_meta_from_parts	PUT /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Updatemetafromparts
MonitorApi	acknowledge_alarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/acknowledge	Acknowledgealarm
MonitorApi	assign_alarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/assign	Assignalarm
MonitorApi	attach_alarm_note	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/note	Attachalarmnote
MonitorApi	attach_alarm_ticket	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/ticket	Attachalarmticket
MonitorApi	clear_alarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/clear	Clearalarm
MonitorApi	delete_service_super_stack_meta	DELETE /sam/monitor/services/{service}/superstack	Deleteservicesuperstackmeta
MonitorApi	get_service	GET /sam/monitor/services/{service}	Getservice
MonitorApi	get_service_alarm	GET /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}	Getservicealarm
MonitorApi	get_service_alarms	GET /sam/monitor/services/{service}/stages/{stage}/alarms	Getservicealarms
MonitorApi	get_service_heartbeat	GET /sam/monitor/services/{service}/stages/{stage}/heartbeats	Getserviceheartbeat
MonitorApi	get_service_kpis	GET /sam/monitor/services/{service}/kpis	Getservicekpis
MonitorApi	get_service_spec	GET /sam/monitor/services/{service}/specs/{spec}	Getservicespec
MonitorApi	get_service_specs	GET /sam/monitor/services/{service}/specs	Getservicespecs
MonitorApi	get_service_vitals	GET /sam/monitor/services/{service}/stages/{stage}/vitals	Getservicevitals
MonitorApi	get_services	GET /sam/monitor/services	Getservices
MonitorApi	get_services_with_specs	GET /sam/monitor/specs/services	Getserviceswithspecs
MonitorApi	get_supertack_services	GET /sam/monitor/superstack-services	Getsupertackservices
MonitorApi	hide_service	POST /sam/monitor/services/{service}/stages/{stage}/hide	Hideservice
MonitorApi	ignore_alarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/ignore	Ignorealarm
MonitorApi	register_service	POST /sam/monitor/services	Registerservice
MonitorApi	save_service_super_stack_meta	POST /sam/monitor/services/{service}/superstack	Saveservicesuperstackmeta
MonitorApi	search_alarms	GET /sam/monitor/services/{service}/alarms	Searchalarms
MonitorApi	show_service	POST /sam/monitor/services/{service}/stages/{stage}/show	Showservice
MonitorApi	terminate_alarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/terminate	Terminatealarm
MonitorApi	trigger_alarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms	Triggeralarm
NotesApi	create_note	POST /notes/notes	Createnote
NotesApi	delete_note	DELETE /notes/notes/{note_id}	Deletenote
NotesApi	get_note	GET /notes/notes/{note_id}	Getnote
NotesApi	update_note	PUT /notes/notes/{note_id}	Updatenote
PlacesApi	advanced_search_places	GET /places/search/places/string	Advancedsearchplaces
PlacesApi	create_place_places_places_post	POST /places/places	Create Place
PlacesApi	delete_place	DELETE /places/places/{place_uuid}	Deleteplace
PlacesApi	forward_geocoding_places_geocoding_forward_get	GET /places/geocoding/forward	Forward Geocoding
PlacesApi	get_place	GET /places/places/{place_uuid}	Getplace
PlacesApi	reverse_geocoding_places_geocoding_reverse_get	GET /places/geocoding/reverse	Reverse Geocoding
PlacesApi	search_places	GET /places/places	Searchplaces
PlacesApi	update_place	PUT /places/places/{place_uuid}	Updateplace
ProductsApi	create_product	POST /products/products	Createproduct
ProductsApi	delete_product	DELETE /products/products/{product_uuid}	Deleteproduct
ProductsApi	get_product	GET /products/products/{product_uuid}	Getproduct
ProductsApi	search_product_catalog	GET /products/products/{product_uuid}/catalogs	Searchproductcatalog
ProductsApi	search_products	GET /products/products	Searchproducts
ProductsApi	update_product	PUT /products/products/{product_uuid}	Updateproduct
ProjectsApi	add_member_to_project	POST /sam/projects/projects/{project_uuid}/members/{entity_uuid}	Addmembertoproject
ProjectsApi	archive_project	DELETE /sam/projects/projects/{project_uuid}	Archiveproject
ProjectsApi	create_project	POST /sam/projects/projects	Createproject
ProjectsApi	create_project_credential	POST /sam/projects/projects/{project_uuid}/credentials	Createprojectcredential
ProjectsApi	create_project_credit	POST /sam/projects/projects/{project_uuid}/credits	Createprojectcredit
ProjectsApi	create_project_invoice	POST /sam/projects/projects/{project_uuid}/invoices	Createprojectinvoice
ProjectsApi	create_project_key	POST /sam/projects/projects/{project_uuid}/keys	Createprojectkey
ProjectsApi	create_usage_type	POST /sam/projects/usage/types	Createusagetype
ProjectsApi	delete_project_credential	DELETE /sam/projects/projects/{project_uuid}/credentials/{service_name}	Deleteprojectcredential
ProjectsApi	delete_project_key	DELETE /sam/projects/projects/{project_uuid}/keys	Deleteprojectkey
ProjectsApi	delete_usage_type	DELETE /sam/projects/usage/types/{usage_type_key}	Deleteusagetype
ProjectsApi	get_all_project_credentials	GET /sam/projects/projects/{project_uuid}/credentials	Getallprojectcredentials
ProjectsApi	get_all_project_credits	GET /sam/projects/projects/{project_uuid}/credits	Getallprojectcredits
ProjectsApi	get_all_project_usage	GET /sam/projects/projects/{project_uuid}/usage	Getallprojectusage
ProjectsApi	get_member_projects	GET /sam/projects/members/{entity_uuid}/projects	Getmemberprojects
ProjectsApi	get_project	GET /sam/projects/projects/{project_uuid}	Getproject
ProjectsApi	get_project_credit_transactions	GET /sam/projects/projects/{project_uuid}/credits/{credit_uuid}/transactions	Getprojectcredittransactions
ProjectsApi	get_project_invoice	GET /sam/projects/projects/{project_uuid}/invoices	Getprojectinvoice
ProjectsApi	get_project_invoice_history	GET /sam/projects/projects/{project_uuid}/invoices/history	Getprojectinvoicehistory
ProjectsApi	get_project_keys	GET /sam/projects/projects/{project_uuid}/keys	Getprojectkeys
ProjectsApi	get_project_members	GET /sam/projects/projects/{project_uuid}/members	Getprojectmembers
ProjectsApi	get_specific_project_credential	GET /sam/projects/projects/{project_uuid}/credentials/{service_name}	Getspecificprojectcredential
ProjectsApi	get_specific_project_usage	GET /sam/projects/projects/{project_uuid}/usage/{usage_type_key}	Getspecificprojectusage
ProjectsApi	get_usage_type	GET /sam/projects/usage/types/{usage_type_key}	Getusagetype
ProjectsApi	remove_member_from_project	DELETE /sam/projects/projects/{project_uuid}/members/{entity_uuid}	Removememberfromproject
ProjectsApi	revoke_project_credit	DELETE /sam/projects/projects/{project_uuid}/credits/{credit_uuid}	Revokeprojectcredit
ProjectsApi	search_projects	GET /sam/projects/projects	Searchprojects
ProjectsApi	search_usage_type	GET /sam/projects/usage/types	Searchusagetype
ProjectsApi	update_project	PUT /sam/projects/projects/{project_uuid}	Updateproject
ProjectsApi	update_project_credential	PUT /sam/projects/projects/{project_uuid}/credentials/{service_name}	Updateprojectcredential
ProjectsApi	update_usage_type	PUT /sam/projects/usage/types/{usage_type_key}	Updateusagetype
ReviewsApi	create_review	POST /products/reviews/types/{entity_type}/entities/{entity_uuid}	Create
ReviewsApi	delete_review	DELETE /products/reviews/types/{entity_type}/entities/{entity_uuid}/reviews/{review_uuid}	Deletereview
ReviewsApi	get_review	GET /products/reviews/types/{entity_type}/entities/{entity_uuid}/reviews/{review_uuid}	Getreview
ReviewsApi	search_reviews	GET /products/reviews/types/{entity_type}/entities/{entity_uuid}	Searchreview
ReviewsApi	update_review	PUT /products/reviews/types/{entity_type}/entities/{entity_uuid}/reviews/{review_uuid}	Updatereview
SecurityApi	create_encryption_key	POST /sam/security/encryption/categories/{category}/keys	Createencryptionkey
SecurityApi	create_key	POST /sam/security/keys	Createkey
SecurityApi	delete_key	DELETE /sam/security/keys/{key_uuid}	Deletekey
SecurityApi	generate_token	POST /sam/security/tokens	Generatetoken
SecurityApi	get_encryption_key	GET /sam/security/encryption/categories/{category}/keys	Getencryptionkey
SecurityApi	get_key	GET /sam/security/keys/{key_uuid}	Getkey
SecurityApi	search_keys	GET /sam/security/keys	Searchkeys
SecurityApi	verify_key	POST /sam/security/keys/verify	Verifykey
StaffApi	create_staff	POST /places/staff	Createstaff
StaffApi	delete_staff	DELETE /places/staff/{staff_uuid}	Deletestaff
StaffApi	get_staff	GET /places/staff/{staff_uuid}	Getstaff
StaffApi	search_staff	GET /places/staff	Searchstaff
StaffApi	update_staff	PUT /places/staff/{staff_uuid}	Updatestaff
SupportApi	create_contact	POST /sam/support/contact	Createcontact
SupportApi	create_ticket	POST /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets	Createticket
SupportApi	list_tickets	GET /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets	Listtickets
SupportApi	update_ticket	PUT /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets/{ticket_id}	Updateticket
SupportApi	view_ticket	GET /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets/{ticket_id}	Viewticket
TagApi	delete_tag	DELETE /places/tags/{tag_uuid}	Deletetag
TagsApi	create_tag	POST /places/tags	Createtag
TagsApi	get_tag	GET /places/tags/{tag_uuid}	Gettag
TagsApi	search_tag	GET /places/tags	Searchtag
TagsApi	update_tag	PUT /places/tags/{tag_uuid}	Updatetag
UsersApi	confirm_signup	POST /sam/users/auth/signup/confirm	Confirmsignup
UsersApi	create_participant	POST /sam/users/participants	Createparticipant
UsersApi	create_user	POST /sam/users	Createuser
UsersApi	delete_participant	DELETE /sam/users/participants/{participant_id}	Deleteparticipant
UsersApi	delete_user	DELETE /sam/users/{user_id}	Deleteuser
UsersApi	get_participant	GET /sam/users/participants/{participant_id}	Getparticipant
UsersApi	get_user	GET /sam/users/{user_id}	Getuser
UsersApi	login	POST /sam/users/auth/login	Login
UsersApi	refresh_token	POST /sam/users/auth/{app_client}/refresh-token	Refreshtoken
UsersApi	reset_password	POST /sam/users/auth/password/reset	Resetpassword
UsersApi	reset_password_confirmation	POST /sam/users/auth/password/reset/confirm	Resetpasswordconfirmation
UsersApi	search_participants	GET /sam/users/participants	Searchparticipants
UsersApi	signup	POST /sam/users/auth/signup	Signup
UsersApi	update_participant	PUT /sam/users/participants/{participant_id}	Updateparticipant
UsersApi	update_user	PUT /sam/users/{user_id}	Updateuser
UsersApi	user_validations	POST /sam/users/validations/{field}	Uservalidations

Documentation For Models

• AddressBase
• AlarmAcknowledge
• AlarmAssign
• AlarmCreate
• AlarmIgnore
• AlarmNote
• AlarmResponse
• AlarmTerminate
• AlarmTicket
• AppointmentBase
• AppointmentResponse
• AttachPaymentToProject
• Basic
• BasicMeta
• BasicMetaCreate
• CatalogBase
• CatalogReturn
• CategoryBase
• CategoryDb
• Company
• CompanyBase
• CompanyResponse
• Contact
• ContactBase
• ContactMethod
• ContactResponse
• CreateField200Response
• CreateFile200Response
• CreateKeyResponse
• CreateMeta200Response
• CreateNoteResponse
• CreateProjectCredential
• CreateProjectCredit
• CreateProjectInvoice
• CreateReview
• CreateSlug200Response
• CreateTicket
• Credential
• CustomList
• DatesMeta
• DeleteFact200Response
• DeleteField200Response
• DeleteFile200Response
• DeleteMeta200Response
• DeleteNote200Response
• Detailed
• DetailedMeta
• DetailedMetaCreate
• Discount
• Email
• Fact
• FactCreate
• Field
• FieldDynamo
• GetAppointment403Response
• GetInvoiceResponse
• GetProjectCredential
• GetProjectInvoiceHistory
• GetProjectInvoiceResponse
• GetSecret
• GetServiceServiceWithSpecsResponse
• GetServiceSpecResponse
• GetServiceSpecsResponse
• GetTransactionResponse
• HeartbeatResponse
• History
• HttpValidationError
• KpiResponse
• LineItem
• LoggingDynamo
• MetaChildren
• MetaCreate
• MetaCustom
• MetaDynamo
• Note
• NoteBase
• NoteDynamoHistoryResponse
• NoteDynamoResponse
• NoteMeta
• OptionGroup
• Options
• Page
• Pagination
• ParticipantCreate
• ParticipantUpdate
• ParticipantUserReturn
• Payment
• PaymentMethodResponse
• PlaceBase
• PlaceResponse
• ProductBase
• ProductReturn
• ProjectCreditResponse
• ProjectDb
• ProjectsProjectCreate
• ProjectsProjectGet
• ProjectsProjectMemberDb
• ProjectsProjectUpdate
• ProjectsProjectUsageDb
• ProjectsUsageTypeCreate
• ProjectsUsageTypeDb
• ProjectsUsageTypeGet
• ProjectsUsageTypeUnitPrice
• ProjectsUsageTypeUpdate
• ResponseAddmembertoproject
• ResponseArchiveproject
• ResponseCreatekey
• ResponseCreateprojectcredential
• ResponseCreateprojectinvoice
• ResponseDeletekey
• ResponseDeleteprojectcredential
• ResponseDeleteusagetype
• ResponseGeneratetoken
• ResponseRemovememberfromproject
• ResponseRevokeprojectcredit
• ResponseUpdateprojectcredential
• SaveFact200Response
• SecurityCreateToken
• SecurityEncryptionKeyGet
• SecurityEncryptionKeyResponse
• SecurityKeyCreate
• SecurityKeyGet
• SecurityKeyVerify
• Selection
• ServiceCreate
• ServiceMessageResponse
• ServiceResponse
• ServiceSuperStackMeta
• ServiceSuperStackMetaFaq
• ServiceSuperStackMetaFeature
• ServiceSuperStackMetaGettingStarted
• ServiceSuperStackMetaGettingStartedEndpointTeaser
• ServiceSuperStackMetaUseCase
• Slugger
• StaffCreate
• StaffDb
• StaffResponse
• StatsVitalsResponse
• StripeAccountResponse
• StripeCustomerSecretResponse
• TagBase
• TagDb
• Tax
• TicketResponse
• TicketsResponse
• TouchMeta200Response
• UpdateField200Response
• UpdateFile200Response
• UpdateMeta200Response
• UpdateNote200Response
• UpdateProjectCredentialRequest
• UpdateReview
• User
• UserConfirmation
• UserEmail
• UserFlags
• UserLogin
• UserLoginReturn
• UserPasswordReset
• UserPasswordResetConfirmation
• UserResponse
• UserSignup
• UserSignupReturn
• UserTokenReturn
• UserValidations
• ValidationError
• Validations

To get access to the crate's generated documentation, use:

cargo doc --open

Author

support@ehelply.com