@datafire/vestorly
Client library for Vestorly API
Installation and Usage
npm install --save @datafire/vestorly
let vestorly = require('@datafire/vestorly').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Vestorly Developers API
Actions
findAdvisorByID
Returns a single advisor given their ID
vestorly.findAdvisorByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Advisor Id to fetch
- vestorly_auth required
Output
- output Advisor
findArticlePhrases
Returns phrases used in Categories
vestorly.findArticlePhrases({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - text_search
string
: Text to search phrases - size
integer
: Number of returned phrases - from
integer
: Number of phrases to skip
- vestorly_auth required
Output
- output ArticlePhrases
findArticles
Returns all articles
vestorly.findArticles({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - limit
integer
: Limit on the number of articles to return - text_query
string
: Search query parameter - sort_direction
string
: Direction of sort (used with sort_by parameter) - sort_by
string
: Field on model to sort by
- vestorly_auth required
Output
- output Articles
findArticleByID
Returns a single article
vestorly.findArticleByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Article Id to fetch
- vestorly_auth required
Output
- output Articleresponse
findCustomFeedFilters
Returns all Categorie's filters
vestorly.findCustomFeedFilters({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output CustomFeedFilters
createCustomFeedFilter
Creates a new Category filter
vestorly.createCustomFeedFilter({
"vestorly_auth": "",
"custom_feed_filter": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - custom_feed_filter required CustomFeedFilterInput
- vestorly_auth required
Output
- output CustomFeedFilterresponse
deleteCustomFeedFilter
Deletes the Category's filter
vestorly.deleteCustomFeedFilter({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of category filter to delete
- vestorly_auth required
Output
- output CustomFeedFilterresponse
findCustomFeedFilterByID
Returns a single Category's filter
vestorly.findCustomFeedFilterByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Custom Feed Filter Id to fetch
- vestorly_auth required
Output
- output CustomFeedFilterresponse
updateCustomFeedFilterById
Updates a Category Feed Filter
vestorly.updateCustomFeedFilterById({
"vestorly_auth": "",
"id": "",
"custom_feed_filter": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of category filter to update - custom_feed_filter required CustomFeedFilterInput
- vestorly_auth required
Output
- output CustomFeedFilterresponse
findCustomFeeds
Returns all Categories
vestorly.findCustomFeeds({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output CustomFeeds
createCustomFeed
Creates a new Category
vestorly.createCustomFeed({
"vestorly_auth": "",
"custom_feed": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - custom_feed required CustomFeedInput
- vestorly_auth required
Output
- output CustomFeedresponse
deleteCustomFeed
Deletes a new Category
vestorly.deleteCustomFeed({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of category to delete
- vestorly_auth required
Output
- output CustomFeedresponse
findCustomFeedByID
Returns a single Category
vestorly.findCustomFeedByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Custom Feed Id to fetch
- vestorly_auth required
Output
- output CustomFeedresponse
updateCategoryById
Updates a Category
vestorly.updateCategoryById({
"vestorly_auth": "",
"id": "",
"custom_feed": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of category to update - custom_feed required CustomFeedInput
- vestorly_auth required
Output
- output CustomFeedresponse
findCustomFeedArticles
Returns Articles by Category
vestorly.findCustomFeedArticles({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Category Id to fetch - limit
integer
: Limit on the number of articles to return - sort_by
string
: Field on model to sort by - start
integer
: Field where the fetch will start from - created_at_gte_days_ago
string
: Filter retrieved articles since this date - text_query
string
: Search query parameter
- vestorly_auth required
Output
- output Articles
duplicateCustomFeed
Duplicates Category
vestorly.duplicateCustomFeed({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of category to duplicate
- vestorly_auth required
Output
- output CustomFeedresponse
findEvents
Returns all events
vestorly.findEvents({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output Events
createEvent
Creates a new event in the system
vestorly.createEvent({
"vestorly_auth": "",
"event": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - event required EventInput
- vestorly_auth required
Output
- output Eventcreateresponse
findEventByID
Returns a single event if the user has access
vestorly.findEventByID({
"id": "",
"vestorly_auth": ""
}, context)
Input
- input
object
- id required
string
: Mongo ID of event to fetch - access_token
string
: OAuth Token - vestorly_auth required
string
: Vestorly Auth Token
- id required
Output
- output Eventresponse
findGroups
Returns all groups
vestorly.findGroups({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output Groups
createGroup
Creates a new Group
vestorly.createGroup({
"vestorly_auth": "",
"group": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - group required GroupInput
- vestorly_auth required
Output
- output Groupresponse
deleteGroup
Deletes a Group
vestorly.deleteGroup({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of group to delete
- vestorly_auth required
Output
- output Groupresponse
findGroupByID
Returns a single group if user has access
vestorly.findGroupByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Mongo ID of group to fetch
- vestorly_auth required
Output
- output Groupresponse
updateGroupById
Updates a Group
vestorly.updateGroupById({
"vestorly_auth": "",
"id": "",
"group": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of group to update - group required GroupInput
- vestorly_auth required
Output
- output Groupresponse
findMemberEvents
Returns all MemberEvents
vestorly.findMemberEvents({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output MemberEvents
findMemberReports
Returns all member reports
vestorly.findMemberReports({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output MemberReports
findMembers
Returns all members
vestorly.findMembers({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - start
integer
: Skips number of members from start - limit
integer
: Number of members to return
- vestorly_auth required
Output
- output Members
createMember
Create a new member in the Vestorly Platform
vestorly.createMember({
"vestorly_auth": "",
"member": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - member required Member
- vestorly_auth required
Output
- output Memberresponse
findMemberByID
Returns a single member
vestorly.findMemberByID({
"id": "",
"vestorly_auth": ""
}, context)
Input
- input
object
- id required
string
: Mongo ID of member to fetch - vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- id required
Output
- output Memberresponse
updateMemberByID
Updates a single member
vestorly.updateMemberByID({
"id": "",
"vestorly_auth": "",
"member": null
}, context)
Input
- input
object
- id required
string
: Mongo ID of member to fetch - vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - member required Member
- id required
Output
- output Memberresponse
findNewsletterSettings
Returns all newsletter settings
vestorly.findNewsletterSettings({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output NewsletterSettings
findNewsletterSettingsByID
Returns a single newsletter settings if the user has access
vestorly.findNewsletterSettingsByID({
"id": "",
"vestorly_auth": ""
}, context)
Input
- input
object
- id required
string
: Mongo ID of newsletter settings to fetch - vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- id required
Output
- output Newslettersettingresponse
updateNewsletterSettingsByID
Update a single newsletter setting by ID
vestorly.updateNewsletterSettingsByID({
"id": "",
"vestorly_auth": "",
"newsletter_setting": null
}, context)
Input
- input
object
- id required
string
: Mongo ID of newsletter settings to update - vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - newsletter_setting required NewsletterSettingsInput
- id required
Output
- output Newslettersettingresponse
findNewsletters
Returns all newsletters
vestorly.findNewsletters({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output Newsletters
getNewsletterByID
Get a newsletter by ID
vestorly.getNewsletterByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Mongo ID of event to get
- vestorly_auth required
Output
- output Newsletterresponse
updateNewsletterByID
Updates a newsletter
vestorly.updateNewsletterByID({
"vestorly_auth": "",
"id": "",
"newsletter": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Mongo ID of event to update - newsletter required NewsletterInput
- vestorly_auth required
Output
- output Newsletterresponse
findPosts
Query all posts
vestorly.findPosts({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - text_query
string
: Filter post by parameters - external_url
string
: Filter by External URL - is_published
string
: Filter by is_published boolean
- vestorly_auth required
Output
- output Posts
createPost
Create a new post in the Vestorly Platform
vestorly.createPost({
"vestorly_auth": "",
"post": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - post required PostInput
- vestorly_auth required
Output
- output Postresponse
getPostByID
Query all posts
vestorly.getPostByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: ID of post to fetch
- vestorly_auth required
Output
- output Postresponse
updatePostByID
Update A Post
vestorly.updatePostByID({
"vestorly_auth": "",
"id": "",
"post": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of post to update - post required Post
- vestorly_auth required
Output
- output Postresponse
findSeedCustomFeeds
Returns all Categories keywords
vestorly.findSeedCustomFeeds({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output SeedCustomFeeds
createSeedCustomFeed
Creates a new Category Keyword
vestorly.createSeedCustomFeed({
"vestorly_auth": "",
"seed_custom_feed": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - seed_custom_feed required SeedCustomFeedInput
- vestorly_auth required
Output
- output SeedCustomFeedresponse
deleteSeedCustomFeed
Deletes a Category keywords
vestorly.deleteSeedCustomFeed({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of seed category to delete
- vestorly_auth required
Output
- output SeedCustomFeedresponse
findSeedCustomFeedByID
Returns a single Category keyword
vestorly.findSeedCustomFeedByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: Seed Custom Feed Id to fetch
- vestorly_auth required
Output
- output SeedCustomFeedresponse
updateSeedCustomFeedById
Updates a Category keywords
vestorly.updateSeedCustomFeedById({
"vestorly_auth": "",
"id": "",
"seed_custom_feed": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: id of seed category to update - seed_custom_feed required SeedCustomFeedInput
- vestorly_auth required
Output
- output SeedCustomFeedresponse
login
Login To Vestorly Platform
vestorly.login({
"username": "",
"password": ""
}, context)
Input
- input
object
- username required
string
: Username in the vestorly platform - password required
string
: Password in Vestorly Platform
- username required
Output
- output Session
logout
Logout of the vestorly platform
vestorly.logout({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Authenication token - id required
string
: ID of pet to session
- vestorly_auth required
Output
- output SessionLogoutResponse
findSources
Returns all sources
vestorly.findSources({
"vestorly_auth": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token
- vestorly_auth required
Output
- output Sources
createSource
Create source
vestorly.createSource({
"vestorly_auth": "",
"source": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - source required SourceInput
- vestorly_auth required
Output
- output Sourceresponse
getSourceByID
Get Source By ID
vestorly.getSourceByID({
"vestorly_auth": "",
"id": ""
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: ID of source to fetch
- vestorly_auth required
Output
- output Sourceresponse
updateSourceByID
Update Source By ID
vestorly.updateSourceByID({
"vestorly_auth": "",
"id": "",
"source": null
}, context)
Input
- input
object
- vestorly_auth required
string
: Vestorly Auth Token - access_token
string
: OAuth Token - id required
string
: ID of source to fetch - source required SourceInput
- vestorly_auth required
Output
- output Sourceresponse
Definitions
Advisor
- Advisor
object
- about
string
- account_type
string
- address
string
- adv_brochure
string
- api_key
string
- city
string
- company
string
- compliance_bcc_email_address
string
- dashboard_url
string
- disclosure
string
- email_report_blast
string
- external_options
string
- first_name
string
- id required
string
- last_name
string
- linkedin
string
- logo
string
- name required
string
- plan
string
- profile_picture
string
- reg_number
string
- state
string
- tag
string
- twitter_handle
string
- website
string
- zip
string
- about
Advisorresponse
- Advisorresponse
object
- advisor Advisor
Advisors
- Advisors
object
- advisors
array
- items Advisor
- advisors
Article
- Article
object
- _id required
string
- body
string
- created_at
string
- external_url
string
- external_url_source
string
- external_url_type
string
- image_height
integer
- image_path
string
- image_url
string
- image_width
integer
- is_mobile_proxy_needed
boolean
- is_proxy_needed
boolean
- is_responsive
boolean
- logo_url
string
- needs_sanitize
boolean
- proxy_url
string
- redirector_link
string
- square_logo_url
string
- suitability_score
string
- summary
string
- title required
string
- topic
string
- url
string
- _id required
ArticlePhrase
- ArticlePhrase
object
- created_at
integer
- length
integer
- text
string
- created_at
ArticlePhraseresponse
- ArticlePhraseresponse
object
- article_phrase ArticlePhrase
ArticlePhrases
- ArticlePhrases
object
- article_phrases
array
- items ArticlePhrase
- article_phrases
Articleresponse
- Articleresponse
object
- article Article
Articles
- Articles
object
- articles
array
- items Article
- articles
CustomFeed
- CustomFeed
object
- _id required
string
- custom_feed_filter_id
string
- custom_feed_permission_id
string
- custom_feed_template_id
string
- custom_feed_visibility
integer
- default
boolean
- display_label
string
- is_auto_curated_newsletter_custom_feed
boolean
- label required
string
- links
string
- popularity
number
- premium_content
boolean
- seed_custom_feed_id
string
- third_party_articles_custom_feed_id
string
- _id required
CustomFeedFilter
- CustomFeedFilter
object
- _id required
string
- custom_feed_id required
string
- source_ids
array
- items
string
- items
- _id required
CustomFeedFilterInput
- CustomFeedFilterInput
object
- custom_feed_id required
string
- source_ids
array
- items
string
- items
- custom_feed_id required
CustomFeedFilterresponse
- CustomFeedFilterresponse
object
- custom_feed_filter CustomFeedFilter
CustomFeedFilters
- CustomFeedFilters
object
- custom_feed_filters
array
- items CustomFeedFilter
- custom_feed_filters
CustomFeedInput
- CustomFeedInput
object
- custom_feed_filter_id
string
- custom_feed_permission_id
string
- custom_feed_visibility
integer
- default
boolean
- is_auto_curated_newsletter_custom_feed
boolean
- label required
string
- popularity
number
- premium_content
boolean
- seed_custom_feed_id
string
- social_posting_id
string
- third_party_articles_custom_feed_id
string
- custom_feed_filter_id
CustomFeedresponse
- CustomFeedresponse
object
- custom_feed CustomFeed
CustomFeeds
- CustomFeeds
object
- custom_feeds
array
- items CustomFeed
- custom_feeds
Event
- Event
object
- _id required
string
- advisor_id
string
- created_at
string
- event_content EventContent
- original_url required
string
- originator_email
string
- originator_id
string
- parent_event_id
string
- referer
string
- subject_email required
string
- subject_id
string
- type required
string
(values: page_view, sign_up, sign_in, content_posted, create_post, publish_post, update_post, delete_post, unpublish_post, invite, publish_newsletter, publish_social, click, delivered, open, dropped, bounce)
- _id required
EventContent
- EventContent
object
- _id
string
: Mongo id of event - content_field
string
- content_id
string
- content_type
string
- created_at
string
- slug
string
- updated_at
string
- _id
EventInput
- EventInput
object
- advisor_id
string
- created_at
string
- event_content EventContent
- original_url required
string
- originator_email
string
- originator_id
string
- parent_event_id
string
- referer
string
- subject_email required
string
- subject_id
string
- type required
string
(values: page_view, sign_up, sign_in, content_posted, create_post, publish_post, update_post, delete_post, unpublish_post, invite, publish_newsletter, publish_social, click, delivered, open, dropped, bounce)
- advisor_id
Eventcreateresponse
- Eventcreateresponse
object
- meta Meta
Eventresponse
- Eventresponse
object
- event Event
Events
- Events
object
- events
array
- items Event
- events
Features
- Features
object
- _id required
string
- _id required
Group
- Group
object
- _id required
string
- autopublish
boolean
- is_default
boolean
- is_hidden
boolean
- name
string
- new_weekly_mailer_content
string
- newsletter_subject
string
- number_articles_per_group
integer
- number_articles_per_newsletter
integer
- _id required
GroupInput
- GroupInput
object
- _id required
string
- autopublish
boolean
- is_default
boolean
- is_hidden
boolean
- name
string
- new_weekly_mailer_content
string
- newsletter_subject
string
- number_articles_per_group
integer
- number_articles_per_newsletter
integer
- _id required
Groupresponse
- Groupresponse
object
- group Group
Groups
- Groups
object
- groups
array
- items Group
- groups
Member
- Member
object
- _id required
string
- address
string
- age
string
- assets
string
- city
string
- data_estimated
boolean
- education
string
- email required
string
- estimated_location
string
- estimated_zip
string
- family
string
- first_name
string
- gender
string
- genuine_email
boolean
- high_net_worth
boolean
- home_market_value
string
- home_owner_status
string
- hometown
string
- household_income
string
- interest_consultation
string
- interest_in_new_advisor
string
- invited_by
string
- invited_on
string
- is_client
boolean
- is_hidden
boolean
- last_active_date
string
- last_name
string
- location
string
- marital_status
string
- message
string
- occupation
string
- phone
string
- picture_url
string
- portfolio_size
string
- profile_url
string
- register_ip_addr
string
- signed_up_with
string
- state
string
- subscribed_group_ids
array
- items
string
- items
- tags
array
- items
string
- items
- unsubscribed
boolean
- unsubscribed_date
boolean
- user_type
string
- zip
string
- _id required
MemberEvent
- MemberEvent
object
- _id
string
- content_url
string
- created_at
string
- event_date
string
- event_source
string
- event_type
string
- member_id
string
- original_url
string
- originator_email
string
- originator_group_id
string
- originator_id
string
- originator_name
string
- originator_type
string
- parent_event_id
string
- parent_originator_id
string
- referer
string
- source
string
- subject_id
string
- type
string
- username
string
- _id
MemberEvents
- MemberEvents
object
- member_events
array
- items MemberEvent
- members
array
- items TruncatedMember
- member_events
MemberReport
- MemberReport
object
- day
integer
- event_count
integer
- originator_group_id
string
- parent_originator_id
string
- source
string
- type
string
- year
integer
- day
MemberReports
- MemberReports
object
- member_reports
array
- items MemberReport
- member_reports
Memberresponse
- Memberresponse
object
- member Member
Members
Meta
- Meta
object
- message
string
- message
Newsletter
- Newsletter
object
- _id
string
- click_count
integer
- is_default
boolean
- is_sent
boolean
- total_click_count
integer
- unique_click_count
integer
- _id
NewsletterInput
- NewsletterInput
object
- click_count
integer
- is_default
boolean
- is_sent
boolean
- total_click_count
integer
- unique_click_count
integer
- click_count
NewsletterSetting
- NewsletterSetting
object
- _id required
string
- banner_color
string
- body_html
string
- email_accent_color
string
- email_day_of_week
integer
- email_hour
integer
- email_status
string
- facebook_active_wall
string
- footer_email_font
string
- footer_html
string
- footer_image_url
string
- group_id
string
- header_background_color
string
- header_image_url
string
- intro_text
string
- linkedin_active_wall
string
- montage_enabled
boolean
- montage_facebook_image_url
string
- montage_linkedin_image_url
string
- montage_title
string
- montage_twitter_image_url
string
- newsletter_ids
array
- items
string
- items
- newsletter_type
string
- primary_email_font
string
- salutation_text
string
- social_day_of_week
integer
- social_description
string
- social_posting_text
string
- social_title
string
- subject
string
- title_color
string
- _id required
NewsletterSettings
- NewsletterSettings
object
- newsletter_settings
array
- items NewsletterSetting
- newsletter_settings
NewsletterSettingsInput
- NewsletterSettingsInput
object
- newsletter_setting NewsletterSetting
Newsletterresponse
- Newsletterresponse
object
- newsletter Newsletter
Newsletters
- Newsletters
object
- newsletters
array
- items Newsletter
- newsletters
Newslettersettingresponse
- Newslettersettingresponse
object
- newsletter_setting NewsletterSetting
OrgSetting
- OrgSetting
object
- _id required
string
- company_address
string
- company_contact_email
string
- company_homepage_url
string
- is_default
boolean
- name
string
- privacy_policy_url
string
- site_url
string
- terms_and_conditions_url
string
- _id required
PersonalSettings
- PersonalSettings
object
- _id required
string
- _id required
Post
- Post
object
- _id
string
- advisor_id
string
- approval_status
string
- approval_transactions
array
- items
string
- items
- article_id
string
- comment
string
- created_at
string
- display_date
string
- display_summary
string
- display_tag
string
- external_url
string
- external_url_source
string
- external_url_type
string
- group_ids
array
- items
string
- items
- image_height
string
- image_path
string
- image_url
string
- image_width
string
- is_featured
boolean
- is_mobile_proxy_needed
boolean
- is_proxy_needed
boolean
- is_published
boolean
- is_responsive
boolean
- logo_url
string
- needs_sanitize
string
- newsletter_ids
array
- items
string
- items
- post_date
string
- proxy_url
string
- redirector_link
string
- slug
string
- square_logo_url
string
- suitability_score
string
- summary
string
- title
string
- topic
string
- updated_at
string
- vestorly_url
string
- video
string
- video_id
string
- _id
PostInput
- PostInput
object
- advisor_id
string
- approval_status
string
- approval_transactions
array
- items
string
- items
- article_id
string
- comment
string
- created_at
string
- display_date
string
- display_summary
string
- display_tag
string
- external_url
string
- external_url_source
string
- external_url_type
string
- group_ids
array
- items
string
- items
- image_height
string
- image_path
string
- image_url
string
- image_width
string
- is_featured
boolean
- is_mobile_proxy_needed
boolean
- is_proxy_needed
boolean
- is_published
boolean
- is_responsive
boolean
- logo_url
string
- needs_sanitize
string
- newsletter_ids
array
- items
string
- items
- post_date
string
- proxy_url
string
- slug
string
- square_logo_url
string
- suitability_score
string
- summary
string
- title required
string
- topic
string
- updated_at
string
- vestorly_url
string
- video
string
- video_id
string
- advisor_id
Postrequest
- Postrequest
object
- post PostInput
Postresponse
- Postresponse
object
- post Post
Posts
- Posts
object
- posts
array
- items Post
- posts
SeedCustomFeed
- SeedCustomFeed
object
- _id required
string
- article_id
string
- custom_feed_id
string
- not_article_id
string
- not_seeds
array
- items
string
- items
- seeds
array
- items
string
- items
- sort_by
string
- _id required
SeedCustomFeedInput
- SeedCustomFeedInput
object
- article_id
string
- custom_feed_id required
string
- not_article_id
string
- not_seeds
array
- items
string
- items
- seeds
array
- items
string
- items
- sort_by
string
- article_id
SeedCustomFeedresponse
- SeedCustomFeedresponse
object
- seed_custom_feed SeedCustomFeed
SeedCustomFeeds
- SeedCustomFeeds
object
- seed_custom_feeds
array
- items SeedCustomFeed
- seed_custom_feeds
Session
SessionLogoutResponse
- SessionLogoutResponse
object
- message
string
- message
Settings
- Settings
object
- _id required
string
- adv_brochure
string
- company
string
- disclosure
string
- feature Features
- name
string
- orgsetting OrgSetting
- personalsetting PersonalSettings
- picture_url
string
- slug
string
- website
string
- _id required
Source
- Source
object
- _id required
string
- custom_rss_feed
boolean
- enabled
boolean
- logo_url
string
- name required
string
- rss_publisher required
string
- url required
string
- _id required
SourceInput
- SourceInput
object
- custom_rss_feed
boolean
- enabled
boolean
- logo_url
string
- name required
string
- rss_publisher required
string
- url required
string
- custom_rss_feed
Sourceresponse
- Sourceresponse
object
- source Source
Sources
- Sources
object
- sources
array
- items Source
- sources
TruncatedMember
- TruncatedMember
object
- _id
string
- added_on
string
- email
string
- first_name
string
- last_name
string
- picture_url
string
- _id
User
- User
object
- _id required
string
- company
string
- first_name
string
- last_name
string
- name
string
- new_user
boolean
- picture_url
string
- plan_expired
boolean
- plan_id
string
- plan_setup
boolean
- plan_status
string
- plan_stripe
boolean
- show_tour
boolean
- slug
string
- user_type
string
- username
string
- website
string
- _id required