Download the PHP package pion/smart-emailing-v3 without Composer
On this page you can find all versions of the php package pion/smart-emailing-v3. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package smart-emailing-v3
Smart Emailing API v3
API wrapper for Smart emailing API.
- Installation
- Usage
- Supports
- Advanced docs
- Contribution or overriding
- Upgrading
- Copyright and License
- Smart emailing API
Installation
Requirements
This package requires PHP 7.4 and higher.
Install via composer
Usage
Create an Api instance with your username and apiKey.
then use the $api with desired method/component.
or
Error handling
When sending any request you can catch the error exception RequestException.
Supports
- [x] Import contacts
- [x] Import orders
- [x] Ping
- [x] Credentials
- [x] Contactlist
- [ ] Customfields
- [x] Contacts
- [ ] Contacts in list
- [ ] Custom emails
- [x] Emails
- [x] Newsletter
- [ ] Webhooks
- [x] (DEPRECATED) E-shops
Advanced docs
Import contacts
The import holds 2 main data points:
- Settings
$import->settings()->setUpdate(true) - Contacts
$import->newContact() : Contact,$import->contacts() : arrayand$import->addContact($contact) : self
Example of usage is above.
Contact
The import holds 3 main data points:
- All data accessible via public properties. Fluent set method has basic validation and date convert logic
- CustomFields
$contact->customFields()for adding new fields - ContactLists
$contact->contactLists()for adding new contact list
See source code for all methods/properties that you can use
ContactLists
Uses a data holder with create/add/get/isEmpty/toArray/jsonSerialize methods.
Import orders
The import holds 2 main data points:
- Settings
$import->settings()->setSkipInvalidOrders(true) - Orders
$import->newOrder() : Order,$import->orders() : arrayand$import->addOrder($order) : self
Example of usage is above.
CustomFields
The customFields uses a wrapper for each request related to custom-fields. To create a new instance call $api->customFields().
On this object you can create any request that is currently implemented. See below.
Create
Quick way that will create request with required customField
or
Search / List
Enables searching threw the custom fields with a filter/sort support. Results are limited by 100 per page. The response
returns meta data (MetaDataInterface) and an array of Models\CustomFieldDefinition by calling $response->data().
Response
- data() returns an array
Models\CustomFieldDefinition - meta() returns a
stdClasswith properties (defined inMetaDataInterface)
Get a list without advanced search
Creates a search request and setups only $page or $limit. The full response from api with customfield_options_url or
Advanced search - filter/sort/etc
Request methods
- Getters are via public property
- page
- limit
- select
- expand
- sort
- Fluent Setters (with a validation) - more below.
filter()returns a Filters setup - more below
expandBy(string : $expand)
Using this parameter, "customfield_options_url" property will be replaced by "customfield_options" contianing expanded data. See examples below For more information see "/customfield-options" endpoint.
Allowed values: "customfield_options"
select(string : $select)
Comma separated list of properties to select. eg. "?select=id,name" If not provided, all fields are selected.
Allowed values: "id", "name", "type"
sortBy(string : $sort)
Comma separated list of sorting keys from left side. Prepend "-" to any key for desc direction, eg. "?sort=type,-name"
Allowed values: "id", "name", "type"
setPage(int : $page)
Sets the current page
limit(int : $limit)
Sets the limit of result in single query
filter()
Allows filtering custom fields with multiple filter conditions.
- Getters are via public property
- name
- type
- id
- Fluent Setters (with a validation)
- byName($value)
- byType($value)
- byId($value)
Get by name
Runs a search query with name filter and checks if the given name is found in customFields. Returns false or the CustomFields\CustomField.
Uses send logic (throws RequestException).
Send / Transactional emails
The implementation of API call send/transactional-emails-bulk: https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_transactional_emails
Full transactional email example
Send / Bulk custom emails
The implementation of API call send/custom-emails-bulk: https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_emails
Full custom email example
Send / Bulk custom sms
The implementation of API call send/custom-sms-bulk: https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns-Send_bulk_custom_SMS
Full send sms example
Upgrading
See UPGRADE.md for how to upgrade to newer versions.
Contribution or overriding
See CONTRIBUTING.md for how to contribute changes. All contributions are welcome.
Copyright and License
smart-emailing-v3 was written by Martin Kluska and is released under the MIT License.
Copyright (c) 2016 - 2022 Martin Kluska and contributors
