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.

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 | addentitytoappointment | POST /appointments/appointments/{appointmentuuid}/entities/{entityuuid} | Addentitytoappointment *AppointmentsApi* | createappointment | POST /appointments/appointments | Createappointment AppointmentsApi | deleteappointment | DELETE /appointments/appointments/{appointmentuuid} | Deleteappointment AppointmentsApi | detachentityfromappointment | DELETE /appointments/appointments/{appointmentuuid}/entities/{entityuuid} | Removeentityfromappointment *AppointmentsApi* | getappointment | GET /appointments/appointments/{appointmentuuid} | Getappointment *AppointmentsApi* | searchappointment | GET /appointments/appointments | Searchappointments AppointmentsApi | searchappointmententities | GET /appointments/appointments/{appointmentuuid}/entities | Searchappointmententities *AppointmentsApi* | searchentityappointments | GET /appointments/appointments/entities/{entityuuid}/appointments | Getentityappointments AppointmentsApi | updateappointment | PUT /appointments/appointments/{appointmentuuid} | Updateappointment BillingApi | createbillingaccount | POST /sam/billing/projects/{projectuuid}/accounts | Createbillingaccount *BillingApi* | getclientsecret | GET /sam/billing/projects/{projectuuid}/secrets | Getclientsecret BillingApi | haspayment | GET /sam/billing/projects/{projectuuid}/payment-methods-exist | Haspayment BillingApi | listpaymentmethods | GET /sam/billing/projects/{projectuuid}/payment-methods | Listpaymentmethods *BillingApi* | processpayment | POST /sam/billing/projects/{projectuuid}/payments | Processpayment *BillingApi* | reconcilepaymentmethod | GET /sam/billing/projects/{projectuuid}/payment-methods-reconciliation | Reconcilepaymentmethod BillingApi | removepaymentmethod | DELETE /sam/billing/projects/{projectuuid}/payment-methods | Removepaymentmethod *CatalogsApi* | attachproducttocatalog | POST /products/catalogs/{cataloguuid}/products/{productuuid} | Addproducttocatalog CatalogsApi | createcatalog | POST /products/catalogs | Createcatalog *CatalogsApi* | deletecatalog | DELETE /products/catalogs/{cataloguuid} | Deletecatalog *CatalogsApi* | detachproductfromcatalog | DELETE /products/catalogs/{cataloguuid}/products/{productuuid} | Removeproductfromcatalog CatalogsApi | getcatalog | GET /products/catalogs/{cataloguuid} | Getcatalog CatalogsApi | searchcatalogproducts | GET /products/catalogs/{cataloguuid}/products | Searchcatalogproducts *CatalogsApi* | searchcatalogs | GET /products/catalogs | Searchcatalogs CatalogsApi | updatecatalog | PUT /products/catalogs/{cataloguuid} | Updatecatalog CategoryApi | createcategoryplacescategoriespost | POST /places/categories | Create Category CategoryApi | deletecategoryplacescategoriescategoryuuiddelete | DELETE /places/categories/{categoryuuid} | Delete Category *CategoryApi* | getcategoryplacescategoriescategoryuuidget | GET /places/categories/{categoryuuid} | Get Category CategoryApi | searchcategoriesplacescategoriesget | GET /places/categories | Search Categories CategoryApi | updatecategoryplacescategoriescategoryuuidput | PUT /places/categories/{categoryuuid} | Update Category *CompaniesApi* | createcompanyplacescompaniespost | POST /places/companies | Create Company *CompaniesApi* | deleteplaceplacescompaniescompanyuuiddelete | DELETE /places/companies/{companyuuid} | Delete Place CompaniesApi | getcompanyplacescompaniescompanyuuidget | GET /places/companies/{companyuuid} | Get Company *CompaniesApi* | searchcompaniesplacescompaniesget | GET /places/companies | Search Companies *CompaniesApi* | updatecompanyplacescompaniescompanyuuidput | PUT /places/companies/{companyuuid} | Update Company ContentApi | createfile | POST /files/files | Createfile *ContentApi* | deletefile | DELETE /files/files/{fileuuid} | Deletefile *ContentApi* | getfile | GET /files/files/{fileuuid} | Getfile *ContentApi* | updatefile | PUT /files/files/{fileuuid} | Updatefile *FactsApi* | deletefact | POST /sam/facts/facts/{factname} | Deletefact *FactsApi* | deletefact0 | POST /sam/facts/facts/{factname} | Deletefact FactsApi | getfact | GET /sam/facts/facts/{factname} | Getfact FactsApi | getfact0 | GET /sam/facts/facts/{factname} | Getfact *FactsApi* | getfacts | GET /sam/facts/facts | Getfacts FactsApi | getfacts0 | GET /sam/facts/facts | Getfacts FactsApi | savefact | POST /sam/facts/facts | Savefact *FactsApi* | savefact0 | POST /sam/facts/facts | Savefact *FieldsApi* | createfield | POST /fields/fields | Createfield FieldsApi | deletefield | DELETE /fields/fields/{fielduuid} | Deletefield FieldsApi | getfield | GET /fields/fields/{fielduuid} | Getfield FieldsApi | updatefield | PUT /fields/fields/{fielduuid} | Updatefield LoggingApi | getsubjectlogs | GET /sam/logging/logs/services/{service}/subjects/{subject} | Getsubjectlogs MetaApi | createmeta | POST /meta/meta/service/{service}/type/{typename}/entity/{entityuuid} | Createmeta *MetaApi* | createslug | POST /meta/slug | Createslug MetaApi | deletemeta | DELETE /meta/meta/{metauuid} | Deletemeta MetaApi | deletemetafromparts | DELETE /meta/meta/service/{service}/type/{typename}/entity/{entityuuid} | Deletemetafromparts *MetaApi* | getmeta | GET /meta/meta/{metauuid} | Getmeta *MetaApi* | getmetafromparts | GET /meta/meta/service/{service}/type/{typename}/entity/{entityuuid} | Getmetafromparts MetaApi | touchmeta | POST /meta/meta/{metauuid}/touch | Touchmeta MetaApi | updatemeta | PUT /meta/meta/{metauuid} | Updatemeta MetaApi | updatemetafromparts | PUT /meta/meta/service/{service}/type/{typename}/entity/{entityuuid} | Updatemetafromparts *MonitorApi* | acknowledgealarm | POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid}/acknowledge | Acknowledgealarm *MonitorApi* | assignalarm | POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid}/assign | Assignalarm *MonitorApi* | attachalarmnote | POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid}/note | Attachalarmnote MonitorApi | attachalarmticket | POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid}/ticket | Attachalarmticket *MonitorApi* | clearalarm | POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid}/clear | Clearalarm *MonitorApi* | deleteservicesuperstackmeta | DELETE /sam/monitor/services/{service}/superstack | Deleteservicesuperstackmeta *MonitorApi* | getservice | GET /sam/monitor/services/{service} | Getservice MonitorApi | getservicealarm | GET /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid} | Getservicealarm *MonitorApi* | getservicealarms | GET /sam/monitor/services/{service}/stages/{stage}/alarms | Getservicealarms *MonitorApi* | getserviceheartbeat | GET /sam/monitor/services/{service}/stages/{stage}/heartbeats | Getserviceheartbeat *MonitorApi* | getservicekpis | GET /sam/monitor/services/{service}/kpis | Getservicekpis *MonitorApi* | getservicespec | GET /sam/monitor/services/{service}/specs/{spec} | Getservicespec *MonitorApi* | getservicespecs | GET /sam/monitor/services/{service}/specs | Getservicespecs *MonitorApi* | getservicevitals | GET /sam/monitor/services/{service}/stages/{stage}/vitals | Getservicevitals *MonitorApi* | getservices | GET /sam/monitor/services | Getservices MonitorApi | getserviceswithspecs | GET /sam/monitor/specs/services | Getserviceswithspecs *MonitorApi* | getsupertackservices | GET /sam/monitor/superstack-services | Getsupertackservices *MonitorApi* | hideservice | POST /sam/monitor/services/{service}/stages/{stage}/hide | Hideservice MonitorApi | ignorealarm | POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid}/ignore | Ignorealarm MonitorApi | registerservice | POST /sam/monitor/services | Registerservice *MonitorApi* | saveservicesuperstackmeta | POST /sam/monitor/services/{service}/superstack | Saveservicesuperstackmeta *MonitorApi* | searchalarms | GET /sam/monitor/services/{service}/alarms | Searchalarms MonitorApi | showservice | POST /sam/monitor/services/{service}/stages/{stage}/show | Showservice *MonitorApi* | terminatealarm | POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarmuuid}/terminate | Terminatealarm *MonitorApi* | triggeralarm | POST /sam/monitor/services/{service}/stages/{stage}/alarms | Triggeralarm NotesApi | createnote | POST /notes/notes | Createnote *NotesApi* | deletenote | DELETE /notes/notes/{noteid} | Deletenote *NotesApi* | getnote | GET /notes/notes/{noteid} | Getnote *NotesApi* | updatenote | PUT /notes/notes/{noteid} | Updatenote *PlacesApi* | advancedsearchplaces | GET /places/search/places/string | Advancedsearchplaces *PlacesApi* | createplaceplacesplacespost | POST /places/places | Create Place *PlacesApi* | deleteplace | DELETE /places/places/{placeuuid} | Deleteplace *PlacesApi* | forwardgeocodingplacesgeocodingforwardget | GET /places/geocoding/forward | Forward Geocoding PlacesApi | getplace | GET /places/places/{placeuuid} | Getplace PlacesApi | reversegeocodingplacesgeocodingreverseget | GET /places/geocoding/reverse | Reverse Geocoding *PlacesApi* | searchplaces | GET /places/places | Searchplaces PlacesApi | updateplace | PUT /places/places/{placeuuid} | Updateplace ProductsApi | createproduct | POST /products/products | Createproduct *ProductsApi* | deleteproduct | DELETE /products/products/{productuuid} | Deleteproduct *ProductsApi* | getproduct | GET /products/products/{productuuid} | Getproduct *ProductsApi* | searchproductcatalog | GET /products/products/{productuuid}/catalogs | Searchproductcatalog ProductsApi | searchproducts | GET /products/products | Searchproducts *ProductsApi* | updateproduct | PUT /products/products/{productuuid} | Updateproduct *ProjectsApi* | addmembertoproject | POST /sam/projects/projects/{projectuuid}/members/{entityuuid} | Addmembertoproject ProjectsApi | archiveproject | DELETE /sam/projects/projects/{projectuuid} | Archiveproject ProjectsApi | createproject | POST /sam/projects/projects | Createproject *ProjectsApi* | createprojectcredential | POST /sam/projects/projects/{projectuuid}/credentials | Createprojectcredential ProjectsApi | createprojectcredit | POST /sam/projects/projects/{projectuuid}/credits | Createprojectcredit *ProjectsApi* | createprojectinvoice | POST /sam/projects/projects/{projectuuid}/invoices | Createprojectinvoice ProjectsApi | createprojectkey | POST /sam/projects/projects/{projectuuid}/keys | Createprojectkey *ProjectsApi* | createusagetype | POST /sam/projects/usage/types | Createusagetype *ProjectsApi* | deleteprojectcredential | DELETE /sam/projects/projects/{projectuuid}/credentials/{servicename} | Deleteprojectcredential *ProjectsApi* | deleteprojectkey | DELETE /sam/projects/projects/{projectuuid}/keys | Deleteprojectkey ProjectsApi | deleteusagetype | DELETE /sam/projects/usage/types/{usagetypekey} | Deleteusagetype ProjectsApi | getallprojectcredentials | GET /sam/projects/projects/{projectuuid}/credentials | Getallprojectcredentials ProjectsApi | getallprojectcredits | GET /sam/projects/projects/{projectuuid}/credits | Getallprojectcredits ProjectsApi | getallprojectusage | GET /sam/projects/projects/{projectuuid}/usage | Getallprojectusage ProjectsApi | getmemberprojects | GET /sam/projects/members/{entityuuid}/projects | Getmemberprojects *ProjectsApi* | getproject | GET /sam/projects/projects/{projectuuid} | Getproject *ProjectsApi* | getprojectcredittransactions | GET /sam/projects/projects/{projectuuid}/credits/{credituuid}/transactions | Getprojectcredittransactions ProjectsApi | getprojectinvoice | GET /sam/projects/projects/{projectuuid}/invoices | Getprojectinvoice *ProjectsApi* | getprojectinvoicehistory | GET /sam/projects/projects/{projectuuid}/invoices/history | Getprojectinvoicehistory *ProjectsApi* | getprojectkeys | GET /sam/projects/projects/{projectuuid}/keys | Getprojectkeys ProjectsApi | getprojectmembers | GET /sam/projects/projects/{projectuuid}/members | Getprojectmembers *ProjectsApi* | getspecificprojectcredential | GET /sam/projects/projects/{projectuuid}/credentials/{servicename} | Getspecificprojectcredential ProjectsApi | getspecificprojectusage | GET /sam/projects/projects/{projectuuid}/usage/{usagetypekey} | Getspecificprojectusage ProjectsApi | getusagetype | GET /sam/projects/usage/types/{usagetypekey} | Getusagetype ProjectsApi | removememberfromproject | DELETE /sam/projects/projects/{projectuuid}/members/{entityuuid} | Removememberfromproject *ProjectsApi* | revokeprojectcredit | DELETE /sam/projects/projects/{projectuuid}/credits/{credituuid} | Revokeprojectcredit *ProjectsApi* | searchprojects | GET /sam/projects/projects | Searchprojects ProjectsApi | searchusagetype | GET /sam/projects/usage/types | Searchusagetype ProjectsApi | updateproject | PUT /sam/projects/projects/{projectuuid} | Updateproject ProjectsApi | updateprojectcredential | PUT /sam/projects/projects/{projectuuid}/credentials/{servicename} | Updateprojectcredential ProjectsApi | updateusagetype | PUT /sam/projects/usage/types/{usagetypekey} | Updateusagetype ReviewsApi | createreview | POST /products/reviews/types/{entitytype}/entities/{entityuuid} | Create *ReviewsApi* | deletereview | DELETE /products/reviews/types/{entitytype}/entities/{entityuuid}/reviews/{reviewuuid} | Deletereview *ReviewsApi* | getreview | GET /products/reviews/types/{entitytype}/entities/{entityuuid}/reviews/{reviewuuid} | Getreview *ReviewsApi* | searchreviews | GET /products/reviews/types/{entitytype}/entities/{entityuuid} | Searchreview ReviewsApi | updatereview | PUT /products/reviews/types/{entitytype}/entities/{entityuuid}/reviews/{reviewuuid} | Updatereview SecurityApi | createencryptionkey | POST /sam/security/encryption/categories/{category}/keys | Createencryptionkey SecurityApi | createkey | POST /sam/security/keys | Createkey *SecurityApi* | deletekey | DELETE /sam/security/keys/{keyuuid} | Deletekey *SecurityApi* | generatetoken | POST /sam/security/tokens | Generatetoken SecurityApi | getencryptionkey | GET /sam/security/encryption/categories/{category}/keys | Getencryptionkey SecurityApi | getkey | GET /sam/security/keys/{keyuuid} | Getkey SecurityApi | searchkeys | GET /sam/security/keys | Searchkeys *SecurityApi* | verifykey | POST /sam/security/keys/verify | Verifykey StaffApi | createstaff | POST /places/staff | Createstaff *StaffApi* | deletestaff | DELETE /places/staff/{staffuuid} | Deletestaff *StaffApi* | getstaff | GET /places/staff/{staffuuid} | Getstaff *StaffApi* | searchstaff | GET /places/staff | Searchstaff StaffApi | updatestaff | PUT /places/staff/{staffuuid} | Updatestaff SupportApi | createcontact | POST /sam/support/contact | Createcontact *SupportApi* | createticket | POST /sam/support/projects/{projectuuid}/members/{memberuuid}/tickets | Createticket SupportApi | listtickets | GET /sam/support/projects/{projectuuid}/members/{memberuuid}/tickets | Listtickets *SupportApi* | updateticket | PUT /sam/support/projects/{projectuuid}/members/{memberuuid}/tickets/{ticketid} | Updateticket *SupportApi* | viewticket | GET /sam/support/projects/{projectuuid}/members/{memberuuid}/tickets/{ticketid} | Viewticket *TagApi* | deletetag | DELETE /places/tags/{taguuid} | Deletetag *TagsApi* | createtag | POST /places/tags | Createtag TagsApi | gettag | GET /places/tags/{taguuid} | Gettag TagsApi | searchtag | GET /places/tags | Searchtag *TagsApi* | updatetag | PUT /places/tags/{taguuid} | Updatetag *UsersApi* | confirmsignup | POST /sam/users/auth/signup/confirm | Confirmsignup UsersApi | createparticipant | POST /sam/users/participants | Createparticipant *UsersApi* | createuser | POST /sam/users | Createuser UsersApi | deleteparticipant | DELETE /sam/users/participants/{participantid} | Deleteparticipant UsersApi | deleteuser | DELETE /sam/users/{userid} | Deleteuser UsersApi | getparticipant | GET /sam/users/participants/{participantid} | Getparticipant UsersApi | getuser | GET /sam/users/{userid} | Getuser UsersApi | login | POST /sam/users/auth/login | Login UsersApi | refreshtoken | POST /sam/users/auth/{appclient}/refresh-token | Refreshtoken UsersApi | resetpassword | POST /sam/users/auth/password/reset | Resetpassword *UsersApi* | resetpasswordconfirmation | POST /sam/users/auth/password/reset/confirm | Resetpasswordconfirmation *UsersApi* | searchparticipants | GET /sam/users/participants | Searchparticipants UsersApi | signup | POST /sam/users/auth/signup | Signup UsersApi | updateparticipant | PUT /sam/users/participants/{participantid} | Updateparticipant UsersApi | updateuser | PUT /sam/users/{userid} | Updateuser UsersApi | user_validations | POST /sam/users/validations/{field} | Uservalidations

Documentation For Models

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

cargo doc --open

Author

support@ehelply.com