Persona.UsersApi

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

Method	HTTP request	Description
usersPost	POST /users	Create a new user.
usersTemporaryPost	POST /users/temporary	Create a new user with email.
usersUuidEntitlementGet	GET /users/{uuid}/entitlement	Get users entitlements.
usersUuidGdprPut	PUT /users/{uuid}/gdpr	Updates the GDPR consent settings for a given user.
usersUuidGet	GET /users/{uuid}	Get user by UUID.
usersUuidLegalPut	PUT /users/{uuid}/legal	Updates the legal consent settings for a given user.
usersUuidNewslettersGet	GET /users/{uuid}/newsletters	Get newsletter subscriptions
usersUuidNewslettersPut	PUT /users/{uuid}/newsletters	Update newsletter subscriptions
usersUuidPasswordPut	PUT /users/{uuid}/password	Set / Change user password
usersUuidPatch	PATCH /users/{uuid}	Update a user
usersUuidPaymentsGet	GET /users/{uuid}/payments	Get user's subscriptions and payment events
usersUuidScopeGet	GET /users/{uuid}/scope	Check if user has valid token for a scope
usersUuidSubscriptionsSubsnoAddressChangeDelete	DELETE /users/{uuid}/subscriptions/{subsno}/addressChange	Delete temporary address change for subscription
usersUuidSubscriptionsSubsnoAddressChangePatch	PATCH /users/{uuid}/subscriptions/{subsno}/addressChange	Edit temporary address change dates of a subscription
usersUuidSubscriptionsSubsnoAddressChangePost	POST /users/{uuid}/subscriptions/{subsno}/addressChange	Make a temporary address change for a subscription
usersUuidSubscriptionsSubsnoCancelPut	PUT /users/{uuid}/subscriptions/{subsno}/cancel	Cancels user subscription
usersUuidSubscriptionsSubsnoPausePatch	PATCH /users/{uuid}/subscriptions/{subsno}/pause	Edit pause duration
usersUuidSubscriptionsSubsnoPausePost	POST /users/{uuid}/subscriptions/{subsno}/pause	Pause users subscription
usersUuidSubscriptionsSubsnoReclamationPost	POST /users/{uuid}/subscriptions/{subsno}/reclamation	Create a new delivery reclamation for a subscription
usersUuidSubscriptionsSubsnoReclamationsReclaimnoGet	GET /users/{uuid}/subscriptions/{subsno}/reclamations/{reclaimno}	Get a delivery reclamation
usersUuidSubscriptionsSubsnoUnpausePost	POST /users/{uuid}/subscriptions/{subsno}/unpause	Unpause users subscription

usersPost

LoginResponse usersPost(body)

Create a new user.

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var body = new Persona.NewUser(); // NewUser | 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.usersPost(body, callback);

Parameters

Name	Type	Description	Notes
body	NewUser

Return type

LoginResponse

Authorization

No authorization required

HTTP request headers

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

usersTemporaryPost

LoginResponse usersTemporaryPost(body)

Create a new user with email.

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var body = new Persona.NewTemporaryUser(); // NewTemporaryUser | 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.usersTemporaryPost(body, callback);

Parameters

Name	Type	Description	Notes
body	NewTemporaryUser

Return type

LoginResponse

Authorization

No authorization required

HTTP request headers

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

usersUuidEntitlementGet

[String] usersUuidEntitlementGet(uuid, opts)

Get users entitlements.

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

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

Parameters

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

Return type

[String]

Authorization

No authorization required

HTTP request headers

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

usersUuidGdprPut

User usersUuidGdprPut(uuid, body, opts)

Updates the GDPR consent settings for a given user.

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var body = [new Persona.GdprConsent()]; // [GdprConsent] | 
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.usersUuidGdprPut(uuid, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
body	[GdprConsent]
authUser	String	[optional]
authorization	String	[optional]

Return type

User

Authorization

No authorization required

HTTP request headers

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

usersUuidGet

User usersUuidGet(uuid, opts)

Get user by UUID.

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

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

Parameters

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

Return type

User

Authorization

No authorization required

HTTP request headers

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

usersUuidLegalPut

User usersUuidLegalPut(uuid, body, opts)

Updates the legal consent settings for a given user.

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var body = [new Persona.LegalConsent()]; // [LegalConsent] | 
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.usersUuidLegalPut(uuid, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
body	[LegalConsent]
authUser	String	[optional]
authorization	String	[optional]

Return type

User

Authorization

No authorization required

HTTP request headers

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

usersUuidNewslettersGet

[Newsletter] usersUuidNewslettersGet(uuid, opts)

Get newsletter subscriptions

Get list of newsletter subscriptions from mailchimp

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
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. Returned data: ' + data);
  }
};
apiInstance.usersUuidNewslettersGet(uuid, opts, callback);

Parameters

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

Return type

[Newsletter]

Authorization

No authorization required

HTTP request headers

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

usersUuidNewslettersPut

[Newsletter] usersUuidNewslettersPut(uuid, body, opts)

Update newsletter subscriptions

Get list of newsletter subscriptions from mailchimp

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var body = [new Persona.Newsletter()]; // [Newsletter] | 
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.usersUuidNewslettersPut(uuid, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
body	[Newsletter]
authUser	String	[optional]
authorization	String	[optional]

Return type

[Newsletter]

Authorization

No authorization required

HTTP request headers

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

usersUuidPasswordPut

User usersUuidPasswordPut(uuid, body, opts)

Set / Change user password

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var body = new Persona.UserUpdatePassword(); // UserUpdatePassword | 
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.usersUuidPasswordPut(uuid, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
body	UserUpdatePassword
authUser	String	[optional]
authorization	String	[optional]

Return type

User

Authorization

No authorization required

HTTP request headers

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

usersUuidPatch

User usersUuidPatch(uuid, body, opts)

Update a user

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var body = new Persona.UserUpdate(); // UserUpdate | 
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.usersUuidPatch(uuid, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
body	UserUpdate
authUser	String	[optional]
authorization	String	[optional]

Return type

User

Authorization

No authorization required

HTTP request headers

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

usersUuidPaymentsGet

[SubscriptionPayments] usersUuidPaymentsGet(uuid, opts)

Get user's subscriptions and payment events

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
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. Returned data: ' + data);
  }
};
apiInstance.usersUuidPaymentsGet(uuid, opts, callback);

Parameters

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

Return type

[SubscriptionPayments]

Authorization

No authorization required

HTTP request headers

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

usersUuidScopeGet

Number usersUuidScopeGet(uuid, scope, opts)

Check if user has valid token for a scope

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var scope = "scope_example"; // String | 
var opts = {
  '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.usersUuidScopeGet(uuid, scope, opts, callback);

Parameters

Name	Type	Notes
uuid	String
scope	String
authorization	String	[optional]

Return type

Number

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoAddressChangeDelete

Subscription usersUuidSubscriptionsSubsnoAddressChangeDelete(uuid, subsno, body, opts)

Delete temporary address change for subscription

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var body = new Persona.DeleteTempAddressChangeDates(); // DeleteTempAddressChangeDates | 
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.usersUuidSubscriptionsSubsnoAddressChangeDelete(uuid, subsno, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
body	DeleteTempAddressChangeDates
authUser	String	[optional]
authorization	String	[optional]

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoAddressChangePatch

Subscription usersUuidSubscriptionsSubsnoAddressChangePatch(uuid, subsno, body, opts)

Edit temporary address change dates of a subscription

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var body = new Persona.TemporaryAddressChangeDates(); // TemporaryAddressChangeDates | 
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.usersUuidSubscriptionsSubsnoAddressChangePatch(uuid, subsno, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
body	TemporaryAddressChangeDates
authUser	String	[optional]
authorization	String	[optional]

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoAddressChangePost

Subscription usersUuidSubscriptionsSubsnoAddressChangePost(uuid, subsno, body, opts)

Make a temporary address change for a subscription

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var body = new Persona.TemporaryAddressChange(); // TemporaryAddressChange | 
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.usersUuidSubscriptionsSubsnoAddressChangePost(uuid, subsno, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
body	TemporaryAddressChange
authUser	String	[optional]
authorization	String	[optional]

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoCancelPut

Subscription usersUuidSubscriptionsSubsnoCancelPut(uuid, subsno, body, opts)

Cancels user subscription

The subscription continues to be valid until the end of the billing period. Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var body = new Persona.CancelSubscriptionReason(); // CancelSubscriptionReason | 
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.usersUuidSubscriptionsSubsnoCancelPut(uuid, subsno, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
body	CancelSubscriptionReason
authUser	String	[optional]
authorization	String	[optional]

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoPausePatch

Subscription usersUuidSubscriptionsSubsnoPausePatch(uuid, subsno, body, opts)

Edit pause duration

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var body = new Persona.SubscriptionPauseEdit(); // SubscriptionPauseEdit | 
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.usersUuidSubscriptionsSubsnoPausePatch(uuid, subsno, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
body	SubscriptionPauseEdit
authUser	String	[optional]
authorization	String	[optional]

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoPausePost

Subscription usersUuidSubscriptionsSubsnoPausePost(uuid, subsno, body, opts)

Pause users subscription

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var body = new Persona.SubscriptionPauseDates(); // SubscriptionPauseDates | 
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.usersUuidSubscriptionsSubsnoPausePost(uuid, subsno, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
body	SubscriptionPauseDates
authUser	String	[optional]
authorization	String	[optional]

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoReclamationPost

DeliveryReclamation usersUuidSubscriptionsSubsnoReclamationPost(uuid, subsno, body, opts)

Create a new delivery reclamation for a subscription

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var body = new Persona.NewDeliveryReclamation(); // NewDeliveryReclamation | 
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.usersUuidSubscriptionsSubsnoReclamationPost(uuid, subsno, body, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
body	NewDeliveryReclamation
authUser	String	[optional]
authorization	String	[optional]

Return type

DeliveryReclamation

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoReclamationsReclaimnoGet

DeliveryReclamation usersUuidSubscriptionsSubsnoReclamationsReclaimnoGet(uuid, subsno, reclaimno, opts)

Get a delivery reclamation

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var reclaimno = 56; // Number | 
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.usersUuidSubscriptionsSubsnoReclamationsReclaimnoGet(uuid, subsno, reclaimno, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
reclaimno	Number
authUser	String	[optional]
authorization	String	[optional]

Return type

DeliveryReclamation

Authorization

No authorization required

HTTP request headers

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

usersUuidSubscriptionsSubsnoUnpausePost

Subscription usersUuidSubscriptionsSubsnoUnpausePost(uuid, subsno, opts)

Unpause users subscription

Authorization header expects the following format ‘OAuth {token}’

Example

var Persona = require('persona');

var apiInstance = new Persona.UsersApi();
var uuid = null; // String | 
var subsno = 56; // Number | 
var opts = {
  'authUser': null, // String | 
  'authorization': "authorization_example", // String | 
  'startDate': new Date("2013-10-20"), // Date | 
  'endDate': new Date("2013-10-20") // Date | 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.usersUuidSubscriptionsSubsnoUnpausePost(uuid, subsno, opts, callback);

Parameters

Name	Type	Notes
uuid	String
subsno	Number
authUser	String	[optional]
authorization	String	[optional]
startDate	Date	[optional]
endDate	Date	[optional]

Return type

Subscription

Authorization

No authorization required

HTTP request headers

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

Files

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

Persona.UsersApi

usersPost

Example

Parameters

Return type

Authorization

HTTP request headers

usersTemporaryPost

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidEntitlementGet

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidGdprPut

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidGet

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidLegalPut

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidNewslettersGet

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidNewslettersPut

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidPasswordPut

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidPatch

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidPaymentsGet

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidScopeGet

Example

Parameters

Return type

Authorization

HTTP request headers

usersUuidSubscriptionsSubsnoAddressChangeDelete