Class: AssociationAPI

new AssociationAPI(rest)

This class is used to interact with Associations in TidyHQ.

Parameters:

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

Source: src/Association.js, line 14

Methods

(async) getOrganization(id, optionsopt) → {Promise.<TidyAPI_V1_Organization>}

Get a single organization.

Parameters:

Name Type Attributes Default Description

id string The ID of the organization.

options

object

{}

Properties

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

Source: src/Association.js, line 42

Returns:

- The organization.

Type:: Promise.<TidyAPI_V1_Organization>

(async) getOrganizationContacts(organization_id, optionsopt) → {Promise.<TidyAPI_V1_OrganizationContacts>}

Get the contacts that fall under an organization.

Parameters:

Name Type Attributes Default Description

organization_id string The ID of the organization.

options

object

{}

Properties

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

Source: src/Association.js, line 54

Returns:

- The list of contacts.

Type:: Promise.<TidyAPI_V1_OrganizationContacts>

(async) getOrganizationEvent(organization_id, event_id, optionsopt) → {Promise.<TidyAPI_V1_Event>}

Get a single event that falls under an organization.

Parameters:

Name Type Attributes Default Description

organization_id string The ID of the organization.

event_id number The ID of the event.

options

object

{}

Properties

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

Source: src/Association.js, line 84

Returns:

- The event.

Type:: Promise.<TidyAPI_V1_Event>

(async) getOrganizationEvents(organization_id, optionsopt) → {Promise.<TidyAPI_V1_Events>}

Get the events that fall under an organization.

Parameters:

Name Type Attributes Default Description

organization_id string The ID of the organization.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.
`limit`	number	<optional>	The maximum number of contacts to return.
`offset`	number	<optional>	The number of contacts to skip.
`start_at`	string	<optional>	The start date of the events to return in ISO 8601 format.
`end_at`	string	<optional>	The end date of the events to return in ISO 8601 format.
`public`	boolean	<optional>	Whether to return only public events or not.

Source: src/Association.js, line 71

Returns:

- The list of events.

Type:: Promise.<TidyAPI_V1_Events>

(async) getOrganizationMeeting(organization_id, meeting_id, optionsopt) → {Promise.<TidyAPI_V1_Meeting>}

Get a single meeting that falls under an organization.

Parameters:

Name Type Attributes Default Description

organization_id string The ID of the organization.

meeting_id string The ID of the meeting.

options

object

{}

Properties

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

Source: src/Association.js, line 111

Returns:

- The meeting.

Type:: Promise.<TidyAPI_V1_Meeting>

(async) getOrganizationMeetings(organization_id, optionsopt) → {Promise.<TidyAPI_V1_Meetings>}

Get the meetings that fall under an organization.

Parameters:

Name Type Attributes Default Description

organization_id string The ID of the organization.

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.

Source: src/Association.js, line 98

Returns:

- The list of meetings.

Type:: Promise.<TidyAPI_V1_Meetings>

(async) getOrganizations(optionsopt) → {Promise.<TidyAPI_V1_Organizations>}

Get the organizations that fall under the association associated with the access token.

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

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

Source: src/Association.js, line 30

Returns:

- The list of organizations.

Type:: Promise.<TidyAPI_V1_Organizations>