Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
emaile2e-client
Advanced tools
emaile2e-client - npm Package Compare versions
Comparing version 0.1.1513789929 to 0.1.1513898268
@@ -7,12 +7,12 @@ # Emaile2eClient.InboxcontrollerApi | ||
| ------------- | ------------- | ------------- | ||
| [**createUsingPOST**](InboxcontrollerApi.md#createUsingPOST) | **POST** /inboxes | Create an inbox | ||
| [**deleteUsingDELETE**](InboxcontrollerApi.md#deleteUsingDELETE) | **DELETE** /inboxes/{uuid} | Delete an inbox | ||
| [**indexUsingGET**](InboxcontrollerApi.md#indexUsingGET) | **GET** /inboxes | List your inboxes | ||
| [**sendEmailUsingPOST**](InboxcontrollerApi.md#sendEmailUsingPOST) | **POST** /inboxes/{uuid} | Send an email | ||
| [**viewUsingGET**](InboxcontrollerApi.md#viewUsingGET) | **GET** /inboxes/{uuid} | Fetch emails for a given inbox | ||
| [**createRandomInboxUsingPOST**](InboxcontrollerApi.md#createRandomInboxUsingPOST) | **POST** /inboxes | Create an inbox | ||
| [**deleteInboxUsingDELETE**](InboxcontrollerApi.md#deleteInboxUsingDELETE) | **DELETE** /inboxes/{uuid} | Delete an inbox | ||
| [**getEmailsForInboxUsingGET**](InboxcontrollerApi.md#getEmailsForInboxUsingGET) | **GET** /inboxes/{uuid} | Fetch emails for a given inbox | ||
| [**getListOfInboxesUsingGET**](InboxcontrollerApi.md#getListOfInboxesUsingGET) | **GET** /inboxes | List your inboxes | ||
| [**sendEmailFromUserUsingPOST**](InboxcontrollerApi.md#sendEmailFromUserUsingPOST) | **POST** /inboxes/{uuid} | Send an email | ||
| <a name="createUsingPOST"></a> | ||
| # **createUsingPOST** | ||
| > ResponseInboxDto createUsingPOST(apiKey) | ||
| <a name="createRandomInboxUsingPOST"></a> | ||
| # **createRandomInboxUsingPOST** | ||
| > ResponseInboxDto createRandomInboxUsingPOST(apiKey) | ||
@@ -31,3 +31,3 @@ Create an inbox | ||
| apiInstance.createUsingPOST(apiKey).then(function(data) { | ||
| apiInstance.createRandomInboxUsingPOST(apiKey).then(function(data) { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
@@ -59,5 +59,5 @@ }, function(error) { | ||
| <a name="deleteUsingDELETE"></a> | ||
| # **deleteUsingDELETE** | ||
| > Response deleteUsingDELETE(apiKey, uuid) | ||
| <a name="deleteInboxUsingDELETE"></a> | ||
| # **deleteInboxUsingDELETE** | ||
| > Response deleteInboxUsingDELETE(apiKey, uuid) | ||
@@ -78,3 +78,3 @@ Delete an inbox | ||
| apiInstance.deleteUsingDELETE(apiKey, uuid).then(function(data) { | ||
| apiInstance.deleteInboxUsingDELETE(apiKey, uuid).then(function(data) { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
@@ -107,9 +107,9 @@ }, function(error) { | ||
| <a name="indexUsingGET"></a> | ||
| # **indexUsingGET** | ||
| > ResponseListInboxDto indexUsingGET(apiKey) | ||
| <a name="getEmailsForInboxUsingGET"></a> | ||
| # **getEmailsForInboxUsingGET** | ||
| > ResponseListEmailDto getEmailsForInboxUsingGET(apiKey, uuid, opts) | ||
| List your inboxes | ||
| Fetch emails for a given inbox | ||
| Return a list of your inboxes. Each inbox has a uuid and an email address. Emails sent to the email address are stored in the inbox and can be fetched via `/inboxes/{uuid}`. | ||
| Return a list of emails stored in a given inbox. Each email contains various properties including the email body (in eml format), subject, and sender. The `since` parameter is a ISO8601 LocalDateTime that will filter for emails received on or after the given DateTime. Note that because an inbox may take 5 to 10 seconds to receive an email, you can use the `waitFor` parameter to hold a request open until the desired number of emails is present. If this number is not met after 60 seconds, an error will be returned. | ||
@@ -124,3 +124,10 @@ ### Example | ||
| apiInstance.indexUsingGET(apiKey).then(function(data) { | ||
| var uuid = "uuid_example"; // String | The inbox's id. | ||
| var opts = { | ||
| 'minCount': 56, // Number | Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | ||
| 'maxWait': 789, // Number | Maximum seconds API should spend retrying your inbox until the minCount is satisfied | ||
| 'since': new Date("2013-10-20T19:20:30+01:00") // Date | Filter for emails received on or after this ISO8601 LocalDateTime. | ||
| }; | ||
| apiInstance.getEmailsForInboxUsingGET(apiKey, uuid, opts).then(function(data) { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
@@ -138,6 +145,10 @@ }, function(error) { | ||
| **apiKey** | **String**| Your API Key. Sign up and find it in your dashboard. | [default to test] | ||
| **uuid** | **String**| The inbox's id. | | ||
| **minCount** | **Number**| Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | [optional] | ||
| **maxWait** | **Number**| Maximum seconds API should spend retrying your inbox until the minCount is satisfied | [optional] | ||
| **since** | **Date**| Filter for emails received on or after this ISO8601 LocalDateTime. | [optional] | ||
| ### Return type | ||
| [**ResponseListInboxDto**](ResponseListInboxDto.md) | ||
| [**ResponseListEmailDto**](ResponseListEmailDto.md) | ||
@@ -153,9 +164,9 @@ ### Authorization | ||
| <a name="sendEmailUsingPOST"></a> | ||
| # **sendEmailUsingPOST** | ||
| > Response sendEmailUsingPOST(apiKey, uuid, sendEmailDto) | ||
| <a name="getListOfInboxesUsingGET"></a> | ||
| # **getListOfInboxesUsingGET** | ||
| > ResponseListInboxDto getListOfInboxesUsingGET(apiKey) | ||
| Send an email | ||
| List your inboxes | ||
| Send an email from the given inbox's email address. Useful if you need to test a user contacting you, for instance. | ||
| Return a list of your inboxes. Each inbox has a uuid and an email address. Emails sent to the email address are stored in the inbox and can be fetched via `/inboxes/{uuid}`. | ||
@@ -170,7 +181,3 @@ ### Example | ||
| var uuid = "uuid_example"; // String | The inbox's id. | ||
| var sendEmailDto = new Emaile2eClient.SendEmailDto(); // SendEmailDto | The email to send. | ||
| apiInstance.sendEmailUsingPOST(apiKey, uuid, sendEmailDto).then(function(data) { | ||
| apiInstance.getListOfInboxesUsingGET(apiKey).then(function(data) { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
@@ -188,8 +195,6 @@ }, function(error) { | ||
| **apiKey** | **String**| Your API Key. Sign up and find it in your dashboard. | [default to test] | ||
| **uuid** | **String**| The inbox's id. | | ||
| **sendEmailDto** | [**SendEmailDto**](SendEmailDto.md)| The email to send. | | ||
| ### Return type | ||
| [**Response**](Response.md) | ||
| [**ResponseListInboxDto**](ResponseListInboxDto.md) | ||
@@ -205,9 +210,9 @@ ### Authorization | ||
| <a name="viewUsingGET"></a> | ||
| # **viewUsingGET** | ||
| > ResponseListEmailDto viewUsingGET(apiKey, uuid, opts) | ||
| <a name="sendEmailFromUserUsingPOST"></a> | ||
| # **sendEmailFromUserUsingPOST** | ||
| > Response sendEmailFromUserUsingPOST(apiKey, uuid, sendEmailDto) | ||
| Fetch emails for a given inbox | ||
| Send an email | ||
| Return a list of emails stored in a given inbox. Each email contains various properties including the email body (in eml format), subject, and sender. The `since` parameter is a ISO8601 LocalDateTime that will filter for emails received on or after the given DateTime. Note that because an inbox may take 5 to 10 seconds to receive an email, you can use the `waitFor` parameter to hold a request open until the desired number of emails is present. If this number is not met after 60 seconds, an error will be returned. | ||
| Send an email from the given inbox's email address. Useful if you need to test a user contacting you, for instance. | ||
@@ -224,8 +229,5 @@ ### Example | ||
| var opts = { | ||
| 'minCount': 56, // Number | Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | ||
| 'maxWait': 789, // Number | Maximum seconds API should spend retrying your inbox until the minCount is satisfied | ||
| 'since': new Date("2013-10-20T19:20:30+01:00") // Date | Filter for emails received on or after this ISO8601 LocalDateTime. | ||
| }; | ||
| apiInstance.viewUsingGET(apiKey, uuid, opts).then(function(data) { | ||
| var sendEmailDto = new Emaile2eClient.SendEmailDto(); // SendEmailDto | The email to send. | ||
| apiInstance.sendEmailFromUserUsingPOST(apiKey, uuid, sendEmailDto).then(function(data) { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
@@ -244,9 +246,7 @@ }, function(error) { | ||
| **uuid** | **String**| The inbox's id. | | ||
| **minCount** | **Number**| Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | [optional] | ||
| **maxWait** | **Number**| Maximum seconds API should spend retrying your inbox until the minCount is satisfied | [optional] | ||
| **since** | **Date**| Filter for emails received on or after this ISO8601 LocalDateTime. | [optional] | ||
| **sendEmailDto** | [**SendEmailDto**](SendEmailDto.md)| The email to send. | | ||
| ### Return type | ||
| [**ResponseListEmailDto**](ResponseListEmailDto.md) | ||
| [**Response**](Response.md) | ||
@@ -253,0 +253,0 @@ ### Authorization |
| { | ||
| "name": "emaile2e-client", | ||
| "version": "0.1.1513789929", | ||
| "version": "0.1.1513898268", | ||
| "description": "The official javascript client for the Emaile2e API. See https://emaile2e.com for more information.", | ||
@@ -5,0 +5,0 @@ "license": "Unlicense", |
@@ -118,3 +118,3 @@ # emaile2e-client | ||
| api.createUsingPOST(apiKey).then(function(data) { | ||
| api.createRandomInboxUsingPOST(apiKey).then(function(data) { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
@@ -134,7 +134,7 @@ }, function(error) { | ||
| ------------ | ------------- | ------------- | ------------- | ||
| *Emaile2eClient.InboxcontrollerApi* | [**createUsingPOST**](docs/InboxcontrollerApi.md#createUsingPOST) | **POST** /inboxes | Create an inbox | ||
| *Emaile2eClient.InboxcontrollerApi* | [**deleteUsingDELETE**](docs/InboxcontrollerApi.md#deleteUsingDELETE) | **DELETE** /inboxes/{uuid} | Delete an inbox | ||
| *Emaile2eClient.InboxcontrollerApi* | [**indexUsingGET**](docs/InboxcontrollerApi.md#indexUsingGET) | **GET** /inboxes | List your inboxes | ||
| *Emaile2eClient.InboxcontrollerApi* | [**sendEmailUsingPOST**](docs/InboxcontrollerApi.md#sendEmailUsingPOST) | **POST** /inboxes/{uuid} | Send an email | ||
| *Emaile2eClient.InboxcontrollerApi* | [**viewUsingGET**](docs/InboxcontrollerApi.md#viewUsingGET) | **GET** /inboxes/{uuid} | Fetch emails for a given inbox | ||
| *Emaile2eClient.InboxcontrollerApi* | [**createRandomInboxUsingPOST**](docs/InboxcontrollerApi.md#createRandomInboxUsingPOST) | **POST** /inboxes | Create an inbox | ||
| *Emaile2eClient.InboxcontrollerApi* | [**deleteInboxUsingDELETE**](docs/InboxcontrollerApi.md#deleteInboxUsingDELETE) | **DELETE** /inboxes/{uuid} | Delete an inbox | ||
| *Emaile2eClient.InboxcontrollerApi* | [**getEmailsForInboxUsingGET**](docs/InboxcontrollerApi.md#getEmailsForInboxUsingGET) | **GET** /inboxes/{uuid} | Fetch emails for a given inbox | ||
| *Emaile2eClient.InboxcontrollerApi* | [**getListOfInboxesUsingGET**](docs/InboxcontrollerApi.md#getListOfInboxesUsingGET) | **GET** /inboxes | List your inboxes | ||
| *Emaile2eClient.InboxcontrollerApi* | [**sendEmailFromUserUsingPOST**](docs/InboxcontrollerApi.md#sendEmailFromUserUsingPOST) | **POST** /inboxes/{uuid} | Send an email | ||
| *Emaile2eClient.UsercontrollerApi* | [**getUserUsingGET**](docs/UsercontrollerApi.md#getUserUsingGET) | **GET** /user | Fetch a user | ||
@@ -141,0 +141,0 @@ |
@@ -36,3 +36,3 @@ /** | ||
| * @module api/InboxcontrollerApi | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -58,3 +58,3 @@ | ||
| */ | ||
| this.createUsingPOSTWithHttpInfo = function(apiKey) { | ||
| this.createRandomInboxUsingPOSTWithHttpInfo = function(apiKey) { | ||
| var postBody = null; | ||
@@ -64,3 +64,3 @@ | ||
| if (apiKey === undefined || apiKey === null) { | ||
| throw new Error("Missing the required parameter 'apiKey' when calling createUsingPOST"); | ||
| throw new Error("Missing the required parameter 'apiKey' when calling createRandomInboxUsingPOST"); | ||
| } | ||
@@ -97,4 +97,4 @@ | ||
| */ | ||
| this.createUsingPOST = function(apiKey) { | ||
| return this.createUsingPOSTWithHttpInfo(apiKey) | ||
| this.createRandomInboxUsingPOST = function(apiKey) { | ||
| return this.createRandomInboxUsingPOSTWithHttpInfo(apiKey) | ||
| .then(function(response_and_data) { | ||
@@ -113,3 +113,3 @@ return response_and_data.data; | ||
| */ | ||
| this.deleteUsingDELETEWithHttpInfo = function(apiKey, uuid) { | ||
| this.deleteInboxUsingDELETEWithHttpInfo = function(apiKey, uuid) { | ||
| var postBody = null; | ||
@@ -119,3 +119,3 @@ | ||
| if (apiKey === undefined || apiKey === null) { | ||
| throw new Error("Missing the required parameter 'apiKey' when calling deleteUsingDELETE"); | ||
| throw new Error("Missing the required parameter 'apiKey' when calling deleteInboxUsingDELETE"); | ||
| } | ||
@@ -125,3 +125,3 @@ | ||
| if (uuid === undefined || uuid === null) { | ||
| throw new Error("Missing the required parameter 'uuid' when calling deleteUsingDELETE"); | ||
| throw new Error("Missing the required parameter 'uuid' when calling deleteInboxUsingDELETE"); | ||
| } | ||
@@ -160,4 +160,4 @@ | ||
| */ | ||
| this.deleteUsingDELETE = function(apiKey, uuid) { | ||
| return this.deleteUsingDELETEWithHttpInfo(apiKey, uuid) | ||
| this.deleteInboxUsingDELETE = function(apiKey, uuid) { | ||
| return this.deleteInboxUsingDELETEWithHttpInfo(apiKey, uuid) | ||
| .then(function(response_and_data) { | ||
@@ -170,8 +170,14 @@ return response_and_data.data; | ||
| /** | ||
| * List your inboxes | ||
| * Return a list of your inboxes. Each inbox has a uuid and an email address. Emails sent to the email address are stored in the inbox and can be fetched via `/inboxes/{uuid}`. | ||
| * Fetch emails for a given inbox | ||
| * Return a list of emails stored in a given inbox. Each email contains various properties including the email body (in eml format), subject, and sender. The `since` parameter is a ISO8601 LocalDateTime that will filter for emails received on or after the given DateTime. Note that because an inbox may take 5 to 10 seconds to receive an email, you can use the `waitFor` parameter to hold a request open until the desired number of emails is present. If this number is not met after 60 seconds, an error will be returned. | ||
| * @param {String} apiKey Your API Key. Sign up and find it in your dashboard. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ResponseListInboxDto} and HTTP response | ||
| * @param {String} uuid The inbox's id. | ||
| * @param {Object} opts Optional parameters | ||
| * @param {Number} opts.minCount Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | ||
| * @param {Number} opts.maxWait Maximum seconds API should spend retrying your inbox until the minCount is satisfied | ||
| * @param {Date} opts.since Filter for emails received on or after this ISO8601 LocalDateTime. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ResponseListEmailDto} and HTTP response | ||
| */ | ||
| this.indexUsingGETWithHttpInfo = function(apiKey) { | ||
| this.getEmailsForInboxUsingGETWithHttpInfo = function(apiKey, uuid, opts) { | ||
| opts = opts || {}; | ||
| var postBody = null; | ||
@@ -181,10 +187,19 @@ | ||
| if (apiKey === undefined || apiKey === null) { | ||
| throw new Error("Missing the required parameter 'apiKey' when calling indexUsingGET"); | ||
| throw new Error("Missing the required parameter 'apiKey' when calling getEmailsForInboxUsingGET"); | ||
| } | ||
| // verify the required parameter 'uuid' is set | ||
| if (uuid === undefined || uuid === null) { | ||
| throw new Error("Missing the required parameter 'uuid' when calling getEmailsForInboxUsingGET"); | ||
| } | ||
| var pathParams = { | ||
| 'uuid': uuid | ||
| }; | ||
| var queryParams = { | ||
| 'apiKey': apiKey | ||
| 'apiKey': apiKey, | ||
| 'minCount': opts['minCount'], | ||
| 'maxWait': opts['maxWait'], | ||
| 'since': opts['since'] | ||
| }; | ||
@@ -199,6 +214,6 @@ var headerParams = { | ||
| var accepts = ['*/*']; | ||
| var returnType = ResponseListInboxDto; | ||
| var returnType = ResponseListEmailDto; | ||
| return this.apiClient.callApi( | ||
| '/inboxes', 'GET', | ||
| '/inboxes/{uuid}', 'GET', | ||
| pathParams, queryParams, headerParams, formParams, postBody, | ||
@@ -210,9 +225,14 @@ authNames, contentTypes, accepts, returnType | ||
| /** | ||
| * List your inboxes | ||
| * Return a list of your inboxes. Each inbox has a uuid and an email address. Emails sent to the email address are stored in the inbox and can be fetched via `/inboxes/{uuid}`. | ||
| * Fetch emails for a given inbox | ||
| * Return a list of emails stored in a given inbox. Each email contains various properties including the email body (in eml format), subject, and sender. The `since` parameter is a ISO8601 LocalDateTime that will filter for emails received on or after the given DateTime. Note that because an inbox may take 5 to 10 seconds to receive an email, you can use the `waitFor` parameter to hold a request open until the desired number of emails is present. If this number is not met after 60 seconds, an error will be returned. | ||
| * @param {String} apiKey Your API Key. Sign up and find it in your dashboard. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ResponseListInboxDto} | ||
| * @param {String} uuid The inbox's id. | ||
| * @param {Object} opts Optional parameters | ||
| * @param {Number} opts.minCount Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | ||
| * @param {Number} opts.maxWait Maximum seconds API should spend retrying your inbox until the minCount is satisfied | ||
| * @param {Date} opts.since Filter for emails received on or after this ISO8601 LocalDateTime. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ResponseListEmailDto} | ||
| */ | ||
| this.indexUsingGET = function(apiKey) { | ||
| return this.indexUsingGETWithHttpInfo(apiKey) | ||
| this.getEmailsForInboxUsingGET = function(apiKey, uuid, opts) { | ||
| return this.getEmailsForInboxUsingGETWithHttpInfo(apiKey, uuid, opts) | ||
| .then(function(response_and_data) { | ||
@@ -225,30 +245,17 @@ return response_and_data.data; | ||
| /** | ||
| * Send an email | ||
| * Send an email from the given inbox's email address. Useful if you need to test a user contacting you, for instance. | ||
| * List your inboxes | ||
| * Return a list of your inboxes. Each inbox has a uuid and an email address. Emails sent to the email address are stored in the inbox and can be fetched via `/inboxes/{uuid}`. | ||
| * @param {String} apiKey Your API Key. Sign up and find it in your dashboard. | ||
| * @param {String} uuid The inbox's id. | ||
| * @param {module:model/SendEmailDto} sendEmailDto The email to send. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Response} and HTTP response | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ResponseListInboxDto} and HTTP response | ||
| */ | ||
| this.sendEmailUsingPOSTWithHttpInfo = function(apiKey, uuid, sendEmailDto) { | ||
| var postBody = sendEmailDto; | ||
| this.getListOfInboxesUsingGETWithHttpInfo = function(apiKey) { | ||
| var postBody = null; | ||
| // verify the required parameter 'apiKey' is set | ||
| if (apiKey === undefined || apiKey === null) { | ||
| throw new Error("Missing the required parameter 'apiKey' when calling sendEmailUsingPOST"); | ||
| throw new Error("Missing the required parameter 'apiKey' when calling getListOfInboxesUsingGET"); | ||
| } | ||
| // verify the required parameter 'uuid' is set | ||
| if (uuid === undefined || uuid === null) { | ||
| throw new Error("Missing the required parameter 'uuid' when calling sendEmailUsingPOST"); | ||
| } | ||
| // verify the required parameter 'sendEmailDto' is set | ||
| if (sendEmailDto === undefined || sendEmailDto === null) { | ||
| throw new Error("Missing the required parameter 'sendEmailDto' when calling sendEmailUsingPOST"); | ||
| } | ||
| var pathParams = { | ||
| 'uuid': uuid | ||
| }; | ||
@@ -266,6 +273,6 @@ var queryParams = { | ||
| var accepts = ['*/*']; | ||
| var returnType = Response; | ||
| var returnType = ResponseListInboxDto; | ||
| return this.apiClient.callApi( | ||
| '/inboxes/{uuid}', 'POST', | ||
| '/inboxes', 'GET', | ||
| pathParams, queryParams, headerParams, formParams, postBody, | ||
@@ -277,11 +284,9 @@ authNames, contentTypes, accepts, returnType | ||
| /** | ||
| * Send an email | ||
| * Send an email from the given inbox's email address. Useful if you need to test a user contacting you, for instance. | ||
| * List your inboxes | ||
| * Return a list of your inboxes. Each inbox has a uuid and an email address. Emails sent to the email address are stored in the inbox and can be fetched via `/inboxes/{uuid}`. | ||
| * @param {String} apiKey Your API Key. Sign up and find it in your dashboard. | ||
| * @param {String} uuid The inbox's id. | ||
| * @param {module:model/SendEmailDto} sendEmailDto The email to send. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Response} | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ResponseListInboxDto} | ||
| */ | ||
| this.sendEmailUsingPOST = function(apiKey, uuid, sendEmailDto) { | ||
| return this.sendEmailUsingPOSTWithHttpInfo(apiKey, uuid, sendEmailDto) | ||
| this.getListOfInboxesUsingGET = function(apiKey) { | ||
| return this.getListOfInboxesUsingGETWithHttpInfo(apiKey) | ||
| .then(function(response_and_data) { | ||
@@ -294,19 +299,15 @@ return response_and_data.data; | ||
| /** | ||
| * Fetch emails for a given inbox | ||
| * Return a list of emails stored in a given inbox. Each email contains various properties including the email body (in eml format), subject, and sender. The `since` parameter is a ISO8601 LocalDateTime that will filter for emails received on or after the given DateTime. Note that because an inbox may take 5 to 10 seconds to receive an email, you can use the `waitFor` parameter to hold a request open until the desired number of emails is present. If this number is not met after 60 seconds, an error will be returned. | ||
| * Send an email | ||
| * Send an email from the given inbox's email address. Useful if you need to test a user contacting you, for instance. | ||
| * @param {String} apiKey Your API Key. Sign up and find it in your dashboard. | ||
| * @param {String} uuid The inbox's id. | ||
| * @param {Object} opts Optional parameters | ||
| * @param {Number} opts.minCount Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | ||
| * @param {Number} opts.maxWait Maximum seconds API should spend retrying your inbox until the minCount is satisfied | ||
| * @param {Date} opts.since Filter for emails received on or after this ISO8601 LocalDateTime. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ResponseListEmailDto} and HTTP response | ||
| * @param {module:model/SendEmailDto} sendEmailDto The email to send. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Response} and HTTP response | ||
| */ | ||
| this.viewUsingGETWithHttpInfo = function(apiKey, uuid, opts) { | ||
| opts = opts || {}; | ||
| var postBody = null; | ||
| this.sendEmailFromUserUsingPOSTWithHttpInfo = function(apiKey, uuid, sendEmailDto) { | ||
| var postBody = sendEmailDto; | ||
| // verify the required parameter 'apiKey' is set | ||
| if (apiKey === undefined || apiKey === null) { | ||
| throw new Error("Missing the required parameter 'apiKey' when calling viewUsingGET"); | ||
| throw new Error("Missing the required parameter 'apiKey' when calling sendEmailFromUserUsingPOST"); | ||
| } | ||
@@ -316,6 +317,11 @@ | ||
| if (uuid === undefined || uuid === null) { | ||
| throw new Error("Missing the required parameter 'uuid' when calling viewUsingGET"); | ||
| throw new Error("Missing the required parameter 'uuid' when calling sendEmailFromUserUsingPOST"); | ||
| } | ||
| // verify the required parameter 'sendEmailDto' is set | ||
| if (sendEmailDto === undefined || sendEmailDto === null) { | ||
| throw new Error("Missing the required parameter 'sendEmailDto' when calling sendEmailFromUserUsingPOST"); | ||
| } | ||
| var pathParams = { | ||
@@ -325,6 +331,3 @@ 'uuid': uuid | ||
| var queryParams = { | ||
| 'apiKey': apiKey, | ||
| 'minCount': opts['minCount'], | ||
| 'maxWait': opts['maxWait'], | ||
| 'since': opts['since'] | ||
| 'apiKey': apiKey | ||
| }; | ||
@@ -339,6 +342,6 @@ var headerParams = { | ||
| var accepts = ['*/*']; | ||
| var returnType = ResponseListEmailDto; | ||
| var returnType = Response; | ||
| return this.apiClient.callApi( | ||
| '/inboxes/{uuid}', 'GET', | ||
| '/inboxes/{uuid}', 'POST', | ||
| pathParams, queryParams, headerParams, formParams, postBody, | ||
@@ -350,14 +353,11 @@ authNames, contentTypes, accepts, returnType | ||
| /** | ||
| * Fetch emails for a given inbox | ||
| * Return a list of emails stored in a given inbox. Each email contains various properties including the email body (in eml format), subject, and sender. The `since` parameter is a ISO8601 LocalDateTime that will filter for emails received on or after the given DateTime. Note that because an inbox may take 5 to 10 seconds to receive an email, you can use the `waitFor` parameter to hold a request open until the desired number of emails is present. If this number is not met after 60 seconds, an error will be returned. | ||
| * Send an email | ||
| * Send an email from the given inbox's email address. Useful if you need to test a user contacting you, for instance. | ||
| * @param {String} apiKey Your API Key. Sign up and find it in your dashboard. | ||
| * @param {String} uuid The inbox's id. | ||
| * @param {Object} opts Optional parameters | ||
| * @param {Number} opts.minCount Wait a maximum of 60 seconds for atleast this many emails in an inbox before returning a result. | ||
| * @param {Number} opts.maxWait Maximum seconds API should spend retrying your inbox until the minCount is satisfied | ||
| * @param {Date} opts.since Filter for emails received on or after this ISO8601 LocalDateTime. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ResponseListEmailDto} | ||
| * @param {module:model/SendEmailDto} sendEmailDto The email to send. | ||
| * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Response} | ||
| */ | ||
| this.viewUsingGET = function(apiKey, uuid, opts) { | ||
| return this.viewUsingGETWithHttpInfo(apiKey, uuid, opts) | ||
| this.sendEmailFromUserUsingPOST = function(apiKey, uuid, sendEmailDto) { | ||
| return this.sendEmailFromUserUsingPOSTWithHttpInfo(apiKey, uuid, sendEmailDto) | ||
| .then(function(response_and_data) { | ||
@@ -364,0 +364,0 @@ return response_and_data.data; |
@@ -36,3 +36,3 @@ /** | ||
| * @module api/UsercontrollerApi | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -39,0 +39,0 @@ |
@@ -35,3 +35,3 @@ /** | ||
| * @module ApiClient | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -38,0 +38,0 @@ |
@@ -56,3 +56,3 @@ /** | ||
| * @module index | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -59,0 +59,0 @@ var exports = { |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/EmailDto | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/InboxDto | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/Response | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/ResponseInboxDto | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/ResponseListEmailDto | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/ResponseListInboxDto | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/SendEmailDto | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
@@ -39,3 +39,3 @@ /** | ||
| * @module model/UserDto | ||
| * @version 0.1.1513789929 | ||
| * @version 0.1.1513898268 | ||
| */ | ||
@@ -42,0 +42,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.43%
144175
No dependency changes