Skip to content
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

Remove references to 'whitelabel' #783

Merged
merged 2 commits into from
Nov 18, 2018
Merged

Remove references to 'whitelabel' #783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8303f41
Remove references to 'whitelabel'
crweiner Nov 3, 2018
90d21d9
Remove references to 'whitelabel'
crweiner Nov 5, 2018
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
2,101 changes: 1,051 additions & 1,050 deletions USAGE.md
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions USE_CASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This documentation provides examples for specific use cases. Please [open an iss
- [Send Multiple Emails to Multiple Recipients](#send-multiple-emails-to-multiple-recipients)
- [Transactional Templates](#transactional-templates)
- [Legacy Templates](#legacy-templates)
- [How to Setup a Domain Whitelabel](#how-to-setup-a-domain-whitelabel)
- [How to Setup a Domain Authentication](#how-to-setup-a-domain-authentication)
- [How to View Email Statistics](#how-to-view-email-statistics)
- [Deploying to Heroku](#deploying-to-heroku)
- [Google App Engine Installation](#google-app-engine-installation)
Expand Down Expand Up @@ -1281,12 +1281,12 @@ try {
}
```

<a name="domain-whitelabel"></a>
# How to Setup a Domain Whitelabel
<a name="domain-authentication"></a>
# How to Setup a Domain Authentication

You can find documentation for how to setup a domain whitelabel via the UI [here](https://example.com/docs/Classroom/Basics/Whitelabel/setup_domain_whitelabel.html) and via API [here](https://github.com/sendgrid/sendgrid-php/blob/master/USAGE.md#whitelabel).
You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](https://github.com/sendgrid/sendgrid-php/blob/master/USAGE.md#sender-authentication).

Find more information about all of SendGrid's whitelabeling related documentation [here](https://example.com/docs/Classroom/Basics/Whitelabel/index.html).
Find more information about all of SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/).

<a name="email-stats"></a>
# How to View Email Statistics
Expand Down
54 changes: 27 additions & 27 deletions examples/whitelabel/whitelabel.php → ...erauthentication/senderauthentication.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
$sg = new \SendGrid($apiKey);

////////////////////////////////////////////////////
// Create a domain whitelabel. #
// Create a domain authentication. #
// POST /whitelabel/domains #

$request_body = json_decode('{
Expand All @@ -35,7 +35,7 @@
}

////////////////////////////////////////////////////
// List all domain whitelabels. #
// List all domain authentications. #
// GET /whitelabel/domains #

$query_params = json_decode('{"username": "test_string", "domain": "test_string", "exclude_subusers": "true", "limit": 1, "offset": 1}');
Expand All @@ -50,7 +50,7 @@
}

////////////////////////////////////////////////////
// Get the default domain whitelabel. #
// Get the default domain authentication. #
// GET /whitelabel/domains/default #

try {
Expand All @@ -63,7 +63,7 @@
}

////////////////////////////////////////////////////
// List the domain whitelabel associated with the given user. #
// List the domain authentication associated with the given user. #
// GET /whitelabel/domains/subuser #

try {
Expand All @@ -76,7 +76,7 @@
}

////////////////////////////////////////////////////
// Disassociate a domain whitelabel from a given user. #
// Disassociate a domain authentication from a given user. #
// DELETE /whitelabel/domains/subuser #

try {
Expand All @@ -89,7 +89,7 @@
}

////////////////////////////////////////////////////
// Update a domain whitelabel. #
// Update a domain authentication. #
// PATCH /whitelabel/domains/{domain_id} #

$request_body = json_decode('{
Expand All @@ -108,7 +108,7 @@
}

////////////////////////////////////////////////////
// Retrieve a domain whitelabel. #
// Retrieve a domain authentication. #
// GET /whitelabel/domains/{domain_id} #

$domain_id = "test_url_param";
Expand All @@ -123,7 +123,7 @@
}

////////////////////////////////////////////////////
// Delete a domain whitelabel. #
// Delete a domain authentication. #
// DELETE /whitelabel/domains/{domain_id} #

$domain_id = "test_url_param";
Expand All @@ -138,7 +138,7 @@
}

////////////////////////////////////////////////////
// Associate a domain whitelabel with a given user. #
// Associate a domain authentication with a given user. #
// POST /whitelabel/domains/{domain_id}/subuser #

$request_body = json_decode('{
Expand All @@ -156,7 +156,7 @@
}

////////////////////////////////////////////////////
// Add an IP to a domain whitelabel. #
// Add an IP to a domain authentication. #
// POST /whitelabel/domains/{id}/ips #

$request_body = json_decode('{
Expand All @@ -174,7 +174,7 @@
}

////////////////////////////////////////////////////
// Remove an IP from a domain whitelabel. #
// Remove an IP from a domain authentication. #
// DELETE /whitelabel/domains/{id}/ips/{ip} #

$id = "test_url_param";
Expand All @@ -190,7 +190,7 @@
}

////////////////////////////////////////////////////
// Validate a domain whitelabel. #
// Validate a domain authentication. #
// POST /whitelabel/domains/{id}/validate #

$id = "test_url_param";
Expand All @@ -205,7 +205,7 @@
}

////////////////////////////////////////////////////
// Create an IP whitelabel #
// Create a reverse DNS record #
// POST /whitelabel/ips #

$request_body = json_decode('{
Expand All @@ -224,7 +224,7 @@
}

////////////////////////////////////////////////////
// Retrieve all IP whitelabels #
// Retrieve all reverse DNS records #
// GET /whitelabel/ips #

$query_params = json_decode('{"ip": "test_string", "limit": 1, "offset": 1}');
Expand All @@ -239,7 +239,7 @@
}

////////////////////////////////////////////////////
// Retrieve an IP whitelabel #
// Retrieve a reverse DNS record #
// GET /whitelabel/ips/{id} #

$id = "test_url_param";
Expand All @@ -254,7 +254,7 @@
}

////////////////////////////////////////////////////
// Delete an IP whitelabel #
// Delete a reverse DNS record #
// DELETE /whitelabel/ips/{id} #

$id = "test_url_param";
Expand All @@ -269,7 +269,7 @@
}

////////////////////////////////////////////////////
// Validate an IP whitelabel #
// Validate a reverse DNS record #
// POST /whitelabel/ips/{id}/validate #

$id = "test_url_param";
Expand All @@ -284,7 +284,7 @@
}

////////////////////////////////////////////////////
// Create a Link Whitelabel #
// Create a Branded Link #
// POST /whitelabel/links #

$request_body = json_decode('{
Expand All @@ -304,7 +304,7 @@
}

////////////////////////////////////////////////////
// Retrieve all link whitelabels #
// Retrieve all link brandings #
// GET /whitelabel/links #

$query_params = json_decode('{"limit": 1}');
Expand All @@ -319,7 +319,7 @@
}

////////////////////////////////////////////////////
// Retrieve a Default Link Whitelabel #
// Retrieve a Default Link BrandingBranding #
// GET /whitelabel/links/default #

$query_params = json_decode('{"domain": "test_string"}');
Expand All @@ -334,7 +334,7 @@
}

////////////////////////////////////////////////////
// Retrieve Associated Link Whitelabel #
// Retrieve Associated Link Branding #
// GET /whitelabel/links/subuser #

$query_params = json_decode('{"username": "test_string"}');
Expand All @@ -349,7 +349,7 @@
}

////////////////////////////////////////////////////
// Disassociate a Link Whitelabel #
// Disassociate a Link Branding #
// DELETE /whitelabel/links/subuser #

$query_params = json_decode('{"username": "test_string"}');
Expand All @@ -364,7 +364,7 @@
}

////////////////////////////////////////////////////
// Update a Link Whitelabel #
// Update a Link Branding #
// PATCH /whitelabel/links/{id} #

$request_body = json_decode('{
Expand All @@ -382,7 +382,7 @@
}

////////////////////////////////////////////////////
// Retrieve a Link Whitelabel #
// Retrieve a Link Branding #
// GET /whitelabel/links/{id} #

$id = "test_url_param";
Expand All @@ -397,7 +397,7 @@
}

////////////////////////////////////////////////////
// Delete a Link Whitelabel #
// Delete a Link Branding #
// DELETE /whitelabel/links/{id} #

$id = "test_url_param";
Expand All @@ -412,7 +412,7 @@
}

////////////////////////////////////////////////////
// Validate a Link Whitelabel #
// Validate a Link Branding #
// POST /whitelabel/links/{id}/validate #

$id = "test_url_param";
Expand All @@ -427,7 +427,7 @@
}

////////////////////////////////////////////////////
// Associate a Link Whitelabel #
// Associate a Link Branding #
// POST /whitelabel/links/{link_id}/subuser #

$request_body = json_decode('{
Expand Down
0 ...tion/Whitelabel/WhitelabelDomainsTest.php → ...thentication/DomainAuthenticationTest.php
View file
Open in desktop
File renamed without changes.
0 ...ration/Whitelabel/WhitelabelLinksTest.php → ...SenderAuthentication/LinkBrandingTest.php
View file
Open in desktop
File renamed without changes.
0 ...egration/Whitelabel/WhitelabelIpsTest.php → ...n/SenderAuthentication/ReverseDNSTest.php
View file
Open in desktop
File renamed without changes.