Class: MembershipsAPI

new MembershipsAPI(rest)

This class is used to interact with Memberships in TidyHQ.

Parameters:

Name	Type	Description
`rest`	Rest	The rest instance to use for requests.

Source: src/Memberships.js, line 15

Methods

(async) getMembership(membership_id, optionsopt) → {Promise.<TidyAPI_V1_Membership>}

Get a single membership.

Parameters:

Name Type Attributes Default Description

membership_id string The ID of the membership.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Memberships.js, line 93

Returns:

- The membership.

Type:: Promise.<TidyAPI_V1_Membership>

(async) getMemberships(optionsopt) → {Promise.<TidyAPI_V1_Memberships>}

Get a list of all memberships.

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	string	<optional>	The number of results to return.
`offset`	string	<optional>	The number of results to skip.
`active`	boolean	<optional>	Whether to return active memberships.
`updated_since`	string	<optional>	The date to return memberships updated since in ISO 8601 format.

Source: src/Memberships.js, line 52

Returns:

- The list of memberships.

Type:: Promise.<TidyAPI_V1_Memberships>

(async) getMembershipsForContact(contact_id, optionsopt) → {Promise.<TidyAPI_V1_Memberships>}

Get a list of all memberships for a contact.

Parameters:

Name Type Attributes Default Description

contact_id string The ID of the contact.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	string	<optional>	The number of results to return.
`offset`	string	<optional>	The number of results to skip.
`active`	boolean	<optional>	Whether to return active memberships.
`updated_since`	string	<optional>	The date to return memberships updated since in ISO 8601 format.

Source: src/Memberships.js, line 67

Returns:

- The list of memberships.

Type:: Promise.<TidyAPI_V1_Memberships>

(async) getMembershipsForMembershipLevel(membership_level_id, optionsopt) → {Promise.<TidyAPI_V1_Memberships>}

Get a list of all memberships for a membership level.

Parameters:

Name Type Attributes Default Description

membership_level_id string The ID of the membership level.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	string	<optional>	The number of results to return.
`offset`	string	<optional>	The number of results to skip.
`active`	boolean	<optional>	Whether to return active memberships.
`updated_since`	string	<optional>	The date to return memberships updated since in ISO 8601 format.

Source: src/Memberships.js, line 82

Returns:

- The list of memberships.

Type:: Promise.<TidyAPI_V1_Memberships>