Module: Phyllo

Defined in:: lib/phyllo/version.rb,
lib/phyllo.rb,
lib/phyllo/api_error.rb,
lib/phyllo/api_client.rb,
lib/phyllo/models/user.rb,
lib/phyllo/models/error.rb,
lib/phyllo/configuration.rb,
lib/phyllo/models/honors.rb,
lib/phyllo/api/income_api.rb,
lib/phyllo/models/account.rb,
lib/phyllo/models/comment.rb,
lib/phyllo/models/content.rb,
lib/phyllo/models/honors1.rb,
lib/phyllo/models/profile.rb,
lib/phyllo/models/refresh.rb,
lib/phyllo/api/connect_api.rb,
lib/phyllo/api/publish_api.rb,
lib/phyllo/api/webhook_api.rb,
lib/phyllo/models/account1.rb,
lib/phyllo/models/comment1.rb,
lib/phyllo/models/content1.rb,
lib/phyllo/models/metadata.rb,
lib/phyllo/models/profile1.rb,
lib/phyllo/models/projects.rb,
lib/phyllo/models/refresh1.rb,
lib/phyllo/api/activity_api.rb,
lib/phyllo/api/identity_api.rb,
lib/phyllo/models/education.rb,
lib/phyllo/models/metadata1.rb,
lib/phyllo/models/projects1.rb,
lib/phyllo/models/education1.rb,
lib/phyllo/api/engagement_api.rb,
lib/phyllo/models/error_error.rb,
lib/phyllo/models/account_list.rb,
lib/phyllo/models/content_list.rb,
lib/phyllo/models/demographics.rb,
lib/phyllo/models/honors1_date.rb,
lib/phyllo/models/profile_list.rb,
lib/phyllo/models/publications.rb,
lib/phyllo/models/user_request.rb,
lib/phyllo/models/account1_data.rb,
lib/phyllo/models/account_list1.rb,
lib/phyllo/models/content_group.rb,
lib/phyllo/models/content_list1.rb,
lib/phyllo/models/profile_list1.rb,
lib/phyllo/models/publications1.rb,
lib/phyllo/models/user_request1.rb,
lib/phyllo/models/user_response.rb,
lib/phyllo/models/work_platform.rb,
lib/phyllo/models/certifications.rb,
lib/phyllo/models/content_group1.rb,
lib/phyllo/models/content_search.rb,
lib/phyllo/models/fetch_historic.rb,
lib/phyllo/models/platform_error.rb,
lib/phyllo/models/user_attribute.rb,
lib/phyllo/models/work_platform1.rb,
lib/phyllo/models/activity_artist.rb,
lib/phyllo/models/certifications1.rb,
lib/phyllo/models/commerce_payout.rb,
lib/phyllo/models/content_search1.rb,
lib/phyllo/models/fetch_historic1.rb,
lib/phyllo/models/platform_error1.rb,
lib/phyllo/models/publish_content.rb,
lib/phyllo/models/user_attribute1.rb,
lib/phyllo/models/webhook_payload.rb,
lib/phyllo/models/work_experience.rb,
lib/phyllo/models/activity_artist1.rb,
lib/phyllo/models/activity_content.rb,
lib/phyllo/models/comment_response.rb,
lib/phyllo/models/commerce_balance.rb,
lib/phyllo/models/commerce_payout1.rb,
lib/phyllo/models/webhook_payload1.rb,
lib/phyllo/models/webhook_response.rb,
lib/phyllo/models/work_experience1.rb,
lib/phyllo/models/account_attribute.rb,
lib/phyllo/models/activity_content1.rb,
lib/phyllo/models/commerce_balance1.rb,
lib/phyllo/models/content_attribute.rb,
lib/phyllo/models/education1_school.rb,
lib/phyllo/models/sdk_token_request.rb,
lib/phyllo/models/webhook_response1.rb,
lib/phyllo/models/account_attribute1.rb,
lib/phyllo/models/content1_sponsored.rb,
lib/phyllo/models/content_attribute1.rb,
lib/phyllo/models/content_group_list.rb,
lib/phyllo/models/publications1_date.rb,
lib/phyllo/models/sdk_token_request1.rb,
lib/phyllo/models/sdk_token_response.rb,
lib/phyllo/models/social_transaction.rb,
lib/phyllo/models/user_response_list.rb,
lib/phyllo/models/work_platform_list.rb,
lib/phyllo/models/content1_engagement.rb,
lib/phyllo/models/content_group_list1.rb,
lib/phyllo/models/content_search_list.rb,
lib/phyllo/models/profile1_reputation.rb,
lib/phyllo/models/sdk_token_response1.rb,
lib/phyllo/models/social_transaction1.rb,
lib/phyllo/models/user_response_list1.rb,
lib/phyllo/models/work_platform_list1.rb,
lib/phyllo/models/account1_data_income.rb,
lib/phyllo/models/activity_artist_list.rb,
lib/phyllo/models/commerce_payout_list.rb,
lib/phyllo/models/commerce_transaction.rb,
lib/phyllo/models/content_group_search.rb,
lib/phyllo/models/content_search_list1.rb,
lib/phyllo/models/send_webhook_payload.rb,
lib/phyllo/models/account1_data_publish.rb,
lib/phyllo/models/activity_artist_list1.rb,
lib/phyllo/models/activity_content_list.rb,
lib/phyllo/models/comment_response_list.rb,
lib/phyllo/models/commerce_balance_list.rb,
lib/phyllo/models/commerce_payout_list1.rb,
lib/phyllo/models/commerce_transaction1.rb,
lib/phyllo/models/content_group_search1.rb,
lib/phyllo/models/profile1_emails_inner.rb,
lib/phyllo/models/publish_content_media.rb,
lib/phyllo/models/send_webhook_payload1.rb,
lib/phyllo/models/volunteer_experiences.rb,
lib/phyllo/models/webhook_response_list.rb,
lib/phyllo/models/account1_data_activity.rb,
lib/phyllo/models/account1_data_identity.rb,
lib/phyllo/models/activity_artist_search.rb,
lib/phyllo/models/activity_content_list1.rb,
lib/phyllo/models/commerce_balance_list1.rb,
lib/phyllo/models/commerce_payout_search.rb,
lib/phyllo/models/content1_collaboration.rb,
lib/phyllo/models/create_webhook_request.rb,
lib/phyllo/models/education1_time_period.rb,
lib/phyllo/models/publish_content_media1.rb,
lib/phyllo/models/publish_content_media2.rb,
lib/phyllo/models/update_webhook_request.rb,
lib/phyllo/models/volunteer_experiences1.rb,
lib/phyllo/models/webhook_response_list1.rb,
lib/phyllo/models/activity_artist_search1.rb,
lib/phyllo/models/activity_content_search.rb,
lib/phyllo/models/commerce_balance_amount.rb,
lib/phyllo/models/commerce_balance_search.rb,
lib/phyllo/models/commerce_payout_search1.rb,
lib/phyllo/models/create_webhook_request1.rb,
lib/phyllo/models/demographics_attributes.rb,
lib/phyllo/models/publish_content_request.rb,
lib/phyllo/models/social_transaction_list.rb,
lib/phyllo/models/update_webhook_request1.rb,
lib/phyllo/models/work_platform1_products.rb,
lib/phyllo/models/work_platform_attribute.rb,
lib/phyllo/models/account1_data_engagement.rb,
lib/phyllo/models/activity_content_search1.rb,
lib/phyllo/models/commerce_balance_amount1.rb,
lib/phyllo/models/commerce_balance_search1.rb,
lib/phyllo/models/profile1_addresses_inner.rb,
lib/phyllo/models/publish_content_request1.rb,
lib/phyllo/models/publish_content_response.rb,
lib/phyllo/models/social_transaction_list1.rb,
lib/phyllo/models/work_experience1_company.rb,
lib/phyllo/models/work_platform_attribute1.rb,
lib/phyllo/models/commerce_transaction_list.rb,
lib/phyllo/models/content_group1_engagement.rb,
lib/phyllo/models/content_group_search_list.rb,
lib/phyllo/models/publish_content_response1.rb,
lib/phyllo/models/social_transaction_search.rb,
lib/phyllo/models/work_experience1_location.rb,
lib/phyllo/models/commerce_transaction_list1.rb,
lib/phyllo/models/content_group_search_list1.rb,
lib/phyllo/models/social_transaction_search1.rb,
lib/phyllo/models/activity_artist_search_list.rb,
lib/phyllo/models/certifications1_time_period.rb,
lib/phyllo/models/commerce_payout_search_list.rb,
lib/phyllo/models/commerce_transaction_search.rb,
lib/phyllo/models/disconnect_account_response.rb,
lib/phyllo/models/activity_artist_search_list1.rb,
lib/phyllo/models/activity_content_search_list.rb,
lib/phyllo/models/commerce_balance_search_list.rb,
lib/phyllo/models/commerce_payout_search_list1.rb,
lib/phyllo/models/commerce_transaction_search1.rb,
lib/phyllo/models/disconnect_account_response1.rb,
lib/phyllo/models/profile1_phone_numbers_inner.rb,
lib/phyllo/models/work_experience1_time_period.rb,
lib/phyllo/models/activity_content_search_list1.rb,
lib/phyllo/models/commerce_balance_search_list1.rb,
lib/phyllo/models/commerce_payout1_bank_details.rb,
lib/phyllo/models/publish_content_response1_data.rb,
lib/phyllo/models/social_transaction_search_list.rb,
lib/phyllo/models/work_platform1_products_income.rb,
lib/phyllo/models/work_platform1_products_switch.rb,
lib/phyllo/models/account1_data_identity_audience.rb,
lib/phyllo/models/social_transaction_search_list1.rb,
lib/phyllo/models/work_platform1_products_publish.rb,
lib/phyllo/models/commerce_transaction_search_list.rb,
lib/phyllo/models/publish_content1_additional_info.rb,
lib/phyllo/models/work_platform1_products_activity.rb,
lib/phyllo/models/work_platform1_products_identity.rb,
lib/phyllo/models/account1_data_engagement_audience.rb,
lib/phyllo/models/activity_content1_additional_info.rb,
lib/phyllo/models/commerce_transaction_search_list1.rb,
lib/phyllo/models/education1_time_period_start_date.rb,
lib/phyllo/models/work_platform1_products_engagement.rb,
lib/phyllo/models/content1_engagement_additional_info.rb,
lib/phyllo/models/certifications1_time_period_end_date.rb,
lib/phyllo/models/demographics_attributes1_cities_inner.rb,
lib/phyllo/models/work_experience1_time_period_end_date.rb,
lib/phyllo/models/work_experience1_company_employee_count.rb,
lib/phyllo/models/work_experience1_time_period_start_date.rb,
lib/phyllo/models/demographics_attributes1_countries_inner.rb,
lib/phyllo/models/v1_get_audience_demographics200_response.rb,
lib/phyllo/models/work_platform1_products_identity_audience.rb,
lib/phyllo/models/work_platform1_products_engagement_audience.rb,
lib/phyllo/models/content1_engagement_additional_info_story_navigation.rb,
lib/phyllo/models/publish_content_response1_data_all_of_published_info.rb,
lib/phyllo/models/demographics_attributes1_gender_age_distribution_inner.rb

Overview

#API References

The **Phyllo API** is built on RESTful principles and returns JSON encoded responses and accepts JSON payloads. It is only available through HTTPS to ensure the security of the data in transfer. These APIs must be called only from your server and never from your app / frontend as this is a security concern. The API operates in three environments: sandbox, staging and production. The sandbox environment returns mock data and is used for testing the basic functionality of the system. The staging environment is exactly like a production environment but with certain limitations. It is used for your internal testing and development purposes. The production environment connects to real platform accounts and all data reads and writes are made to live accounts. This is what you would use to get data for your customers.

The version of the OpenAPI document: v1.0 Contact: [email protected] Generated by: openapi-generator.tech Generator version: 7.6.0

Defined Under Namespace

Classes: Account, Account1, Account1Data, Account1DataActivity, Account1DataEngagement, Account1DataEngagementAudience, Account1DataIdentity, Account1DataIdentityAudience, Account1DataIncome, Account1DataPublish, AccountAttribute, AccountAttribute1, AccountList, AccountList1, ActivityApi, ActivityArtist, ActivityArtist1, ActivityArtistList, ActivityArtistList1, ActivityArtistSearch, ActivityArtistSearch1, ActivityArtistSearchList, ActivityArtistSearchList1, ActivityContent, ActivityContent1, ActivityContent1AdditionalInfo, ActivityContentList, ActivityContentList1, ActivityContentSearch, ActivityContentSearch1, ActivityContentSearchList, ActivityContentSearchList1, ApiClient, ApiError, Certifications, Certifications1, Certifications1TimePeriod, Certifications1TimePeriodEndDate, Comment, Comment1, CommentResponse, CommentResponseList, CommerceBalance, CommerceBalance1, CommerceBalanceAmount, CommerceBalanceAmount1, CommerceBalanceList, CommerceBalanceList1, CommerceBalanceSearch, CommerceBalanceSearch1, CommerceBalanceSearchList, CommerceBalanceSearchList1, CommercePayout, CommercePayout1, CommercePayout1BankDetails, CommercePayoutList, CommercePayoutList1, CommercePayoutSearch, CommercePayoutSearch1, CommercePayoutSearchList, CommercePayoutSearchList1, CommerceTransaction, CommerceTransaction1, CommerceTransactionList, CommerceTransactionList1, CommerceTransactionSearch, CommerceTransactionSearch1, CommerceTransactionSearchList, CommerceTransactionSearchList1, Configuration, ConnectApi, Content, Content1, Content1Collaboration, Content1Engagement, Content1EngagementAdditionalInfo, Content1EngagementAdditionalInfoStoryNavigation, Content1Sponsored, ContentAttribute, ContentAttribute1, ContentGroup, ContentGroup1, ContentGroup1Engagement, ContentGroupList, ContentGroupList1, ContentGroupSearch, ContentGroupSearch1, ContentGroupSearchList, ContentGroupSearchList1, ContentList, ContentList1, ContentSearch, ContentSearch1, ContentSearchList, ContentSearchList1, CreateWebhookRequest, CreateWebhookRequest1, Demographics, DemographicsAttributes, DemographicsAttributes1CitiesInner, DemographicsAttributes1CountriesInner, DemographicsAttributes1GenderAgeDistributionInner, DisconnectAccountResponse, DisconnectAccountResponse1, Education, Education1, Education1School, Education1TimePeriod, Education1TimePeriodStartDate, EngagementApi, Error, ErrorError, FetchHistoric, FetchHistoric1, Honors, Honors1, Honors1Date, IdentityApi, IncomeApi, Metadata, Metadata1, PlatformError, PlatformError1, Profile, Profile1, Profile1AddressesInner, Profile1EmailsInner, Profile1PhoneNumbersInner, Profile1Reputation, ProfileList, ProfileList1, Projects, Projects1, Publications, Publications1, Publications1Date, PublishApi, PublishContent, PublishContent1AdditionalInfo, PublishContentMedia, PublishContentMedia1, PublishContentMedia2, PublishContentRequest, PublishContentRequest1, PublishContentResponse, PublishContentResponse1, PublishContentResponse1Data, PublishContentResponse1DataAllOfPublishedInfo, Refresh, Refresh1, SDKTokenRequest, SDKTokenRequest1, SDKTokenResponse, SDKTokenResponse1, SendWebhookPayload, SendWebhookPayload1, SocialTransaction, SocialTransaction1, SocialTransactionList, SocialTransactionList1, SocialTransactionSearch, SocialTransactionSearch1, SocialTransactionSearchList, SocialTransactionSearchList1, UpdateWebhookRequest, UpdateWebhookRequest1, User, UserAttribute, UserAttribute1, UserRequest, UserRequest1, UserResponse, UserResponseList, UserResponseList1, V1GetAudienceDemographics200Response, VolunteerExperiences, VolunteerExperiences1, WebhookApi, WebhookPayload, WebhookPayload1, WebhookResponse, WebhookResponse1, WebhookResponseList, WebhookResponseList1, WorkExperience, WorkExperience1, WorkExperience1Company, WorkExperience1CompanyEmployeeCount, WorkExperience1Location, WorkExperience1TimePeriod, WorkExperience1TimePeriodEndDate, WorkExperience1TimePeriodStartDate, WorkPlatform, WorkPlatform1, WorkPlatform1Products, WorkPlatform1ProductsActivity, WorkPlatform1ProductsEngagement, WorkPlatform1ProductsEngagementAudience, WorkPlatform1ProductsIdentity, WorkPlatform1ProductsIdentityAudience, WorkPlatform1ProductsIncome, WorkPlatform1ProductsPublish, WorkPlatform1ProductsSwitch, WorkPlatformAttribute, WorkPlatformAttribute1, WorkPlatformList, WorkPlatformList1

Constant Summary collapse

VERSION =

"1.0.0"

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

Phyllo.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/phyllo.rb', line 233

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end