Check out our spring line!
", + "ip_pool": "marketing", + "list_ids": [ + 110, + 124 + ], + "plain_content": "Check out our spring line!", + "segment_ids": [ + 110 + ], + "sender_id": 124451, + "subject": "New Products for Spring!", + "suppression_group_id": 42, + "title": "March Newsletter" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/campaigns'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all Campaigns + +**This endpoint allows you to retrieve a list of all of your campaigns.** + +Returns campaigns in reverse order they were created (newest first). + +Returns an empty array if no campaigns exist. + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### GET /campaigns + + +```javascript + const queryParams = { + 'limit': 1, + 'offset': 1 +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/campaigns'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update a Campaign + +Update a campaign. This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters. + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### PATCH /campaigns/{campaign_id} + + +```javascript + const data = { + "categories": [ + "summer line" + ], + "html_content": "Check out our summer line!
", + "plain_content": "Check out our summer line!", + "subject": "New Products for Summer!", + "title": "May Newsletter" +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/campaigns/{campaign_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete a Campaign + +**This endpoint allows you to delete a specific campaign.** + +Our Marketing Campaigns API lets you create, manage, send, and schedule campaigns. + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### DELETE /campaigns/{campaign_id} + + +```javascript + request.method = 'DELETE'; + request.url = '/v3/campaigns/{campaign_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve a single campaign + +**This endpoint allows you to retrieve a specific campaign.** + +Our Marketing Campaigns API lets you create, manage, send, and schedule campaigns. + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### GET /campaigns/{campaign_id} + + +```javascript + request.method = 'GET'; + request.url = '/v3/campaigns/{campaign_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Unschedule a Scheduled Campaign + +**This endpoint allows you to unschedule a campaign that has already been scheduled to be sent.** + +A successful unschedule will return a 204. +If the specified campaign is in the process of being sent, the only option is to cancel (a different method). + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### DELETE /campaigns/{campaign_id}/schedules + + +```javascript + request.method = 'DELETE'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Schedule a Campaign + +**This endpoint allows you to schedule a specific date and time for your campaign to be sent.** + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### POST /campaigns/{campaign_id}/schedules + + +```javascript + const data = { + "send_at": 1489771528 +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## View Scheduled Time of a Campaign + +**This endpoint allows you to retrieve the date and time that the given campaign has been scheduled to be sent.** + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### GET /campaigns/{campaign_id}/schedules + + +```javascript + request.method = 'GET'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update a Scheduled Campaign + +**This endpoint allows to you change the scheduled time and date for a campaign to be sent.** + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### PATCH /campaigns/{campaign_id}/schedules + + +```javascript + const data = { + "send_at": 1489451436 +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Send a Campaign + +**This endpoint allows you to immediately send a campaign at the time you make the API call.** + +Usually, a POST would have a request body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed. + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### POST /campaigns/{campaign_id}/schedules/now + + +```javascript + request.method = 'POST'; + request.url = '/v3/campaigns/{campaign_id}/schedules/now'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Send a Test Campaign + +**This endpoint allows you to send a test campaign.** + +To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"] + +For more information: + +* [User Guide > Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) + +### POST /campaigns/{campaign_id}/schedules/test + + +```javascript + const data = { + "to": "your.email@example.com" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/campaigns/{campaign_id}/schedules/test'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# CATEGORIES + +## Retrieve all categories + +**This endpoint allows you to retrieve a list of all of your categories.** + +Categories can help organize your email analytics by enabling you to tag emails by type or broad topic. You can define your custom categories. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html). + +### GET /categories + + +```javascript + const queryParams = { + 'category': 'test_string', + 'limit': 1, + 'offset': 1 +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/categories'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve Email Statistics for Categories + +**This endpoint allows you to retrieve all of your email statistics for each of your categories.** + +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 according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html). + +### GET /categories/stats + + +```javascript +const queryParams = { + 'aggregated_by': 'day', + 'categories': 'test_string', + 'end_date': '2016-04-01', + 'limit': 1, + 'offset': 1, + 'start_date': '2016-01-01' +}; +request.qs = queryParams; +request.method = 'GET'; +request.url = '/v3/categories/stats'; +client + .request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + + +**Attention:** in order to receive the email statistics for multiple categories at once, you need to set the `qsStringifyOptions` as follows: + +```javascript +const client = require('@sendgrid/client') +client.setDefaultRequest('qsStringifyOptions', {arrayFormat: 'repeat'}); + +const request = {} +const queryParams = { + 'aggregated_by': 'day', + 'categories': ['test_category_1', 'cat facts'], + 'end_date': '2016-04-01', + 'limit': 1, + 'offset': 1, + 'start_date': '2016-01-01' +}; +request.qs = queryParams; +request.method = 'GET'; +request.url = '/v3/categories/stats'; +client + .request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?] + +**This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.** + +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 according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html). + +### GET /categories/stats/sums + + +```javascript + const queryParams = { + 'aggregated_by': 'day', + 'end_date': '2016-04-01', + 'limit': 1, + 'offset': 1, + 'sort_by_direction': 'asc', + 'sort_by_metric': 'test_string', + 'start_date': '2016-01-01' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/categories/stats/sums'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# CLIENTS + +## Retrieve email statistics by client type. + +**This endpoint allows you to retrieve your email statistics segmented by client type.** + +**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. + +Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html). + +### GET /clients/stats + + +```javascript + const queryParams = { + 'aggregated_by': 'day', + 'end_date': '2016-04-01', + 'start_date': '2016-01-01' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/clients/stats'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve stats by a specific client type. + +**This endpoint allows you to retrieve your email statistics segmented by a specific client type.** + +**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. + +## Available Client Types +- phone +- tablet +- webmail +- desktop + +Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html). + +### GET /clients/{client_type}/stats + + +```javascript + const queryParams = { + 'aggregated_by': 'day', + 'end_date': '2016-04-01', + 'start_date': '2016-01-01' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/clients/{client_type}/stats'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# CONTACTDB + +## Create a Custom Field + +**This endpoint allows you to create a custom field.** + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### POST /contactdb/custom_fields + + +```javascript + const data = { + "name": "pet", + "type": "text" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/contactdb/custom_fields'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all custom fields + +**This endpoint allows you to retrieve all custom fields.** + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### GET /contactdb/custom_fields + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/custom_fields'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete a Custom Field + +**This endpoint allows you to delete a custom field by ID.** + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### DELETE /contactdb/custom_fields/{custom_field_id} + + +```javascript + request.method = 'DELETE'; + request.url = '/v3/contactdb/custom_fields/{custom_field_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve a Custom Field + +**This endpoint allows you to retrieve a custom field by ID.** + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### GET /contactdb/custom_fields/{custom_field_id} + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/custom_fields/{custom_field_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Create a List + +**This endpoint allows you to create a list for your recipients.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### POST /contactdb/lists + + +```javascript + const data = { + "name": "your list name" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/contactdb/lists'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete Multiple lists + +**This endpoint allows you to delete multiple recipient lists.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### DELETE /contactdb/lists + + +```javascript + const data = [ + 1, + 2, + 3, + 4 +]; + request.body = data; + request.method = 'DELETE'; + request.url = '/v3/contactdb/lists'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all lists + +**This endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### GET /contactdb/lists + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/lists'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete a List + +**This endpoint allows you to delete a specific recipient 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. + +### DELETE /contactdb/lists/{list_id} + + +```javascript + const queryParams = { + 'delete_contacts': 'true' +}; + request.qs = queryParams; + request.method = 'DELETE'; + request.url = '/v3/contactdb/lists/{list_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update a List + +**This endpoint allows you to update the name of one of your recipient lists.** + + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### PATCH /contactdb/lists/{list_id} + + +```javascript + const data = { + "name": "newlistname" +}; + request.body = data; + const queryParams = { + 'list_id': 1 +}; + request.qs = queryParams; + request.method = 'PATCH'; + request.url = '/v3/contactdb/lists/{list_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve a single list + +This endpoint allows you to retrieve a single recipient list. + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### GET /contactdb/lists/{list_id} + + +```javascript + const queryParams = { + 'list_id': 1 +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/contactdb/lists/{list_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Add Multiple Recipients to a List + +**This endpoint allows you to add multiple recipients to a list.** + +Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs should be passed exactly as they are returned from recipient endpoints. + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### POST /contactdb/lists/{list_id}/recipients + + +```javascript + const data = [ + "recipient_id1", + "recipient_id2" +]; + request.body = data; + request.method = 'POST'; + request.url = '/v3/contactdb/lists/{list_id}/recipients'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all recipients on a List + +**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. + +### GET /contactdb/lists/{list_id}/recipients + + +```javascript +const queryParams = { + 'page': 1, + 'page_size': 1 +}; +request.qs = queryParams; +request.method = 'GET'; +var list_id = 1; +request.url = '/v3/contactdb/lists/{list_id}/recipients'; +client.request(request) +.then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); +}) +``` +## Add a Single Recipient to a List + +**This endpoint allows you to add a single recipient to a list.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### POST /contactdb/lists/{list_id}/recipients/{recipient_id} + + +```javascript + request.method = 'POST'; + request.url = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete a Single Recipient from a Single List + +**This endpoint allows you to delete a single recipient from a list.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### DELETE /contactdb/lists/{list_id}/recipients/{recipient_id} + + +```javascript + const queryParams = { + 'list_id': 1, + 'recipient_id': 1 +}; + request.qs = queryParams; + request.method = 'DELETE'; + request.url = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Add recipients + +**This endpoint allows you to add a Marketing Campaigns recipient.** + +You can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields Twilio SendGrid provides. + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### POST /contactdb/recipients + + +```javascript + const data = [ + { + "age": "25", + "email": "example@example.com", + "first_name": "", + "last_name": "User" + }, + { + "age": "25", + "email": "example2@example.com", + "first_name": "Example", + "last_name": "User" + } +]; + request.body = data; + request.method = 'POST'; + request.url = '/v3/contactdb/recipients'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete Recipient + +**This endpoint allows you to delete one or more recipients.** + +The body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete. + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### DELETE /contactdb/recipients + + +```javascript + const data = [ + "recipient_id1", + "recipient_id2" +]; + request.body = data; + request.method = 'DELETE'; + request.url = '/v3/contactdb/recipients'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve recipients + +**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.** + +Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of +the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved. + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### GET /contactdb/recipients + + +```javascript + const queryParams = { + 'page': 1, + 'page_size': 1 +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update Recipient + +**This endpoint allows you to update one or more recipients.** + +The body of an API call to this endpoint must include an array of one or more recipient objects. + +It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields Twilio SendGrid provides. + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### PATCH /contactdb/recipients + + +```javascript + const data = [ + { + "email": "jones@example.com", + "first_name": "Guy", + "last_name": "Jones" + } +]; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/contactdb/recipients'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve the count of billable recipients + +**This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for.** + +You are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable count value. + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### GET /contactdb/recipients/billable_count + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/billable_count'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve a Count of Recipients + +**This endpoint allows you to retrieve the total number of Marketing Campaigns recipients.** + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### GET /contactdb/recipients/count + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/count'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve recipients matching search criteria + +**This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.** + +field_name: + +* is a variable that is substituted for your actual custom field name from your recipient. +* Text fields must be URL encoded. Date fields are searchable only by Unix timestamp (e.g. 2/2/2015 becomes 1422835200) +* If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert +your epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to +Mon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through +Mon, 02 Feb 2015 23:59:59 GMT. + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### GET /contactdb/recipients/search + + +```javascript + const queryParams = { + '{field_name}': 'test_string' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/search'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete a Recipient + +**This endpoint allows you to delete a single recipient with the given ID from your contact database.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### DELETE /contactdb/recipients/{recipient_id} + + +```javascript + request.method = 'DELETE'; + request.url = '/v3/contactdb/recipients/{recipient_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve a single recipient + +**This endpoint allows you to retrieve a single recipient by ID from your contact database.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### GET /contactdb/recipients/{recipient_id} + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/{recipient_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve the lists that a recipient is on + +**This endpoint allows you to retrieve the lists that a given recipient belongs to.** + +Each recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to. + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +### GET /contactdb/recipients/{recipient_id}/lists + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/{recipient_id}/lists'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve reserved fields + +**This endpoint allows you to list all fields that are reserved and can't be used for custom field names.** + +The contactdb is a database of your contacts for [Twilio SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html). + +### GET /contactdb/reserved_fields + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/reserved_fields'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Create a Segment + +**This endpoint allows you to create a segment.** + +All recipients in your contactdb will be added or removed automatically depending on whether they match the criteria for this segment. + +List Id: + +* Send this to segment from an existing list. +* Don't send this to segment from your entire contactdb. + +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) + +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 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". + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +For more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment). + +### POST /contactdb/segments + + +```javascript + const data = { + "conditions": [ + { + "and_or": "", + "field": "last_name", + "operator": "eq", + "value": "Miller" + }, + { + "and_or": "and", + "field": "last_clicked", + "operator": "gt", + "value": "01/02/2015" + }, + { + "and_or": "or", + "field": "clicks.campaign_identifier", + "operator": "eq", + "value": "513" + } + ], + "list_id": 4, + "name": "Last Name Miller" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/contactdb/segments'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all segments + +**This endpoint allows you to retrieve all of your segments.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +For more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment). + +### GET /contactdb/segments + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/segments'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete a segment + +**This endpoint allows you to delete a segment from your recipients' database.** + +You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment. + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +For more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment). + +### DELETE /contactdb/segments/{segment_id} + + +```javascript + const queryParams = { + 'delete_contacts': 'true' +}; + request.qs = queryParams; + request.method = 'DELETE'; + request.url = '/v3/contactdb/segments/{segment_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update a segment + +**This endpoint allows you to update a segment.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +For more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment). + +### PATCH /contactdb/segments/{segment_id} + + +```javascript + const data = { + "conditions": [ + { + "and_or": "", + "field": "last_name", + "operator": "eq", + "value": "Miller" + } + ], + "list_id": 5, + "name": "The Millers" +}; + request.body = data; + const queryParams = { + 'segment_id': 'test_string' +}; + request.qs = queryParams; + request.method = 'PATCH'; + request.url = '/v3/contactdb/segments/{segment_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve a segment + +**This endpoint allows you to retrieve a single segment with the given ID.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +For more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment). + +### GET /contactdb/segments/{segment_id} + + +```javascript + const queryParams = { + 'segment_id': 1 +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/contactdb/segments/{segment_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve recipients on a segment + +**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.** + +The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients. + +For more information about segments in Marketing Campaigns, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/lists.html#-Create-a-Segment). + +### GET /contactdb/segments/{segment_id}/recipients + + +```javascript + const queryParams = { + 'page': 1, + 'page_size': 1 +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/contactdb/segments/{segment_id}/recipients'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Get Contact Upload Status + + + +### GET /contactdb/status + + +```javascript + request.method = 'GET'; + request.url = '/v3/contactdb/status'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# DEVICES + +## Retrieve email statistics by device type. + +**This endpoint allows you to retrieve your email statistics segmented by the device type.** + +**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. + +## Available Device Types +| **Device** | **Description** | **Example** | +|---|---|---| +| Desktop | Email software on a desktop computer. | I.E., Outlook, Sparrow, or Apple Mail. | +| Webmail | A web-based email client. | I.E., Yahoo, Google, AOL, or Outlook.com. | +| Phone | A smartphone. | iPhone, Android, Blackberry, etc. +| Tablet | A tablet computer. | iPad, Android-based tablet, etc. | +| Other | An unrecognized device. | + +Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html). + +### GET /devices/stats + + +```javascript + const queryParams = { + 'aggregated_by': 'day', + 'end_date': '2016-04-01', + 'limit': 1, + 'offset': 1, + 'start_date': '2016-01-01' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/devices/stats'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# GEO + +## Retrieve email statistics by country and state/province. + +**This endpoint allows you to retrieve your email statistics segmented by country and state/province.** + +**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. + +Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html). + +### GET /geo/stats + + +```javascript + const queryParams = { + 'aggregated_by': 'day', + 'country': 'US', + 'end_date': '2016-04-01', + 'limit': 1, + 'offset': 1, + 'start_date': '2016-01-01' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/geo/stats'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# IPS + +## Add IPs + +This endpoint is for adding a(n) IP Address(es) to your account. + +### POST /ips + + +```javascript + const data = { + "count": 90323478, + "subusers": [ + "subuser1", + "subuser2" + ], + "user_can_send": true, + "warmup": true +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/ips'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all IP addresses + +**This endpoint allows you to retrieve a list of all assigned and unassigned IPs.** + +The response includes warm-up status, pools, assigned subusers, and authentication info. The start_date field corresponds to when warmup started for that IP. + +A single IP address or a range of IP addresses may be dedicated to an account to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it. + +### GET /ips + + +```javascript + const queryParams = { + 'exclude_whitelabels': 'true', + 'ip': 'test_string', + 'limit': 1, + 'offset': 1, + 'sort_by_direction': 'asc', + 'subuser': 'test_string' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/ips'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all assigned IPs + +**This endpoint allows you to retrieve only assigned IP addresses.** + +A single IP address or a range of IP addresses may be dedicated to an account to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it. + +### GET /ips/assigned + + +```javascript + request.method = 'GET'; + request.url = '/v3/ips/assigned'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Create an IP pool. + +**This endpoint allows you to create an IP pool.** + +**Each user can create up to 10 different IP pools.** + +IP Pools allow you to group your dedicated Twilio SendGrid IP addresses. 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. + +IP pools can only be used with authenticated IP addresses. + +If an IP pool is NOT specified for an email, it will use any IP available, including ones in pools. + +### POST /ips/pools + + +```javascript + const data = { + "name": "marketing" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/ips/pools'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all IP pools. + +**This endpoint allows you to retrieve all of your IP pools.** + +IP Pools allow you to group your dedicated Twilio SendGrid IP addresses. 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. + +IP pools can only be used with authenticated IP addresses. + +If an IP pool is NOT specified for an email, it will use any IP available, including ones in pools. + +### GET /ips/pools + + +```javascript + request.method = 'GET'; + request.url = '/v3/ips/pools'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update an IP pools name. + +**This endpoint allows you to update the name of an IP pool.** + +IP Pools allow you to group your dedicated Twilio SendGrid IP addresses. 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. + +IP pools can only be used with authenticated IP addresses. + +If an IP pool is NOT specified for an email, it will use any IP available, including ones in pools. + +### PUT /ips/pools/{pool_name} + + +```javascript + const data = { + "name": "new_pool_name" +}; + request.body = data; + request.method = 'PUT'; + request.url = '/v3/ips/pools/{pool_name}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Delete an IP pool. + +**This endpoint allows you to delete an IP pool.** + +IP Pools allow you to group your dedicated Twilio SendGrid IP addresses. 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. + +IP pools can only be used with authenticated IP addresses. + +If an IP pool is NOT specified for an email, it will use any IP available, including ones in pools. + +### DELETE /ips/pools/{pool_name} + + +```javascript + request.method = 'DELETE'; + request.url = '/v3/ips/pools/{pool_name}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all IPs in a specified pool. + +**This endpoint allows you to list all of the IP addresses that are in a specific IP pool.** + +IP Pools allow you to group your dedicated Twilio SendGrid IP addresses. 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. + +IP pools can only be used with authenticated IP addresses. + +If an IP pool is NOT specified for an email, it will use any IP available, including ones in pools. + +### GET /ips/pools/{pool_name} + + +```javascript + request.method = 'GET'; + request.url = '/v3/ips/pools/{pool_name}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Add an IP address to a pool + +**This endpoint allows you to add an IP address to an IP pool.** + +You can add the same IP address to multiple pools. It may take up to 60 seconds for your IP address to be added to a pool after your request is made. + +A single IP address or a range of IP addresses may be dedicated to an account to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it. + +### POST /ips/pools/{pool_name}/ips + + +```javascript + const data = { + "ip": "0.0.0.0" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/ips/pools/{pool_name}/ips'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Remove an IP address from a pool. + +**This endpoint allows you to remove an IP address from an IP pool.** + +The same IP address can be added to multiple IP pools. + +A single IP address or a range of IP addresses may be dedicated to an account to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it. + +### DELETE /ips/pools/{pool_name}/ips/{ip} + + +```javascript + request.method = 'DELETE'; + request.url = '/v3/ips/pools/{pool_name}/ips/{ip}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Get remaining IPs count + +This endpoint gets the amount of IP Addresses that can still be created during a given period and the price of those IPs. + +### GET /ips/remaining + + +```javascript + request.method = 'GET'; + request.url = '/v3/ips/remaining'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Add an IP to warmup + +**This endpoint allows you to enter an IP address into warmup mode.** + +Twilio SendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how Twilio SendGrid limits your email traffic for IPs in warmup. + +For more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html). + +### POST /ips/warmup + + +```javascript + const data = { + "ip": "0.0.0.0" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/ips/warmup'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all IPs currently in warmup + +**This endpoint allows you to retrieve all of your IP addresses that are currently warming up.** + +Twilio SendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how Twilio SendGrid limits your email traffic for IPs in warmup. + +For more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html). + +### GET /ips/warmup + + +```javascript + request.method = 'GET'; + request.url = '/v3/ips/warmup'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Remove an IP from warmup + +**This endpoint allows you to remove an IP address from warmup mode.** + +Twilio SendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how Twilio SendGrid limits your email traffic for IPs in warmup. + +For more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html). + +### DELETE /ips/warmup/{ip_address} + + +```javascript + request.method = 'DELETE'; + request.url = '/v3/ips/warmup/{ip_address}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve warmup status for a specific IP address + +**This endpoint allows you to retrieve the warmup status for a specific IP address.** + +Twilio SendGrid can automatically warm up dedicated IP addresses by limiting the amount of mail that can be sent through them per hour, with the limit determined by how long the IP address has been in warmup. See the [warmup schedule](https://sendgrid.com/docs/API_Reference/Web_API_v3/IP_Management/ip_warmup_schedule.html) for more details on how Twilio SendGrid limits your email traffic for IPs in warmup. + +For more general information about warming up IPs, please see our [Classroom](https://sendgrid.com/docs/Classroom/Deliver/Delivery_Introduction/warming_up_ips.html). + +### GET /ips/warmup/{ip_address} + + +```javascript + request.method = 'GET'; + request.url = '/v3/ips/warmup/{ip_address}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all IP pools an IP address belongs to + +**This endpoint allows you to see which IP pools a particular IP address has been added to.** + +The same IP address can be added to multiple IP pools. + +A single IP address or a range of IP addresses may be dedicated to an account to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it. + +### GET /ips/{ip_address} + + +```javascript + request.method = 'GET'; + request.url = '/v3/ips/{ip_address}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# MAIL + +## Create a batch ID + +**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 any time up to 10 minutes before the scheduled date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint. + +More Information: + +* [Scheduling Parameters > Batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html) + +### POST /mail/batch + + +```javascript + request.method = 'POST'; + request.url = '/v3/mail/batch'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Validate batch ID + +**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 any time up to 10 minutes before the scheduled date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint. + +More Information: + +* [Scheduling Parameters > Batch ID](https://sendgrid.com/docs/API_Reference/SMTP_API/scheduling_parameters.html) + +### GET /mail/batch/{batch_id} + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail/batch/{batch_id}'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## v3 Mail Send + +This endpoint allows you to send an email over Twilio SendGrid's v3 Web API, the most recent version of our API. If you are looking for documentation about the v2 Mail Send endpoint, please see our [v2 API Reference](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). + +* Top level parameters are referred to as "global". +* Individual fields within the personalizations array will override any other global, or message level, parameters that are defined outside of personalizations. + +**Twilio SendGrid provides libraries to help you quickly and easily integrate with the v3 Web API in 7 different languages: [C#](https://github.com/sendgrid/sendgrid-csharp), [Go](https://github.com/sendgrid/sendgrid-go), [Java](https://github.com/sendgrid/sendgrid-java), [Node JS](https://github.com/sendgrid/sendgrid-nodejs), [PHP](https://github.com/sendgrid/sendgrid-php), [Python](https://github.com/sendgrid/sendgrid-python), and [Ruby](https://github.com/sendgrid/sendgrid-ruby).** + + +For more detailed information about how to use the v3 Mail Send endpoint, please visit our [Classroom](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/index.html). + +### POST /mail/send + +// This endpoint has a helper, check it out [here](../mail). + +```javascript + const data = { + "content": [ + { + "type": "text/html", + "value": "Hello, world!
" + } + ], + "from": { + "email": "sam.smith@example.com", + "name": "Sam Smith" + }, + "personalizations": [ + { + "subject": "Hello, World!", + "to": [ + { + "email": "john.doe@example.com", + "name": "John Doe" + } + ] + } + ], + "reply_to": { + "email": "sam.smith@example.com", + "name": "Sam Smith" + }, + "subject": "Hello, World!" +}; + request.body = data; + request.method = 'POST'; + request.url = '/v3/mail/send'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# MAIL SETTINGS + +## Retrieve all mail settings + +**This endpoint allows you to retrieve a list of all mail settings.** + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings + + +```javascript + const queryParams = { + 'limit': 1, + 'offset': 1 +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/mail_settings'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update address whitelist mail settings + +**This endpoint allows you to update your current email address whitelist settings.** + +The address whitelist setting whitelists a specified email address or domain for which mail should never be suppressed. For example, you own the domain example.com, and one or more of your recipients use email@example.com addresses, by placing example.com in the address whitelist setting, all bounces, blocks, and unsubscribes logged for that domain will be ignored and sent as if under normal sending conditions. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/address_whitelist + + +```javascript + const data = { + "enabled": true, + "list": [ + "email1@example.com", + "example.com" + ] +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/address_whitelist'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve address whitelist mail settings + +**This endpoint allows you to retrieve your current email address whitelist settings.** + +The address whitelist setting whitelists a specified email address or domain for which mail should never be suppressed. For example, you own the domain example.com, and one or more of your recipients use email@example.com addresses, by placing example.com in the address whitelist setting, all bounces, blocks, and unsubscribes logged for that domain will be ignored and sent as if under normal sending conditions. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/address_whitelist + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/address_whitelist'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update BCC mail settings + +**This endpoint allows you to update your current BCC mail settings.** + +When the BCC mail setting is enabled, Twilio SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/bcc + + +```javascript + const data = { + "email": "email@example.com", + "enabled": false +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/bcc'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve all BCC mail settings + +**This endpoint allows you to retrieve your current BCC mail settings.** + +When the BCC mail setting is enabled, Twilio SendGrid will automatically send a blind carbon copy (BCC) to an address for every email sent without adding that address to the header. Please note that only one email address may be entered in this field if you wish to distribute BCCs to multiple addresses you will need to create a distribution group or use forwarding rules. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/bcc + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/bcc'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update bounce purge mail settings + +**This endpoint allows you to update your current bounce purge settings.** + +This setting allows you to set a schedule for Twilio SendGrid to automatically delete contacts from your soft and hard bounce suppression lists. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/bounce_purge + + +```javascript + const data = { + "enabled": true, + "hard_bounces": 5, + "soft_bounces": 5 +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/bounce_purge'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve bounce purge mail settings + +**This endpoint allows you to retrieve your current bounce purge settings.** + +This setting allows you to set a schedule for Twilio SendGrid to automatically delete contacts from your soft and hard bounce suppression lists. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/bounce_purge + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/bounce_purge'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update footer mail settings + +**This endpoint allows you to update your current Footer mail settings.** + +The footer setting will insert a custom footer at the bottom of the text and HTML bodies. Use the embedded HTML editor and plain text entry fields to create the content of the footers to be inserted into your emails. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/footer + + +```javascript + const data = { + "enabled": true, + "html_content": "...", + "plain_content": "..." +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/footer'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve footer mail settings + +**This endpoint allows you to retrieve your current Footer mail settings.** + +The footer setting will insert a custom footer at the bottom of the text and HTML bodies. Use the embedded HTML editor and plain text entry fields to create the content of the footers to be inserted into your emails. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/footer + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/footer'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update forward bounce mail settings + +**This endpoint allows you to update your current bounce forwarding mail settings.** + +Activating this setting allows you to specify an email address to which bounce reports are forwarded. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/forward_bounce + + +```javascript + const data = { + "email": "example@example.com", + "enabled": true +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/forward_bounce'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve forward bounce mail settings + +**This endpoint allows you to retrieve your current bounce forwarding mail settings.** + +Activating this setting allows you to specify an email address to which bounce reports are forwarded. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/forward_bounce + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/forward_bounce'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update forward spam mail settings + +**This endpoint allows you to update your current Forward Spam mail settings.** + +Enabling the forward spam setting allows you to specify an email address to which spam reports will be forwarded. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/forward_spam + + +```javascript + const data = { + "email": "", + "enabled": false +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/forward_spam'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve forward spam mail settings + +**This endpoint allows you to retrieve your current Forward Spam mail settings.** + +Enabling the forward spam setting allows you to specify an email address to which spam reports will be forwarded. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/forward_spam + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/forward_spam'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update plain content mail settings + +**This endpoint allows you to update your current Plain Content mail settings.** + +The plain content setting will automatically convert any plain text emails that you send to HTML before sending. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/plain_content + + +```javascript + const data = { + "enabled": false +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/plain_content'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve plain content mail settings + +**This endpoint allows you to retrieve your current Plain Content mail settings.** + +The plain content setting will automatically convert any plain text emails that you send to HTML before sending. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/plain_content + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/plain_content'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update spam check mail settings + +**This endpoint allows you to update your current spam checker mail settings.** + +The spam checker filter notifies you when emails are detected that exceed a predefined spam threshold. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/spam_check + + +```javascript + const data = { + "enabled": true, + "max_score": 5, + "url": "url" +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/spam_check'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve spam check mail settings + +**This endpoint allows you to retrieve your current Spam Checker mail settings.** + +The spam checker filter notifies you when emails are detected that exceed a predefined spam threshold. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/spam_check + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/spam_check'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Update template mail settings + +**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). + +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. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### PATCH /mail_settings/template + + +```javascript + const data = { + "enabled": true, + "html_content": "<% body %>" +}; + request.body = data; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/template'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` +## Retrieve legacy template mail settings + +**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). + +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. + +Mail settings allow you to tell Twilio SendGrid specific things to do to every email that you send to your recipients over Twilio SendGrid's [Web API](https://sendgrid.com/docs/API_Reference/Web_API/mail.html) or [SMTP Relay](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html). + +### GET /mail_settings/template + + +```javascript + request.method = 'GET'; + request.url = '/v3/mail_settings/template'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# MAILBOX PROVIDERS + +## Retrieve email statistics by mailbox provider. + +**This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.** + +**We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. + +Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/index.html). + +### GET /mailbox_providers/stats + + +```javascript + const queryParams = { + 'aggregated_by': 'day', + 'end_date': '2016-04-01', + 'limit': 1, + 'mailbox_providers': 'test_string', + 'offset': 1, + 'start_date': '2016-01-01' +}; + request.qs = queryParams; + request.method = 'GET'; + request.url = '/v3/mailbox_providers/stats'; + client.request(request) + .then(([response, body]) => { + console.log(response.statusCode); + console.log(response.body); + }) +``` + +# MESSAGES + +## Filter all messages +> In order to gain access to the Email Activity Feed API, you must purchase [additional email activity history](https://app.sendgrid.com/settings/billing/addons/email_activity). + +Filter all messages to search your Email Activity. All queries need to be [URL encoded](https://meyerweb.com/eric/tools/dencoder/), and have this format: + +`query={query_type}="{query_content}"` + +encoded, this would look like this: + +`query=type%3D%22query_content%22` + +for example: + +Filter by a specific email - `query=to_email%3D%22example%40example.com%22` + +Filter by subject line - `query=subject%3d%22A%20Great%20Subject%22` + +You can filter by other operators besides `=`. We also accept `!=`, `<`, and `>`. + +If you use the `@sendgrid/client` library, you do not have to encode anything (it will end up being double encoded). + +For a tutorial on how to get started, check out [Getting Started with the Email Activity API](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html). + +**Full list of basic query types and examples:** +(replace the data in quotes with the information you want to query) + +| Query | +Unencoded example (put this one into the try it out query - it'll automatically encode it for you) | +Encoded example (use this one in your code) | +
|---|---|---|
msg_id |
+ msg_id="filter0307p1las1-16816-5A023E36-1.0" |
+ msg_id%3D%22filter0307p1las1-16816-5A023E36-1.0%22 |
+
from_email |
+ from_email="testing@sendgrid.net" |
+ from_email%3D%22testing%40sendgrid.net%22 |
+
subject |
+ subject="This is a subject test" |
+ subject%22This%20is%20a%20subject%20test%22 |
+
to_email |
+ to_email="example@example.com" |
+ to_email%3D%22example%40example.com%22 |
+
status |
+ status="processed" |
+ status%22processed%22 |
+
template_id |
+ template_id="8f0d27bc-cf8f-42d3-b951-3990af7d0619" |
+ template_id%3D%228f0d27bc-cf8f-42d3-b951-3990af7d0619%22 |
+
template_name |
+ template_name="example_template" |
+ template_name%3D%22example_template%22 |
+
campaign_name |
+ campaign_name="example_campaign" |
+ campaign_name%3D%22example_campaign%22 |
+
campaign_id |
+ campaign_id="1453849" |
+ campaign_id%3D%221453849%22 |
+
api_key_id |
+ api_key_id="-hVjtoFgGUNPq3DPPPkJN3mCIDIwrl3qdFZcqYKnlq94" (everything after the middle dot in the API key) |
+ api_key_id%3D%22-hVjtoFgGUNPq3DPPPkJN3mCIDIwrl3qdFZcqYKnlq94%22 |
+
api_key_name |
+ api_key_name="test_name" |
+ api_key_name%3D%22test_name%22 |
+
events |
+ status="processed" |
+ status%3D%22processed%22 |
+
originating_ip - this is the IP address of the person sending the message |
+ originating_ip="4.77.777.77" |
+ originating_ip%3D%224.77.777.77%22 |
+
categories - custom tags that you create |
+ categories="category_example" |
+ categories="category_example" |
+
unique_args - custom tracking arguments that you can attach to SMTP API calls |
+ unique_args="example argument" |
+ unique_args%3D%22example%20argument%22 |
+
outbound_ip - this is the Twilio SendGrid dedicated IP address used to send the email |
+ outbound_ip="4.77.777.77" |
+ outbound_ip%3D%224.77.777.77%22 |
+
last_event_time |
+ last_event_time="2017-11-07T23:13:58Z" |
+ last_event_time%3D%E2%80%9C2017-11-07T23%3A13%3A58Z%E2%80%9D |
+
clicks |
+ clicks="0" |
+ clicks%3D%220%22 |
+
unsubscribe_group_name |
+ unsubscribe_group_name="Global Unsubscribes" |
+ unsubscribe_group_name%3D%22Global%20Unsubscribes%22 |
+
unsubscribe_group_id |
+ unsubscribe_group_id="1041" |
+ unsubscribe_group_id%3D%221041%22 |
+
teammate - teamates username |
+ teammate="my_username" |
+ teammate%3D%22my_username%22 |
+
-
+
- Validated link branding marked as "default" +
- Legacy link brands (migrated from the whitelabel wizard) +
- Default SendGrid link whitelabel (i.e. 100.ct.sendgrid.net) +
Check out our spring line!
', + ip_pool: 'marketing', + list_ids: [ + 110, + 124, + ], + plain_content: 'Check out our spring line!', + segment_ids: [ + 110, + ], + sender_id: 124451, + subject: 'New Products for Spring!', + suppression_group_id: 42, + title: 'March Newsletter', + }; + request.method = 'POST'; + request.url = '/v3/campaigns'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_campaigns_get', () => { + const request = {}; + request.qs = { + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/campaigns'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_campaigns__campaign_id__patch', () => { + const request = {}; + request.body = { + categories: [ + 'summer line', + ], + html_content: 'Check out our summer line!
', + plain_content: 'Check out our summer line!', + subject: 'New Products for Summer!', + title: 'May Newsletter', + }; + request.method = 'PATCH'; + request.url = '/v3/campaigns/{campaign_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_campaigns__campaign_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/campaigns/{campaign_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_campaigns__campaign_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/campaigns/{campaign_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_campaigns__campaign_id__schedules_delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_campaigns__campaign_id__schedules_post', () => { + const request = {}; + request.body = { + send_at: 1489771528, + }; + request.method = 'POST'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_campaigns__campaign_id__schedules_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_campaigns__campaign_id__schedules_patch', () => { + const request = {}; + request.body = { + send_at: 1489451436, + }; + request.method = 'PATCH'; + request.url = '/v3/campaigns/{campaign_id}/schedules'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_campaigns__campaign_id__schedules_now_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/campaigns/{campaign_id}/schedules/now'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_campaigns__campaign_id__schedules_test_post', () => { + const request = {}; + request.body = { + to: 'your.email@example.com', + }; + request.method = 'POST'; + request.url = '/v3/campaigns/{campaign_id}/schedules/test'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_categories_get', () => { + const request = {}; + request.qs = { + category: 'test_string', + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/categories'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_categories_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + categories: 'test_string', + end_date: '2016-04-01', + limit: 1, + offset: 1, + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/categories/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_categories_stats_sums_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + limit: 1, + offset: 1, + sort_by_direction: 'asc', + sort_by_metric: 'test_string', + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/categories/stats/sums'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_clients_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/clients/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_clients__client_type__stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/clients/{client_type}/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_custom_fields_post', () => { + const request = {}; + request.body = { + name: 'pet', + type: 'text', + }; + request.method = 'POST'; + request.url = '/v3/contactdb/custom_fields'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_contactdb_custom_fields_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/custom_fields'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_custom_fields__custom_field_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/contactdb/custom_fields/{custom_field_id}'; + it('should have the correct response code', () => { + return testRequest(request, 202); + }); +}); + +describe('test_contactdb_custom_fields__custom_field_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/custom_fields/{custom_field_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_lists_post', () => { + const request = {}; + request.body = { + name: 'your list name', + }; + request.method = 'POST'; + request.url = '/v3/contactdb/lists'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_contactdb_lists_delete', () => { + const request = {}; + request.body = [ + 1, + 2, + 3, + 4, + ]; + request.method = 'DELETE'; + request.url = '/v3/contactdb/lists'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_contactdb_lists_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/lists'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_lists__list_id__delete', () => { + const request = {}; + request.qs = { + delete_contacts: 'true', + }; + request.method = 'DELETE'; + request.url = '/v3/contactdb/lists/{list_id}'; + it('should have the correct response code', () => { + return testRequest(request, 202); + }); +}); + +describe('test_contactdb_lists__list_id__patch', () => { + const request = {}; + request.body = { + name: 'newlistname', + }; + request.qs = { + list_id: 1, + }; + request.method = 'PATCH'; + request.url = '/v3/contactdb/lists/{list_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_lists__list_id__get', () => { + const request = {}; + request.qs = { + list_id: 1, + }; + request.method = 'GET'; + request.url = '/v3/contactdb/lists/{list_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_lists__list_id__recipients_post', () => { + const request = {}; + request.body = [ + 'recipient_id1', + 'recipient_id2', + ]; + request.method = 'POST'; + request.url = '/v3/contactdb/lists/{list_id}/recipients'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_contactdb_lists__list_id__recipients_get', () => { + const request = {}; + request.qs = { + list_id: 1, + page: 1, + page_size: 1, + }; + request.method = 'GET'; + request.url = '/v3/contactdb/lists/{list_id}/recipients'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_lists__list_id__recipients__recipient_id__post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_contactdb_lists__list_id__recipients__recipient_id__delete', () => { + const request = {}; + request.qs = { + list_id: 1, + recipient_id: 1, + }; + request.method = 'DELETE'; + request.url = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_contactdb_recipients_post', () => { + const request = {}; + request.body = [ + { + age: 25, + email: 'example@example.com', + first_name: '', + last_name: 'User', + }, + { + age: 25, + email: 'example2@example.com', + first_name: 'Example', + last_name: 'User', + }, + ]; + request.method = 'POST'; + request.url = '/v3/contactdb/recipients'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_contactdb_recipients_delete', () => { + const request = {}; + request.body = [ + 'recipient_id1', + 'recipient_id2', + ]; + request.method = 'DELETE'; + request.url = '/v3/contactdb/recipients'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_recipients_get', () => { + const request = {}; + request.qs = { + page: 1, + page_size: 1, + }; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_recipients_patch', () => { + const request = {}; + request.body = [ + { + email: 'jones@example.com', + first_name: 'Guy', + last_name: 'Jones', + }, + ]; + request.method = 'PATCH'; + request.url = '/v3/contactdb/recipients'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_contactdb_recipients_billable_count_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/billable_count'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_recipients_count_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/count'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_recipients_search_get', () => { + const request = {}; + request.qs = { + '{field_name}': 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/search'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_recipients__recipient_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/contactdb/recipients/{recipient_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_contactdb_recipients__recipient_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/{recipient_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_recipients__recipient_id__lists_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/recipients/{recipient_id}/lists'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_reserved_fields_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/reserved_fields'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_segments_post', () => { + const request = {}; + request.body = { + conditions: [ + { + and_or: '', + field: 'last_name', + operator: 'eq', + value: 'Miller', + }, + { + and_or: 'and', + field: 'last_clicked', + operator: 'gt', + value: '01/02/2015', + }, + { + and_or: 'or', + field: 'clicks.campaign_identifier', + operator: 'eq', + value: '513', + }, + ], + list_id: 4, + name: 'Last Name Miller', + }; + request.method = 'POST'; + request.url = '/v3/contactdb/segments'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_segments_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/segments'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_segments__segment_id__delete', () => { + const request = {}; + request.qs = { + delete_contacts: 'true', + }; + request.method = 'DELETE'; + request.url = '/v3/contactdb/segments/{segment_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_contactdb_segments__segment_id__patch', () => { + const request = {}; + request.body = { + conditions: [ + { + and_or: '', + field: 'last_name', + operator: 'eq', + value: 'Miller', + }, + ], + list_id: 5, + name: 'The Millers', + }; + request.qs = { + segment_id: 'test_string', + }; + request.method = 'PATCH'; + request.url = '/v3/contactdb/segments/{segment_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_segments__segment_id__get', () => { + const request = {}; + request.qs = { + segment_id: 1, + }; + request.method = 'GET'; + request.url = '/v3/contactdb/segments/{segment_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_segments__segment_id__recipients_get', () => { + const request = {}; + request.qs = { + page: 1, + page_size: 1, + }; + request.method = 'GET'; + request.url = '/v3/contactdb/segments/{segment_id}/recipients'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_contactdb_status_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/contactdb/status'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_devices_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + limit: 1, + offset: 1, + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/devices/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_geo_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + country: 'US', + end_date: '2016-04-01', + limit: 1, + offset: 1, + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/geo/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_post', () => { + const request = {}; + request.body = { + count: 90323478, + subusers: [ + 'subuser1', + 'subuser2', + ], + user_can_send: true, + warmup: true, + }; + request.method = 'POST'; + request.url = '/v3/ips'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_ips_get', () => { + const request = {}; + request.qs = { + exclude_whitelabels: 'true', + ip: 'test_string', + limit: 1, + offset: 1, + sort_by_direction: 'asc', + subuser: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/ips'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_assigned_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/ips/assigned'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_pools_post', () => { + const request = {}; + request.body = { + name: 'marketing', + }; + request.method = 'POST'; + request.url = '/v3/ips/pools'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_pools_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/ips/pools'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_pools__pool_name__put', () => { + const request = {}; + request.body = { + name: 'new_pool_name', + }; + request.method = 'PUT'; + request.url = '/v3/ips/pools/{pool_name}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_pools__pool_name__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/ips/pools/{pool_name}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_ips_pools__pool_name__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/ips/pools/{pool_name}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_pools__pool_name__ips_post', () => { + const request = {}; + request.body = { + ip: '0.0.0.0', + }; + request.method = 'POST'; + request.url = '/v3/ips/pools/{pool_name}/ips'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_ips_pools__pool_name__ips__ip__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/ips/pools/{pool_name}/ips/{ip}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_ips_remaining_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/ips/remaining'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_warmup_post', () => { + const request = {}; + request.body = { + ip: '0.0.0.0', + }; + request.method = 'POST'; + request.url = '/v3/ips/warmup'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_warmup_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/ips/warmup'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips_warmup__ip_address__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/ips/warmup/{ip_address}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_ips_warmup__ip_address__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/ips/warmup/{ip_address}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_ips__ip_address__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/ips/{ip_address}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_batch_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/mail/batch'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_mail_batch__batch_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail/batch/{batch_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_send_post', () => { + const request = {}; + request.body = { + content: [ + { + type: 'text/html', + value: 'Hello, world!
', + }, + ], + from: { + email: 'sam.smith@example.com', + name: 'Sam Smith', + }, + personalizations: [ + { + subject: 'Hello, World!', + to: [ + { + email: 'john.doe@example.com', + name: 'John Doe', + }, + ], + }, + ], + reply_to: { + email: 'sam.smith@example.com', + name: 'Sam Smith', + }, + subject: 'Hello, World!', + }; + request.method = 'POST'; + request.url = '/v3/mail/send'; + it('should have the correct response code', () => { + return testRequest(request, 202); + }); +}); + +describe('test_mail_settings_get', () => { + const request = {}; + request.qs = { + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/mail_settings'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_address_whitelist_patch', () => { + const request = {}; + request.body = { + enabled: true, + list: [ + 'email1@example.com', + 'example.com', + ], + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/address_whitelist'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_address_whitelist_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/address_whitelist'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_bcc_patch', () => { + const request = {}; + request.body = { + email: 'email@example.com', + enabled: false, + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/bcc'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_bcc_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/bcc'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_bounce_purge_patch', () => { + const request = {}; + request.body = { + enabled: true, + hard_bounces: 5, + soft_bounces: 5, + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/bounce_purge'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_bounce_purge_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/bounce_purge'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_footer_patch', () => { + const request = {}; + request.body = { + enabled: true, + html_content: '...', + plain_content: '...', + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/footer'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_footer_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/footer'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_forward_bounce_patch', () => { + const request = {}; + request.body = { + email: 'example@example.com', + enabled: true, + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/forward_bounce'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_forward_bounce_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/forward_bounce'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_forward_spam_patch', () => { + const request = {}; + request.body = { + email: '', + enabled: false, + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/forward_spam'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_forward_spam_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/forward_spam'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_plain_content_patch', () => { + const request = {}; + request.body = { + enabled: false, + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/plain_content'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_plain_content_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/plain_content'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_spam_check_patch', () => { + const request = {}; + request.body = { + enabled: true, + max_score: 5, + url: 'url', + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/spam_check'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_spam_check_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/spam_check'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_template_patch', () => { + const request = {}; + request.body = { + enabled: true, + html_content: '<% body %>', + }; + request.method = 'PATCH'; + request.url = '/v3/mail_settings/template'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mail_settings_template_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/mail_settings/template'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_mailbox_providers_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + limit: 1, + mailbox_providers: 'test_string', + offset: 1, + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/mailbox_providers/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_partner_settings_get', () => { + const request = {}; + request.qs = { + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/partner_settings'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_partner_settings_new_relic_patch', () => { + const request = {}; + request.body = { + enable_subuser_statistics: true, + enabled: true, + license_key: '', + }; + request.method = 'PATCH'; + request.url = '/v3/partner_settings/new_relic'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_partner_settings_new_relic_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/partner_settings/new_relic'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_scopes_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/scopes'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_scopes_requests_get', () => { + const request = {}; + request.qs = { + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/scopes/requests'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_scopes_requests__request_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/scopes/requests/{request_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_scopes_requests__request_id__approve_patch', () => { + const request = {}; + request.method = 'PATCH'; + request.url = '/v3/scopes/requests/{request_id}/approve'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_senders_post', () => { + const request = {}; + request.body = { + address: '123 Elm St.', + address_2: 'Apt. 456', + city: 'Denver', + country: 'United States', + from: { + email: 'from@example.com', + name: 'Example INC', + }, + nickname: 'My Sender ID', + reply_to: { + email: 'replyto@example.com', + name: 'Example INC', + }, + state: 'Colorado', + zip: '80202', + }; + request.method = 'POST'; + request.url = '/v3/senders'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_senders_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/senders'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_senders__sender_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/senders/{sender_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_senders__sender_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/senders/{sender_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_senders__sender_id__patch', () => { + const request = {}; + request.body = { + address: '123 Elm St.', + address_2: 'Apt. 456', + city: 'Denver', + country: 'United States', + from: { + email: 'from@example.com', + name: 'Example INC', + }, + nickname: 'My Sender ID', + reply_to: { + email: 'replyto@example.com', + name: 'Example INC', + }, + state: 'Colorado', + zip: '80202', + }; + request.method = 'PATCH'; + request.url = '/v3/senders/{sender_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_senders__sender_id__resend_verification_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/senders/{sender_id}/resend_verification'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + limit: 1, + offset: 1, + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers_post', () => { + const request = {}; + request.body = { + email: 'John@example.com', + ips: [ + '1.1.1.1', + '2.2.2.2', + ], + password: 'johns_password', + username: 'John@example.com', + }; + request.method = 'POST'; + request.url = '/v3/subusers'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers_get', () => { + const request = {}; + request.qs = { + limit: 1, + offset: 1, + username: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/subusers'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers_reputations_get', () => { + const request = {}; + request.qs = { + usernames: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/subusers/reputations'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + limit: 1, + offset: 1, + start_date: '2016-01-01', + subusers: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/subusers/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers_stats_monthly_get', () => { + const request = {}; + request.qs = { + date: 'test_string', + limit: 1, + offset: 1, + sort_by_direction: 'asc', + sort_by_metric: 'test_string', + subuser: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/subusers/stats/monthly'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers_stats_sums_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + limit: 1, + offset: 1, + sort_by_direction: 'asc', + sort_by_metric: 'test_string', + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/subusers/stats/sums'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers__subuser_name__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/subusers/{subuser_name}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_subusers__subuser_name__patch', () => { + const request = {}; + request.body = { + disabled: false, + }; + request.method = 'PATCH'; + request.url = '/v3/subusers/{subuser_name}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_subusers__subuser_name__ips_put', () => { + const request = {}; + request.body = [ + '127.0.0.1', + ]; + request.method = 'PUT'; + request.url = '/v3/subusers/{subuser_name}/ips'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers__subuser_name__monitor_put', () => { + const request = {}; + request.body = { + email: 'example@example.com', + frequency: 500, + }; + request.method = 'PUT'; + request.url = '/v3/subusers/{subuser_name}/monitor'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers__subuser_name__monitor_post', () => { + const request = {}; + request.body = { + email: 'example@example.com', + frequency: 50000, + }; + request.method = 'POST'; + request.url = '/v3/subusers/{subuser_name}/monitor'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers__subuser_name__monitor_delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/subusers/{subuser_name}/monitor'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_subusers__subuser_name__monitor_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/subusers/{subuser_name}/monitor'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_subusers__subuser_name__stats_monthly_get', () => { + const request = {}; + request.qs = { + date: 'test_string', + limit: 1, + offset: 1, + sort_by_direction: 'asc', + sort_by_metric: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/subusers/{subuser_name}/stats/monthly'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_blocks_delete', () => { + const request = {}; + request.body = { + delete_all: false, + emails: [ + 'example1@example.com', + 'example2@example.com', + ], + }; + request.method = 'DELETE'; + request.url = '/v3/suppression/blocks'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_blocks_get', () => { + const request = {}; + request.qs = { + end_time: 1, + limit: 1, + offset: 1, + start_time: 1, + }; + request.method = 'GET'; + request.url = '/v3/suppression/blocks'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_blocks__email__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/suppression/blocks/{email}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_blocks__email__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/suppression/blocks/{email}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_bounces_delete', () => { + const request = {}; + request.body = { + delete_all: true, + emails: [ + 'example@example.com', + 'example2@example.com', + ], + }; + request.method = 'DELETE'; + request.url = '/v3/suppression/bounces'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_bounces_get', () => { + const request = {}; + request.qs = { + end_time: 1, + start_time: 1, + }; + request.method = 'GET'; + request.url = '/v3/suppression/bounces'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_bounces__email__delete', () => { + const request = {}; + request.qs = { + email_address: 'example@example.com', + }; + request.method = 'DELETE'; + request.url = '/v3/suppression/bounces/{email}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_bounces__email__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/suppression/bounces/{email}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_invalid_emails_delete', () => { + const request = {}; + request.body = { + delete_all: false, + emails: [ + 'example1@example.com', + 'example2@example.com', + ], + }; + request.method = 'DELETE'; + request.url = '/v3/suppression/invalid_emails'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_invalid_emails_get', () => { + const request = {}; + request.qs = { + end_time: 1, + limit: 1, + offset: 1, + start_time: 1, + }; + request.method = 'GET'; + request.url = '/v3/suppression/invalid_emails'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_invalid_emails__email__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/suppression/invalid_emails/{email}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_invalid_emails__email__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/suppression/invalid_emails/{email}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_spam_reports_delete', () => { + const request = {}; + request.body = { + delete_all: false, + emails: [ + 'example1@example.com', + 'example2@example.com', + ], + }; + request.method = 'DELETE'; + request.url = '/v3/suppression/spam_reports'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_spam_reports_get', () => { + const request = {}; + request.qs = { + end_time: 1, + limit: 1, + offset: 1, + start_time: 1, + }; + request.method = 'GET'; + request.url = '/v3/suppression/spam_reports'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_spam_reports__email__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/suppression/spam_reports/{email}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_suppression_spam_reports__email__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/suppression/spam_reports/{email}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_suppression_unsubscribes_get', () => { + const request = {}; + request.qs = { + end_time: 1, + limit: 1, + offset: 1, + start_time: 1, + }; + request.method = 'GET'; + request.url = '/v3/suppression/unsubscribes'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_teammates_post', () => { + const request = {}; + request.body = { + email: 'teammate1@example.com', + is_admin: false, + scopes: [ + 'user.profile.read', + 'user.profile.update', + ], + }; + request.method = 'POST'; + request.url = '/v3/teammates'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_teammates_get', () => { + const request = {}; + request.qs = { + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/teammates'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_teammates_pending_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/teammates/pending'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_teammates_pending__token__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/teammates/pending/{token}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_teammates_pending__token__resend_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/teammates/pending/{token}/resend'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_teammates__username__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/teammates/{username}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_teammates__username__patch', () => { + const request = {}; + request.body = { + is_admin: false, + scopes: [ + 'user.profile.read', + 'user.profile.edit', + ], + }; + request.method = 'PATCH'; + request.url = '/v3/teammates/{username}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_teammates__username__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/teammates/{username}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_templates_post', () => { + const request = {}; + request.body = { + name: 'example_name', + }; + request.method = 'POST'; + request.url = '/v3/templates'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_templates_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/templates'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_templates__template_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/templates/{template_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_templates__template_id__patch', () => { + const request = {}; + request.body = { + name: 'new_example_name', + }; + request.method = 'PATCH'; + request.url = '/v3/templates/{template_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_templates__template_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/templates/{template_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_templates__template_id__versions_post', () => { + const request = {}; + request.body = { + active: 1, + html_content: '<%body%>', + name: 'example_version_name', + plain_content: '<%body%>', + subject: '<%subject%>', + template_id: 'ddb96bbc-9b92-425e-8979-99464621b543', + }; + request.method = 'POST'; + request.url = '/v3/templates/{template_id}/versions'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_templates__template_id__versions__version_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/templates/{template_id}/versions/{version_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_templates__template_id__versions__version_id__patch', () => { + const request = {}; + request.body = { + active: 1, + html_content: '<%body%>', + name: 'updated_example_name', + plain_content: '<%body%>', + subject: '<%subject%>', + }; + request.method = 'PATCH'; + request.url = '/v3/templates/{template_id}/versions/{version_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_templates__template_id__versions__version_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/templates/{template_id}/versions/{version_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_templates__template_id__versions__version_id__activate_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/templates/{template_id}/versions/{version_id}/activate'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_get', () => { + const request = {}; + request.qs = { + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/tracking_settings'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_click_patch', () => { + const request = {}; + request.body = { + enabled: true, + }; + request.method = 'PATCH'; + request.url = '/v3/tracking_settings/click'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_click_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/tracking_settings/click'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_google_analytics_patch', () => { + const request = {}; + request.body = { + enabled: true, + utm_campaign: 'website', + utm_content: '', + utm_medium: 'email', + utm_source: 'sendgrid.com', + utm_term: '', + }; + request.method = 'PATCH'; + request.url = '/v3/tracking_settings/google_analytics'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_google_analytics_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/tracking_settings/google_analytics'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_open_patch', () => { + const request = {}; + request.body = { + enabled: true, + }; + request.method = 'PATCH'; + request.url = '/v3/tracking_settings/open'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_open_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/tracking_settings/open'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_subscription_patch', () => { + const request = {}; + request.body = { + enabled: true, + html_content: 'html content', + landing: 'landing page html', + plain_content: 'text content', + replace: 'replacement tag', + url: 'url', + }; + request.method = 'PATCH'; + request.url = '/v3/tracking_settings/subscription'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_tracking_settings_subscription_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/tracking_settings/subscription'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_account_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/account'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_credits_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/credits'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_email_put', () => { + const request = {}; + request.body = { + email: 'example@example.com', + }; + request.method = 'PUT'; + request.url = '/v3/user/email'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_email_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/email'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_password_put', () => { + const request = {}; + request.body = { + new_password: 'new_password', + old_password: 'old_password', + }; + request.method = 'PUT'; + request.url = '/v3/user/password'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_profile_patch', () => { + const request = {}; + request.body = { + city: 'Orange', + first_name: 'Example', + last_name: 'User', + }; + request.method = 'PATCH'; + request.url = '/v3/user/profile'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_profile_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/profile'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_scheduled_sends_post', () => { + const request = {}; + request.body = { + batch_id: 'YOUR_BATCH_ID', + status: 'pause', + }; + request.method = 'POST'; + request.url = '/v3/user/scheduled_sends'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_user_scheduled_sends_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/scheduled_sends'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_scheduled_sends__batch_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/user/scheduled_sends/{batch_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_user_scheduled_sends__batch_id__patch', () => { + const request = {}; + request.body = { + status: 'pause', + }; + request.method = 'PATCH'; + request.url = '/v3/user/scheduled_sends/{batch_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_user_scheduled_sends__batch_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/scheduled_sends/{batch_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_settings_enforced_tls_patch', () => { + const request = {}; + request.body = { + require_tls: true, + require_valid_cert: false, + }; + request.method = 'PATCH'; + request.url = '/v3/user/settings/enforced_tls'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_settings_enforced_tls_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/settings/enforced_tls'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_username_put', () => { + const request = {}; + request.body = { + username: 'test_username', + }; + request.method = 'PUT'; + request.url = '/v3/user/username'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_username_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/username'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_webhooks_event_settings_patch', () => { + const request = {}; + request.body = { + bounce: true, + click: true, + deferred: true, + delivered: true, + dropped: true, + enabled: true, + group_resubscribe: true, + group_unsubscribe: true, + open: true, + processed: true, + spam_report: true, + unsubscribe: true, + url: 'url', + }; + request.method = 'PATCH'; + request.url = '/v3/user/webhooks/event/settings'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_webhooks_event_settings_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/webhooks/event/settings'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_webhooks_event_test_post', () => { + const request = {}; + request.body = { + url: 'url', + }; + request.method = 'POST'; + request.url = '/v3/user/webhooks/event/test'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_user_webhooks_parse_settings_post', () => { + const request = {}; + request.body = { + hostname: 'myhostname.com', + send_raw: false, + spam_check: true, + url: 'http://email.myhosthame.com', + }; + request.method = 'POST'; + request.url = '/v3/user/webhooks/parse/settings'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_user_webhooks_parse_settings_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/webhooks/parse/settings'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_webhooks_parse_settings__hostname__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/user/webhooks/parse/settings/{hostname}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_user_webhooks_parse_settings__hostname__patch', () => { + const request = {}; + request.body = { + send_raw: true, + spam_check: false, + url: 'http://newdomain.com/parse', + }; + request.method = 'PATCH'; + request.url = '/v3/user/webhooks/parse/settings/{hostname}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_webhooks_parse_settings__hostname__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/user/webhooks/parse/settings/{hostname}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_user_webhooks_parse_stats_get', () => { + const request = {}; + request.qs = { + aggregated_by: 'day', + end_date: '2016-04-01', + limit: 'test_string', + offset: 'test_string', + start_date: '2016-01-01', + }; + request.method = 'GET'; + request.url = '/v3/user/webhooks/parse/stats'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains_post', () => { + const request = {}; + request.body = { + automatic_security: false, + custom_spf: true, + default: true, + domain: 'example.com', + ips: [ + '192.168.1.1', + '192.168.1.2', + ], + subdomain: 'news', + username: 'john@example.com', + }; + request.method = 'POST'; + request.url = '/v3/whitelabel/domains'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_whitelabel_domains_get', () => { + const request = {}; + request.qs = { + domain: 'test_string', + exclude_subusers: 'true', + limit: 1, + offset: 1, + username: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/whitelabel/domains'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains_default_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/whitelabel/domains/default'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains_subuser_delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/whitelabel/domains/subuser'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_whitelabel_domains_subuser_get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/whitelabel/domains/subuser'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains__domain_id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/whitelabel/domains/{domain_id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_whitelabel_domains__domain_id__patch', () => { + const request = {}; + request.body = { + custom_spf: true, + default: false, + }; + request.method = 'PATCH'; + request.url = '/v3/whitelabel/domains/{domain_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains__domain_id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/whitelabel/domains/{domain_id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains__domain_id__subuser_post', () => { + const request = {}; + request.body = { + username: 'jane@example.com', + }; + request.method = 'POST'; + request.url = '/v3/whitelabel/domains/{domain_id}/subuser'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_whitelabel_domains__id__ips_post', () => { + const request = {}; + request.body = { + ip: '192.168.0.1', + }; + request.method = 'POST'; + request.url = '/v3/whitelabel/domains/{id}/ips'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains__id__ips__ip__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/whitelabel/domains/{id}/ips/{ip}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_domains__id__validate_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/whitelabel/domains/{id}/validate'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_ips_post', () => { + const request = {}; + request.body = { + domain: 'example.com', + ip: '192.168.1.1', + subdomain: 'email', + }; + request.method = 'POST'; + request.url = '/v3/whitelabel/ips'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_whitelabel_ips_get', () => { + const request = {}; + request.qs = { + ip: 'test_string', + limit: 1, + offset: 1, + }; + request.method = 'GET'; + request.url = '/v3/whitelabel/ips'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_ips__id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/whitelabel/ips/{id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_whitelabel_ips__id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/whitelabel/ips/{id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_ips__id__validate_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/whitelabel/ips/{id}/validate'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_links_post', () => { + const request = {}; + request.body = { + default: true, + domain: 'example.com', + subdomain: 'mail', + }; + request.qs = { + limit: 1, + offset: 1, + }; + request.method = 'POST'; + request.url = '/v3/whitelabel/links'; + it('should have the correct response code', () => { + return testRequest(request, 201); + }); +}); + +describe('test_whitelabel_links_get', () => { + const request = {}; + request.qs = { + limit: 1, + }; + request.method = 'GET'; + request.url = '/v3/whitelabel/links'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_links_default_get', () => { + const request = {}; + request.qs = { + domain: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/whitelabel/links/default'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_links_subuser_delete', () => { + const request = {}; + request.qs = { + username: 'test_string', + }; + request.method = 'DELETE'; + request.url = '/v3/whitelabel/links/subuser'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_whitelabel_links_subuser_get', () => { + const request = {}; + request.qs = { + username: 'test_string', + }; + request.method = 'GET'; + request.url = '/v3/whitelabel/links/subuser'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_links__id__delete', () => { + const request = {}; + request.method = 'DELETE'; + request.url = '/v3/whitelabel/links/{id}'; + xit('should have the correct response code', () => { + return testRequest(request, 204); + }); +}); + +describe('test_whitelabel_links__id__patch', () => { + const request = {}; + request.body = { + default: true, + }; + request.method = 'PATCH'; + request.url = '/v3/whitelabel/links/{id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_links__id__get', () => { + const request = {}; + request.method = 'GET'; + request.url = '/v3/whitelabel/links/{id}'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_links__id__validate_post', () => { + const request = {}; + request.method = 'POST'; + request.url = '/v3/whitelabel/links/{id}/validate'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('test_whitelabel_links__link_id__subuser_post', () => { + const request = {}; + request.body = { + username: 'jane@example.com', + }; + request.method = 'POST'; + request.url = '/v3/whitelabel/links/{link_id}/subuser'; + it('should have the correct response code', () => { + return testRequest(request, 200); + }); +}); + +describe('setDataResidency', () => { + let consoleWarnSpy; + beforeEach(() => { + testClient = require('./client'); + consoleWarnSpy = sinon.spy(console, 'warn'); + }); + afterEach(() => { + console.warn.restore(); + }); + it('should have default value of hostname as https://api.sendgrid.com/', () => { + expect(testClient.defaultRequest.baseUrl).to.equal('https://api.sendgrid.com/'); + expect(testClient.sendgrid_region).to.equal('global'); + }); + it('should send to host EU', () => { + testClient.setDataResidency('eu'); + expect(testClient.defaultRequest.baseUrl).to.equal('https://api.eu.sendgrid.com/'); + }); + it('should send to host Global/default', () => { + testClient.setDataResidency('global'); + expect(testClient.defaultRequest.baseUrl).to.equal('https://api.sendgrid.com/'); + expect(testClient.sendgrid_region).to.equal('global'); + }); + it('should override the existing set hostname, if data residency setter is called after', () => { + testClient.setApiKey('SG.1234567890'); + testClient.setDataResidency('eu'); + expect(testClient.defaultRequest.baseUrl).to.equal('https://api.eu.sendgrid.com/'); + }); + it('should give a warning if the provided value is not allowed', () => { + testClient.setDataResidency(''); + expect(consoleWarnSpy.calledOnce).to.equal(true); + }); + it('should give a warning if the provided value is null', () => { + testClient.setDataResidency(null); + expect(consoleWarnSpy.calledOnce).to.equal(true); + }); + it('setting the API Key wont reset the region set', () => { + testClient.setDataResidency('eu'); + testClient.setApiKey('SG.1234567890'); + expect(testClient.defaultRequest.baseUrl).to.equal('https://api.eu.sendgrid.com/'); + expect(testClient.sendgrid_region).to.equal('eu'); + }); + it('should send to host global and then call setApiKey', () => { + testClient.setDataResidency('global'); + testClient.setApiKey('SG.1234567890'); + expect(testClient.defaultRequest.baseUrl).to.equal('https://api.sendgrid.com/'); + expect(testClient.sendgrid_region).to.equal('global'); + + + }); +}); + diff --git a/backend/node_modules/@sendgrid/client/src/request.d.ts b/backend/node_modules/@sendgrid/client/src/request.d.ts new file mode 100644 index 0000000..900454c --- /dev/null +++ b/backend/node_modules/@sendgrid/client/src/request.d.ts @@ -0,0 +1,3 @@ +import RequestOptions from "@sendgrid/helpers/classes/request"; + +export type ClientRequest = RequestOptions; diff --git a/backend/node_modules/@sendgrid/client/src/response.d.ts b/backend/node_modules/@sendgrid/client/src/response.d.ts new file mode 100644 index 0000000..3c84e37 --- /dev/null +++ b/backend/node_modules/@sendgrid/client/src/response.d.ts @@ -0,0 +1,3 @@ +import Response from "@sendgrid/helpers/classes/response"; + +export type ClientResponse = Response; diff --git a/backend/node_modules/@sendgrid/helpers/LICENSE b/backend/node_modules/@sendgrid/helpers/LICENSE new file mode 100644 index 0000000..3154774 --- /dev/null +++ b/backend/node_modules/@sendgrid/helpers/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (C) 2023, Twilio SendGrid, Inc.Hello HTML world!
', + templateId: 'd-df80613cccc6441ea5cd7c95377bc1ef', + }; + }); + + afterEach(() => { + console.warn.restore(); + }); + + it('should log an error if template subject line contains improperly escaped "\'" character', () => { + data = Object.assign(data, { + dynamicTemplateData: { + subject: 'Testing Templates and \'Stuff\'', + }, + }); + + const mail = new Mail(data); + + expect(logSpy.calledOnce).to.equal(true); + expect(logSpy.calledWith(DYNAMIC_TEMPLATE_CHAR_WARNING)).to.equal(true); + }); + + it('should log an error if template subject line contains improperly escaped """ character', () => { + data = Object.assign(data, { + dynamicTemplateData: { + subject: '"Testing Templates" and Stuff', + }, + }); + + const mail = new Mail(data); + + expect(logSpy.calledOnce).to.equal(true); + expect(logSpy.calledWith(DYNAMIC_TEMPLATE_CHAR_WARNING)).to.equal(true); + }); + + it('should log an error if template subject line contains improperly escaped "&" character', () => { + data = Object.assign(data, { + dynamicTemplateData: { + subject: 'Testing Templates & Stuff', + }, + }); + + const mail = new Mail(data); + + expect(logSpy.calledOnce).to.equal(true); + expect(logSpy.calledWith(DYNAMIC_TEMPLATE_CHAR_WARNING)).to.equal(true); + }); + }); + + describe('set replyToList to set multiple reply-to', () => { + let data; + + this.beforeEach(() => { + data = { + to: 'send-to@example.org', + from: 'sender@example.org', + subject: 'test replyToList', + category: 'test', + text: 'Testing replyToList settings', + html: 'Testing replyToList settings
', + }; + }); + + it('should set the replyToList', () => { + let replyToList = [ + { + 'name': 'Test User1', + 'email': 'test_user1@example.org' + }, + { + 'email': 'test_user2@example.org' + } + ]; + data.replyToList = replyToList; + + const mail = new Mail(data); + + expect(mail.replyToList) + .to.be.deep.equal(replyToList); + }); + + it('should throw error for incorrect replyToList format', () => { + let replyToList = [ + { + 'name': 'Test User1' + }, + { + 'email_data': 'test_user2@example.org' + } + ]; + data.replyToList = replyToList; + + expect(() => new Mail(data)) + .to.throw('Expected each replyTo to contain an `email` string'); + }); + + it('should throw error for as replyToList is not an array', () => { + let replyToList = { + 'name': 'Test User1', + 'email': 'test_user1@example.org' + }; + data.replyToList = replyToList; + expect(() => new Mail(data)) + .to.throw('Array expected for`replyToList`'); + }); + }); +}); diff --git a/backend/node_modules/@sendgrid/helpers/classes/personalization.d.ts b/backend/node_modules/@sendgrid/helpers/classes/personalization.d.ts new file mode 100644 index 0000000..43163ab --- /dev/null +++ b/backend/node_modules/@sendgrid/helpers/classes/personalization.d.ts @@ -0,0 +1,128 @@ +import { EmailData, EmailJSON } from "./email-address"; + +export interface PersonalizationData { + to: EmailData | EmailData[], + from?: EmailData, + cc?: EmailData | EmailData[], + bcc?: EmailData | EmailData[], + subject?: string; + headers?: { [key: string]: string }; + substitutions?: { [key: string]: string }; + dynamicTemplateData?: { [key: string]: any; }; + customArgs?: { [key: string]: string }; + sendAt?: number; +} + +export interface PersonalizationJSON { + to: EmailJSON | EmailJSON[]; + from?: EmailJSON; + cc?: EmailJSON[]; + bcc?: EmailJSON[]; + headers?: { [key: string]: string; }; + substitutions?: { [key: string]: string; }; + dynamic_template_data?: { [key: string]: string; }; + custom_args?: { [key: string]: string; }; + subject?: string; + send_at?: number; +} + +export default class Personalization { + constructor(data?: PersonalizationData); + + fromData(data: PersonalizationData): void; + + /** + * Set subject + */ + setSubject(subject: string): void; + + /** + * Set send at + */ + setSendAt(sendAt: number): void; + + /** + * Set to + */ + setTo(to: EmailData | EmailData[]): void; + + /** + * Set from + */ + setFrom(from: EmailData): void; + + /** + * Add a single to + */ + addTo(to: EmailData): void; + + /** + * Set cc + */ + setCc(cc: EmailData | EmailData[]): void; + + /** + * Add a single cc + */ + addCc(cc: EmailData): void; + + /** + * Set bcc + */ + setBcc(bcc: EmailData | EmailData[]): void; + + /** + * Add a single bcc + */ + addBcc(bcc: EmailData): void; + + /** + * Set headers + */ + setHeaders(headers: { [key: string]: string }): void; + + /** + * Add a header + */ + addHeader(key: string, value: string): void; + + /** + * Set custom args + */ + setCustomArgs(customArgs: { [key: string]: string }): void; + + /** + * Add a custom arg + */ + addCustomArg(key: string, value: string): void; + + /** + * Set substitutions + */ + setSubstitutions(substitutions: { [key: string]: string }): void; + + /** + * Add a substitution + */ + addSubstitution(key: string, value: string): void; + + /** + * Reverse merge substitutions, preserving existing ones + */ + reverseMergeSubstitutions(substitutions: { [key: string]: string }): void; + + /** + * Set substitution wrappers + */ + setSubstitutionWrappers(wrappers: string[]): void; + + /** + * Set dynamic template data + */ + setDynamicTemplateData(dynamicTemplateData: { [key: string]: any }): void; + + /** + * To JSON + */ + toJSON(): PersonalizationJSON; +} \ No newline at end of file diff --git a/backend/node_modules/@sendgrid/helpers/classes/personalization.js b/backend/node_modules/@sendgrid/helpers/classes/personalization.js new file mode 100644 index 0000000..188113b --- /dev/null +++ b/backend/node_modules/@sendgrid/helpers/classes/personalization.js @@ -0,0 +1,371 @@ +'use strict'; + +/** + * Dependencies + */ +const EmailAddress = require('./email-address'); +const toCamelCase = require('../helpers/to-camel-case'); +const toSnakeCase = require('../helpers/to-snake-case'); +const deepClone = require('../helpers/deep-clone'); +const deepMerge = require('deepmerge'); +const wrapSubstitutions = require('../helpers/wrap-substitutions'); + +/** + * Personalization class + */ +class Personalization { + + /** + * Constructor + */ + constructor(data) { + + //Init array and object placeholders + this.to = []; + this.cc = []; + this.bcc = []; + this.headers = {}; + this.customArgs = {}; + this.substitutions = {}; + this.substitutionWrappers = ['{{', '}}']; + this.dynamicTemplateData = {}; + + //Build from data if given + if (data) { + this.fromData(data); + } + } + + /** + * From data + */ + fromData(data) { + + //Expecting object + if (typeof data !== 'object') { + throw new Error('Expecting object for Mail data'); + } + + //Convert to camel case to make it workable, making a copy to prevent + //changes to the original objects + data = deepClone(data); + data = toCamelCase(data, ['substitutions', 'dynamicTemplateData', 'customArgs', 'headers']); + + //Extract properties from data + const { + to, from, cc, bcc, subject, headers, customArgs, sendAt, + substitutions, substitutionWrappers, dynamicTemplateData, + } = data; + + //Set data + this.setTo(to); + this.setFrom(from); + this.setCc(cc); + this.setBcc(bcc); + this.setSubject(subject); + this.setHeaders(headers); + this.setSubstitutions(substitutions); + this.setSubstitutionWrappers(substitutionWrappers); + this.setCustomArgs(customArgs); + this.setDynamicTemplateData(dynamicTemplateData); + this.setSendAt(sendAt); + } + + /** + * Set subject + */ + setSubject(subject) { + if (typeof subject === 'undefined') { + return; + } + if (typeof subject !== 'string') { + throw new Error('String expected for `subject`'); + } + this.subject = subject; + } + + /** + * Set send at + */ + setSendAt(sendAt) { + if (typeof sendAt === 'undefined') { + return; + } + if (!Number.isInteger(sendAt)) { + throw new Error('Integer expected for `sendAt`'); + } + this.sendAt = sendAt; + } + + /** + * Set to + */ + setTo(to) { + if (typeof to === 'undefined') { + return; + } + if (!Array.isArray(to)) { + to = [to]; + } + this.to = EmailAddress.create(to); + } + + /** + * Set from + * */ + setFrom(from) { + if (typeof from === 'undefined') { + return; + } + this.from = EmailAddress.create(from); + } + + /** + * Add a single to + */ + addTo(to) { + if (typeof to === 'undefined') { + return; + } + this.to.push(EmailAddress.create(to)); + } + + /** + * Set cc + */ + setCc(cc) { + if (typeof cc === 'undefined') { + return; + } + if (!Array.isArray(cc)) { + cc = [cc]; + } + this.cc = EmailAddress.create(cc); + } + + /** + * Add a single cc + */ + addCc(cc) { + if (typeof cc === 'undefined') { + return; + } + this.cc.push(EmailAddress.create(cc)); + } + + /** + * Set bcc + */ + setBcc(bcc) { + if (typeof bcc === 'undefined') { + return; + } + if (!Array.isArray(bcc)) { + bcc = [bcc]; + } + this.bcc = EmailAddress.create(bcc); + } + + /** + * Add a single bcc + */ + addBcc(bcc) { + if (typeof bcc === 'undefined') { + return; + } + this.bcc.push(EmailAddress.create(bcc)); + } + + /** + * Set headers + */ + setHeaders(headers) { + if (typeof headers === 'undefined') { + return; + } + if (typeof headers !== 'object' || headers === null) { + throw new Error('Object expected for `headers`'); + } + this.headers = headers; + } + + /** + * Add a header + */ + addHeader(key, value) { + if (typeof key !== 'string') { + throw new Error('String expected for header key'); + } + if (typeof value !== 'string') { + throw new Error('String expected for header value'); + } + this.headers[key] = value; + } + + /** + * Set custom args + */ + setCustomArgs(customArgs) { + if (typeof customArgs === 'undefined') { + return; + } + if (typeof customArgs !== 'object' || customArgs === null) { + throw new Error('Object expected for `customArgs`'); + } + this.customArgs = customArgs; + } + + /** + * Add a custom arg + */ + addCustomArg(key, value) { + if (typeof key !== 'string') { + throw new Error('String expected for custom arg key'); + } + if (typeof value !== 'string') { + throw new Error('String expected for custom arg value'); + } + this.customArgs[key] = value; + } + + /** + * Set substitutions + */ + setSubstitutions(substitutions) { + if (typeof substitutions === 'undefined') { + return; + } + if (typeof substitutions !== 'object') { + throw new Error('Object expected for `substitutions`'); + } + this.substitutions = substitutions; + } + + /** + * Add a substitution + */ + addSubstitution(key, value) { + if (typeof key !== 'string') { + throw new Error('String expected for substitution key'); + } + if (typeof value !== 'string' && typeof value !== 'number') { + throw new Error('String or Number expected for substitution value'); + } + this.substitutions[key] = value; + } + + /** + * Reverse merge substitutions, preserving existing ones + */ + reverseMergeSubstitutions(substitutions) { + if (typeof substitutions === 'undefined' || substitutions === null) { + return; + } + if (typeof substitutions !== 'object') { + throw new Error( + 'Object expected for `substitutions` in reverseMergeSubstitutions' + ); + } + this.substitutions = Object.assign({}, substitutions, this.substitutions); + } + + /** + * Set substitution wrappers + */ + setSubstitutionWrappers(wrappers) { + if (typeof wrappers === 'undefined' || wrappers === null) { + return; + } + + if (!Array.isArray(wrappers) || wrappers.length !== 2) { + throw new Error( + 'Array expected with two elements for `substitutionWrappers`' + ); + } + this.substitutionWrappers = wrappers; + } + + /** + * Reverse merge dynamic template data, preserving existing ones + */ + deepMergeDynamicTemplateData(dynamicTemplateData) { + if (typeof dynamicTemplateData === 'undefined' || dynamicTemplateData === null) { + return; + } + if (typeof dynamicTemplateData !== 'object') { + throw new Error( + 'Object expected for `dynamicTemplateData` in deepMergeDynamicTemplateData' + ); + } + this.dynamicTemplateData = deepMerge(dynamicTemplateData, this.dynamicTemplateData); + } + + /** + * Set dynamic template data + */ + setDynamicTemplateData(dynamicTemplateData) { + if (typeof dynamicTemplateData === 'undefined') { + return; + } + if (typeof dynamicTemplateData !== 'object') { + throw new Error('Object expected for `dynamicTemplateData`'); + } + this.dynamicTemplateData = dynamicTemplateData; + } + + /** + * To JSON + */ + toJSON() { + + //Get data from self + const { + to, from, cc, bcc, subject, headers, customArgs, sendAt, + substitutions, substitutionWrappers, dynamicTemplateData, + } = this; + + //Initialize with mandatory values + const json = {to}; + + //Arrays + if (Array.isArray(cc) && cc.length > 0) { + json.cc = cc; + } + if (Array.isArray(bcc) && bcc.length > 0) { + json.bcc = bcc; + } + + //Objects + if (Object.keys(headers).length > 0) { + json.headers = headers; + } + if (substitutions && Object.keys(substitutions).length > 0) { + const [left, right] = substitutionWrappers; + json.substitutions = wrapSubstitutions(substitutions, left, right); + } + if (Object.keys(customArgs).length > 0) { + json.customArgs = customArgs; + } + + if (dynamicTemplateData && Object.keys(dynamicTemplateData).length > 0) { + json.dynamicTemplateData = dynamicTemplateData; + } + + //Simple properties + if (typeof subject !== 'undefined') { + json.subject = subject; + } + if (typeof sendAt !== 'undefined') { + json.sendAt = sendAt; + } + if (typeof from !== 'undefined') { + json.from = from; + } + + //Return as snake cased object + return toSnakeCase(json, ['substitutions', 'dynamicTemplateData', 'customArgs', 'headers']); + } +} + +//Export class +module.exports = Personalization; diff --git a/backend/node_modules/@sendgrid/helpers/classes/personalization_specs/527-camel-case-headers.spec.js b/backend/node_modules/@sendgrid/helpers/classes/personalization_specs/527-camel-case-headers.spec.js new file mode 100644 index 0000000..e9fa1d7 --- /dev/null +++ b/backend/node_modules/@sendgrid/helpers/classes/personalization_specs/527-camel-case-headers.spec.js @@ -0,0 +1,36 @@ +'use strict'; + +/** + * Dependencies + */ +const Personalization = require('../personalization'); +const EmailAddress = require('../email-address'); + +/** + * Tests + */ +describe('Personalization', function() { + + //Create new personalization before each test + let p; + beforeEach(function() { + p = new Personalization(); + }); + + // camel case headers test + describe('#527', function() { + it('shouldn\'t convert the headers to camel/snake case', function() { + const p = new Personalization({ + to: 'test@example.com', + headers: { + 'List-Unsubscribe': 'Hello world
'; + + //Test string with nested html tags + const html2 = 'Hello World!
Hello World!
';
+
+ //Tests
+ it('should strip out html tags', function() {
+ expect(convertHTML2PlainString(html1)).to.be.equal('Hello world');
+ });
+ it('should strip out nested html tags', function() {
+ expect(convertHTML2PlainString(html2)).to.be.equal('Hello World!');
+ });
+ it('should strip out html tags with attributes', function() {
+ expect(convertHTML2PlainString(html3)).to.be.equal('Hello World!');
+ });
+});
diff --git a/backend/node_modules/@sendgrid/helpers/helpers/index.d.ts b/backend/node_modules/@sendgrid/helpers/helpers/index.d.ts
new file mode 100644
index 0000000..c7f7c12
--- /dev/null
+++ b/backend/node_modules/@sendgrid/helpers/helpers/index.d.ts
@@ -0,0 +1,19 @@
+import arrayToJSON = require("@sendgrid/helpers/helpers/array-to-json");
+import convertKeys = require("@sendgrid/helpers/helpers/convert-keys");
+import deepClone = require("@sendgrid/helpers/helpers/deep-clone");
+import mergeData = require("@sendgrid/helpers/helpers/merge-data");
+import splitNameEmail = require("@sendgrid/helpers/helpers/split-name-email");
+import toCamelCase = require("@sendgrid/helpers/helpers/to-camel-case");
+import toSnakeCase = require("@sendgrid/helpers/helpers/to-snake-case");
+import wrapSubstitutions = require("@sendgrid/helpers/helpers/wrap-substitutions");
+
+export {
+ arrayToJSON,
+ convertKeys,
+ deepClone,
+ mergeData,
+ splitNameEmail,
+ toCamelCase,
+ toSnakeCase,
+ wrapSubstitutions,
+}
\ No newline at end of file
diff --git a/backend/node_modules/@sendgrid/helpers/helpers/index.js b/backend/node_modules/@sendgrid/helpers/helpers/index.js
new file mode 100644
index 0000000..1e88aa1
--- /dev/null
+++ b/backend/node_modules/@sendgrid/helpers/helpers/index.js
@@ -0,0 +1,27 @@
+'use strict';
+
+/**
+ * Expose helpers
+ */
+const arrayToJSON = require('./array-to-json');
+const convertKeys = require('./convert-keys');
+const deepClone = require('./deep-clone');
+const mergeData = require('./merge-data');
+const splitNameEmail = require('./split-name-email');
+const toCamelCase = require('./to-camel-case');
+const toSnakeCase = require('./to-snake-case');
+const wrapSubstitutions = require('./wrap-substitutions');
+
+/**
+ * Export
+ */
+module.exports = {
+ arrayToJSON,
+ convertKeys,
+ deepClone,
+ mergeData,
+ splitNameEmail,
+ toCamelCase,
+ toSnakeCase,
+ wrapSubstitutions,
+};
diff --git a/backend/node_modules/@sendgrid/helpers/helpers/merge-data-deep.d.ts b/backend/node_modules/@sendgrid/helpers/helpers/merge-data-deep.d.ts
new file mode 100644
index 0000000..58c1db3
--- /dev/null
+++ b/backend/node_modules/@sendgrid/helpers/helpers/merge-data-deep.d.ts
@@ -0,0 +1,6 @@
+/**
+ * Merge data deep helper
+ */
+declare function mergeDataDeepHello HTML world!
', + }; + + it('should throw an error when no data provided', () => { + return expect(sgMail.send()).to.eventually.be.rejectedWith(Error); + }); + + it('should send a basic email', () => { + sgClient.setDefaultHeader('X-Mock', 202); + return sgMail + .send(data) + .then(([response, body]) => { + expect(response.statusCode).to.equal(202); + }); + }); + + it('should throw an error if callback is not a function', () => { + return expect(function() { + sgMail.send(data, false, {}); + }).to.throw(Error); + }); + + it('should include custom headers to the request', () => { + sgClient.setDefaultHeader('X-Mock', 202); + const clientSpy = sinon.spy(sgClient, "request") + return sgMail + .send(Object.assign(data, { headers: { customHeader: "Custom Header Content" } })) + .then(([response, body]) => { + expect(response.statusCode).to.equal(202); + expect(clientSpy).to.have.been.calledWith(sinon.match({ + url: "/v3/mail/send", + method: "POST", + headers: { customHeader: "Custom Header Content" } + })); + }); + }); + + it('should send email with correct replyToList format', () => { + sgClient.setDefaultHeader('X-Mock', 202); + data["replyToList"] = [ + { + "name": "Test Team", + "email": "test@example.org" + }, + { + "name": "Support Test Team", + "email": "support.test@example.org" + } + ]; + return sgMail + .send(data) + .then(([response, body]) => { + expect(response.statusCode).to.equal(202); + }); + }); + + it('should throw error with wrong replyToList format', () => { + sgClient.setDefaultHeader('X-Mock', 202); + data["replyToList"] = { + "name": "Support Test Team", + "email": "support.test@example.org" + }; + return expect(function() { + sgMail.send(data, false, {}); + }).to.throw(Error); + }); + + it('should throw error if any record in replyToList is without email', () => { + data["replyToList"] = [ + { + "name": "Test Team", + "email": "test@example.org" + }, + { + "name": "Support Test Team" + } + ]; + return expect(function() { + sgMail.send(data, false, {}); + }).to.throw(Error); + }); + + it('should throw error if both replyTo and replyToList are mentioned', () => { + data["replyTo"] = { + "name": "Manual Tester", + "email": "manual.test@example.org" + }; + data["replyToList"] = [ + { + "name": "Test Team", + "email": "test@example.org" + }, + { + "name": "Support Test Team", + "email": "support.test@example.org" + } + ]; + return expect(function() { + sgMail.send(data, false, {}); + }).to.throw(Error); + }); +}); + diff --git a/backend/node_modules/append-field/.npmignore b/backend/node_modules/append-field/.npmignore deleted file mode 100644 index c2658d7..0000000 --- a/backend/node_modules/append-field/.npmignore +++ /dev/null @@ -1 +0,0 @@ -node_modules/ diff --git a/backend/node_modules/append-field/README.md b/backend/node_modules/append-field/README.md deleted file mode 100644 index 62b901b..0000000 --- a/backend/node_modules/append-field/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# `append-field` - -A [W3C HTML JSON forms spec](http://www.w3.org/TR/html-json-forms/) compliant -field appender (for lack of a better name). Useful for people implementing -`application/x-www-form-urlencoded` and `multipart/form-data` parsers. - -It works best on objects created with `Object.create(null)`. Otherwise it might -conflict with variables from the prototype (e.g. `hasOwnProperty`). - -## Installation - -```sh -npm install --save append-field -``` - -## Usage - -```javascript -var appendField = require('append-field') -var obj = Object.create(null) - -appendField(obj, 'pets[0][species]', 'Dahut') -appendField(obj, 'pets[0][name]', 'Hypatia') -appendField(obj, 'pets[1][species]', 'Felis Stultus') -appendField(obj, 'pets[1][name]', 'Billie') - -console.log(obj) -``` - -```text -{ pets: - [ { species: 'Dahut', name: 'Hypatia' }, - { species: 'Felis Stultus', name: 'Billie' } ] } -``` - -## API - -### `appendField(store, key, value)` - -Adds the field named `key` with the value `value` to the object `store`. - -## License - -MIT diff --git a/backend/node_modules/append-field/index.js b/backend/node_modules/append-field/index.js deleted file mode 100644 index fc5acc8..0000000 --- a/backend/node_modules/append-field/index.js +++ /dev/null @@ -1,12 +0,0 @@ -var parsePath = require('./lib/parse-path') -var setValue = require('./lib/set-value') - -function appendField (store, key, value) { - var steps = parsePath(key) - - steps.reduce(function (context, step) { - return setValue(context, step, context[step.key], value) - }, store) -} - -module.exports = appendField diff --git a/backend/node_modules/append-field/lib/parse-path.js b/backend/node_modules/append-field/lib/parse-path.js deleted file mode 100644 index 31d6179..0000000 --- a/backend/node_modules/append-field/lib/parse-path.js +++ /dev/null @@ -1,53 +0,0 @@ -var reFirstKey = /^[^\[]*/ -var reDigitPath = /^\[(\d+)\]/ -var reNormalPath = /^\[([^\]]+)\]/ - -function parsePath (key) { - function failure () { - return [{ type: 'object', key: key, last: true }] - } - - var firstKey = reFirstKey.exec(key)[0] - if (!firstKey) return failure() - - var len = key.length - var pos = firstKey.length - var tail = { type: 'object', key: firstKey } - var steps = [tail] - - while (pos < len) { - var m - - if (key[pos] === '[' && key[pos + 1] === ']') { - pos += 2 - tail.append = true - if (pos !== len) return failure() - continue - } - - m = reDigitPath.exec(key.substring(pos)) - if (m !== null) { - pos += m[0].length - tail.nextType = 'array' - tail = { type: 'array', key: parseInt(m[1], 10) } - steps.push(tail) - continue - } - - m = reNormalPath.exec(key.substring(pos)) - if (m !== null) { - pos += m[0].length - tail.nextType = 'object' - tail = { type: 'object', key: m[1] } - steps.push(tail) - continue - } - - return failure() - } - - tail.last = true - return steps -} - -module.exports = parsePath diff --git a/backend/node_modules/append-field/lib/set-value.js b/backend/node_modules/append-field/lib/set-value.js deleted file mode 100644 index c15e873..0000000 --- a/backend/node_modules/append-field/lib/set-value.js +++ /dev/null @@ -1,64 +0,0 @@ -function valueType (value) { - if (value === undefined) return 'undefined' - if (Array.isArray(value)) return 'array' - if (typeof value === 'object') return 'object' - return 'scalar' -} - -function setLastValue (context, step, currentValue, entryValue) { - switch (valueType(currentValue)) { - case 'undefined': - if (step.append) { - context[step.key] = [entryValue] - } else { - context[step.key] = entryValue - } - break - case 'array': - context[step.key].push(entryValue) - break - case 'object': - return setLastValue(currentValue, { type: 'object', key: '', last: true }, currentValue[''], entryValue) - case 'scalar': - context[step.key] = [context[step.key], entryValue] - break - } - - return context -} - -function setValue (context, step, currentValue, entryValue) { - if (step.last) return setLastValue(context, step, currentValue, entryValue) - - var obj - switch (valueType(currentValue)) { - case 'undefined': - if (step.nextType === 'array') { - context[step.key] = [] - } else { - context[step.key] = Object.create(null) - } - return context[step.key] - case 'object': - return context[step.key] - case 'array': - if (step.nextType === 'array') { - return currentValue - } - - obj = Object.create(null) - context[step.key] = obj - currentValue.forEach(function (item, i) { - if (item !== undefined) obj['' + i] = item - }) - - return obj - case 'scalar': - obj = Object.create(null) - obj[''] = currentValue - context[step.key] = obj - return obj - } -} - -module.exports = setValue diff --git a/backend/node_modules/append-field/package.json b/backend/node_modules/append-field/package.json deleted file mode 100644 index 8d6e716..0000000 --- a/backend/node_modules/append-field/package.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "name": "append-field", - "version": "1.0.0", - "license": "MIT", - "author": "Linus Unnebäck
[Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+200/-34 (#6890 #6889 #6888 #6885 #6881 #6767 #6874 #6873 )")
+- 
[Jay](https://github.com/jasonsaayman "+26/-1 ()")
+- 
[Willian Agostini](https://github.com/WillianAgostini "+21/-0 (#5707 )")
+- 
[George Cheng](https://github.com/Gerhut "+3/-3 (#5096 )")
+- 
[FatahChan](https://github.com/FatahChan "+2/-2 (#6855 )")
+- 
[Ionuț G. Stan](https://github.com/igstan "+1/-1 (#6661 )")
+
+## [1.8.4](https://github.com/axios/axios/compare/v1.8.3...v1.8.4) (2025-03-19)
+
+
+### Bug Fixes
+
+* **buildFullPath:** handle `allowAbsoluteUrls: false` without `baseURL` ([#6833](https://github.com/axios/axios/issues/6833)) ([f10c2e0](https://github.com/axios/axios/commit/f10c2e0de7fde0051f848609a29c2906d0caa1d9))
+
+### Contributors to this release
+
+- 
[Marc Hassan](https://github.com/mhassan1 "+5/-1 (#6833 )")
+
+## [1.8.3](https://github.com/axios/axios/compare/v1.8.2...v1.8.3) (2025-03-10)
+
+
+### Bug Fixes
+
+* add missing type for allowAbsoluteUrls ([#6818](https://github.com/axios/axios/issues/6818)) ([10fa70e](https://github.com/axios/axios/commit/10fa70ef14fe39558b15a179f0e82f5f5e5d11b2))
+* **xhr/fetch:** pass `allowAbsoluteUrls` to `buildFullPath` in `xhr` and `fetch` adapters ([#6814](https://github.com/axios/axios/issues/6814)) ([ec159e5](https://github.com/axios/axios/commit/ec159e507bdf08c04ba1a10fe7710094e9e50ec9))
+
+### Contributors to this release
+
+- 
[Ashcon Partovi](https://github.com/Electroid "+6/-0 (#6811 )")
+- 
[StefanBRas](https://github.com/StefanBRas "+4/-0 (#6818 )")
+- [Marc Hassan](https://github.com/mhassan1 "+2/-2 (#6814 )")
+
+## [1.8.2](https://github.com/axios/axios/compare/v1.8.1...v1.8.2) (2025-03-07)
+
+
+### Bug Fixes
+
+* **http-adapter:** add allowAbsoluteUrls to path building ([#6810](https://github.com/axios/axios/issues/6810)) ([fb8eec2](https://github.com/axios/axios/commit/fb8eec214ce7744b5ca787f2c3b8339b2f54b00f))
+
+### Contributors to this release
+
+- 
[Fasoro-Joseph Alexander](https://github.com/lexcorp16 "+1/-1 (#6810 )")
+
+## [1.8.1](https://github.com/axios/axios/compare/v1.8.0...v1.8.1) (2025-02-26)
+
+
+### Bug Fixes
+
+* **utils:** move `generateString` to platform utils to avoid importing crypto module into client builds; ([#6789](https://github.com/axios/axios/issues/6789)) ([36a5a62](https://github.com/axios/axios/commit/36a5a620bec0b181451927f13ac85b9888b86cec))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+51/-47 (#6789 )")
+
+# [1.8.0](https://github.com/axios/axios/compare/v1.7.9...v1.8.0) (2025-02-25)
+
+
+### Bug Fixes
+
+* **examples:** application crashed when navigating examples in browser ([#5938](https://github.com/axios/axios/issues/5938)) ([1260ded](https://github.com/axios/axios/commit/1260ded634ec101dd5ed05d3b70f8e8f899dba6c))
+* missing word in SUPPORT_QUESTION.yml ([#6757](https://github.com/axios/axios/issues/6757)) ([1f890b1](https://github.com/axios/axios/commit/1f890b13f2c25a016f3c84ae78efb769f244133e))
+* **utils:** replace getRandomValues with crypto module ([#6788](https://github.com/axios/axios/issues/6788)) ([23a25af](https://github.com/axios/axios/commit/23a25af0688d1db2c396deb09229d2271cc24f6c))
+
+
+### Features
+
+* Add config for ignoring absolute URLs ([#5902](https://github.com/axios/axios/issues/5902)) ([#6192](https://github.com/axios/axios/issues/6192)) ([32c7bcc](https://github.com/axios/axios/commit/32c7bcc0f233285ba27dec73a4b1e81fb7a219b3))
+
+
+### Reverts
+
+* Revert "chore: expose fromDataToStream to be consumable (#6731)" (#6732) ([1317261](https://github.com/axios/axios/commit/1317261125e9c419fe9f126867f64d28f9c1efda)), closes [#6731](https://github.com/axios/axios/issues/6731) [#6732](https://github.com/axios/axios/issues/6732)
+
+
+### BREAKING CHANGES
+
+* code relying on the above will now combine the URLs instead of prefer request URL
+
+* feat: add config option for allowing absolute URLs
+
+* fix: add default value for allowAbsoluteUrls in buildFullPath
+
+* fix: typo in flow control when setting allowAbsoluteUrls
+
+### Contributors to this release
+
+- 
[Michael Toscano](https://github.com/GethosTheWalrus "+42/-8 (#6192 )")
+- [Willian Agostini](https://github.com/WillianAgostini "+26/-3 (#6788 #6777 )")
+- 
[Naron](https://github.com/naronchen "+27/-0 (#5901 )")
+- 
[shravan || श्रvan](https://github.com/shravan20 "+7/-3 (#6116 )")
+- 
[Justin Dhillon](https://github.com/justindhillon "+0/-7 (#6312 )")
+- 
[yionr](https://github.com/yionr "+5/-1 (#6129 )")
+- 
[Shin'ya Ueoka](https://github.com/ueokande "+3/-3 (#5935 )")
+- 
[Dan Dascalescu](https://github.com/dandv "+3/-3 (#5908 #6757 )")
+- 
[Nitin Ramnani](https://github.com/NitinRamnani "+2/-2 (#5938 )")
+- 
[Shay Molcho](https://github.com/shaymolcho "+2/-2 (#6770 )")
+- [Jay](https://github.com/jasonsaayman "+0/-3 (#6732 )")
+- fancy45daddy
+- 
[Habip Akyol](https://github.com/habipakyol "+1/-1 (#6030 )")
+- 
[Bailey Lissington](https://github.com/llamington "+1/-1 (#6771 )")
+- 
[Bernardo da Eira Duarte](https://github.com/bernardoduarte "+1/-1 (#6480 )")
+- 
[Shivam Batham](https://github.com/Shivam-Batham "+1/-1 (#5949 )")
+- 
[Lipin Kariappa](https://github.com/lipinnnnn "+1/-1 (#5936 )")
+
+## [1.7.9](https://github.com/axios/axios/compare/v1.7.8...v1.7.9) (2024-12-04)
+
+
+### Reverts
+
+* Revert "fix(types): export CJS types from ESM (#6218)" (#6729) ([c44d2f2](https://github.com/axios/axios/commit/c44d2f2316ad289b38997657248ba10de11deb6c)), closes [#6218](https://github.com/axios/axios/issues/6218) [#6729](https://github.com/axios/axios/issues/6729)
+
+### Contributors to this release
+
+- [Jay](https://github.com/jasonsaayman "+596/-108 (#6729 )")
+
+## [1.7.8](https://github.com/axios/axios/compare/v1.7.7...v1.7.8) (2024-11-25)
+
+
+### Bug Fixes
+
+* allow passing a callback as paramsSerializer to buildURL ([#6680](https://github.com/axios/axios/issues/6680)) ([eac4619](https://github.com/axios/axios/commit/eac4619fe2e0926e876cd260ee21e3690381dbb5))
+* **core:** fixed config merging bug ([#6668](https://github.com/axios/axios/issues/6668)) ([5d99fe4](https://github.com/axios/axios/commit/5d99fe4491202a6268c71e5dcc09192359d73cea))
+* fixed width form to not shrink after 'Send Request' button is clicked ([#6644](https://github.com/axios/axios/issues/6644)) ([7ccd5fd](https://github.com/axios/axios/commit/7ccd5fd42402102d38712c32707bf055be72ab54))
+* **http:** add support for File objects as payload in http adapter ([#6588](https://github.com/axios/axios/issues/6588)) ([#6605](https://github.com/axios/axios/issues/6605)) ([6841d8d](https://github.com/axios/axios/commit/6841d8d18ddc71cc1bd202ffcfddb3f95622eef3))
+* **http:** fixed proxy-from-env module import ([#5222](https://github.com/axios/axios/issues/5222)) ([12b3295](https://github.com/axios/axios/commit/12b32957f1258aee94ef859809ed39f8f88f9dfa))
+* **http:** use `globalThis.TextEncoder` when available ([#6634](https://github.com/axios/axios/issues/6634)) ([df956d1](https://github.com/axios/axios/commit/df956d18febc9100a563298dfdf0f102c3d15410))
+* ios11 breaks when build ([#6608](https://github.com/axios/axios/issues/6608)) ([7638952](https://github.com/axios/axios/commit/763895270f7b50c7c780c3c9807ae8635de952cd))
+* **types:** add missing types for mergeConfig function ([#6590](https://github.com/axios/axios/issues/6590)) ([00de614](https://github.com/axios/axios/commit/00de614cd07b7149af335e202aef0e076c254f49))
+* **types:** export CJS types from ESM ([#6218](https://github.com/axios/axios/issues/6218)) ([c71811b](https://github.com/axios/axios/commit/c71811b00f2fcff558e4382ba913bdac4ad7200e))
+* updated stream aborted error message to be more clear ([#6615](https://github.com/axios/axios/issues/6615)) ([cc3217a](https://github.com/axios/axios/commit/cc3217a612024d83a663722a56d7a98d8759c6d5))
+* use URL API instead of DOM to fix a potential vulnerability warning; ([#6714](https://github.com/axios/axios/issues/6714)) ([0a8d6e1](https://github.com/axios/axios/commit/0a8d6e19da5b9899a2abafaaa06a75ee548597db))
+
+### Contributors to this release
+
+- 
[Remco Haszing](https://github.com/remcohaszing "+108/-596 (#6218 )")
+- [Jay](https://github.com/jasonsaayman "+281/-19 (#6640 #6619 )")
+- 
[Aayush Yadav](https://github.com/aayushyadav020 "+124/-111 (#6617 )")
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+12/-65 (#6714 )")
+- 
[Ell Bradshaw](https://github.com/cincodenada "+29/-0 (#6489 )")
+- 
[Amit Saini](https://github.com/amitsainii "+13/-3 (#5237 )")
+- 
[Tommaso Paulon](https://github.com/guuido "+14/-1 (#6680 )")
+- 
[Akki](https://github.com/Aakash-Rana "+5/-5 (#6668 )")
+- 
[Sampo Silvennoinen](https://github.com/stscoundrel "+3/-3 (#6633 )")
+- 
[Kasper Isager Dalsgarð](https://github.com/kasperisager "+2/-2 (#6634 )")
+- 
[Christian Clauss](https://github.com/cclauss "+4/-0 (#6683 )")
+- 
[Pavan Welihinda](https://github.com/pavan168 "+2/-2 (#5222 )")
+- 
[Taylor Flatt](https://github.com/taylorflatt "+2/-2 (#6615 )")
+- 
[Kenzo Wada](https://github.com/Kenzo-Wada "+2/-2 (#6608 )")
+- 
[Ngole Lawson](https://github.com/echelonnought "+3/-0 (#6644 )")
+- 
[Haven](https://github.com/Baoyx007 "+3/-0 (#6590 )")
+- 
[Shrivali Dutt](https://github.com/shrivalidutt "+1/-1 (#6637 )")
+- 
[Henco Appel](https://github.com/hencoappel "+1/-1 (#6605 )")
+
+## [1.7.7](https://github.com/axios/axios/compare/v1.7.6...v1.7.7) (2024-08-31)
+
+
+### Bug Fixes
+
+* **fetch:** fix stream handling in Safari by fallback to using a stream reader instead of an async iterator; ([#6584](https://github.com/axios/axios/issues/6584)) ([d198085](https://github.com/axios/axios/commit/d1980854fee1765cd02fa0787adf5d6e34dd9dcf))
+* **http:** fixed support for IPv6 literal strings in url ([#5731](https://github.com/axios/axios/issues/5731)) ([364993f](https://github.com/axios/axios/commit/364993f0d8bc6e0e06f76b8a35d2d0a35cab054c))
+
+### Contributors to this release
+
+- 
[Rishi556](https://github.com/Rishi556 "+39/-1 (#5731 )")
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+27/-7 (#6584 )")
+
+## [1.7.6](https://github.com/axios/axios/compare/v1.7.5...v1.7.6) (2024-08-30)
+
+
+### Bug Fixes
+
+* **fetch:** fix content length calculation for FormData payload; ([#6524](https://github.com/axios/axios/issues/6524)) ([085f568](https://github.com/axios/axios/commit/085f56861a83e9ac02c140ad9d68dac540dfeeaa))
+* **fetch:** optimize signals composing logic; ([#6582](https://github.com/axios/axios/issues/6582)) ([df9889b](https://github.com/axios/axios/commit/df9889b83c2cc37e9e6189675a73ab70c60f031f))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+98/-46 (#6582 )")
+- 
[Jacques Germishuys](https://github.com/jacquesg "+5/-1 (#6524 )")
+- 
[kuroino721](https://github.com/kuroino721 "+3/-1 (#6575 )")
+
+## [1.7.5](https://github.com/axios/axios/compare/v1.7.4...v1.7.5) (2024-08-23)
+
+
+### Bug Fixes
+
+* **adapter:** fix undefined reference to hasBrowserEnv ([#6572](https://github.com/axios/axios/issues/6572)) ([7004707](https://github.com/axios/axios/commit/7004707c4180b416341863bd86913fe4fc2f1df1))
+* **core:** add the missed implementation of AxiosError#status property; ([#6573](https://github.com/axios/axios/issues/6573)) ([6700a8a](https://github.com/axios/axios/commit/6700a8adac06942205f6a7a21421ecb36c4e0852))
+* **core:** fix `ReferenceError: navigator is not defined` for custom environments; ([#6567](https://github.com/axios/axios/issues/6567)) ([fed1a4b](https://github.com/axios/axios/commit/fed1a4b2d78ed4a588c84e09d32749ed01dc2794))
+* **fetch:** fix credentials handling in Cloudflare workers ([#6533](https://github.com/axios/axios/issues/6533)) ([550d885](https://github.com/axios/axios/commit/550d885eb90fd156add7b93bbdc54d30d2f9a98d))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+187/-83 (#6573 #6567 #6566 #6564 #6563 #6557 #6556 #6555 #6554 #6552 )")
+- 
[Antonin Bas](https://github.com/antoninbas "+6/-6 (#6572 )")
+- 
[Hans Otto Wirtz](https://github.com/hansottowirtz "+4/-1 (#6533 )")
+
+## [1.7.4](https://github.com/axios/axios/compare/v1.7.3...v1.7.4) (2024-08-13)
+
+
+### Bug Fixes
+
+* **sec:** CVE-2024-39338 ([#6539](https://github.com/axios/axios/issues/6539)) ([#6543](https://github.com/axios/axios/issues/6543)) ([6b6b605](https://github.com/axios/axios/commit/6b6b605eaf73852fb2dae033f1e786155959de3a))
+* **sec:** disregard protocol-relative URL to remediate SSRF ([#6539](https://github.com/axios/axios/issues/6539)) ([07a661a](https://github.com/axios/axios/commit/07a661a2a6b9092c4aa640dcc7f724ec5e65bdda))
+
+### Contributors to this release
+
+- 
[Lev Pachmanov](https://github.com/levpachmanov "+47/-11 (#6543 )")
+- 
[Đỗ Trọng Hải](https://github.com/hainenber "+49/-4 (#6539 )")
+
+## [1.7.3](https://github.com/axios/axios/compare/v1.7.2...v1.7.3) (2024-08-01)
+
+
+### Bug Fixes
+
+* **adapter:** fix progress event emitting; ([#6518](https://github.com/axios/axios/issues/6518)) ([e3c76fc](https://github.com/axios/axios/commit/e3c76fc9bdd03aa4d98afaf211df943e2031453f))
+* **fetch:** fix withCredentials request config ([#6505](https://github.com/axios/axios/issues/6505)) ([85d4d0e](https://github.com/axios/axios/commit/85d4d0ea0aae91082f04e303dec46510d1b4e787))
+* **xhr:** return original config on errors from XHR adapter ([#6515](https://github.com/axios/axios/issues/6515)) ([8966ee7](https://github.com/axios/axios/commit/8966ee7ea62ecbd6cfb39a905939bcdab5cf6388))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+211/-159 (#6518 #6519 )")
+- 
[Valerii Sidorenko](https://github.com/ValeraS "+3/-3 (#6515 )")
+- 
[prianYu](https://github.com/prianyu "+2/-2 (#6505 )")
+
+## [1.7.2](https://github.com/axios/axios/compare/v1.7.1...v1.7.2) (2024-05-21)
+
+
+### Bug Fixes
+
+* **fetch:** enhance fetch API detection; ([#6413](https://github.com/axios/axios/issues/6413)) ([4f79aef](https://github.com/axios/axios/commit/4f79aef81b7c4644328365bfc33acf0a9ef595bc))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+3/-3 (#6413 )")
+
+## [1.7.1](https://github.com/axios/axios/compare/v1.7.0...v1.7.1) (2024-05-20)
+
+
+### Bug Fixes
+
+* **fetch:** fixed ReferenceError issue when TextEncoder is not available in the environment; ([#6410](https://github.com/axios/axios/issues/6410)) ([733f15f](https://github.com/axios/axios/commit/733f15fe5bd2d67e1fadaee82e7913b70d45dc5e))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+14/-9 (#6410 )")
+
+# [1.7.0](https://github.com/axios/axios/compare/v1.7.0-beta.2...v1.7.0) (2024-05-19)
+
+
+### Features
+
+* **adapter:** add fetch adapter; ([#6371](https://github.com/axios/axios/issues/6371)) ([a3ff99b](https://github.com/axios/axios/commit/a3ff99b59d8ec2ab5dd049e68c043617a4072e42))
+
+### Bug Fixes
+
+* **core/axios:** handle un-writable error stack ([#6362](https://github.com/axios/axios/issues/6362)) ([81e0455](https://github.com/axios/axios/commit/81e0455b7b57fbaf2be16a73ebe0e6591cc6d8f9))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+1015/-127 (#6371 )")
+- [Jay](https://github.com/jasonsaayman "+30/-14 ()")
+- 
[Alexandre ABRIOUX](https://github.com/alexandre-abrioux "+56/-6 (#6362 )")
+
+# [1.7.0-beta.2](https://github.com/axios/axios/compare/v1.7.0-beta.1...v1.7.0-beta.2) (2024-05-19)
+
+
+### Bug Fixes
+
+* **fetch:** capitalize HTTP method names; ([#6395](https://github.com/axios/axios/issues/6395)) ([ad3174a](https://github.com/axios/axios/commit/ad3174a3515c3c2573f4bcb94818d582826f3914))
+* **fetch:** fix & optimize progress capturing for cases when the request data has a nullish value or zero data length ([#6400](https://github.com/axios/axios/issues/6400)) ([95a3e8e](https://github.com/axios/axios/commit/95a3e8e346cfd6a5548e171f2341df3235d0e26b))
+* **fetch:** fix headers getting from a stream response; ([#6401](https://github.com/axios/axios/issues/6401)) ([870e0a7](https://github.com/axios/axios/commit/870e0a76f60d0094774a6a63fa606eec52a381af))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+99/-46 (#6405 #6404 #6401 #6400 #6395 )")
+
+# [1.7.0-beta.1](https://github.com/axios/axios/compare/v1.7.0-beta.0...v1.7.0-beta.1) (2024-05-07)
+
+
+### Bug Fixes
+
+* **core/axios:** handle un-writable error stack ([#6362](https://github.com/axios/axios/issues/6362)) ([81e0455](https://github.com/axios/axios/commit/81e0455b7b57fbaf2be16a73ebe0e6591cc6d8f9))
+* **fetch:** fix cases when ReadableStream or Response.body are not available; ([#6377](https://github.com/axios/axios/issues/6377)) ([d1d359d](https://github.com/axios/axios/commit/d1d359da347704e8b28d768e61515a3e96c5b072))
+* **fetch:** treat fetch-related TypeError as an AxiosError.ERR_NETWORK error; ([#6380](https://github.com/axios/axios/issues/6380)) ([bb5f9a5](https://github.com/axios/axios/commit/bb5f9a5ab768452de9e166dc28d0ffc234245ef1))
+
+### Contributors to this release
+
+- [Alexandre ABRIOUX](https://github.com/alexandre-abrioux "+56/-6 (#6362 )")
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+42/-17 (#6380 #6377 )")
+
+# [1.7.0-beta.0](https://github.com/axios/axios/compare/v1.6.8...v1.7.0-beta.0) (2024-04-28)
+
+
+### Features
+
+* **adapter:** add fetch adapter; ([#6371](https://github.com/axios/axios/issues/6371)) ([a3ff99b](https://github.com/axios/axios/commit/a3ff99b59d8ec2ab5dd049e68c043617a4072e42))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+1015/-127 (#6371 )")
+- [Jay](https://github.com/jasonsaayman "+30/-14 ()")
+
+## [1.6.8](https://github.com/axios/axios/compare/v1.6.7...v1.6.8) (2024-03-15)
+
+
+### Bug Fixes
+
+* **AxiosHeaders:** fix AxiosHeaders conversion to an object during config merging ([#6243](https://github.com/axios/axios/issues/6243)) ([2656612](https://github.com/axios/axios/commit/2656612bc10fe2757e9832b708ed773ab340b5cb))
+* **import:** use named export for EventEmitter; ([7320430](https://github.com/axios/axios/commit/7320430aef2e1ba2b89488a0eaf42681165498b1))
+* **vulnerability:** update follow-redirects to 1.15.6 ([#6300](https://github.com/axios/axios/issues/6300)) ([8786e0f](https://github.com/axios/axios/commit/8786e0ff55a8c68d4ca989801ad26df924042e27))
+
+### Contributors to this release
+
+- [Jay](https://github.com/jasonsaayman "+4572/-3446 (#6238 )")
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+30/-0 (#6231 )")
+- 
[Mitchell](https://github.com/Creaous "+9/-9 (#6300 )")
+- 
[Emmanuel](https://github.com/mannoeu "+2/-2 (#6196 )")
+- 
[Lucas Keller](https://github.com/ljkeller "+3/-0 (#6194 )")
+- 
[Aditya Mogili](https://github.com/ADITYA-176 "+1/-1 ()")
+- 
[Miroslav Petrov](https://github.com/petrovmiroslav "+1/-1 (#6243 )")
+
+## [1.6.7](https://github.com/axios/axios/compare/v1.6.6...v1.6.7) (2024-01-25)
+
+
+### Bug Fixes
+
+* capture async stack only for rejections with native error objects; ([#6203](https://github.com/axios/axios/issues/6203)) ([1a08f90](https://github.com/axios/axios/commit/1a08f90f402336e4d00e9ee82f211c6adb1640b0))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+30/-26 (#6203 )")
+- 
[zhoulixiang](https://github.com/zh-lx "+0/-3 (#6186 )")
+
+## [1.6.6](https://github.com/axios/axios/compare/v1.6.5...v1.6.6) (2024-01-24)
+
+
+### Bug Fixes
+
+* fixed missed dispatchBeforeRedirect argument ([#5778](https://github.com/axios/axios/issues/5778)) ([a1938ff](https://github.com/axios/axios/commit/a1938ff073fcb0f89011f001dfbc1fa1dc995e39))
+* wrap errors to improve async stack trace ([#5987](https://github.com/axios/axios/issues/5987)) ([123f354](https://github.com/axios/axios/commit/123f354b920f154a209ea99f76b7b2ef3d9ebbab))
+
+### Contributors to this release
+
+- 
[Ilya Priven](https://github.com/ikonst "+91/-8 (#5987 )")
+- 
[Zao Soula](https://github.com/zaosoula "+6/-6 (#5778 )")
+
+## [1.6.5](https://github.com/axios/axios/compare/v1.6.4...v1.6.5) (2024-01-05)
+
+
+### Bug Fixes
+
+* **ci:** refactor notify action as a job of publish action; ([#6176](https://github.com/axios/axios/issues/6176)) ([0736f95](https://github.com/axios/axios/commit/0736f95ce8776366dc9ca569f49ba505feb6373c))
+* **dns:** fixed lookup error handling; ([#6175](https://github.com/axios/axios/issues/6175)) ([f4f2b03](https://github.com/axios/axios/commit/f4f2b039dd38eb4829e8583caede4ed6d2dd59be))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+41/-6 (#6176 #6175 )")
+- [Jay](https://github.com/jasonsaayman "+6/-1 ()")
+
+## [1.6.4](https://github.com/axios/axios/compare/v1.6.3...v1.6.4) (2024-01-03)
+
+
+### Bug Fixes
+
+* **security:** fixed formToJSON prototype pollution vulnerability; ([#6167](https://github.com/axios/axios/issues/6167)) ([3c0c11c](https://github.com/axios/axios/commit/3c0c11cade045c4412c242b5727308cff9897a0e))
+* **security:** fixed security vulnerability in follow-redirects ([#6163](https://github.com/axios/axios/issues/6163)) ([75af1cd](https://github.com/axios/axios/commit/75af1cdff5b3a6ca3766d3d3afbc3115bb0811b8))
+
+### Contributors to this release
+
+- [Jay](https://github.com/jasonsaayman "+34/-6 ()")
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+34/-3 (#6172 #6167 )")
+- 
[Guy Nesher](https://github.com/gnesher "+10/-10 (#6163 )")
+
+## [1.6.3](https://github.com/axios/axios/compare/v1.6.2...v1.6.3) (2023-12-26)
+
+
+### Bug Fixes
+
+* Regular Expression Denial of Service (ReDoS) ([#6132](https://github.com/axios/axios/issues/6132)) ([5e7ad38](https://github.com/axios/axios/commit/5e7ad38fb0f819fceb19fb2ee5d5d38f56aa837d))
+
+### Contributors to this release
+
+- [Jay](https://github.com/jasonsaayman "+15/-6 (#6145 )")
+- [Willian Agostini](https://github.com/WillianAgostini "+17/-2 (#6132 )")
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+3/-0 (#6084 )")
+
+## [1.6.2](https://github.com/axios/axios/compare/v1.6.1...v1.6.2) (2023-11-14)
+
+
+### Features
+
+* **withXSRFToken:** added withXSRFToken option as a workaround to achieve the old `withCredentials` behavior; ([#6046](https://github.com/axios/axios/issues/6046)) ([cff9967](https://github.com/axios/axios/commit/cff996779b272a5e94c2b52f5503ccf668bc42dc))
+
+### PRs
+- feat(withXSRFToken): added withXSRFToken option as a workaround to achieve the old `withCredentials` behavior; ( [#6046](https://api.github.com/repos/axios/axios/pulls/6046) )
+```
+
+📢 This PR added 'withXSRFToken' option as a replacement for old withCredentials behaviour.
+You should now use withXSRFToken along with withCredential to get the old behavior.
+This functionality is considered as a fix.
+```
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+271/-146 (#6081 #6080 #6079 #6078 #6046 #6064 #6063 )")
+- 
[Ng Choon Khon (CK)](https://github.com/ckng0221 "+4/-4 (#6073 )")
+- 
[Muhammad Noman](https://github.com/mnomanmemon "+2/-2 (#6048 )")
+
+## [1.6.1](https://github.com/axios/axios/compare/v1.6.0...v1.6.1) (2023-11-08)
+
+
+### Bug Fixes
+
+* **formdata:** fixed content-type header normalization for non-standard browser environments; ([#6056](https://github.com/axios/axios/issues/6056)) ([dd465ab](https://github.com/axios/axios/commit/dd465ab22bbfa262c6567be6574bf46a057d5288))
+* **platform:** fixed emulated browser detection in node.js environment; ([#6055](https://github.com/axios/axios/issues/6055)) ([3dc8369](https://github.com/axios/axios/commit/3dc8369e505e32a4e12c22f154c55fd63ac67fbb))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+432/-65 (#6059 #6056 #6055 )")
+- 
[Fabian Meyer](https://github.com/meyfa "+5/-2 (#5835 )")
+
+### PRs
+- feat(withXSRFToken): added withXSRFToken option as a workaround to achieve the old `withCredentials` behavior; ( [#6046](https://api.github.com/repos/axios/axios/pulls/6046) )
+```
+
+📢 This PR added 'withXSRFToken' option as a replacement for old withCredentials behaviour.
+You should now use withXSRFToken along with withCredential to get the old behavior.
+This functionality is considered as a fix.
+```
+
+# [1.6.0](https://github.com/axios/axios/compare/v1.5.1...v1.6.0) (2023-10-26)
+
+
+### Bug Fixes
+
+* **CSRF:** fixed CSRF vulnerability CVE-2023-45857 ([#6028](https://github.com/axios/axios/issues/6028)) ([96ee232](https://github.com/axios/axios/commit/96ee232bd3ee4de2e657333d4d2191cd389e14d0))
+* **dns:** fixed lookup function decorator to work properly in node v20; ([#6011](https://github.com/axios/axios/issues/6011)) ([5aaff53](https://github.com/axios/axios/commit/5aaff532a6b820bb9ab6a8cd0f77131b47e2adb8))
+* **types:** fix AxiosHeaders types; ([#5931](https://github.com/axios/axios/issues/5931)) ([a1c8ad0](https://github.com/axios/axios/commit/a1c8ad008b3c13d53e135bbd0862587fb9d3fc09))
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+449/-114 (#6032 #6021 #6011 #5932 #5931 )")
+- 
[Valentin Panov](https://github.com/valentin-panov "+4/-4 (#6028 )")
+- 
[Rinku Chaudhari](https://github.com/therealrinku "+1/-1 (#5889 )")
+
+## [1.5.1](https://github.com/axios/axios/compare/v1.5.0...v1.5.1) (2023-09-26)
+
+
+### Bug Fixes
+
+* **adapters:** improved adapters loading logic to have clear error messages; ([#5919](https://github.com/axios/axios/issues/5919)) ([e410779](https://github.com/axios/axios/commit/e4107797a7a1376f6209fbecfbbce73d3faa7859))
+* **formdata:** fixed automatic addition of the `Content-Type` header for FormData in non-browser environments; ([#5917](https://github.com/axios/axios/issues/5917)) ([bc9af51](https://github.com/axios/axios/commit/bc9af51b1886d1b3529617702f2a21a6c0ed5d92))
+* **headers:** allow `content-encoding` header to handle case-insensitive values ([#5890](https://github.com/axios/axios/issues/5890)) ([#5892](https://github.com/axios/axios/issues/5892)) ([4c89f25](https://github.com/axios/axios/commit/4c89f25196525e90a6e75eda9cb31ae0a2e18acd))
+* **types:** removed duplicated code ([9e62056](https://github.com/axios/axios/commit/9e6205630e1c9cf863adf141c0edb9e6d8d4b149))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+89/-18 (#5919 #5917 )")
+- 
[David Dallas](https://github.com/DavidJDallas "+11/-5 ()")
+- 
[Sean Sattler](https://github.com/fb-sean "+2/-8 ()")
+- 
[Mustafa Ateş Uzun](https://github.com/0o001 "+4/-4 ()")
+- 
[Przemyslaw Motacki](https://github.com/sfc-gh-pmotacki "+2/-1 (#5892 )")
+- 
[Michael Di Prisco](https://github.com/Cadienvan "+1/-1 ()")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+# [1.5.0](https://github.com/axios/axios/compare/v1.4.0...v1.5.0) (2023-08-26)
+
+
+### Bug Fixes
+
+* **adapter:** make adapter loading error more clear by using platform-specific adapters explicitly ([#5837](https://github.com/axios/axios/issues/5837)) ([9a414bb](https://github.com/axios/axios/commit/9a414bb6c81796a95c6c7fe668637825458e8b6d))
+* **dns:** fixed `cacheable-lookup` integration; ([#5836](https://github.com/axios/axios/issues/5836)) ([b3e327d](https://github.com/axios/axios/commit/b3e327dcc9277bdce34c7ef57beedf644b00d628))
+* **headers:** added support for setting header names that overlap with class methods; ([#5831](https://github.com/axios/axios/issues/5831)) ([d8b4ca0](https://github.com/axios/axios/commit/d8b4ca0ea5f2f05efa4edfe1e7684593f9f68273))
+* **headers:** fixed common Content-Type header merging; ([#5832](https://github.com/axios/axios/issues/5832)) ([8fda276](https://github.com/axios/axios/commit/8fda2766b1e6bcb72c3fabc146223083ef13ce17))
+
+
+### Features
+
+* export getAdapter function ([#5324](https://github.com/axios/axios/issues/5324)) ([ca73eb8](https://github.com/axios/axios/commit/ca73eb878df0ae2dace81fe3a7f1fb5986231bf1))
+* **export:** export adapters without `unsafe` prefix ([#5839](https://github.com/axios/axios/issues/5839)) ([1601f4a](https://github.com/axios/axios/commit/1601f4a27a81ab47fea228f1e244b2c4e3ce28bf))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+66/-29 (#5839 #5837 #5836 #5832 #5831 )")
+- 
[夜葬](https://github.com/geekact "+42/-0 (#5324 )")
+- 
[Jonathan Budiman](https://github.com/JBudiman00 "+30/-0 (#5788 )")
+- [Michael Di Prisco](https://github.com/Cadienvan "+3/-5 (#5791 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+# [1.4.0](https://github.com/axios/axios/compare/v1.3.6...v1.4.0) (2023-04-27)
+
+
+### Bug Fixes
+
+* **formdata:** add `multipart/form-data` content type for FormData payload on custom client environments; ([#5678](https://github.com/axios/axios/issues/5678)) ([bbb61e7](https://github.com/axios/axios/commit/bbb61e70cb1185adfb1cbbb86eaf6652c48d89d1))
+* **package:** export package internals with unsafe path prefix; ([#5677](https://github.com/axios/axios/issues/5677)) ([df38c94](https://github.com/axios/axios/commit/df38c949f26414d88ba29ec1e353c4d4f97eaf09))
+
+
+### Features
+
+* **dns:** added support for a custom lookup function; ([#5339](https://github.com/axios/axios/issues/5339)) ([2701911](https://github.com/axios/axios/commit/2701911260a1faa5cc5e1afe437121b330a3b7bb))
+* **types:** export `AxiosHeaderValue` type. ([#5525](https://github.com/axios/axios/issues/5525)) ([726f1c8](https://github.com/axios/axios/commit/726f1c8e00cffa0461a8813a9bdcb8f8b9d762cf))
+
+
+### Performance Improvements
+
+* **merge-config:** optimize mergeConfig performance by avoiding duplicate key visits; ([#5679](https://github.com/axios/axios/issues/5679)) ([e6f7053](https://github.com/axios/axios/commit/e6f7053bf1a3e87cf1f9da8677e12e3fe829d68e))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+151/-16 (#5684 #5339 #5679 #5678 #5677 )")
+- 
[Arthur Fiorette](https://github.com/arthurfiorette "+19/-19 (#5525 )")
+- 
[PIYUSH NEGI](https://github.com/npiyush97 "+2/-18 (#5670 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.3.6](https://github.com/axios/axios/compare/v1.3.5...v1.3.6) (2023-04-19)
+
+
+### Bug Fixes
+
+* **types:** added transport to RawAxiosRequestConfig ([#5445](https://github.com/axios/axios/issues/5445)) ([6f360a2](https://github.com/axios/axios/commit/6f360a2531d8d70363fd9becef6a45a323f170e2))
+* **utils:** make isFormData detection logic stricter to avoid unnecessary calling of the `toString` method on the target; ([#5661](https://github.com/axios/axios/issues/5661)) ([aa372f7](https://github.com/axios/axios/commit/aa372f7306295dfd1100c1c2c77ce95c95808e76))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+48/-10 (#5665 #5661 #5663 )")
+- [Michael Di Prisco](https://github.com/Cadienvan "+2/-0 (#5445 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.3.5](https://github.com/axios/axios/compare/v1.3.4...v1.3.5) (2023-04-05)
+
+
+### Bug Fixes
+
+* **headers:** fixed isValidHeaderName to support full list of allowed characters; ([#5584](https://github.com/axios/axios/issues/5584)) ([e7decef](https://github.com/axios/axios/commit/e7decef6a99f4627e27ed9ea5b00ce8e201c3841))
+* **params:** re-added the ability to set the function as `paramsSerializer` config; ([#5633](https://github.com/axios/axios/issues/5633)) ([a56c866](https://github.com/axios/axios/commit/a56c8661209d5ce5a645a05f294a0e08a6c1f6b3))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+28/-10 (#5633 #5584 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.3.4](https://github.com/axios/axios/compare/v1.3.3...v1.3.4) (2023-02-22)
+
+
+### Bug Fixes
+
+* **blob:** added a check to make sure the Blob class is available in the browser's global scope; ([#5548](https://github.com/axios/axios/issues/5548)) ([3772c8f](https://github.com/axios/axios/commit/3772c8fe74112a56e3e9551f894d899bc3a9443a))
+* **http:** fixed regression bug when handling synchronous errors inside the adapter; ([#5564](https://github.com/axios/axios/issues/5564)) ([a3b246c](https://github.com/axios/axios/commit/a3b246c9de5c3bc4b5a742e15add55b375479451))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+38/-26 (#5564 )")
+- 
[lcysgsg](https://github.com/lcysgsg "+4/-0 (#5548 )")
+- [Michael Di Prisco](https://github.com/Cadienvan "+3/-0 (#5444 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.3.3](https://github.com/axios/axios/compare/v1.3.2...v1.3.3) (2023-02-13)
+
+
+### Bug Fixes
+
+* **formdata:** added a check to make sure the FormData class is available in the browser's global scope; ([#5545](https://github.com/axios/axios/issues/5545)) ([a6dfa72](https://github.com/axios/axios/commit/a6dfa72010db5ad52db8bd13c0f98e537e8fd05d))
+* **formdata:** fixed setting NaN as Content-Length for form payload in some cases; ([#5535](https://github.com/axios/axios/issues/5535)) ([c19f7bf](https://github.com/axios/axios/commit/c19f7bf770f90ae8307f4ea3104f227056912da1))
+* **headers:** fixed the filtering logic of the clear method; ([#5542](https://github.com/axios/axios/issues/5542)) ([ea87ebf](https://github.com/axios/axios/commit/ea87ebfe6d1699af072b9e7cd40faf8f14b0ab93))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+11/-7 (#5545 #5535 #5542 )")
+- 
[陈若枫](https://github.com/ruofee "+2/-2 (#5467 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.3.2](https://github.com/axios/axios/compare/v1.3.1...v1.3.2) (2023-02-03)
+
+
+### Bug Fixes
+
+* **http:** treat http://localhost as base URL for relative paths to avoid `ERR_INVALID_URL` error; ([#5528](https://github.com/axios/axios/issues/5528)) ([128d56f](https://github.com/axios/axios/commit/128d56f4a0fb8f5f2ed6e0dd80bc9225fee9538c))
+* **http:** use explicit import instead of TextEncoder global; ([#5530](https://github.com/axios/axios/issues/5530)) ([6b3c305](https://github.com/axios/axios/commit/6b3c305fc40c56428e0afabedc6f4d29c2830f6f))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+2/-1 (#5530 #5528 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.3.1](https://github.com/axios/axios/compare/v1.3.0...v1.3.1) (2023-02-01)
+
+
+### Bug Fixes
+
+* **formdata:** add hotfix to use the asynchronous API to compute the content-length header value; ([#5521](https://github.com/axios/axios/issues/5521)) ([96d336f](https://github.com/axios/axios/commit/96d336f527619f21da012fe1f117eeb53e5a2120))
+* **serializer:** fixed serialization of array-like objects; ([#5518](https://github.com/axios/axios/issues/5518)) ([08104c0](https://github.com/axios/axios/commit/08104c028c0f9353897b1b6691d74c440fd0c32d))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+27/-8 (#5521 #5518 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+# [1.3.0](https://github.com/axios/axios/compare/v1.2.6...v1.3.0) (2023-01-31)
+
+
+### Bug Fixes
+
+* **headers:** fixed & optimized clear method; ([#5507](https://github.com/axios/axios/issues/5507)) ([9915635](https://github.com/axios/axios/commit/9915635c69d0ab70daca5738488421f67ca60959))
+* **http:** add zlib headers if missing ([#5497](https://github.com/axios/axios/issues/5497)) ([65e8d1e](https://github.com/axios/axios/commit/65e8d1e28ce829f47a837e45129730e541950d3c))
+
+
+### Features
+
+* **fomdata:** added support for spec-compliant FormData & Blob types; ([#5316](https://github.com/axios/axios/issues/5316)) ([6ac574e](https://github.com/axios/axios/commit/6ac574e00a06731288347acea1e8246091196953))
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+352/-67 (#5514 #5512 #5510 #5509 #5508 #5316 #5507 )")
+- 
[ItsNotGoodName](https://github.com/ItsNotGoodName "+43/-2 (#5497 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.2.6](https://github.com/axios/axios/compare/v1.2.5...v1.2.6) (2023-01-28)
+
+
+### Bug Fixes
+
+* **headers:** added missed Authorization accessor; ([#5502](https://github.com/axios/axios/issues/5502)) ([342c0ba](https://github.com/axios/axios/commit/342c0ba9a16ea50f5ed7d2366c5c1a2c877e3f26))
+* **types:** fixed `CommonRequestHeadersList` & `CommonResponseHeadersList` types to be private in commonJS; ([#5503](https://github.com/axios/axios/issues/5503)) ([5a3d0a3](https://github.com/axios/axios/commit/5a3d0a3234d77361a1bc7cedee2da1e11df08e2c))
+
+### Contributors to this release
+
+-  [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+24/-9 (#5503 #5502 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.2.5](https://github.com/axios/axios/compare/v1.2.4...v1.2.5) (2023-01-26)
+
+
+### Bug Fixes
+
+* **types:** fixed AxiosHeaders to handle spread syntax by making all methods non-enumerable; ([#5499](https://github.com/axios/axios/issues/5499)) ([580f1e8](https://github.com/axios/axios/commit/580f1e8033a61baa38149d59fd16019de3932c22))
+
+### Contributors to this release
+
+-  [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+82/-54 (#5499 )")
+-  [Elliot Ford](https://github.com/EFord36 "+1/-1 (#5462 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.2.4](https://github.com/axios/axios/compare/v1.2.3...v1.2.4) (2023-01-22)
+
+
+### Bug Fixes
+
+* **types:** renamed `RawAxiosRequestConfig` back to `AxiosRequestConfig`; ([#5486](https://github.com/axios/axios/issues/5486)) ([2a71f49](https://github.com/axios/axios/commit/2a71f49bc6c68495fa419003a3107ed8bd703ad0))
+* **types:** fix `AxiosRequestConfig` generic; ([#5478](https://github.com/axios/axios/issues/5478)) ([9bce81b](https://github.com/axios/axios/commit/186ea062da8b7d578ae78b1a5c220986b9bce81b))
+
+### Contributors to this release
+
+-  [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+242/-108 (#5486 #5482 )")
+-  [Daniel Hillmann](https://github.com/hilleer "+1/-1 (#5478 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.2.3](https://github.com/axios/axios/compare/1.2.2...1.2.3) (2023-01-10)
+
+
+### Bug Fixes
+
+* **types:** fixed AxiosRequestConfig header interface by refactoring it to RawAxiosRequestConfig; ([#5420](https://github.com/axios/axios/issues/5420)) ([0811963](https://github.com/axios/axios/commit/08119634a22f1d5b19f5c9ea0adccb6d3eebc3bc))
+
+### Contributors to this release
+
+-  [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS "+938/-442 (#5456 #5455 #5453 #5451 #5449 #5447 #5446 #5443 #5442 #5439 #5420 )")
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.2.2] - 2022-12-29
+
+### Fixed
+- fix(ci): fix release script inputs [#5392](https://github.com/axios/axios/pull/5392)
+- fix(ci): prerelease scipts [#5377](https://github.com/axios/axios/pull/5377)
+- fix(ci): release scripts [#5376](https://github.com/axios/axios/pull/5376)
+- fix(ci): typescript tests [#5375](https://github.com/axios/axios/pull/5375)
+- fix: Brotli decompression [#5353](https://github.com/axios/axios/pull/5353)
+- fix: add missing HttpStatusCode [#5345](https://github.com/axios/axios/pull/5345)
+
+### Chores
+- chore(ci): set conventional-changelog header config [#5406](https://github.com/axios/axios/pull/5406)
+- chore(ci): fix automatic contributors resolving [#5403](https://github.com/axios/axios/pull/5403)
+- chore(ci): improved logging for the contributors list generator [#5398](https://github.com/axios/axios/pull/5398)
+- chore(ci): fix release action [#5397](https://github.com/axios/axios/pull/5397)
+- chore(ci): fix version bump script by adding bump argument for target version [#5393](https://github.com/axios/axios/pull/5393)
+- chore(deps): bump decode-uri-component from 0.2.0 to 0.2.2 [#5342](https://github.com/axios/axios/pull/5342)
+- chore(ci): GitHub Actions Release script [#5384](https://github.com/axios/axios/pull/5384)
+- chore(ci): release scripts [#5364](https://github.com/axios/axios/pull/5364)
+
+### Contributors to this release
+-  [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS)
+-  [Winnie](https://github.com/winniehell)
+
+## [1.2.1] - 2022-12-05
+
+### Changed
+- feat(exports): export mergeConfig [#5151](https://github.com/axios/axios/pull/5151)
+
+### Fixed
+- fix(CancelledError): include config [#4922](https://github.com/axios/axios/pull/4922)
+- fix(general): removing multiple/trailing/leading whitespace [#5022](https://github.com/axios/axios/pull/5022)
+- fix(headers): decompression for responses without Content-Length header [#5306](https://github.com/axios/axios/pull/5306)
+- fix(webWorker): exception to sending form data in web worker [#5139](https://github.com/axios/axios/pull/5139)
+
+### Refactors
+- refactor(types): AxiosProgressEvent.event type to any [#5308](https://github.com/axios/axios/pull/5308)
+- refactor(types): add missing types for static AxiosError.from method [#4956](https://github.com/axios/axios/pull/4956)
+
+### Chores
+- chore(docs): remove README link to non-existent upgrade guide [#5307](https://github.com/axios/axios/pull/5307)
+- chore(docs): typo in issue template name [#5159](https://github.com/axios/axios/pull/5159)
+
+### Contributors to this release
+
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS)
+- [Zachary Lysobey](https://github.com/zachlysobey)
+- [Kevin Ennis](https://github.com/kevincennis)
+- [Philipp Loose](https://github.com/phloose)
+- [secondl1ght](https://github.com/secondl1ght)
+- [wenzheng](https://github.com/0x30)
+- [Ivan Barsukov](https://github.com/ovarn)
+- [Arthur Fiorette](https://github.com/arthurfiorette)
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.2.0] - 2022-11-10
+
+### Changed
+
+- changed: refactored module exports [#5162](https://github.com/axios/axios/pull/5162)
+- change: re-added support for loading Axios with require('axios').default [#5225](https://github.com/axios/axios/pull/5225)
+
+### Fixed
+
+- fix: improve AxiosHeaders class [#5224](https://github.com/axios/axios/pull/5224)
+- fix: TypeScript type definitions for commonjs [#5196](https://github.com/axios/axios/pull/5196)
+- fix: type definition of use method on AxiosInterceptorManager to match the the README [#5071](https://github.com/axios/axios/pull/5071)
+- fix: __dirname is not defined in the sandbox [#5269](https://github.com/axios/axios/pull/5269)
+- fix: AxiosError.toJSON method to avoid circular references [#5247](https://github.com/axios/axios/pull/5247)
+- fix: Z_BUF_ERROR when content-encoding is set but the response body is empty [#5250](https://github.com/axios/axios/pull/5250)
+
+### Refactors
+- refactor: allowing adapters to be loaded by name [#5277](https://github.com/axios/axios/pull/5277)
+
+### Chores
+
+- chore: force CI restart [#5243](https://github.com/axios/axios/pull/5243)
+- chore: update ECOSYSTEM.md [#5077](https://github.com/axios/axios/pull/5077)
+- chore: update get/index.html [#5116](https://github.com/axios/axios/pull/5116)
+- chore: update Sandbox UI/UX [#5205](https://github.com/axios/axios/pull/5205)
+- chore:(actions): remove git credentials after checkout [#5235](https://github.com/axios/axios/pull/5235)
+- chore(actions): bump actions/dependency-review-action from 2 to 3 [#5266](https://github.com/axios/axios/pull/5266)
+- chore(packages): bump loader-utils from 1.4.1 to 1.4.2 [#5295](https://github.com/axios/axios/pull/5295)
+- chore(packages): bump engine.io from 6.2.0 to 6.2.1 [#5294](https://github.com/axios/axios/pull/5294)
+- chore(packages): bump socket.io-parser from 4.0.4 to 4.0.5 [#5241](https://github.com/axios/axios/pull/5241)
+- chore(packages): bump loader-utils from 1.4.0 to 1.4.1 [#5245](https://github.com/axios/axios/pull/5245)
+- chore(docs): update Resources links in README [#5119](https://github.com/axios/axios/pull/5119)
+- chore(docs): update the link for JSON url [#5265](https://github.com/axios/axios/pull/5265)
+- chore(docs): fix broken links [#5218](https://github.com/axios/axios/pull/5218)
+- chore(docs): update and rename UPGRADE_GUIDE.md to MIGRATION_GUIDE.md [#5170](https://github.com/axios/axios/pull/5170)
+- chore(docs): typo fix line #856 and #920 [#5194](https://github.com/axios/axios/pull/5194)
+- chore(docs): typo fix #800 [#5193](https://github.com/axios/axios/pull/5193)
+- chore(docs): fix typos [#5184](https://github.com/axios/axios/pull/5184)
+- chore(docs): fix punctuation in README.md [#5197](https://github.com/axios/axios/pull/5197)
+- chore(docs): update readme in the Handling Errors section - issue reference #5260 [#5261](https://github.com/axios/axios/pull/5261)
+- chore: remove \b from filename [#5207](https://github.com/axios/axios/pull/5207)
+- chore(docs): update CHANGELOG.md [#5137](https://github.com/axios/axios/pull/5137)
+- chore: add sideEffects false to package.json [#5025](https://github.com/axios/axios/pull/5025)
+
+### Contributors to this release
+
+- [Maddy Miller](https://github.com/me4502)
+- [Amit Saini](https://github.com/amitsainii)
+- [ecyrbe](https://github.com/ecyrbe)
+- [Ikko Ashimine](https://github.com/eltociear)
+- [Geeth Gunnampalli](https://github.com/thetechie7)
+- [Shreem Asati](https://github.com/shreem-123)
+- [Frieder Bluemle](https://github.com/friederbluemle)
+- [윤세영](https://github.com/yunseyeong)
+- [Claudio Busatto](https://github.com/cjcbusatto)
+- [Remco Haszing](https://github.com/remcohaszing)
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS)
+- [Csaba Maulis](https://github.com/om4csaba)
+- [MoPaMo](https://github.com/MoPaMo)
+- [Daniel Fjeldstad](https://github.com/w3bdesign)
+- [Adrien Brunet](https://github.com/adrien-may)
+- [Frazer Smith](https://github.com/Fdawgs)
+- [HaiTao](https://github.com/836334258)
+- [AZM](https://github.com/aziyatali)
+- [relbns](https://github.com/relbns)
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.1.3] - 2022-10-15
+
+### Added
+
+- Added custom params serializer support [#5113](https://github.com/axios/axios/pull/5113)
+
+### Fixed
+
+- Fixed top-level export to keep them in-line with static properties [#5109](https://github.com/axios/axios/pull/5109)
+- Stopped including null values to query string. [#5108](https://github.com/axios/axios/pull/5108)
+- Restored proxy config backwards compatibility with 0.x [#5097](https://github.com/axios/axios/pull/5097)
+- Added back AxiosHeaders in AxiosHeaderValue [#5103](https://github.com/axios/axios/pull/5103)
+- Pin CDN install instructions to a specific version [#5060](https://github.com/axios/axios/pull/5060)
+- Handling of array values fixed for AxiosHeaders [#5085](https://github.com/axios/axios/pull/5085)
+
+### Chores
+
+- docs: match badge style, add link to them [#5046](https://github.com/axios/axios/pull/5046)
+- chore: fixing comments typo [#5054](https://github.com/axios/axios/pull/5054)
+- chore: update issue template [#5061](https://github.com/axios/axios/pull/5061)
+- chore: added progress capturing section to the docs; [#5084](https://github.com/axios/axios/pull/5084)
+
+### Contributors to this release
+
+- [Jason Saayman](https://github.com/jasonsaayman)
+- [scarf](https://github.com/scarf005)
+- [Lenz Weber-Tronic](https://github.com/phryneas)
+- [Arvindh](https://github.com/itsarvindh)
+- [Félix Legrelle](https://github.com/FelixLgr)
+- [Patrick Petrovic](https://github.com/ppati000)
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS)
+- [littledian](https://github.com/littledian)
+- [ChronosMasterOfAllTime](https://github.com/ChronosMasterOfAllTime)
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.1.2] - 2022-10-07
+
+### Fixed
+
+- Fixed broken exports for UMD builds.
+
+### Contributors to this release
+
+- [Jason Saayman](https://github.com/jasonsaayman)
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.1.1] - 2022-10-07
+
+### Fixed
+
+- Fixed broken exports for common js. This fix breaks a prior fix, I will fix both issues ASAP but the commonJS use is more impactful.
+
+### Contributors to this release
+
+- [Jason Saayman](https://github.com/jasonsaayman)
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.1.0] - 2022-10-06
+
+### Fixed
+
+- Fixed missing exports in type definition index.d.ts [#5003](https://github.com/axios/axios/pull/5003)
+- Fixed query params composing [#5018](https://github.com/axios/axios/pull/5018)
+- Fixed GenericAbortSignal interface by making it more generic [#5021](https://github.com/axios/axios/pull/5021)
+- Fixed adding "clear" to AxiosInterceptorManager [#5010](https://github.com/axios/axios/pull/5010)
+- Fixed commonjs & umd exports [#5030](https://github.com/axios/axios/pull/5030)
+- Fixed inability to access response headers when using axios 1.x with Jest [#5036](https://github.com/axios/axios/pull/5036)
+
+### Contributors to this release
+
+- [Trim21](https://github.com/trim21)
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS)
+- [shingo.sasaki](https://github.com/s-sasaki-0529)
+- [Ivan Pepelko](https://github.com/ivanpepelko)
+- [Richard Kořínek](https://github.com/risa)
+
+### PRs
+- CVE 2023 45857 ( [#6028](https://api.github.com/repos/axios/axios/pulls/6028) )
+```
+
+⚠️ Critical vulnerability fix. See https://security.snyk.io/vuln/SNYK-JS-AXIOS-6032459
+```
+
+## [1.0.0] - 2022-10-04
+
+### Added
+
+- Added stack trace to AxiosError [#4624](https://github.com/axios/axios/pull/4624)
+- Add AxiosError to AxiosStatic [#4654](https://github.com/axios/axios/pull/4654)
+- Replaced Rollup as our build runner [#4596](https://github.com/axios/axios/pull/4596)
+- Added generic TS types for the exposed toFormData helper [#4668](https://github.com/axios/axios/pull/4668)
+- Added listen callback function [#4096](https://github.com/axios/axios/pull/4096)
+- Added instructions for installing using PNPM [#4207](https://github.com/axios/axios/pull/4207)
+- Added generic AxiosAbortSignal TS interface to avoid importing AbortController polyfill [#4229](https://github.com/axios/axios/pull/4229)
+- Added axios-url-template in ECOSYSTEM.md [#4238](https://github.com/axios/axios/pull/4238)
+- Added a clear() function to the request and response interceptors object so a user can ensure that all interceptors have been removed from an axios instance [#4248](https://github.com/axios/axios/pull/4248)
+- Added react hook plugin [#4319](https://github.com/axios/axios/pull/4319)
+- Adding HTTP status code for transformResponse [#4580](https://github.com/axios/axios/pull/4580)
+- Added blob to the list of protocols supported by the browser [#4678](https://github.com/axios/axios/pull/4678)
+- Resolving proxy from env on redirect [#4436](https://github.com/axios/axios/pull/4436)
+- Added enhanced toFormData implementation with additional options [4704](https://github.com/axios/axios/pull/4704)
+- Adding Canceler parameters config and request [#4711](https://github.com/axios/axios/pull/4711)
+- Added automatic payload serialization to application/x-www-form-urlencoded [#4714](https://github.com/axios/axios/pull/4714)
+- Added the ability for webpack users to overwrite built-ins [#4715](https://github.com/axios/axios/pull/4715)
+- Added string[] to AxiosRequestHeaders type [#4322](https://github.com/axios/axios/pull/4322)
+- Added the ability for the url-encoded-form serializer to respect the formSerializer config [#4721](https://github.com/axios/axios/pull/4721)
+- Added isCancel type assert [#4293](https://github.com/axios/axios/pull/4293)
+- Added data URL support for node.js [#4725](https://github.com/axios/axios/pull/4725)
+- Adding types for progress event callbacks [#4675](https://github.com/axios/axios/pull/4675)
+- URL params serializer [#4734](https://github.com/axios/axios/pull/4734)
+- Added axios.formToJSON method [#4735](https://github.com/axios/axios/pull/4735)
+- Bower platform add data protocol [#4804](https://github.com/axios/axios/pull/4804)
+- Use WHATWG URL API instead of url.parse() [#4852](https://github.com/axios/axios/pull/4852)
+- Add ENUM containing Http Status Codes to typings [#4903](https://github.com/axios/axios/pull/4903)
+- Improve typing of timeout in index.d.ts [#4934](https://github.com/axios/axios/pull/4934)
+
+### Changed
+
+- Updated AxiosError.config to be optional in the type definition [#4665](https://github.com/axios/axios/pull/4665)
+- Updated README emphasizing the URLSearchParam built-in interface over other solutions [#4590](https://github.com/axios/axios/pull/4590)
+- Include request and config when creating a CanceledError instance [#4659](https://github.com/axios/axios/pull/4659)
+- Changed func-names eslint rule to as-needed [#4492](https://github.com/axios/axios/pull/4492)
+- Replacing deprecated substr() with slice() as substr() is deprecated [#4468](https://github.com/axios/axios/pull/4468)
+- Updating HTTP links in README.md to use HTTPS [#4387](https://github.com/axios/axios/pull/4387)
+- Updated to a better trim() polyfill [#4072](https://github.com/axios/axios/pull/4072)
+- Updated types to allow specifying partial default headers on instance create [#4185](https://github.com/axios/axios/pull/4185)
+- Expanded isAxiosError types [#4344](https://github.com/axios/axios/pull/4344)
+- Updated type definition for axios instance methods [#4224](https://github.com/axios/axios/pull/4224)
+- Updated eslint config [#4722](https://github.com/axios/axios/pull/4722)
+- Updated Docs [#4742](https://github.com/axios/axios/pull/4742)
+- Refactored Axios to use ES2017 [#4787](https://github.com/axios/axios/pull/4787)
+
+
+### Deprecated
+- There are multiple deprecations, refactors and fixes provided in this release. Please read through the full release notes to see how this may impact your project and use case.
+
+### Removed
+
+- Removed incorrect argument for NetworkError constructor [#4656](https://github.com/axios/axios/pull/4656)
+- Removed Webpack [#4596](https://github.com/axios/axios/pull/4596)
+- Removed function that transform arguments to array [#4544](https://github.com/axios/axios/pull/4544)
+
+### Fixed
+
+- Fixed grammar in README [#4649](https://github.com/axios/axios/pull/4649)
+- Fixed code error in README [#4599](https://github.com/axios/axios/pull/4599)
+- Optimized the code that checks cancellation [#4587](https://github.com/axios/axios/pull/4587)
+- Fix url pointing to defaults.js in README [#4532](https://github.com/axios/axios/pull/4532)
+- Use type alias instead of interface for AxiosPromise [#4505](https://github.com/axios/axios/pull/4505)
+- Fix some word spelling and lint style in code comments [#4500](https://github.com/axios/axios/pull/4500)
+- Edited readme with 3 updated browser icons of Chrome, FireFox and Safari [#4414](https://github.com/axios/axios/pull/4414)
+- Bump follow-redirects from 1.14.9 to 1.15.0 [#4673](https://github.com/axios/axios/pull/4673)
+- Fixing http tests to avoid hanging when assertions fail [#4435](https://github.com/axios/axios/pull/4435)
+- Fix TS definition for AxiosRequestTransformer [#4201](https://github.com/axios/axios/pull/4201)
+- Fix grammatical issues in README [#4232](https://github.com/axios/axios/pull/4232)
+- Fixing instance.defaults.headers type [#4557](https://github.com/axios/axios/pull/4557)
+- Fixed race condition on immediate requests cancellation [#4261](https://github.com/axios/axios/pull/4261)
+- Fixing Z_BUF_ERROR when no content [#4701](https://github.com/axios/axios/pull/4701)
+- Fixing proxy beforeRedirect regression [#4708](https://github.com/axios/axios/pull/4708)
+- Fixed AxiosError status code type [#4717](https://github.com/axios/axios/pull/4717)
+- Fixed AxiosError stack capturing [#4718](https://github.com/axios/axios/pull/4718)
+- Fixing AxiosRequestHeaders typings [#4334](https://github.com/axios/axios/pull/4334)
+- Fixed max body length defaults [#4731](https://github.com/axios/axios/pull/4731)
+- Fixed toFormData Blob issue on node>v17 [#4728](https://github.com/axios/axios/pull/4728)
+- Bump grunt from 1.5.2 to 1.5.3 [#4743](https://github.com/axios/axios/pull/4743)
+- Fixing content-type header repeated [#4745](https://github.com/axios/axios/pull/4745)
+- Fixed timeout error message for http [4738](https://github.com/axios/axios/pull/4738)
+- Request ignores false, 0 and empty string as body values [#4785](https://github.com/axios/axios/pull/4785)
+- Added back missing minified builds [#4805](https://github.com/axios/axios/pull/4805)
+- Fixed a type error [#4815](https://github.com/axios/axios/pull/4815)
+- Fixed a regression bug with unsubscribing from cancel token; [#4819](https://github.com/axios/axios/pull/4819)
+- Remove repeated compression algorithm [#4820](https://github.com/axios/axios/pull/4820)
+- The error of calling extend to pass parameters [#4857](https://github.com/axios/axios/pull/4857)
+- SerializerOptions.indexes allows boolean | null | undefined [#4862](https://github.com/axios/axios/pull/4862)
+- Require interceptors to return values [#4874](https://github.com/axios/axios/pull/4874)
+- Removed unused imports [#4949](https://github.com/axios/axios/pull/4949)
+- Allow null indexes on formSerializer and paramsSerializer [#4960](https://github.com/axios/axios/pull/4960)
+
+### Chores
+- Set permissions for GitHub actions [#4765](https://github.com/axios/axios/pull/4765)
+- Included githubactions in the dependabot config [#4770](https://github.com/axios/axios/pull/4770)
+- Included dependency review [#4771](https://github.com/axios/axios/pull/4771)
+- Update security.md [#4784](https://github.com/axios/axios/pull/4784)
+- Remove unnecessary spaces [#4854](https://github.com/axios/axios/pull/4854)
+- Simplify the import path of AxiosError [#4875](https://github.com/axios/axios/pull/4875)
+- Fix Gitpod dead link [#4941](https://github.com/axios/axios/pull/4941)
+- Enable syntax highlighting for a code block [#4970](https://github.com/axios/axios/pull/4970)
+- Using Logo Axios in Readme.md [#4993](https://github.com/axios/axios/pull/4993)
+- Fix markup for note in README [#4825](https://github.com/axios/axios/pull/4825)
+- Fix typo and formatting, add colons [#4853](https://github.com/axios/axios/pull/4853)
+- Fix typo in readme [#4942](https://github.com/axios/axios/pull/4942)
+
+### Security
+
+- Update SECURITY.md [#4687](https://github.com/axios/axios/pull/4687)
+
+### Contributors to this release
+
+- [Bertrand Marron](https://github.com/tusbar)
+- [Dmitriy Mozgovoy](https://github.com/DigitalBrainJS)
+- [Dan Mooney](https://github.com/danmooney)
+- [Michael Li](https://github.com/xiaoyu-tamu)
+- [aong](https://github.com/yxwzaxns)
+- [Des Preston](https://github.com/despreston)
+- [Ted Robertson](https://github.com/tredondo)
+- [zhoulixiang](https://github.com/zh-lx)
+- [Arthur Fiorette](https://github.com/arthurfiorette)
+- [Kumar Shanu](https://github.com/Kr-Shanu)
+- [JALAL](https://github.com/JLL32)
+- [Jingyi Lin](https://github.com/MageeLin)
+- [Philipp Loose](https://github.com/phloose)
+- [Alexander Shchukin](https://github.com/sashsvamir)
+- [Dave Cardwell](https://github.com/davecardwell)
+- [Cat Scarlet](https://github.com/catscarlet)
+- [Luca Pizzini](https://github.com/lpizzinidev)
+- [Kai](https://github.com/Schweinepriester)
+- [Maxime Bargiel](https://github.com/mbargiel)
+- [Brian Helba](https://github.com/brianhelba)
+- [reslear](https://github.com/reslear)
+- [Jamie Slome](https://github.com/JamieSlome)
+- [Landro3](https://github.com/Landro3)
+- [rafw87](https://github.com/rafw87)
+- [Afzal Sayed](https://github.com/afzalsayed96)
+- [Koki Oyatsu](https://github.com/kaishuu0123)
+- [Dave](https://github.com/wangcch)
+- [暴走老七](https://github.com/baozouai)
+- [Spencer](https://github.com/spalger)
+- [Adrian Wieprzkowicz](https://github.com/Argeento)
+- [Jamie Telin](https://github.com/lejahmie)
+- [毛呆](https://github.com/aweikalee)
+- [Kirill Shakirov](https://github.com/turisap)
+- [Rraji Abdelbari](https://github.com/estarossa0)
+- [Jelle Schutter](https://github.com/jelleschutter)
+- [Tom Ceuppens](https://github.com/KyorCode)
+- [Johann Cooper](https://github.com/JohannCooper)
+- [Dimitris Halatsis](https://github.com/mitsos1os)
+- [chenjigeng](https://github.com/chenjigeng)
+- [João Gabriel Quaresma](https://github.com/joaoGabriel55)
+- [Victor Augusto](https://github.com/VictorAugDB)
+- [neilnaveen](https://github.com/neilnaveen)
+- [Pavlos](https://github.com/psmoros)
+- [Kiryl Valkovich](https://github.com/visortelle)
+- [Naveen](https://github.com/naveensrinivasan)
+- [wenzheng](https://github.com/0x30)
+- [hcwhan](https://github.com/hcwhan)
+- [Bassel Rachid](https://github.com/basselworkforce)
+- [Grégoire Pineau](https://github.com/lyrixx)
+- [felipedamin](https://github.com/felipedamin)
+- [Karl Horky](https://github.com/karlhorky)
+- [Yue JIN](https://github.com/kingyue737)
+- [Usman Ali Siddiqui](https://github.com/usman250994)
+- [WD](https://github.com/techbirds)
+- [Günther Foidl](https://github.com/gfoidl)
+- [Stephen Jennings](https://github.com/jennings)
+- [C.T.Lin](https://github.com/chentsulin)
+- [mia-z](https://github.com/mia-z)
+- [Parth Banathia](https://github.com/Parth0105)
+- [parth0105pluang](https://github.com/parth0105pluang)
+- [Marco Weber](https://github.com/mrcwbr)
+- [Luca Pizzini](https://github.com/lpizzinidev)
+- [Willian Agostini](https://github.com/WillianAgostini)
+- [Huyen Nguyen](https://github.com/huyenltnguyen)
\ No newline at end of file
diff --git a/backend/node_modules/axios/LICENSE b/backend/node_modules/axios/LICENSE
new file mode 100644
index 0000000..05006a5
--- /dev/null
+++ b/backend/node_modules/axios/LICENSE
@@ -0,0 +1,7 @@
+# Copyright (c) 2014-present Matt Zabriskie & Collaborators
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/backend/node_modules/axios/MIGRATION_GUIDE.md b/backend/node_modules/axios/MIGRATION_GUIDE.md
new file mode 100644
index 0000000..ec3ae0d
--- /dev/null
+++ b/backend/node_modules/axios/MIGRATION_GUIDE.md
@@ -0,0 +1,3 @@
+# Migration Guide
+
+## 0.x.x -> 1.1.0
diff --git a/backend/node_modules/axios/README.md b/backend/node_modules/axios/README.md
new file mode 100644
index 0000000..e5b327e
--- /dev/null
+++ b/backend/node_modules/axios/README.md
@@ -0,0 +1,1679 @@
+
+ 🥇 Gold sponsors
 API-first authentication, authorization, and fraud prevention + |  We’re bound by one common purpose: to give you the financial tools, resources and information you ne... + |  Buy real Instagram followers from Twicsy starting at only $2.97. Twicsy has been voted the best site... + |
 Hi, we're Descope! We are building something in the authentication space for app developers and... + |  At Buzzoid, you can buy Instagram followers quickly, safely, and easily with just a few clicks. Rate... + |  At Famety, you can grow your social media following quickly, safely, and easily with just a few clic... + |
 Buy Instagram Likes + |  Ставки на спорт, БК в Україні + |  SS Market offers professional social media services that rapidly increase your YouTube subscriber co... + |
| 💜 Become a sponsor + | 💜 Become a sponsor + | 💜 Become a sponsor + |
+
+ 
+
+
++
Promise based HTTP client for the browser and node.js
+ ++ Website • + Documentation +
+ +
+
+[](https://www.npmjs.org/package/axios)
+[](https://cdnjs.com/libraries/axios)
+[](https://github.com/axios/axios/actions/workflows/ci.yml)
+[](https://gitpod.io/#https://github.com/axios/axios)
+[](https://coveralls.io/r/mzabriskie/axios)
+[](https://packagephobia.now.sh/result?p=axios)
+[](https://bundlephobia.com/package/axios@latest)
+[](https://npm-stat.com/charts.html?package=axios)
+[](https://gitter.im/mzabriskie/axios)
+[](https://www.codetriage.com/axios/axios)
+[](https://snyk.io/test/npm/axios)
+
+
+
+
+
+
+## Table of Contents
+
+ - [Features](#features)
+ - [Browser Support](#browser-support)
+ - [Installing](#installing)
+ - [Package manager](#package-manager)
+ - [CDN](#cdn)
+ - [Example](#example)
+ - [Axios API](#axios-api)
+ - [Request method aliases](#request-method-aliases)
+ - [Concurrency 👎](#concurrency-deprecated)
+ - [Creating an instance](#creating-an-instance)
+ - [Instance methods](#instance-methods)
+ - [Request Config](#request-config)
+ - [Response Schema](#response-schema)
+ - [Config Defaults](#config-defaults)
+ - [Global axios defaults](#global-axios-defaults)
+ - [Custom instance defaults](#custom-instance-defaults)
+ - [Config order of precedence](#config-order-of-precedence)
+ - [Interceptors](#interceptors)
+ - [Multiple Interceptors](#multiple-interceptors)
+ - [Handling Errors](#handling-errors)
+ - [Cancellation](#cancellation)
+ - [AbortController](#abortcontroller)
+ - [CancelToken 👎](#canceltoken-deprecated)
+ - [Using application/x-www-form-urlencoded format](#using-applicationx-www-form-urlencoded-format)
+ - [URLSearchParams](#urlsearchparams)
+ - [Query string](#query-string-older-browsers)
+ - [🆕 Automatic serialization](#-automatic-serialization-to-urlsearchparams)
+ - [Using multipart/form-data format](#using-multipartform-data-format)
+ - [FormData](#formdata)
+ - [🆕 Automatic serialization](#-automatic-serialization-to-formdata)
+ - [Files Posting](#files-posting)
+ - [HTML Form Posting](#-html-form-posting-browser)
+ - [🆕 Progress capturing](#-progress-capturing)
+ - [🆕 Rate limiting](#-progress-capturing)
+ - [🆕 AxiosHeaders](#-axiosheaders)
+ - [🔥 Fetch adapter](#-fetch-adapter)
+ - [Semver](#semver)
+ - [Promises](#promises)
+ - [TypeScript](#typescript)
+ - [Resources](#resources)
+ - [Credits](#credits)
+ - [License](#license)
+
+## Features
+
+- Make [XMLHttpRequests](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) from the browser
+- Make [http](https://nodejs.org/api/http.html) requests from node.js
+- Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API
+- Intercept request and response
+- Transform request and response data
+- Cancel requests
+- Automatic transforms for [JSON](https://www.json.org/json-en.html) data
+- 🆕 Automatic data object serialization to `multipart/form-data` and `x-www-form-urlencoded` body encodings
+- Client side support for protecting against [XSRF](https://en.wikipedia.org/wiki/Cross-site_request_forgery)
+
+## Browser Support
+
+ |  |  |  |  |
+--- | --- | --- | --- | --- |
+Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ |
+
+[](https://saucelabs.com/u/axios)
+
+## Installing
+
+### Package manager
+
+Using npm:
+
+```bash
+$ npm install axios
+```
+
+Using bower:
+
+```bash
+$ bower install axios
+```
+
+Using yarn:
+
+```bash
+$ yarn add axios
+```
+
+Using pnpm:
+
+```bash
+$ pnpm add axios
+```
+
+Using bun:
+
+```bash
+$ bun add axios
+```
+
+Once the package is installed, you can import the library using `import` or `require` approach:
+
+```js
+import axios, {isCancel, AxiosError} from 'axios';
+```
+
+You can also use the default export, since the named export is just a re-export from the Axios factory:
+
+```js
+import axios from 'axios';
+
+console.log(axios.isCancel('something'));
+````
+
+If you use `require` for importing, **only default export is available**:
+
+```js
+const axios = require('axios');
+
+console.log(axios.isCancel('something'));
+```
+
+For some bundlers and some ES6 linters you may need to do the following:
+
+```js
+import { default as axios } from 'axios';
+```
+
+For cases where something went wrong when trying to import a module into a custom or legacy environment,
+you can try importing the module package directly:
+
+```js
+const axios = require('axios/dist/browser/axios.cjs'); // browser commonJS bundle (ES2017)
+// const axios = require('axios/dist/node/axios.cjs'); // node commonJS bundle (ES2017)
+```
+
+### CDN
+
+Using jsDelivr CDN (ES5 UMD browser module):
+
+```html
+
+```
+
+Using unpkg CDN:
+
+```html
+
+```
+
+## Example
+
+> **Note**: CommonJS usage
+> In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with `require()`, use the following approach:
+
+```js
+import axios from 'axios';
+//const axios = require('axios'); // legacy way
+
+// Make a request for a user with a given ID
+axios.get('/user?ID=12345')
+ .then(function (response) {
+ // handle success
+ console.log(response);
+ })
+ .catch(function (error) {
+ // handle error
+ console.log(error);
+ })
+ .finally(function () {
+ // always executed
+ });
+
+// Optionally the request above could also be done as
+axios.get('/user', {
+ params: {
+ ID: 12345
+ }
+ })
+ .then(function (response) {
+ console.log(response);
+ })
+ .catch(function (error) {
+ console.log(error);
+ })
+ .finally(function () {
+ // always executed
+ });
+
+// Want to use async/await? Add the `async` keyword to your outer function/method.
+async function getUser() {
+ try {
+ const response = await axios.get('/user?ID=12345');
+ console.log(response);
+ } catch (error) {
+ console.error(error);
+ }
+}
+```
+
+> **Note**: `async/await` is part of ECMAScript 2017 and is not supported in Internet
+> Explorer and older browsers, so use with caution.
+
+Performing a `POST` request
+
+```js
+axios.post('/user', {
+ firstName: 'Fred',
+ lastName: 'Flintstone'
+ })
+ .then(function (response) {
+ console.log(response);
+ })
+ .catch(function (error) {
+ console.log(error);
+ });
+```
+
+Performing multiple concurrent requests
+
+```js
+function getUserAccount() {
+ return axios.get('/user/12345');
+}
+
+function getUserPermissions() {
+ return axios.get('/user/12345/permissions');
+}
+
+Promise.all([getUserAccount(), getUserPermissions()])
+ .then(function (results) {
+ const acct = results[0];
+ const perm = results[1];
+ });
+```
+
+## axios API
+
+Requests can be made by passing the relevant config to `axios`.
+
+##### axios(config)
+
+```js
+// Send a POST request
+axios({
+ method: 'post',
+ url: '/user/12345',
+ data: {
+ firstName: 'Fred',
+ lastName: 'Flintstone'
+ }
+});
+```
+
+```js
+// GET request for remote image in node.js
+axios({
+ method: 'get',
+ url: 'https://bit.ly/2mTM3nY',
+ responseType: 'stream'
+})
+ .then(function (response) {
+ response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
+ });
+```
+
+##### axios(url[, config])
+
+```js
+// Send a GET request (default method)
+axios('/user/12345');
+```
+
+### Request method aliases
+
+For convenience, aliases have been provided for all common request methods.
+
+##### axios.request(config)
+##### axios.get(url[, config])
+##### axios.delete(url[, config])
+##### axios.head(url[, config])
+##### axios.options(url[, config])
+##### axios.post(url[, data[, config]])
+##### axios.put(url[, data[, config]])
+##### axios.patch(url[, data[, config]])
+
+###### NOTE
+When using the alias methods `url`, `method`, and `data` properties don't need to be specified in config.
+
+### Concurrency (Deprecated)
+Please use `Promise.all` to replace the below functions.
+
+Helper functions for dealing with concurrent requests.
+
+axios.all(iterable)
+axios.spread(callback)
+
+### Creating an instance
+
+You can create a new instance of axios with a custom config.
+
+##### axios.create([config])
+
+```js
+const instance = axios.create({
+ baseURL: 'https://some-domain.com/api/',
+ timeout: 1000,
+ headers: {'X-Custom-Header': 'foobar'}
+});
+```
+
+### Instance methods
+
+The available instance methods are listed below. The specified config will be merged with the instance config.
+
+##### axios#request(config)
+##### axios#get(url[, config])
+##### axios#delete(url[, config])
+##### axios#head(url[, config])
+##### axios#options(url[, config])
+##### axios#post(url[, data[, config]])
+##### axios#put(url[, data[, config]])
+##### axios#patch(url[, data[, config]])
+##### axios#getUri([config])
+
+## Request Config
+
+These are the available config options for making requests. Only the `url` is required. Requests will default to `GET` if `method` is not specified.
+
+```js
+{
+ // `url` is the server URL that will be used for the request
+ url: '/user',
+
+ // `method` is the request method to be used when making the request
+ method: 'get', // default
+
+ // `baseURL` will be prepended to `url` unless `url` is absolute and option `allowAbsoluteUrls` is set to true.
+ // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
+ // to methods of that instance.
+ baseURL: 'https://some-domain.com/api/',
+
+ // `allowAbsoluteUrls` determines whether or not absolute URLs will override a configured `baseUrl`.
+ // When set to true (default), absolute values for `url` will override `baseUrl`.
+ // When set to false, absolute values for `url` will always be prepended by `baseUrl`.
+ allowAbsoluteUrls: true,
+
+ // `transformRequest` allows changes to the request data before it is sent to the server
+ // This is only applicable for request methods 'PUT', 'POST', 'PATCH' and 'DELETE'
+ // The last function in the array must return a string or an instance of Buffer, ArrayBuffer,
+ // FormData or Stream
+ // You may modify the headers object.
+ transformRequest: [function (data, headers) {
+ // Do whatever you want to transform the data
+
+ return data;
+ }],
+
+ // `transformResponse` allows changes to the response data to be made before
+ // it is passed to then/catch
+ transformResponse: [function (data) {
+ // Do whatever you want to transform the data
+
+ return data;
+ }],
+
+ // `headers` are custom headers to be sent
+ headers: {'X-Requested-With': 'XMLHttpRequest'},
+
+ // `params` are the URL parameters to be sent with the request
+ // Must be a plain object or a URLSearchParams object
+ params: {
+ ID: 12345
+ },
+
+ // `paramsSerializer` is an optional config that allows you to customize serializing `params`.
+ paramsSerializer: {
+
+ // Custom encoder function which sends key/value pairs in an iterative fashion.
+ encode?: (param: string): string => { /* Do custom operations here and return transformed string */ },
+
+ // Custom serializer function for the entire parameter. Allows user to mimic pre 1.x behaviour.
+ serialize?: (params: Record