Skip to content

Latest commit

 

History

History
166 lines (109 loc) · 4.28 KB

ProxyBindingApi.md

File metadata and controls

166 lines (109 loc) · 4.28 KB
Raw

ProxiedMailApi.ProxyBindingApi

All URIs are relative to http://proxiedmail.com

Method HTTP request Description
addProxyBinding POST /api/v1/proxy-bindings Create proxy-email
apiV1ProxyBindingsGet GET /api/v1/proxy-bindings List of proxy emails
patchProxyBinding PATCH /api/v1/proxy-bindings/{id} Update proxy-email

addProxyBinding

AddProxyBinding200Response addProxyBinding(opts)

Create proxy-email

Example

import ProxiedMailApi from 'proxied_mail_api';
let defaultClient = ProxiedMailApi.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new ProxiedMailApi.ProxyBindingApi();
let opts = {
  'proxyBindingCreate': [new ProxiedMailApi.ProxyBindingCreate()] // [ProxyBindingCreate] | 
};
apiInstance.addProxyBinding(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
proxyBindingCreate [ProxyBindingCreate] [optional]

Return type

AddProxyBinding200Response

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV1ProxyBindingsGet

ApiV1ProxyBindingsGet200Response apiV1ProxyBindingsGet()

List of proxy emails

Example

import ProxiedMailApi from 'proxied_mail_api';
let defaultClient = ProxiedMailApi.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new ProxiedMailApi.ProxyBindingApi();
apiInstance.apiV1ProxyBindingsGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

ApiV1ProxyBindingsGet200Response

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

patchProxyBinding

AddProxyBinding200Response patchProxyBinding(id, opts)

Update proxy-email

Example

import ProxiedMailApi from 'proxied_mail_api';
let defaultClient = ProxiedMailApi.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new ProxiedMailApi.ProxyBindingApi();
let id = "id_example"; // String | ID of proxy-email that needs to be fetched
let opts = {
  'patchProxyBindingRequestInner': [new ProxiedMailApi.PatchProxyBindingRequestInner()] // [PatchProxyBindingRequestInner] | 
};
apiInstance.patchProxyBinding(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
id String ID of proxy-email that needs to be fetched
patchProxyBindingRequestInner [PatchProxyBindingRequestInner] [optional]

Return type

AddProxyBinding200Response

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json