facebookbusiness 0.5.0.4 → 0.5.0.5

data/lib/facebook_ads/ad_objects/page_saved_filter.rb

@@ -26,6 +26,123 @@ module FacebookAds
   # pull request for this class.
 
   class PageSavedFilter < AdObject
+    SECTION = [
+      "ACTIVE_FUNDRAISERS",
+      "ADS_CANVAS",
+      "ADS_POSTS",
+      "ALLOWED",
+      "ALL_REFERENCE_FILES",
+      "ARCHIVED_EVENTS",
+      "ATTRIBUTIONS",
+      "AUDIO_RELEASES",
+      "BLOCKED",
+      "BRANDED_CONTENT",
+      "BRANDED_CONTENT_CREATOR",
+      "BRANDED_CONTENT_SUSPECTED",
+      "CANDIDATE_VIDEOS",
+      "CHEX_COMPLETED_ORDERS",
+      "CHEX_PENDING_ORDERS",
+      "CLAIMED",
+      "COMMERCE_COLLECTIONS",
+      "COMMERCE_MERCHANT_SETTINGS",
+      "COMMERCE_PAST_ORDERS",
+      "COMMERCE_PENDING_ORDERS",
+      "COMMERCE_PLATFORM_SETTINGS",
+      "COMMERCE_PRODUCTS",
+      "COMMERCE_SHOP_LINK",
+      "CONTENT_TESTS",
+      "CREATOR_STUDIO",
+      "CREATOR_STUDIO_ALL_MATCHES",
+      "CREATOR_STUDIO_ALL_REFERENCE_FILES",
+      "CREATOR_STUDIO_BLOCKED",
+      "CREATOR_STUDIO_COLLECT_AD_EARNINGS",
+      "CREATOR_STUDIO_DISPUTES",
+      "CREATOR_STUDIO_PUBLISHED_ALL_REFERENCE_FILES",
+      "CREATOR_STUDIO_PUBLISHED_BLOCKED",
+      "CREATOR_STUDIO_PUBLISHED_DISPUTES",
+      "CREATOR_STUDIO_PUBLISHED_MANUAL_REVIEW",
+      "CREATOR_STUDIO_PUBLISHED_TRACKED",
+      "CREATOR_STUDIO_REFERENCE_CONFLICTS",
+      "CREATOR_STUDIO_REFERENCE_POSSIBLE_CONFLICTS",
+      "CREATOR_STUDIO_REFERENCE_RESOLUTIONS",
+      "CREATOR_STUDIO_TAKEDOWNS",
+      "CREATOR_STUDIO_TAKEDOWN_REQUESTS",
+      "CREATOR_STUDIO_TRACKED",
+      "CROSSPOSTED_VIDEOS",
+      "DISPUTES",
+      "DONATIONS_SETTINGS",
+      "DRAFTS",
+      "DRAFT_EVENTS",
+      "DRAFT_FUNDRAISERS",
+      "ENDED_FUNDRAISERS",
+      "EXPIRED_POSTS",
+      "EXPIRING_POSTS",
+      "GEM_PRODUCER_DASHBOARD",
+      "IA_REGIWALL_SETTINGS",
+      "INSTANT_ARTICLES",
+      "INSTANT_ARTICLES_CTA_MANAGEMENT",
+      "INSTANT_ARTICLES_DEVELOPMENT",
+      "INSTANT_ARTICLES_MONETIZATION",
+      "INSTANT_ARTICLES_SAMPLE",
+      "INSTANT_ARTICLES_SETTINGS",
+      "INSTANT_ARTICLES_SIGN_UP",
+      "INSTANT_ARTICLES_TRAFFIC_LIFT",
+      "INVOICES_ACTIVE",
+      "INVOICES_HISTORY",
+      "JOB_APPLICATIONS",
+      "JOB_POSTS",
+      "LEAD_ADS_CRM_SETUP",
+      "LEAD_ADS_CUSTOM_CRM_SETUP",
+      "LEAD_ADS_DRAFT_FORMS",
+      "LEAD_ADS_FORMS",
+      "LIVE_BROADCASTS",
+      "MANUAL_CLAIMS",
+      "MANUAL_CLAIM_FACEBOOK_VIDEOS",
+      "MANUAL_CLAIM_INSTAGRAM_VIDEOS",
+      "MANUAL_REVIEW",
+      "MATCH_RULES",
+      "MONETIZED_VIDEOS",
+      "NEWS_SUBSCRIPTIONS",
+      "NEWS_SUBSCRIPTIONS_PUBLISHER_INSIGHTS",
+      "NEWS_SUBSCRIPTIONS_PUBLISHER_TEST_USERS",
+      "NEW_MATCHES",
+      "PENDING_PROFILE_PICTURE_FRAMES",
+      "PLAYLISTS",
+      "PLAYLIST_DETAILS",
+      "POLLS_COMPOSER",
+      "POSTS_CONFIG",
+      "POST_IDEAS",
+      "PREMIUM_MUSIC_VIDEOS",
+      "PUBLISHED_EVENTS",
+      "PUBLISHED_POSTS",
+      "PUBLISHED_PROFILE_PICTURE_FRAMES",
+      "QR_CODE",
+      "READY_FUNDRAISERS",
+      "REFERENCE_CONFLICTS",
+      "REFERENCE_FILES",
+      "REFERENCE_POSSIBLE_CONFLICTS",
+      "REFERENCE_RESOLUTIONS",
+      "REGISTRATIONS",
+      "REPORTED",
+      "REWARD_PROGRAM",
+      "REWARD_PROGRAM_COLLATERAL_MANAGEMENT",
+      "REWARD_PROGRAM_TRANSACTION_HISTORY",
+      "SCHEDULED_EVENTS",
+      "SCHEDULED_POSTS",
+      "SEASONS",
+      "SEASON_DETAILS",
+      "SOUNDS_COLLECTION",
+      "SOUND_RECORDINGS",
+      "STORY_ARCHIVE",
+      "STREAMER_DASHBOARD",
+      "TAKEDOWNS",
+      "TOURS",
+      "TRACKED",
+      "UNSENT_REPORTS",
+      "VIDEOS",
+      "VIDEOS_COPYRIGHT",
+    ]
+
 
     field :display_name, 'string'
     field :filters, { list: 'object' }
@@ -35,7 +152,6 @@ module FacebookAds
     field :time_created, 'int'
     field :time_updated, 'int'
     has_no_post
-    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/page_upcoming_change.rb

@@ -31,6 +31,7 @@ module FacebookAds
     field :effective_time, 'datetime'
     field :id, 'string'
     field :page, 'Page'
+    field :proposal, 'PageChangeProposal'
     field :timer_status, 'string'
     has_no_delete
 

data/lib/facebook_ads/ad_objects/page_videos_you_can_use.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class PageVideosYouCanUse < AdObject
+
+    field :description, 'string'
+    field :id, 'string'
+    field :title, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/partner_category.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class PartnerCategory < AdObject
+    PRIVATE_OR_PUBLIC = [
+      "PRIVATE",
+      "PUBLIC",
+    ]
+
+
+    field :approximate_count, 'int'
+    field :country, 'string'
+    field :description, 'string'
+    field :details, 'string'
+    field :id, 'string'
+    field :is_private, 'bool'
+    field :name, 'string'
+    field :parent_category, 'string'
+    field :source, 'string'
+    field :status, 'string'
+    field :targeting_type, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/partner_integration_linked.rb

@@ -0,0 +1,129 @@
+# Copyright (c) 2017-present, Facebook, Inc. All rights reserved.
+#
+# You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+# copy, modify, and distribute this software in source code or binary form for use
+# in connection with the web services and APIs provided by Facebook.
+#
+# As with any software that integrates with the Facebook platform, your use of
+# this software is subject to the Facebook Platform Policy
+# [http://developers.facebook.com/policy/]. This copyright notice shall be
+# included in all copies or substantial portions of the software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# FB:AUTOGEN
+
+module FacebookAds
+  # This class is auto-generated.
+
+  # For any issues or feature requests related to this class, please let us know
+  # on github and we'll fix in our codegen framework. We'll not be able to accept
+  # pull request for this class.
+
+  class PartnerIntegrationLinked < AdObject
+    PARTNER = [
+      "adjust",
+      "appsflyer",
+      "avana",
+      "backer_founder",
+      "bandzoogle",
+      "big_commerce",
+      "branch",
+      "cart_3d",
+      "cdk",
+      "default",
+      "drupal",
+      "ec_cube3",
+      "ecwid",
+      "eventbrite",
+      "feedonomics",
+      "foodkit",
+      "google_tag_manager",
+      "haravan",
+      "hubspot",
+      "infusionsoft_zap",
+      "intern",
+      "invoca",
+      "jimdo",
+      "joomla",
+      "jumpseller",
+      "kajabi",
+      "kochava",
+      "kraftly",
+      "leadsbridge",
+      "m_particle",
+      "magento",
+      "magento_2",
+      "marketo",
+      "meesho",
+      "now_floats",
+      "opencart",
+      "prestashop",
+      "productsup",
+      "riversoft",
+      "ruby_on_rails",
+      "salesforce",
+      "salesforce_zap",
+      "segment",
+      "shop_up",
+      "shopify",
+      "shopify_online",
+      "shopline",
+      "singular",
+      "sirclo",
+      "squarespace",
+      "storeden",
+      "tealium",
+      "teespring",
+      "test",
+      "ticketmaster",
+      "verifone",
+      "waca",
+      "webflow",
+      "weebly",
+      "wix",
+      "woocommerce",
+      "wordpress",
+      "yreceipts",
+      "zapier",
+      "zoho_zap",
+    ]
+
+    COMPLETED_INTEGRATION_TYPES = [
+      "0",
+      "1",
+      "2",
+      "3",
+      "4",
+    ]
+
+    SETUP_STATUS = [
+      "COMPLETE",
+      "START",
+    ]
+
+
+    field :ads_pixel, 'AdsPixel'
+    field :application, 'Application'
+    field :completed_integration_types, { list: 'string' }
+    field :external_id, 'string'
+    field :has_oauth_token, 'bool'
+    field :id, 'string'
+    field :name, 'string'
+    field :offline_conversion_data_set, 'OfflineConversionDataSet'
+    field :page, 'Page'
+    field :partner, 'string'
+    field :partner_profile, 'object'
+    field :product_catalog, 'ProductCatalog'
+    field :setup_status, 'string'
+    field :gtm_account_id, 'string'
+    field :gtm_container_id, 'string'
+    field :page_id, 'string'
+
+  end
+end

data/lib/facebook_ads/ad_objects/partner_study.rb

@@ -48,6 +48,10 @@ module FacebookAds
     has_no_post
     has_no_delete
 
+    has_edge :partners do |edge|
+      edge.get 'AdsDataPartner'
+    end
+
     has_edge :submitters do |edge|
       edge.get 'User'
     end

data/lib/facebook_ads/ad_objects/photo.rb

@@ -51,6 +51,26 @@ module FacebookAds
       "uploaded",
     ]
 
+    CHECKIN_ENTRY_POINT = [
+      "BRANDING_CHECKIN",
+      "BRANDING_OTHER",
+      "BRANDING_PHOTO",
+      "BRANDING_STATUS",
+    ]
+
+    FORMATTING = [
+      "MARKDOWN",
+      "PLAINTEXT",
+    ]
+
+    POST_SURFACES_BLACKLIST = [
+      "1",
+      "2",
+      "3",
+      "4",
+      "5",
+    ]
+
 
     field :album, 'Album'
     field :alt_text, 'string'
@@ -79,7 +99,6 @@ module FacebookAds
     field :updated_time, 'datetime'
     field :webp_images, { list: 'PlatformImageSource' }
     field :width, 'int'
-    has_no_post
 
     has_edge :comments do |edge|
       edge.get 'Comment' do |api|
@@ -105,6 +124,15 @@ module FacebookAds
       end
     end
 
+    has_edge :dismisstagsuggestion do |edge|
+      edge.post 'Photo' do |api|
+        api.has_param :closing_action, 'string'
+        api.has_param :closing_source, 'string'
+        api.has_param :facebox, 'int'
+        api.has_param :is_first, 'bool'
+      end
+    end
+
     has_edge :insights do |edge|
       edge.get 'InsightsResult' do |api|
         api.has_param :date_preset, { enum: -> { InsightsResult::DATE_PRESET }}
@@ -116,6 +144,12 @@ module FacebookAds
     end
 
     has_edge :likes do |edge|
+      edge.delete do |api|
+        api.has_param :feedback_source, 'string'
+        api.has_param :nectar_module, 'string'
+        api.has_param :notify, 'bool'
+        api.has_param :tracking, 'string'
+      end
       edge.get 'Profile'
       edge.post 'Photo' do |api|
         api.has_param :feedback_source, 'string'
@@ -125,6 +159,63 @@ module FacebookAds
       end
     end
 
+    has_edge :photos do |edge|
+      edge.post 'Photo' do |api|
+        api.has_param :aid, 'string'
+        api.has_param :allow_spherical_photo, 'bool'
+        api.has_param :alt_text_custom, 'string'
+        api.has_param :android_key_hash, 'string'
+        api.has_param :application_id, 'string'
+        api.has_param :attempt, 'int'
+        api.has_param :audience_exp, 'bool'
+        api.has_param :backdated_time, 'datetime'
+        api.has_param :backdated_time_granularity, { enum: -> { Photo::BACKDATED_TIME_GRANULARITY }}
+        api.has_param :caption, 'string'
+        api.has_param :composer_session_id, 'string'
+        api.has_param :direct_share_status, 'int'
+        api.has_param :feed_targeting, 'object'
+        api.has_param :filter_type, 'int'
+        api.has_param :full_res_is_coming_later, 'bool'
+        api.has_param :initial_view_heading_override_degrees, 'int'
+        api.has_param :initial_view_pitch_override_degrees, 'int'
+        api.has_param :initial_view_vertical_fov_override_degrees, 'int'
+        api.has_param :ios_bundle_id, 'string'
+        api.has_param :is_explicit_location, 'bool'
+        api.has_param :is_explicit_place, 'bool'
+        api.has_param :is_visual_search, 'bool'
+        api.has_param :manual_privacy, 'bool'
+        api.has_param :message, 'string'
+        api.has_param :name, 'string'
+        api.has_param :no_story, 'bool'
+        api.has_param :offline_id, 'int'
+        api.has_param :og_action_type_id, 'string'
+        api.has_param :og_icon_id, 'string'
+        api.has_param :og_object_id, 'string'
+        api.has_param :og_phrase, 'string'
+        api.has_param :og_set_profile_badge, 'bool'
+        api.has_param :og_suggestion_mechanism, 'string'
+        api.has_param :place, 'object'
+        api.has_param :privacy, 'string'
+        api.has_param :profile_id, 'int'
+        api.has_param :proxied_app_id, 'string'
+        api.has_param :published, 'bool'
+        api.has_param :qn, 'string'
+        api.has_param :scheduled_publish_time, 'int'
+        api.has_param :spherical_metadata, 'hash'
+        api.has_param :sponsor_id, 'string'
+        api.has_param :sponsor_relationship, 'int'
+        api.has_param :tags, { list: 'object' }
+        api.has_param :target_id, 'int'
+        api.has_param :targeting, 'object'
+        api.has_param :time_since_original_post, 'int'
+        api.has_param :uid, 'int'
+        api.has_param :unpublished_content_type, { enum: -> { Photo::UNPUBLISHED_CONTENT_TYPE }}
+        api.has_param :url, 'string'
+        api.has_param :user_selected_tags, 'bool'
+        api.has_param :vault_image_id, 'string'
+      end
+    end
+
     has_edge :reactions do |edge|
       edge.get 'Profile' do |api|
         api.has_param :type, { enum: -> { Profile::TYPE }}
@@ -141,6 +232,14 @@ module FacebookAds
 
     has_edge :tags do |edge|
       edge.get 'TaggableSubject'
+      edge.post 'Photo' do |api|
+        api.has_param :owner_uid, 'int'
+        api.has_param :tag_text, 'string'
+        api.has_param :tag_uid, 'int'
+        api.has_param :tags, { list: 'object' }
+        api.has_param :x, 'double'
+        api.has_param :y, 'double'
+      end
     end
 
   end