Skip to content

Commit 9d4cdcc

Browse files
committed
Spelling corrections in CHANGELOG, TROUBLESHOOTING and USAGE
1 parent 5abeaa6 commit 9d4cdcc

3 files changed

Lines changed: 29 additions & 29 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ All notable changes to this project will be documented in this file.
4141
### BREAKING CHANGE
4242
- Pull #244 [refactor helpers using property getter/setter](https://github.com/sendgrid/sendgrid-python/pull/244/files)
4343
- Big thanks to [Denis Vlasov](https://github.com/denis90) for the pull request!
44-
- The changes break the impelmentation of the [Mail Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) `Mail()` class
44+
- The changes break the implementation of the [Mail Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail) `Mail()` class
4545
- `set_from()` is now the property `from_email`
4646
- `set_subject()` is now the property `subject`
4747
- `set_template_id()` is now the property `template_id`
@@ -299,7 +299,7 @@ All notable changes to this project will be documented in this file.
299299
## [1.5.9] - 2015-10-26 ##
300300

301301
### Added ###
302-
- Supression Unsubscribes [GET]
302+
- Suppression Unsubscribes [GET]
303303

304304
## [1.5.8] - 2015-10-21 ##
305305

@@ -332,7 +332,7 @@ All notable changes to this project will be documented in this file.
332332
### Added ###
333333
- Refactored tests and added Tox support
334334
- Framework for Web API v3 endpoints
335-
- Web API v3 endpionts: apikeys, ASM groups and ASM suppressions
335+
- Web API v3 endpoints: apikeys, ASM groups and ASM suppressions
336336

337337
### Fixed ###
338338
- Python 3 Fix [#126](https://github.com/sendgrid/sendgrid-python/issues/126)

TROUBLESHOOTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ In most cases we recommend you download the latest version of the library, but i
8787

8888
`pip install sendgrid==X.X.X`
8989

90-
If you are usring a [requirements file](https://pip.readthedocs.io/en/1.1/requirements.html), please use:
90+
If you are using a [requirements file](https://pip.readthedocs.io/en/1.1/requirements.html), please use:
9191

9292
`sendgrid==X.X.X`
9393

USAGE.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ print response.headers
137137
```
138138
## Retrieve a specific whitelisted IP
139139

140-
**This endpoint allows you to retreive a specific IP address that has been whitelisted.**
140+
**This endpoint allows you to retrieve a specific IP address that has been whitelisted.**
141141

142142
You must include the ID for the specific IP address you want to retrieve in your call.
143143

@@ -204,7 +204,7 @@ print response.headers
204204
```
205205
## Retrieve all alerts
206206

207-
**This endpoint allows you to retieve all of your alerts.**
207+
**This endpoint allows you to retrieve all of your alerts.**
208208

209209
Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
210210
* Usage alerts allow you to set the threshold at which an alert will be sent.
@@ -289,7 +289,7 @@ print response.headers
289289

290290
## Create API keys
291291

292-
**This enpoint allows you to create a new random API Key for the user.**
292+
**This endpoint allows you to create a new random API Key for the user.**
293293

294294
A JSON request body containing a "name" property is required. If number of maximum keys is reached, HTTP 403 will be returned.
295295

@@ -407,7 +407,7 @@ print response.headers
407407

408408
**This endpoint allows you to revoke an existing API Key.**
409409

410-
Authentications using this API Key will fail after this request is made, with some small propogation delay.If the API Key ID does not exist an HTTP 404 will be returned.
410+
Authentications using this API Key will fail after this request is made, with some small propagation delay.If the API Key ID does not exist an HTTP 404 will be returned.
411411

412412
The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
413413

@@ -462,7 +462,7 @@ This endpoint will return information for each group ID that you include in your
462462

463463
Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).
464464

465-
Suppression groups, or [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html), allow you to label a category of content that you regularly send. This gives your recipients the ability to opt out of a specific set of your email. For example, you might define a group for your transactional email, and one for your marketing email so that your users can continue recieving your transactional email witout having to receive your marketing content.
465+
Suppression groups, or [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html), allow you to label a category of content that you regularly send. This gives your recipients the ability to opt out of a specific set of your email. For example, you might define a group for your transactional email, and one for your marketing email so that your users can continue receiving your transactional email without having to receive your marketing content.
466466

467467
### GET /asm/groups
468468

@@ -661,9 +661,9 @@ print response.headers
661661
```
662662
## Retrieve a Global Suppression
663663

664-
**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.**
664+
**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppressed.**
665665

666-
If the email address you include in the URL path parameter `{email}` is alreayd globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned.
666+
If the email address you include in the URL path parameter `{email}` is already globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned.
667667

668668
A global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html).
669669

@@ -1579,7 +1579,7 @@ Valid operators for create and update depend on the type of the field you are se
15791579

15801580
Segment conditions using "eq" or "ne" for email clicks and opens should provide a "field" of either *clicks.campaign_identifier* or *opens.campaign_identifier*. The condition value should be a string containing the id of a completed campaign.
15811581

1582-
Segments may contain multiple condtions, joined by an "and" or "or" in the "and_or" field. The first condition in the conditions list must have an empty "and_or", and subsequent conditions must all specify an "and_or".
1582+
Segments may contain multiple conditions, joined by an "and" or "or" in the "and_or" field. The first condition in the conditions list must have an empty "and_or", and subsequent conditions must all specify an "and_or".
15831583

15841584
The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.
15851585

@@ -1838,7 +1838,7 @@ print response.headers
18381838
```
18391839
## Retrieve all IP pools.
18401840

1841-
**This endpoint allows you to retreive all of your IP pools.**
1841+
**This endpoint allows you to retrieve all of your IP pools.**
18421842

18431843
IP Pools allow you to group your dedicated SendGrid IP addresses together. For example, you could create separate pools for your transactional and marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.
18441844

@@ -2241,7 +2241,7 @@ data = {
22412241
"enable": True,
22422242
"html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
22432243
"substitution_tag": "<%click here%>",
2244-
"text": "If you would like to unsubscribe and stop receiveing these emails <% click here %>."
2244+
"text": "If you would like to unsubscribe and stop receiving these emails <% click here %>."
22452245
}
22462246
}
22472247
}
@@ -2706,7 +2706,7 @@ print response.headers
27062706

27072707
**This endpoint returns a list of all scopes that this user has access to.**
27082708

2709-
API Keys can be used to authenticate the use of [SendGrids v3 Web API](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html), or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissios, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/api_keys.html#-API-Key-Permissions) or [Classroom](https://sendgrid.com/docs/Classroom/Basics/API/api_key_permissions.html).
2709+
API Keys can be used to authenticate the use of [SendGrids v3 Web API](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html), or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissions, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/api_keys.html#-API-Key-Permissions) or [Classroom](https://sendgrid.com/docs/Classroom/Basics/API/api_key_permissions.html).
27102710

27112711
### GET /scopes
27122712

@@ -2822,7 +2822,7 @@ print response.headers
28222822
```
28232823
## Delete a Sender Identity
28242824

2825-
**This endoint allows you to delete one of your sender identities.**
2825+
**This endpoint allows you to delete one of your sender identities.**
28262826

28272827
Sender Identities are required to be verified before use. If your domain has been whitelabeled it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
28282828

@@ -2838,7 +2838,7 @@ print response.headers
28382838
```
28392839
## Resend Sender Identity Verification
28402840

2841-
**This enpdoint allows you to resend a sender identity verification email.**
2841+
**This endpoint allows you to resend a sender identity verification email.**
28422842

28432843
Sender Identities are required to be verified before use. If your domain has been whitelabeled it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
28442844

@@ -3125,7 +3125,7 @@ print response.headers
31253125
```
31263126
## Retrieve the monthly email statistics for a single subuser
31273127

3128-
**This endpoint allows you to retrive the monthly email statistics for a specific subuser.**
3128+
**This endpoint allows you to retrieve the monthly email statistics for a specific subuser.**
31293129

31303130
While you can always view the statistics for all email activity on your account, subuser statistics enable you to view specific segments of your stats for your subusers. Emails sent, bounces, and spam reports are always tracked for subusers. Unsubscribes, clicks, and opens are tracked if you have enabled the required settings.
31313131

@@ -3975,7 +3975,7 @@ print response.headers
39753975

39763976
**This endpoint allows you to retrieve the current credit balance for your account.**
39773977

3978-
Your monthly credit allotment limits the number of emails you may send before incurring overage charges. For more information about credits and billing, please visit our [Clssroom](https://sendgrid.com/docs/Classroom/Basics/Billing/billing_info_and_faqs.html).
3978+
Your monthly credit allotment limits the number of emails you may send before incurring overage charges. For more information about credits and billing, please visit our [Classroom](https://sendgrid.com/docs/Classroom/Basics/Billing/billing_info_and_faqs.html).
39793979

39803980
### GET /user/credits
39813981

@@ -4358,7 +4358,7 @@ print response.headers
43584358

43594359
**This endpoint allows you to retrieve all of your current inbound parse settings.**
43604360

4361-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4361+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
43624362

43634363
### GET /user/webhooks/parse/settings
43644364

@@ -4373,7 +4373,7 @@ print response.headers
43734373

43744374
**This endpoint allows you to update a specific inbound parse setting.**
43754375

4376-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4376+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
43774377

43784378
### PATCH /user/webhooks/parse/settings/{hostname}
43794379

@@ -4394,7 +4394,7 @@ print response.headers
43944394

43954395
**This endpoint allows you to retrieve a specific inbound parse setting.**
43964396

4397-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4397+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
43984398

43994399
### GET /user/webhooks/parse/settings/{hostname}
44004400

@@ -4410,7 +4410,7 @@ print response.headers
44104410

44114411
**This endpoint allows you to delete a specific inbound parse setting.**
44124412

4413-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4413+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
44144414

44154415
### DELETE /user/webhooks/parse/settings/{hostname}
44164416

@@ -4424,9 +4424,9 @@ print response.headers
44244424
```
44254425
## Retrieves Inbound Parse Webhook statistics.
44264426

4427-
**This endpoint allows you to retrieve the statistics for your Parse Webhook useage.**
4427+
**This endpoint allows you to retrieve the statistics for your Parse Webhook usage.**
44284428

4429-
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incomming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 20MB in size, including all attachments.
4429+
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incoming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 20MB in size, including all attachments.
44304430

44314431
There are a number of pre-made integrations for the SendGrid Parse Webhook which make processing events easy. You can find these integrations in the [Library Index](https://sendgrid.com/docs/Integrate/libraries.html#-Webhook-Libraries).
44324432

@@ -4752,7 +4752,7 @@ print response.headers
47524752
```
47534753
## Retrieve all IP whitelabels
47544754

4755-
**This endpoint allows you to retrieve all of the IP whitelabels that have been createdy by this account.**
4755+
**This endpoint allows you to retrieve all of the IP whitelabels that have been created by this account.**
47564756

47574757
You may include a search key by using the "ip" parameter. This enables you to perform a prefix search for a given IP segment (e.g. "192.").
47584758

@@ -4895,7 +4895,7 @@ print response.headers
48954895
**This endpoint allows you to retrieve the associated link whitelabel for a subuser.**
48964896

48974897
Link whitelables can be associated with subusers from the parent account. This functionality allows
4898-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
4898+
subusers to send mail using their parent's link whitelabels. To associate a link whitelabel, the parent account
48994899
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
49004900

49014901
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
@@ -4917,7 +4917,7 @@ print response.headers
49174917
**This endpoint allows you to disassociate a link whitelabel from a subuser.**
49184918

49194919
Link whitelables can be associated with subusers from the parent account. This functionality allows
4920-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
4920+
subusers to send mail using their parent's link whitelabels. To associate a link whitelabel, the parent account
49214921
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
49224922

49234923
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
@@ -5014,7 +5014,7 @@ print response.headers
50145014
**This endpoint allows you to associate a link whitelabel with a subuser account.**
50155015

50165016
Link whitelables can be associated with subusers from the parent account. This functionality allows
5017-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
5017+
subusers to send mail using their parent's link whitelabels. To associate a link whitelabel, the parent account
50185018
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
50195019

50205020
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.

0 commit comments

Comments
 (0)