Skip to content

E-goi/sdk-php

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
docs
docs
 
 
lib
lib
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.php-cs-fixer.dist.php
.php-cs-fixer.dist.php
 
 
.php_cs
.php_cs
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

E-goi

Get started quickly with E-goi with our integration tools. Our SDK is a modern open source library that makes it easy to integrate your application with E-goi services.

Almost anything you can do in E-goi, you can do with our API.

The API describes each available method. Learn about parameters, errors, and how to format your requests. That means you can easily call on E-goi actions for your integration. API Full documentation at https://developers.e-goi.com/api/v3/

Note: This repository is currently in Release Candidate stage. Use with caution in production environments.

Feel free to fork this repository and adapt it to your needs. Contributions and improvements are always welcome!

Changelog

1.1.10RC1

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/e-goi/sdk-php.git"
    }
  ],
  "require": {
    "e-goi/sdk-php": "*@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');



// Configure API key authorization: Apikey
$config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');


$apiInstance = new EgoiClient\Api\AdvancedReportsApi(
    // 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(),
    $config
);
$generate_by_model_report = new \EgoiClient\EgoiModel\GenerateByModelReport(); // \EgoiClient\EgoiModel\GenerateByModelReport | Parameters for the report by model Id

try {
    $result = $apiInstance->generateByModelReport($generate_by_model_report);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdvancedReportsApi->generateByModelReport: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.egoiapp.com

Class Method HTTP request Description
AdvancedReportsApi generateByModelReport POST /reports/advanced/model Generate report by model
AdvancedReportsApi generateContactActivityReport POST /reports/advanced/contact-activity Generate contact activity report
AdvancedReportsApi generateEmailBouncesReport POST /reports/advanced/email-bounces Generate email bounces report
AdvancedReportsApi generateEmailClicksByContactReport POST /reports/advanced/email-clicks-by-contact Generate email clicks by contact report
AdvancedReportsApi generateEmailClicksByUrlReport POST /reports/advanced/email-clicks-by-url Generate email clicks by URL report
AdvancedReportsApi generateEmailEventsReport POST /reports/advanced/email-events Generate email events report
AdvancedReportsApi generateEmailUnsubscriptionsReport POST /reports/advanced/email-unsubscriptions Generate email unsubscriptions report
AdvancedReportsApi generateFormAnswersReport POST /reports/advanced/form-answers Generate form answers report
AdvancedReportsApi generateSendsReport POST /reports/advanced/sends Generate sends report
AdvancedReportsApi generateSmsBouncesReport POST /reports/advanced/sms-bounces Generate SMS bounces report
AdvancedReportsApi generateSmsEventsReport POST /reports/advanced/sms-events Generate SMS events report
AdvancedReportsApi generateSubscriptionsReport POST /reports/advanced/subscriptions Generate subscriptions report
AdvancedReportsApi generateUnsubscriptionsReport POST /reports/advanced/unsubscriptions Generate unsubscriptions report
AdvancedReportsApi getAllAdvancedReports GET /reports/advanced Get all advanced reports
AdvancedReportsApi getAllAdvancedReportsModels GET /reports/advanced/models Get all advanced reports models
AutomationsApi deleteAutomation DELETE /automations/{automation_id} Remove automation
AutomationsApi getAllActions GET /automations/{automation_id}/actions Get all actions from given automation
AutomationsApi getAllAutomations GET /automations Get all automations
CNamesApi createCName POST /cnames Create cname
CNamesApi getAllCNames GET /cnames Get All CNames
CampaignGroupsApi createCampaignGroup POST /campaign-groups Create new campaign group
CampaignGroupsApi deleteCampaignGroup DELETE /campaign-groups/{group_id} Remove Campaign Group
CampaignGroupsApi getAllCampaignGroups GET /campaign-groups Get all campaign groups
CampaignGroupsApi updateCampaignGroup PUT /campaign-groups/{group_id} Update a specific campaign group
CampaignsApi deleteCampaigns DELETE /campaigns/{campaign_hash} Remove Campaign
CampaignsApi getAllCampaigns GET /campaigns Get all Campaigns
ConnectedSitesApi createConnectedSites POST /connectedsites Creates a Connected Site
ConnectedSitesApi deleteConnectedSites DELETE /connectedsites/{domain} Deletes a Connected Site
ConnectedSitesApi getAllConnectedSites GET /connectedsites Get all Connected Sites
ConnectedSitesApi getConnectedSites GET /connectedsites/{domain} Get a Connected Site
ContactsApi actionActivateContacts POST /lists/{list_id}/contacts/actions/activate Activate contacts
ContactsApi actionAttachTag POST /lists/{list_id}/contacts/actions/attach-tag Attach tag to contact
ContactsApi actionDeactivateContacts POST /lists/{list_id}/contacts/actions/deactivate Deactivate contacts
ContactsApi actionDetachTag POST /lists/{list_id}/contacts/actions/detach-tag Detach tag to contact
ContactsApi actionExportContacts POST /lists/{list_id}/contacts/actions/export Exports a list of contacts
ContactsApi actionForgetContacts POST /lists/{list_id}/contacts/actions/forget Forget contacts
ContactsApi actionImportBulk POST /lists/{list_id}/contacts/actions/import-bulk Import collection of contacts
ContactsApi actionStartAutomation POST /lists/{list_id}/contacts/actions/start-automation Start automation
ContactsApi actionUnsubscribeContact POST /lists/{list_id}/contacts/actions/unsubscribe Unsubscribes contacts
ContactsApi actionUpdateContacts POST /lists/{list_id}/contacts/actions/update Updates contacts
ContactsApi createContact POST /lists/{list_id}/contacts Create new contact
ContactsApi getAllContactActivities GET /lists/{list_id}/contacts/{contact_id}/activities Get all contact activities
ContactsApi getAllContacts GET /lists/{list_id}/contacts Get all contacts
ContactsApi getAllContactsBySegment GET /lists/{list_id}/contacts/segment/{segment_id} Get all contacts by Segment Id
ContactsApi getContact GET /lists/{list_id}/contacts/{contact_id} Get contact
ContactsApi patchContact PATCH /lists/{list_id}/contacts/{contact_id} Update a specific contact
ContactsApi searchContacts GET /contacts/search Search contact
ContactsApi updateContactByField POST /lists/{list_id}/contacts/by-field Updates a contact by field
EcommerceApi createCart POST /{domain}/carts Create cart
EcommerceApi createCatalog POST /catalogs Create new catalog
EcommerceApi createOrder POST /{domain}/orders Create order
EcommerceApi createProduct POST /catalogs/{catalog_id}/products Create new product
EcommerceApi deleteCatalog DELETE /catalogs/{catalog_id} Remove catalog
EcommerceApi deleteProduct DELETE /catalogs/{catalog_id}/products/{product_identifier} Remove product
EcommerceApi getAllCatalogs GET /catalogs Get all catalogs
EcommerceApi getAllProducts GET /catalogs/{catalog_id}/products Get all products
EcommerceApi getProduct GET /catalogs/{catalog_id}/products/{product_identifier} Get product
EcommerceApi importOrdersBulk POST /lists/{list_id}/orders Orders import bulk request
EcommerceApi importProducts POST /catalogs/{catalog_id}/products/actions/import Import products
EcommerceApi updateProduct PATCH /catalogs/{catalog_id}/products/{product_identifier} Update product
EmailApi actionEnableEmailRss POST /campaigns/email/rss/{campaign_hash}/actions/enable Enables a rss email campaign
EmailApi actionSendEmail POST /campaigns/email/{campaign_hash}/actions/send Send email message
EmailApi createEmailCampaign POST /campaigns/email Create new email campaign
EmailApi createEmailRssCampaign POST /campaigns/email/rss Create new email rss campaign
EmailApi patchEmailCampaign PATCH /campaigns/email/{campaign_hash} Update a specific email campaign
FieldsApi createExtraField POST /lists/{list_id}/fields/extra Create extra field
FieldsApi createFieldOption POST /lists/{list_id}/fields/extra/{field_id}/options Create new field option
FieldsApi deleteExtraField DELETE /lists/{list_id}/fields/extra/{field_id} Remove extra field
FieldsApi deleteFieldOption DELETE /lists/{list_id}/fields/extra/{field_id}/options/{option_id} Deletes an option
FieldsApi getAllFieldOptions GET /lists/{list_id}/fields/extra/{field_id}/options Get all field options
FieldsApi getAllFields GET /lists/{list_id}/fields Get all fields
FieldsApi patchBaseField PATCH /lists/{list_id}/fields/base/{field_id} Update base field
FieldsApi patchExtraField PATCH /lists/{list_id}/fields/extra/{field_id} Update extra field
FieldsApi updateFieldOption PATCH /lists/{list_id}/fields/extra/{field_id}/options/{option_id} Update field option
ListsApi createList POST /lists Create new list
ListsApi deleteList DELETE /lists/{list_id} Remove list
ListsApi getAllLists GET /lists Get all lists
ListsApi getList GET /lists/{list_id} Get list
ListsApi updateList PATCH /lists/{list_id} Update a specific list
MyAccountApi enableTe POST /my-account/actions/enable-te Enable Track&Engage
MyAccountApi enableTransactional POST /my-account/actions/enable-transactional Enable Transactional
MyAccountApi getMyAccount GET /my-account Get My Account Info
OperationsApi actionApproveOperation POST /operations/actions/approve Approve operation
OperationsApi actionCancelOperation POST /operations/actions/cancel Cancel operation
OperationsApi actionPauseOperation POST /operations/actions/pause Pause operation
OperationsApi actionResumeOperation POST /operations/actions/resume Resume operation
OperationsApi getAllOperations GET /operations Get all queued operations
PingApi ping POST /ping Pings the API
PushApi actionSendPush POST /campaigns/push/{campaign_hash}/actions/send Send push message
PushApi createPushCampaign POST /campaigns/push Create new push campaign
PushApi getPushApp GET /push/apps/{app_id} Get a Push application from E-goi
PushApi getPushApps GET /push/apps Get all Push applications from E-goi
PushApi patchPushCampaign PATCH /campaigns/push/{campaign_hash} Update a specific push campaign
PushApi registerPushEvent POST /push/apps/{app_id}/event Registers an event from the push notification.
PushApi registerPushToken POST /push/apps/{app_id}/token Registers a Firebase token
ReportsApi getEmailReport GET /reports/email/{campaign_hash} Get email report
ReportsApi getPushReport GET /reports/push/{campaign_hash} Get push report
ReportsApi getSMSReport GET /reports/sms/{campaign_hash} Get sms report
ReportsApi getVoiceReport GET /reports/voice/{campaign_hash} Get voice report
ReportsApi getWebPushReport GET /reports/web-push/{campaign_hash} Get webpush report
SegmentsApi deleteSegment DELETE /lists/{list_id}/segments/{segment_id} Remove segment
SegmentsApi getAllSegments GET /lists/{list_id}/segments Get all segments
SendersApi createCellphoneSender POST /senders/cellphone Create cellphone sender
SendersApi createEmailSender POST /senders/email Create email sender
SendersApi createPhoneSender POST /senders/phone Create phone sender
SendersApi deleteCellphoneSender DELETE /senders/cellphone/{sender_id} Remove cellphone sender
SendersApi deleteEmailSender DELETE /senders/email/{sender_id} Remove email sender
SendersApi deletePhoneSender DELETE /senders/phone/{sender_id} Remove phone sender
SendersApi getAllCellphoneSenders GET /senders/cellphone Get all cellphone senders
SendersApi getAllEmailSenders GET /senders/email Get all email senders
SendersApi getAllPhoneSenders GET /senders/phone Get all phone senders
SendersApi putEmailSender PUT /senders/email/{sender_id} Update email sender
SmartSmsApi actionSendSmartSms POST /campaigns/smart-sms/{campaign_hash}/actions/send Send smart sms message
SmartSmsApi createSmartSmsCampaign POST /campaigns/smart-sms Create new smart sms campaign
SmartSmsApi patchSmartSmsCampaign PATCH /campaigns/smart-sms/{campaign_hash} Update a specific smart sms campaign
SmsApi actionSendSms POST /campaigns/sms/{campaign_hash}/actions/send Send sms message
SmsApi createSmsCampaign POST /campaigns/sms Create new sms campaign
SmsApi patchSmsCampaign PATCH /campaigns/sms/{campaign_hash} Update a specific sms campaign
SuppressionListApi createSuppressionList POST /suppression-list Add to suppression list
SuppressionListApi deleteSuppressionList DELETE /suppression-list/{suppression_id} Delete from suppression list
SuppressionListApi getAllSuppressionList GET /suppression-list Get the suppression list
TagsApi createTag POST /tags Create new tag
TagsApi deleteTag DELETE /tags/{tag_id} Remove tag
TagsApi getAllTags GET /tags Get all tags
TagsApi updateTag PUT /tags/{tag_id} Update a specific tag
TrackEngageApi getAllDomains GET /trackengage/domains Get all domains
TrackEngageApi getAllGoals GET /trackengage/goals Get all goals
UsersApi deleteUser DELETE /users/{user_id} Remove user
UsersApi getAllUsers GET /users Get all users
UtilitiesApi getAllCountries GET /utilities/countries Get all countries
VoiceApi actionSendVoice POST /campaigns/voice/{campaign_hash}/actions/send Send voice message
VoiceApi createVoiceCampaign POST /campaigns/voice Create new voice campaign
VoiceApi patchVoiceCampaign PATCH /campaigns/voice/{campaign_hash} Update a specific voice campaign
WebHooksApi createWebhook POST /webhooks Create new webhook
WebHooksApi deleteWebhook DELETE /webhooks/{webhook_id} Remove webhook
WebHooksApi getAllWebhooks GET /webhooks Get all webhooks
WebpushApi actionEnableWebPushRss POST /campaigns/webpush/rss/{campaign_hash}/actions/enable Enable a rss webpush campaign
WebpushApi actionSendWebPush POST /campaigns/web-push/{campaign_hash}/actions/send Send webpush message
WebpushApi createWebPushCampaign POST /campaigns/web-push Create new webpush campaign
WebpushApi createWebPushRssCampaign POST /campaigns/webpush/rss Create new webpush rss campaign
WebpushApi createWebpushSite POST /webpush/sites Creates a webpush site
WebpushApi getAllWebPushSites GET /webpush/sites Get all webpush sites
WebpushApi patchWebPushCampaign PATCH /campaigns/web-push/{campaign_hash} Update a specific webpush campaign

Models

Authorization

Apikey

  • Type: API key
  • API key parameter name: Apikey
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

  • API version: V3
    • Package version: 1.1.10RC1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

E-goi Php Client

developers.e-goi.com/api/v3/

Topics

api php sdk api-wrapper e-goi e-goi-sdk

Resources

Readme
Activity
Custom properties

Stars

7 stars

Watchers

6 watching

Forks

3 forks
Report repository

Releases

10 tags

Packages

 
 
 

Contributors

Languages