README

eHelply SDK for SuperStack Services

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

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new OpenAPI\Client\Api\AppointmentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$appointment_uuid = 'appointment_uuid_example'; // string
$entity_uuid = 'entity_uuid_example'; // string
$x_access_token = 'x_access_token_example'; // string
$x_secret_token = 'x_secret_token_example'; // string
$authorization = 'authorization_example'; // string
$ehelply_active_participant = 'ehelply_active_participant_example'; // string
$ehelply_project = 'ehelply_project_example'; // string
$ehelply_data = 'ehelply_data_example'; // string

try {
    $result = $apiInstance->addEntityToAppointment($appointment_uuid, $entity_uuid, $x_access_token, $x_secret_token, $authorization, $ehelply_active_participant, $ehelply_project, $ehelply_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppointmentsApi->addEntityToAppointment: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class	Method	HTTP request	Description
AppointmentsApi	addEntityToAppointment	POST /appointments/appointments/{appointment_uuid}/entities/{entity_uuid}	Addentitytoappointment
AppointmentsApi	createAppointment	POST /appointments/appointments	Createappointment
AppointmentsApi	deleteAppointment	DELETE /appointments/appointments/{appointment_uuid}	Deleteappointment
AppointmentsApi	detachEntityFromAppointment	DELETE /appointments/appointments/{appointment_uuid}/entities/{entity_uuid}	Removeentityfromappointment
AppointmentsApi	getAppointment	GET /appointments/appointments/{appointment_uuid}	Getappointment
AppointmentsApi	searchAppointment	GET /appointments/appointments	Searchappointments
AppointmentsApi	searchAppointmentEntities	GET /appointments/appointments/{appointment_uuid}/entities	Searchappointmententities
AppointmentsApi	searchEntityAppointments	GET /appointments/appointments/entities/{entity_uuid}/appointments	Getentityappointments
AppointmentsApi	updateAppointment	PUT /appointments/appointments/{appointment_uuid}	Updateappointment
BillingApi	createBillingAccount	POST /sam/billing/projects/{project_uuid}/accounts	Createbillingaccount
BillingApi	getClientSecret	GET /sam/billing/projects/{project_uuid}/secrets	Getclientsecret
BillingApi	hasPayment	GET /sam/billing/projects/{project_uuid}/payment-methods-exist	Haspayment
BillingApi	listPaymentMethods	GET /sam/billing/projects/{project_uuid}/payment-methods	Listpaymentmethods
BillingApi	processPayment	POST /sam/billing/projects/{project_uuid}/payments	Processpayment
BillingApi	reconcilePaymentMethod	GET /sam/billing/projects/{project_uuid}/payment-methods-reconciliation	Reconcilepaymentmethod
BillingApi	removePaymentMethod	DELETE /sam/billing/projects/{project_uuid}/payment-methods	Removepaymentmethod
CatalogsApi	attachProductToCatalog	POST /products/catalogs/{catalog_uuid}/products/{product_uuid}	Addproducttocatalog
CatalogsApi	createCatalog	POST /products/catalogs	Createcatalog
CatalogsApi	deleteCatalog	DELETE /products/catalogs/{catalog_uuid}	Deletecatalog
CatalogsApi	detachProductFromCatalog	DELETE /products/catalogs/{catalog_uuid}/products/{product_uuid}	Removeproductfromcatalog
CatalogsApi	getCatalog	GET /products/catalogs/{catalog_uuid}	Getcatalog
CatalogsApi	searchCatalogProducts	GET /products/catalogs/{catalog_uuid}/products	Searchcatalogproducts
CatalogsApi	searchCatalogs	GET /products/catalogs	Searchcatalogs
CatalogsApi	updateCatalog	PUT /products/catalogs/{catalog_uuid}	Updatecatalog
CategoryApi	createCategoryPlacesCategoriesPost	POST /places/categories	Create Category
CategoryApi	deleteCategoryPlacesCategoriesCategoryUuidDelete	DELETE /places/categories/{category_uuid}	Delete Category
CategoryApi	getCategoryPlacesCategoriesCategoryUuidGet	GET /places/categories/{category_uuid}	Get Category
CategoryApi	searchCategoriesPlacesCategoriesGet	GET /places/categories	Search Categories
CategoryApi	updateCategoryPlacesCategoriesCategoryUuidPut	PUT /places/categories/{category_uuid}	Update Category
CompaniesApi	createCompanyPlacesCompaniesPost	POST /places/companies	Create Company
CompaniesApi	deletePlacePlacesCompaniesCompanyUuidDelete	DELETE /places/companies/{company_uuid}	Delete Place
CompaniesApi	getCompanyPlacesCompaniesCompanyUuidGet	GET /places/companies/{company_uuid}	Get Company
CompaniesApi	searchCompaniesPlacesCompaniesGet	GET /places/companies	Search Companies
CompaniesApi	updateCompanyPlacesCompaniesCompanyUuidPut	PUT /places/companies/{company_uuid}	Update Company
ContentApi	createFile	POST /files/files	Createfile
ContentApi	deleteFile	DELETE /files/files/{file_uuid}	Deletefile
ContentApi	getFile	GET /files/files/{file_uuid}	Getfile
ContentApi	updateFile	PUT /files/files/{file_uuid}	Updatefile
FactsApi	deleteFact	POST /sam/facts/facts/{fact_name}	Deletefact
FactsApi	deleteFact_0	POST /sam/facts/facts/{fact_name}	Deletefact
FactsApi	getFact	GET /sam/facts/facts/{fact_name}	Getfact
FactsApi	getFact_0	GET /sam/facts/facts/{fact_name}	Getfact
FactsApi	getFacts	GET /sam/facts/facts	Getfacts
FactsApi	getFacts_0	GET /sam/facts/facts	Getfacts
FactsApi	saveFact	POST /sam/facts/facts	Savefact
FactsApi	saveFact_0	POST /sam/facts/facts	Savefact
FieldsApi	createField	POST /fields/fields	Createfield
FieldsApi	deleteField	DELETE /fields/fields/{field_uuid}	Deletefield
FieldsApi	getField	GET /fields/fields/{field_uuid}	Getfield
FieldsApi	updateField	PUT /fields/fields/{field_uuid}	Updatefield
LoggingApi	getSubjectLogs	GET /sam/logging/logs/services/{service}/subjects/{subject}	Getsubjectlogs
MetaApi	createMeta	POST /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Createmeta
MetaApi	createSlug	POST /meta/slug	Createslug
MetaApi	deleteMeta	DELETE /meta/meta/{meta_uuid}	Deletemeta
MetaApi	deleteMetaFromParts	DELETE /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Deletemetafromparts
MetaApi	getMeta	GET /meta/meta/{meta_uuid}	Getmeta
MetaApi	getMetaFromParts	GET /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Getmetafromparts
MetaApi	touchMeta	POST /meta/meta/{meta_uuid}/touch	Touchmeta
MetaApi	updateMeta	PUT /meta/meta/{meta_uuid}	Updatemeta
MetaApi	updateMetaFromParts	PUT /meta/meta/service/{service}/type/{type_name}/entity/{entity_uuid}	Updatemetafromparts
MonitorApi	acknowledgeAlarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/acknowledge	Acknowledgealarm
MonitorApi	assignAlarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/assign	Assignalarm
MonitorApi	attachAlarmNote	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/note	Attachalarmnote
MonitorApi	attachAlarmTicket	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/ticket	Attachalarmticket
MonitorApi	clearAlarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms/{alarm_uuid}/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/{alarm_uuid}	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/{alarm_uuid}/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/{alarm_uuid}/terminate	Terminatealarm
MonitorApi	triggerAlarm	POST /sam/monitor/services/{service}/stages/{stage}/alarms	Triggeralarm
NotesApi	createNote	POST /notes/notes	Createnote
NotesApi	deleteNote	DELETE /notes/notes/{note_id}	Deletenote
NotesApi	getNote	GET /notes/notes/{note_id}	Getnote
NotesApi	updateNote	PUT /notes/notes/{note_id}	Updatenote
PlacesApi	advancedSearchPlaces	GET /places/search/places/string	Advancedsearchplaces
PlacesApi	createPlacePlacesPlacesPost	POST /places/places	Create Place
PlacesApi	deletePlace	DELETE /places/places/{place_uuid}	Deleteplace
PlacesApi	forwardGeocodingPlacesGeocodingForwardGet	GET /places/geocoding/forward	Forward Geocoding
PlacesApi	getPlace	GET /places/places/{place_uuid}	Getplace
PlacesApi	reverseGeocodingPlacesGeocodingReverseGet	GET /places/geocoding/reverse	Reverse Geocoding
PlacesApi	searchPlaces	GET /places/places	Searchplaces
PlacesApi	updatePlace	PUT /places/places/{place_uuid}	Updateplace
ProductsApi	createProduct	POST /products/products	Createproduct
ProductsApi	deleteProduct	DELETE /products/products/{product_uuid}	Deleteproduct
ProductsApi	getProduct	GET /products/products/{product_uuid}	Getproduct
ProductsApi	searchProductCatalog	GET /products/products/{product_uuid}/catalogs	Searchproductcatalog
ProductsApi	searchProducts	GET /products/products	Searchproducts
ProductsApi	updateProduct	PUT /products/products/{product_uuid}	Updateproduct
ProjectsApi	addMemberToProject	POST /sam/projects/projects/{project_uuid}/members/{entity_uuid}	Addmembertoproject
ProjectsApi	archiveProject	DELETE /sam/projects/projects/{project_uuid}	Archiveproject
ProjectsApi	createProject	POST /sam/projects/projects	Createproject
ProjectsApi	createProjectCredential	POST /sam/projects/projects/{project_uuid}/credentials	Createprojectcredential
ProjectsApi	createProjectCredit	POST /sam/projects/projects/{project_uuid}/credits	Createprojectcredit
ProjectsApi	createProjectInvoice	POST /sam/projects/projects/{project_uuid}/invoices	Createprojectinvoice
ProjectsApi	createProjectKey	POST /sam/projects/projects/{project_uuid}/keys	Createprojectkey
ProjectsApi	createUsageType	POST /sam/projects/usage/types	Createusagetype
ProjectsApi	deleteProjectCredential	DELETE /sam/projects/projects/{project_uuid}/credentials/{service_name}	Deleteprojectcredential
ProjectsApi	deleteProjectKey	DELETE /sam/projects/projects/{project_uuid}/keys	Deleteprojectkey
ProjectsApi	deleteUsageType	DELETE /sam/projects/usage/types/{usage_type_key}	Deleteusagetype
ProjectsApi	getAllProjectCredentials	GET /sam/projects/projects/{project_uuid}/credentials	Getallprojectcredentials
ProjectsApi	getAllProjectCredits	GET /sam/projects/projects/{project_uuid}/credits	Getallprojectcredits
ProjectsApi	getAllProjectUsage	GET /sam/projects/projects/{project_uuid}/usage	Getallprojectusage
ProjectsApi	getMemberProjects	GET /sam/projects/members/{entity_uuid}/projects	Getmemberprojects
ProjectsApi	getProject	GET /sam/projects/projects/{project_uuid}	Getproject
ProjectsApi	getProjectCreditTransactions	GET /sam/projects/projects/{project_uuid}/credits/{credit_uuid}/transactions	Getprojectcredittransactions
ProjectsApi	getProjectInvoice	GET /sam/projects/projects/{project_uuid}/invoices	Getprojectinvoice
ProjectsApi	getProjectInvoiceHistory	GET /sam/projects/projects/{project_uuid}/invoices/history	Getprojectinvoicehistory
ProjectsApi	getProjectKeys	GET /sam/projects/projects/{project_uuid}/keys	Getprojectkeys
ProjectsApi	getProjectMembers	GET /sam/projects/projects/{project_uuid}/members	Getprojectmembers
ProjectsApi	getSpecificProjectCredential	GET /sam/projects/projects/{project_uuid}/credentials/{service_name}	Getspecificprojectcredential
ProjectsApi	getSpecificProjectUsage	GET /sam/projects/projects/{project_uuid}/usage/{usage_type_key}	Getspecificprojectusage
ProjectsApi	getUsageType	GET /sam/projects/usage/types/{usage_type_key}	Getusagetype
ProjectsApi	removeMemberFromProject	DELETE /sam/projects/projects/{project_uuid}/members/{entity_uuid}	Removememberfromproject
ProjectsApi	revokeProjectCredit	DELETE /sam/projects/projects/{project_uuid}/credits/{credit_uuid}	Revokeprojectcredit
ProjectsApi	searchProjects	GET /sam/projects/projects	Searchprojects
ProjectsApi	searchUsageType	GET /sam/projects/usage/types	Searchusagetype
ProjectsApi	updateProject	PUT /sam/projects/projects/{project_uuid}	Updateproject
ProjectsApi	updateProjectCredential	PUT /sam/projects/projects/{project_uuid}/credentials/{service_name}	Updateprojectcredential
ProjectsApi	updateUsageType	PUT /sam/projects/usage/types/{usage_type_key}	Updateusagetype
ReviewsApi	createReview	POST /products/reviews/types/{entity_type}/entities/{entity_uuid}	Create
ReviewsApi	deleteReview	DELETE /products/reviews/types/{entity_type}/entities/{entity_uuid}/reviews/{review_uuid}	Deletereview
ReviewsApi	getReview	GET /products/reviews/types/{entity_type}/entities/{entity_uuid}/reviews/{review_uuid}	Getreview
ReviewsApi	searchReviews	GET /products/reviews/types/{entity_type}/entities/{entity_uuid}	Searchreview
ReviewsApi	updateReview	PUT /products/reviews/types/{entity_type}/entities/{entity_uuid}/reviews/{review_uuid}	Updatereview
SecurityApi	createEncryptionKey	POST /sam/security/encryption/categories/{category}/keys	Createencryptionkey
SecurityApi	createKey	POST /sam/security/keys	Createkey
SecurityApi	deleteKey	DELETE /sam/security/keys/{key_uuid}	Deletekey
SecurityApi	generateToken	POST /sam/security/tokens	Generatetoken
SecurityApi	getEncryptionKey	GET /sam/security/encryption/categories/{category}/keys	Getencryptionkey
SecurityApi	getKey	GET /sam/security/keys/{key_uuid}	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/{staff_uuid}	Deletestaff
StaffApi	getStaff	GET /places/staff/{staff_uuid}	Getstaff
StaffApi	searchStaff	GET /places/staff	Searchstaff
StaffApi	updateStaff	PUT /places/staff/{staff_uuid}	Updatestaff
SupportApi	createContact	POST /sam/support/contact	Createcontact
SupportApi	createTicket	POST /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets	Createticket
SupportApi	listTickets	GET /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets	Listtickets
SupportApi	updateTicket	PUT /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets/{ticket_id}	Updateticket
SupportApi	viewTicket	GET /sam/support/projects/{project_uuid}/members/{member_uuid}/tickets/{ticket_id}	Viewticket
TagApi	deleteTag	DELETE /places/tags/{tag_uuid}	Deletetag
TagsApi	createTag	POST /places/tags	Createtag
TagsApi	getTag	GET /places/tags/{tag_uuid}	Gettag
TagsApi	searchTag	GET /places/tags	Searchtag
TagsApi	updateTag	PUT /places/tags/{tag_uuid}	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/{participant_id}	Deleteparticipant
UsersApi	deleteUser	DELETE /sam/users/{user_id}	Deleteuser
UsersApi	getParticipant	GET /sam/users/participants/{participant_id}	Getparticipant
UsersApi	getUser	GET /sam/users/{user_id}	Getuser
UsersApi	login	POST /sam/users/auth/login	Login
UsersApi	refreshToken	POST /sam/users/auth/{app_client}/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/{participant_id}	Updateparticipant
UsersApi	updateUser	PUT /sam/users/{user_id}	Updateuser
UsersApi	userValidations	POST /sam/users/validations/{field}	Uservalidations

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@ehelply.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.1.118
- Package version: 1.1.118
Build package: org.openapitools.codegen.languages.PhpClientCodegen

ehelply / superstack-sdk

Maintainers

Details