Skip to content

Minor fixes for README #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
igor-shevchenko wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Minor fixes for README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Create SPF, DKIM records for your domain, see [instruction](https://www.unisende

4. Client usage:

Client allow use any [API methods](https://www.unisender.com/ru/support/api/api), for example "create_field" and "import_contacts":
Client allows using all [API methods](https://www.unisender.com/ru/support/api/api), for example "create_field" and "import_contacts":

```python
# create contacts fields
Expand All @@ -62,15 +62,15 @@ response = cl.import_contacts(

### Advanced usage

In order to send a email message, you need to perform these API requests:

For start mailing your need a complete a set of API requests:
1. Create list;
2. Create fields;
2. Create contact fields;
3. Import contacts;
4. Create email message;
5. Create campaign.

It is not comfortable. To simplify this procedure, use "SimpleClient" and next methods:
It is not convenient. To simplify this procedure, use "SimpleClient" and the following methods:
- **create_email_campaign** - send one email message;
- **create_email_campaigns** - send a lot of email messages.

Expand All @@ -90,15 +90,15 @@ cl = SimpleClient(
#### create_email_campaign

Attributes:
- **recipients*** [list] - each list item must be represented by a dictionary with the same set of keys. Dictionary keys can be used in a email template;
- **email_data*** [dict] - represent fields for "create_email_message" API-method. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createemailmessage/) for a list of valid parameters. Parameter "list_id" is set automatically;
- **campaign_data** [dict] - represent fields for "create_campaign" API-method. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createcampaign/) for a list of valid parameters. Parameter "message_id" is set automatically;
- **recipients*** [list] - each list item must be a dictionary with the same set of keys. Dictionary keys can be used in a email template;
- **email_data*** [dict] - fields for the "create_email_message" API-method. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createemailmessage/) for a list of valid parameters. Parameter "list_id" is set automatically;
- **campaign_data** [dict] - fields for the "create_campaign" API-method. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createcampaign/) for a list of valid parameters. Parameter "message_id" is set automatically;

Return value [int] - created campaign id.

Examples:

1. Send custom email message (with body as HTML) now:
1. Send custom email message (with body as HTML) immediately:
```python
client.create_email_campaign(
recipients = [
Expand Down Expand Up @@ -136,7 +136,7 @@ client.create_email_campaign(
}
)
```
3. Send delayed email message (from UniSender system template) with UTC time zone:
3. Send delayed email message (from UniSender system template) with UTC timezone:

``` python
start_time = datetime.now() + timedelta(hours=2)
Expand All @@ -162,8 +162,8 @@ client.create_email_campaign(
#### create_email_campaigns

Attributes:
- **recipients*** [list] - each list item must be represented by a dictionary with the same set of keys. Dictionary keys can be used in a email template;
- **campaigns** [list] - each list item must be represented by next dictionary:
- **recipients*** [list] - each list item must be a dictionary with the same set of keys. Dictionary keys can be used in a email template;
- **campaigns** [list] - each list item must be a dictionary having the following structure:
```python
{
"email_data": {
Expand All @@ -183,8 +183,8 @@ Attributes:
}
```

- **default_email_data** [dict] - represent default fields for campaigns. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createemailmessage/) for a list of valid parameters. Parameter "list_id" is set automatically;
- **default_campaign_data** [dict] - represent default fields for campaigns. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createcampaign/) for a list of valid parameters. Parameter "message_id" is set automatically.
- **default_email_data** [dict] - default fields for campaigns. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createemailmessage/) for a list of valid parameters. Parameter "list_id" is set automatically;
- **default_campaign_data** [dict] - default fields for campaigns. See the [method documentation](https://www.unisender.com/ru/support/api/messages/createcampaign/) for a list of valid parameters. Parameter "message_id" is set automatically.

Return value [list] - created campaigns ids.

Expand Down Expand Up @@ -218,7 +218,7 @@ client.create_email_campaigns(
"body": '<html>...</html>',
}
},
# Second campaign starts after 1 hours from HTML-message
# Second campaign starts after 1 hour from HTML-message
{
"email_data": {
"subject": 'Email subject',
Expand Down Expand Up @@ -246,4 +246,4 @@ client.create_email_campaigns(
"timezone": 'UTC',
}
)
```
```