Skip to content

Latest commit

 

History

History
378 lines (251 loc) · 8.67 KB

AdminApi.md

File metadata and controls

378 lines (251 loc) · 8.67 KB
Raw

Persona.AdminApi

All URIs are relative to http://http:/v1

Method HTTP request Description
adminFreePassDelete DELETE /admin/free-pass Revokes an existing free pass
adminFreePassPut PUT /admin/free-pass Creates a free pass to an article
adminFreePassesGet GET /admin/free-passes Lists all free passes
adminSearchPost POST /admin/search Search for users
adminTransferPassiveSubscribersListidPost POST /admin/transfer-passive-subscribers/{listid} Transfers passive customers from Kayak to Mailchimp
adminUserPost POST /admin/user Create a new user with admin options.
adminUserUuidDelete DELETE /admin/user/{uuid} Delete user

adminFreePassDelete

adminFreePassDelete(body, opts)

Revokes an existing free pass

Marks a free pass as being revoked so that it can't be used anymore. Currently, revoked free passes can't be reinstated through Persona API (though it's possible to do so with an SQL query).

Example

var Persona = require('persona');

var apiInstance = new Persona.AdminApi();
var body = "body_example"; // String | 
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example" // String | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminFreePassDelete(body, opts, callback);

Parameters

Name Type Description Notes
body String
authUser String [optional]
authorization String [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: Not defined

adminFreePassPut

String adminFreePassPut(body, opts)

Creates a free pass to an article

Free passes can be used to temporarily bypass the paywall for individual articles.

Example

var Persona = require('persona');

var apiInstance = new Persona.AdminApi();
var body = new Persona.FreePassInput(); // FreePassInput | 
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example" // String | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.adminFreePassPut(body, opts, callback);

Parameters

Name Type Description Notes
body FreePassInput
authUser String [optional]
authorization String [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: application/json;charset=utf-8

adminFreePassesGet

[FreePass] adminFreePassesGet(opts)

Lists all free passes

This end point returns the list of all free passes, including those that have been expired or revoked.

Example

var Persona = require('persona');

var apiInstance = new Persona.AdminApi();
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example" // String | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.adminFreePassesGet(opts, callback);

Parameters

Name Type Description Notes
authUser String [optional]
authorization String [optional]

Return type

[FreePass]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8

adminSearchPost

[SearchResult] adminSearchPost(body, opts)

Search for users

Example

var Persona = require('persona');

var apiInstance = new Persona.AdminApi();
var body = new Persona.SearchQuery(); // SearchQuery | 
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example" // String | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.adminSearchPost(body, opts, callback);

Parameters

Name Type Description Notes
body SearchQuery
authUser String [optional]
authorization String [optional]

Return type

[SearchResult]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: application/json;charset=utf-8

adminTransferPassiveSubscribersListidPost

Object adminTransferPassiveSubscribersListidPost(listid, opts)

Transfers passive customers from Kayak to Mailchimp

Passive subscribers/members/customers are users who don't have active entitlements and haven't opted out from email marketing. For the given list (audience) ID, this endpoint transfers the list of passive subscribers from Kayak to Mailchimp (via Faro).

Example

var Persona = require('persona');

var apiInstance = new Persona.AdminApi();
var listid = "listid_example"; // String | 
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example" // String | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.adminTransferPassiveSubscribersListidPost(listid, opts, callback);

Parameters

Name Type Description Notes
listid String
authUser String [optional]
authorization String [optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=utf-8

adminUserPost

LoginResponse adminUserPost(body, opts)

Create a new user with admin options.

Example

var Persona = require('persona');

var apiInstance = new Persona.AdminApi();
var body = new Persona.AdminNewUser(); // AdminNewUser | 
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example" // String | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.adminUserPost(body, opts, callback);

Parameters

Name Type Description Notes
body AdminNewUser
authUser String [optional]
authorization String [optional]

Return type

LoginResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json;charset=utf-8
  • Accept: application/json;charset=utf-8

adminUserUuidDelete

adminUserUuidDelete(uuid, opts)

Delete user

Example

var Persona = require('persona');

var apiInstance = new Persona.AdminApi();
var uuid = null; // String | 
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example" // String | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.adminUserUuidDelete(uuid, opts, callback);

Parameters

Name Type Description Notes
uuid String
authUser String [optional]
authorization String [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined