Skip to content
This repository was archived by the owner on Jul 15, 2024. It is now read-only.

Commit

Permalink
Versoin Bump 1.0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
@thinkingserious
thinkingserious committed Jun 7, 2016
1 parent e781f77 commit f4ba5e3
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 248 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Change Log
All notable changes to this project will be documented in this file.

## [1.0.6] - 2016-05-24
## [1.0.7] - 2016-06-06
### Fixed
- Removed duplicate endpoint

## [1.0.5] - 2016-05-24
## [1.0.6] - 2016-06-06
### Fixed
- Removed duplicate endpoint

## [1.0.5] - 2016-06-06
### Fixed
- Fixed several request body schemas

Expand Down
77 changes: 1 addition & 76 deletions oai.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2670,7 +2670,7 @@
"host": "api.sendgrid.com",
"info": {
"description": "",
"title": "SendGrid V3 API",
"title": "DX - v3 - Officially Documented Only - DO NOT EDIT",
"version": "3.0"
},
"paths": {
Expand Down Expand Up @@ -3799,81 +3799,6 @@
]
}
},
"/asm/groups/:group_id/suppressions": {
"parameters": [],
"post": {
"consumes": [
"application/json"
],
"description": "**This endpoint allows you to determine if the given list of email addresses exists in the given suppression group. The endpoint will return a subset of emails from the request that exists in the suppression group specified.**\n\nSuppressions are email addresses that can be added to [groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html) to prevent certain types of emails from being delivered to those addresses.",
"operationId": "POST_asm-groups-:group_id-suppressions",
"parameters": [
{
"in": "body",
"name": "body",
"schema": {
"example": {
"recipient_emails": [
"[email protected]",
"[email protected]",
"[email protected]"
]
},
"properties": {
"recipient_emails": {
"description": "The list of email address you would like to search for.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"recipient_emails"
],
"type": "object"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "",
"examples": {
"application/json": {
"recipient_emails": [
"[email protected]",
"[email protected]"
]
}
},
"schema": {
"properties": {
"recipient_emails": {
"description": "The subset of email address that do exist in the suppression group.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"recipient_emails"
],
"type": "object"
}
}
},
"security": [
{
"Authorization": []
}
],
"summary": "Search a suppression group for a set of email addresses"
}
},
"/asm/groups/{group_id}": {
"delete": {
"consumes": [
Expand Down
107 changes: 28 additions & 79 deletions oai.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ basePath: /v3
host: api.sendgrid.com
info:
version: '3.0'
title: SendGrid V3 API
title: DX - v3 - Officially Documented Only - DO NOT EDIT
description: ''
consumes:
- application/json
Expand Down Expand Up @@ -150,9 +150,9 @@ paths:
description: |-
**This endpoint allows you to remove an email address from your bounce list.**

Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete a single email addresses from your bounce list.
Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete a single email addresses from your bounce list.

For more information see:
For more information see:

* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
Expand Down Expand Up @@ -198,7 +198,7 @@ paths:

Bounces are messages that are returned to the server that sent it.

For more information see:
For more information see:

* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
Expand Down Expand Up @@ -1625,7 +1625,7 @@ paths:
description: |-
**This endpoint allows you to retrieve your current legacy email template settings.**

This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).

The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.

Expand Down Expand Up @@ -1653,7 +1653,7 @@ paths:
description: |-
**This endpoint allows you to update your current legacy email template settings.**

This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).

The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.

Expand Down Expand Up @@ -3418,7 +3418,7 @@ paths:
description: |-
**This endpoint returns a list of all scopes that this user has access to.**

API Keys can be used to authenticate the use of [SendGrid’s 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).
API Keys can be used to authenticate the use of [SendGrid’s 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).
operationId: GET_scopes
consumes:
- application/json
Expand Down Expand Up @@ -4168,7 +4168,7 @@ paths:

If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.

Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
operationId: GET_categories-stats
consumes:
- application/json
Expand Down Expand Up @@ -4566,7 +4566,7 @@ paths:

If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.

Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
operationId: GET_categories-stats-sums
consumes:
- application/json
Expand Down Expand Up @@ -7746,7 +7746,7 @@ paths:
get:
summary: Retrieve all recipients on a List
description: |-
**This endpoint allows you to retrieve all recipients on the list with the given ID.**
**This endpoint allows you to retrieve all recipients on the list with the given ID.**

The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.
operationId: GET_contactdb-lists-list_id-recipients
Expand Down Expand Up @@ -8581,7 +8581,7 @@ paths:
description: |-
**This endpoint allows you to validate a batch ID.**

If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.

More Information:

Expand Down Expand Up @@ -8629,9 +8629,9 @@ paths:
description: |-
**This endpoint allows you to retrieve all of your bounces.**

Bounces are messages that are returned to the server that sent it.
Bounces are messages that are returned to the server that sent it.

For more information see:
For more information see:

* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
Expand Down Expand Up @@ -8699,7 +8699,7 @@ paths:

Bounces are messages that are returned to the server that sent it.

For more information see:
For more information see:

* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
Expand Down Expand Up @@ -9347,7 +9347,7 @@ paths:
get:
summary: Retrieve all custom fields
description: |-
**This endpoint allows you to retrieve all custom fields.**
**This endpoint allows you to retrieve all custom fields.**

The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).
operationId: GET_contactdb-custom_fields
Expand Down Expand Up @@ -9903,14 +9903,14 @@ paths:
* Send this to segment from an existing list
* Don't send this in order to segment from your entire contactdb.

Valid operators for create and update depend on the type of the field you are segmenting:
Valid operators for create and update depend on the type of the field you are segmenting:

* **Dates:** "eq", "ne", "lt" (before), "gt" (after)
* **Text:** "contains", "eq" (is - matches the full field), "ne" (is not - matches any field where the entire field is not the condition value)
* **Numbers:** "eq", "lt", "gt"
* **Email Clicks and Opens:** "eq" (opened), "ne" (not opened)
* **Dates:** "eq", "ne", "lt" (before), "gt" (after)
* **Text:** "contains", "eq" (is - matches the full field), "ne" (is not - matches any field where the entire field is not the condition value)
* **Numbers:** "eq", "lt", "gt"
* **Email Clicks and Opens:** "eq" (opened), "ne" (not opened)

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.
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.

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".

Expand Down Expand Up @@ -10539,7 +10539,7 @@ paths:
description: |-
**This endpoint allows you to generate a new batch ID. This batch ID can be associated with scheduled sends via the mail/send endpoint.**

If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.

More Information:

Expand Down Expand Up @@ -10582,7 +10582,7 @@ paths:
put:
summary: Update IPs assigned to a subuser
description: |-
Each subuser should be assigned to an IP address, from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have their own, or multiple, IP addresses as well.
Each subuser should be assigned to an IP address, from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have their own, or multiple, IP addresses as well.

More information:

Expand Down Expand Up @@ -13200,9 +13200,9 @@ paths:
description: |-
**This endpoint allows you to delete all email addresses on your blocks list.**

There are two options for deleting blocked emails:
There are two options for deleting blocked emails:

1. You can delete all blocked emails by setting `delete_all` to true in the request body.
1. You can delete all blocked emails by setting `delete_all` to true in the request body.
2. You can delete some blocked emails by specifying the email addresses in an array in the request body.

[Blocks](https://sendgrid.com/docs/Glossary/blocks.html) happen when your message was rejected for a reason related to the message, not the recipient address. This can happen when your mail server IP address has been added to a blacklist or blocked by an ISP, or if the message content is flagged by a filter on the receiving server.
Expand Down Expand Up @@ -13375,7 +13375,7 @@ paths:
description: |-
**This endpoint allows you to remove email addresses from your invalid email address list.**

There are two options for deleting invalid email addresses:
There are two options for deleting invalid email addresses:

1) You can delete all invalid email addresses by setting `delete_all` to true in the request body.
2) You can delete some invalid email addresses by specifying certain addresses in an array in the request body.
Expand Down Expand Up @@ -13484,9 +13484,9 @@ paths:
description: |-
**This endpoint allows you to delete your spam reports.**

There are two options for deleting spam reports:
There are two options for deleting spam reports:

1) You can delete all spam reports by setting "delete_all" to true in the request body.
1) You can delete all spam reports by setting "delete_all" to true in the request body.
2) You can delete some spam reports by specifying the email addresses in an array in the request body.

[Spam reports](https://sendgrid.com/docs/Glossary/spam_reports.html) happen when a recipient indicates that they think your email is [spam](https://sendgrid.com/docs/Glossary/spam.html) and then their email provider reports this to SendGrid.
Expand Down Expand Up @@ -13523,57 +13523,6 @@ paths:
properties: {}
security:
- Authorization: []
'/asm/groups/:group_id/suppressions':
parameters: []
post:
summary: Search a suppression group for a set of email addresses
description: |-
**This endpoint allows you to determine if the given list of email addresses exists in the given suppression group. The endpoint will return a subset of emails from the request that exists in the suppression group specified.**

Suppressions are email addresses that can be added to [groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html) to prevent certain types of emails from being delivered to those addresses.
operationId: 'POST_asm-groups-:group_id-suppressions'
consumes:
- application/json
produces:
- application/json
parameters:
- name: body
in: body
schema:
type: object
properties:
recipient_emails:
type: array
description: The list of email address you would like to search for.
items:
type: string
required:
- recipient_emails
example:
recipient_emails:
- [email protected]
- [email protected]
- [email protected]
responses:
'200':
description: ''
schema:
type: object
properties:
recipient_emails:
type: array
description: The subset of email address that do exist in the suppression group.
items:
type: string
required:
- recipient_emails
examples:
application/json:
recipient_emails:
- [email protected]
- [email protected]
security:
- Authorization: []
'/asm/suppressions/{email}':
parameters:
- name: email
Expand Down
Loading

0 comments on commit f4ba5e3

Please sign in to comment.