facebookbusiness 0.7.0.3 → 0.10.0.0

data/lib/facebook_ads/ad_objects/page_commerce_eligibility.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 PageCommerceEligibility < AdObject
+
+    field :offsite, 'object'
+    field :onsite, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/page_post.rb

@@ -62,19 +62,15 @@ module FacebookAds
     field :comments_mirroring_domain, 'string'
     field :coordinates, 'object'
     field :created_time, 'datetime'
-    field :delivery_growth_optimizations, { list: 'string' }
-    field :entities, 'object'
     field :event, 'Event'
     field :expanded_height, 'int'
     field :expanded_width, 'int'
     field :feed_targeting, 'object'
-    field :formatting, 'string'
     field :from, 'object'
     field :full_picture, 'string'
     field :height, 'int'
     field :icon, 'string'
     field :id, 'string'
-    field :implicit_place, 'Place'
     field :instagram_eligibility, 'string'
     field :is_app_share, 'bool'
     field :is_eligible_for_promotion, 'bool'
@@ -85,7 +81,6 @@ module FacebookAds
     field :is_popular, 'bool'
     field :is_published, 'bool'
     field :is_spherical, 'bool'
-    field :live_video_eligibility, { list: 'string' }
     field :message, 'string'
     field :message_tags, { list: 'string' }
     field :multi_share_end_card, 'bool'
@@ -98,7 +93,6 @@ module FacebookAds
     field :promotable_id, 'string'
     field :promotion_status, 'string'
     field :properties, { list: 'string' }
-    field :publishing_stats, 'int'
     field :scheduled_publish_time, 'double'
     field :shares, 'object'
     field :status_type, 'string'
@@ -108,12 +102,10 @@ module FacebookAds
     field :target, 'Profile'
     field :targeting, 'object'
     field :timeline_visibility, 'string'
-    field :translations, 'hash'
     field :updated_time, 'datetime'
     field :via, 'object'
     field :video_buying_eligibility, { list: 'string' }
     field :width, 'int'
-    field :will_be_autocropped_when_deliver_to_instagram, 'bool'
 
     has_edge :attachments do |edge|
       edge.get

data/lib/facebook_ads/ad_objects/{user_taggable_friend.rb → payment_engine_payment.rb}

@@ -25,24 +25,47 @@ module FacebookAds
   # on github and we'll fix in our codegen framework. We'll not be able to accept
   # pull request for this class.
 
-  class UserTaggableFriend < AdObject
+  class PaymentEnginePayment < AdObject
+    REASON = [
+      "BANNED_USER",
+      "DENIED_REFUND",
+      "GRANTED_REPLACEMENT_ITEM",
+    ]
 
-    field :first_name, 'string'
+
+    field :actions, { list: 'object' }
+    field :application, 'Application'
+    field :country, 'string'
+    field :created_time, 'datetime'
+    field :disputes, { list: 'object' }
+    field :fraud_status, 'string'
+    field :fulfillment_status, 'string'
     field :id, 'string'
-    field :last_name, 'string'
-    field :middle_name, 'string'
-    field :name, 'string'
-    has_no_get
+    field :is_from_ad, 'bool'
+    field :is_from_page_post, 'bool'
+    field :items, { list: 'object' }
+    field :payout_foreign_exchange_rate, 'double'
+    field :phone_support_eligible, 'bool'
+    field :refundable_amount, 'CurrencyAmount'
+    field :request_id, 'string'
+    field :tax, 'string'
+    field :tax_country, 'string'
+    field :test, 'int'
+    field :user, 'User'
     has_no_post
     has_no_delete
 
-    has_edge :picture do |edge|
-      edge.get 'ProfilePictureSource' do |api|
-        api.has_param :breaking_change, { enum: -> { ProfilePictureSource::BREAKING_CHANGE }}
-        api.has_param :height, 'int'
-        api.has_param :redirect, 'bool'
-        api.has_param :type, { enum: -> { ProfilePictureSource::TYPE }}
-        api.has_param :width, 'int'
+    has_edge :dispute do |edge|
+      edge.post 'PaymentEnginePayment' do |api|
+        api.has_param :reason, { enum: -> { PaymentEnginePayment::REASON }}
+      end
+    end
+
+    has_edge :refunds do |edge|
+      edge.post 'PaymentEnginePayment' do |api|
+        api.has_param :amount, 'double'
+        api.has_param :currency, 'string'
+        api.has_param :reason, { enum: -> { PaymentEnginePayment::REASON }}
       end
     end
 

data/lib/facebook_ads/ad_objects/payment_subscription.rb

@@ -29,13 +29,13 @@ module FacebookAds
 
     field :amount, 'string'
     field :app_param_data, 'string'
-    field :application, 'Profile'
+    field :application, 'Application'
     field :billing_period, 'string'
     field :canceled_reason, 'string'
     field :created_time, 'datetime'
     field :currency, 'string'
     field :id, 'string'
-    field :last_payment, 'string'
+    field :last_payment, 'PaymentEnginePayment'
     field :next_bill_time, 'datetime'
     field :next_period_amount, 'string'
     field :next_period_currency, 'string'
@@ -50,7 +50,7 @@ module FacebookAds
     field :trial_currency, 'string'
     field :trial_expiry_time, 'datetime'
     field :updated_time, 'datetime'
-    field :user, 'Profile'
+    field :user, 'User'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/photo.rb

@@ -125,10 +125,6 @@ module FacebookAds
       end
     end
 
-    has_edge :sharedposts do |edge|
-      edge.get 'Post'
-    end
-
     has_edge :sponsor_tags do |edge|
       edge.get 'Page'
     end

data/lib/facebook_ads/ad_objects/playable_content.rb

@@ -31,6 +31,7 @@ module FacebookAds
     field :name, 'string'
     field :owner, 'Profile'
     field :app_id, 'string'
+    field :session_id, 'string'
     field :source, 'file'
     field :source_url, 'string'
     field :source_zip, 'file'

data/lib/facebook_ads/ad_objects/post.rb

@@ -35,6 +35,51 @@ module FacebookAds
       "year",
     ]
 
+    CHECKIN_ENTRY_POINT = [
+      "BRANDING_CHECKIN",
+      "BRANDING_OTHER",
+      "BRANDING_PHOTO",
+      "BRANDING_STATUS",
+    ]
+
+    FORMATTING = [
+      "MARKDOWN",
+      "PLAINTEXT",
+    ]
+
+    PLACE_ATTACHMENT_SETTING = [
+      "1",
+      "2",
+    ]
+
+    POST_SURFACES_BLACKLIST = [
+      "1",
+      "2",
+      "3",
+      "4",
+      "5",
+    ]
+
+    POSTING_TO_REDSPACE = [
+      "disabled",
+      "enabled",
+    ]
+
+    TARGET_SURFACE = [
+      "STORY",
+      "TIMELINE",
+    ]
+
+    UNPUBLISHED_CONTENT_TYPE = [
+      "ADS_POST",
+      "DRAFT",
+      "INLINE_CREATED",
+      "PUBLISHED",
+      "REVIEWABLE_BRANDED_CONTENT",
+      "SCHEDULED",
+      "SCHEDULED_RECURRING",
+    ]
+
     FEED_STORY_VISIBILITY = [
       "hidden",
       "visible",
@@ -59,20 +104,16 @@ module FacebookAds
     field :comments_mirroring_domain, 'string'
     field :coordinates, 'object'
     field :created_time, 'datetime'
-    field :delivery_growth_optimizations, { list: 'string' }
     field :description, 'string'
-    field :entities, 'object'
     field :event, 'Event'
     field :expanded_height, 'int'
     field :expanded_width, 'int'
     field :feed_targeting, 'object'
-    field :formatting, 'string'
     field :from, 'object'
     field :full_picture, 'string'
     field :height, 'int'
     field :icon, 'string'
     field :id, 'string'
-    field :implicit_place, 'Place'
     field :instagram_eligibility, 'string'
     field :is_app_share, 'bool'
     field :is_eligible_for_promotion, 'bool'
@@ -83,8 +124,7 @@ module FacebookAds
     field :is_popular, 'bool'
     field :is_published, 'bool'
     field :is_spherical, 'bool'
-    field :link, 'string'
-    field :live_video_eligibility, { list: 'string' }
+    field :link, 'object'
     field :message, 'string'
     field :message_tags, { list: 'string' }
     field :multi_share_end_card, 'bool'
@@ -99,7 +139,6 @@ module FacebookAds
     field :promotable_id, 'string'
     field :promotion_status, 'string'
     field :properties, { list: 'string' }
-    field :publishing_stats, 'int'
     field :scheduled_publish_time, 'double'
     field :shares, 'object'
     field :source, 'string'
@@ -110,13 +149,11 @@ module FacebookAds
     field :target, 'Profile'
     field :targeting, 'object'
     field :timeline_visibility, 'string'
-    field :translations, 'hash'
     field :type, 'string'
     field :updated_time, 'datetime'
     field :via, 'object'
     field :video_buying_eligibility, { list: 'string' }
     field :width, 'int'
-    field :will_be_autocropped_when_deliver_to_instagram, 'bool'
 
     has_edge :attachments do |edge|
       edge.get
@@ -170,24 +207,6 @@ module FacebookAds
       end
     end
 
-    has_edge :promotions do |edge|
-      edge.post do |api|
-        api.has_param :ad_account_id, 'string'
-        api.has_param :ad_conversion_pixel_id, 'int'
-        api.has_param :audience, { enum: %w{AUTO_LOOKALIKE AUTO_PAGE_LOOKALIKE AUTO_TARGETING COUNTRY_AND_INTEREST CREATE_NEW CUSTOM_AUDIENCE DISTRICT EVENT_CUSTOM_AUDIENCES EVENT_ENGAGEMENT FANS GROUPER HEC_AUDIENCE IG_PROMOTED_POST_AUTO LOCAL LOOKALIKE MARKETPLACE_DEFAULT MULT_CUSTOM_AUDIENCES NCPP SAVED_AUDIENCE SMART_AUDIENCE }}
-        api.has_param :audience_id, 'string'
-        api.has_param :bid_amount, 'int'
-        api.has_param :budget, 'int'
-        api.has_param :cta_type, { enum: %w{ADD_TO_CART APPLY_NOW BOOK_TRAVEL BUY BUY_NOW BUY_TICKETS CALL CALL_ME CONTACT CONTACT_US DONATE DONATE_NOW DOWNLOAD EVENT_RSVP FIND_A_GROUP FIND_YOUR_GROUPS FOLLOW_NEWS_STORYLINE FOLLOW_PAGE FOLLOW_USER GET_DIRECTIONS GET_OFFER GET_OFFER_VIEW GET_QUOTE GET_SHOWTIMES INSTALL_APP INSTALL_MOBILE_APP LEARN_MORE LIKE_PAGE LISTEN_MUSIC LISTEN_NOW MESSAGE_PAGE MOBILE_DOWNLOAD MOMENTS NO_BUTTON OPEN_LINK ORDER_NOW PAY_TO_ACCESS PLAY_GAME PURCHASE_GIFT_CARDS RECORD_NOW REQUEST_TIME SAY_THANKS SEE_MORE SELL_NOW SEND_A_GIFT SHARE SHOP_NOW SIGN_UP SOTTO_SUBSCRIBE SUBSCRIBE UPDATE_APP USE_APP USE_MOBILE_APP VIDEO_ANNOTATION VISIT_PAGES_FEED WATCH_MORE WATCH_VIDEO WHATSAPP_MESSAGE WOODHENGE_SUPPORT }}
-        api.has_param :currency, 'string'
-        api.has_param :flow_id, 'string'
-        api.has_param :placement, 'string'
-        api.has_param :start_time, 'int'
-        api.has_param :stop_time, 'int'
-        api.has_param :targeting, 'Targeting'
-      end
-    end
-
     has_edge :reactions do |edge|
       edge.get 'Profile' do |api|
         api.has_param :type, { enum: -> { Profile::TYPE }}

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -35,6 +35,7 @@ module FacebookAds
       "home_listings",
       "hotels",
       "jobs",
+      "local_delivery_shipping_profiles",
       "local_service_businesses",
       "offer_items",
       "offline_commerce",
@@ -51,17 +52,48 @@ module FacebookAds
     PERMITTED_TASKS = [
       "ADVERTISE",
       "MANAGE",
+      "MANAGE_AR",
     ]
 
     TASKS = [
       "ADVERTISE",
       "MANAGE",
+      "MANAGE_AR",
     ]
 
     STANDARD = [
       "google",
     ]
 
+    ITEM_SUB_TYPE = [
+      "APPLIANCES",
+      "BABY_FEEDING",
+      "BABY_TRANSPORT",
+      "BEAUTY",
+      "BEDDING",
+      "CAMERAS",
+      "CELL_PHONES_AND_SMART_WATCHES",
+      "CLEANING_SUPPLIES",
+      "CLOTHING",
+      "CLOTHING_ACCESSORIES",
+      "COMPUTERS_AND_TABLETS",
+      "DIAPERING_AND_POTTY_TRAINING",
+      "ELECTRONICS_ACCESSORIES",
+      "FURNITURE",
+      "HEALTH",
+      "HOME_GOODS",
+      "JEWELRY",
+      "NURSERY",
+      "PRINTERS_AND_SCANNERS",
+      "PROJECTORS",
+      "SHOES_AND_FOOTWEAR",
+      "SOFTWARE",
+      "TOYS",
+      "TVS_AND_MONITORS",
+      "VIDEO_GAME_CONSOLES_AND_VIDEO_GAMES",
+      "WATCHES",
+    ]
+
 
     field :business, 'Business'
     field :commerce_merchant_settings, 'CommerceMerchantSettings'
@@ -75,9 +107,11 @@ module FacebookAds
     field :product_count, 'int'
     field :store_catalog_settings, 'StoreCatalogSettings'
     field :vertical, 'string'
+    field :catalog_segment_filter, 'object'
+    field :catalog_segment_product_set_id, 'string'
     field :destination_catalog_settings, 'hash'
     field :flight_catalog_settings, 'hash'
-    field :onsite_commerce_merchant, 'object'
+    field :parent_catalog_id, 'string'
 
     has_edge :agencies do |edge|
       edge.delete do |api|
@@ -88,6 +122,7 @@ module FacebookAds
         api.has_param :business, 'string'
         api.has_param :permitted_roles, { list: { enum: -> { ProductCatalog::PERMITTED_ROLES }} }
         api.has_param :permitted_tasks, { list: { enum: -> { ProductCatalog::PERMITTED_TASKS }} }
+        api.has_param :utm_settings, 'hash'
       end
     end
 
@@ -109,6 +144,19 @@ module FacebookAds
         api.has_param :bulk_pagination, 'bool'
         api.has_param :filter, 'object'
       end
+      edge.post 'AutomotiveModel' do |api|
+        api.has_param :automotive_model_id, 'string'
+        api.has_param :body_style, { enum: -> { AutomotiveModel::BODY_STYLE }}
+        api.has_param :currency, 'string'
+        api.has_param :description, 'string'
+        api.has_param :images, { list: 'object' }
+        api.has_param :make, 'string'
+        api.has_param :model, 'string'
+        api.has_param :price, 'int'
+        api.has_param :title, 'string'
+        api.has_param :url, 'string'
+        api.has_param :year, 'int'
+      end
     end
 
     has_edge :batch do |edge|
@@ -233,17 +281,12 @@ module FacebookAds
     has_edge :items_batch do |edge|
       edge.post 'ProductCatalog' do |api|
         api.has_param :allow_upsert, 'bool'
+        api.has_param :item_sub_type, { enum: -> { ProductCatalog::ITEM_SUB_TYPE }}
         api.has_param :item_type, 'string'
         api.has_param :requests, 'hash'
       end
     end
 
-    has_edge :onsite_commerce_merchant do |edge|
-      edge.post 'ProductCatalog' do |api|
-        api.has_param :onsite_commerce_merchant, 'object'
-      end
-    end
-
     has_edge :pricing_variables_batch do |edge|
       edge.get 'ProductCatalogPricingVariablesBatch' do |api|
         api.has_param :handle, 'string'
@@ -268,14 +311,16 @@ module FacebookAds
         api.has_param :encoding, { enum: -> { ProductFeed::ENCODING }}
         api.has_param :feed_type, { enum: -> { ProductFeed::FEED_TYPE }}
         api.has_param :file_name, 'string'
+        api.has_param :item_sub_type, { enum: -> { ProductFeed::ITEM_SUB_TYPE }}
+        api.has_param :migrated_from_feed_id, 'string'
         api.has_param :name, 'string'
         api.has_param :override_type, { enum: -> { ProductFeed::OVERRIDE_TYPE }}
         api.has_param :override_value, 'string'
         api.has_param :quoted_fields_mode, { enum: -> { ProductFeed::QUOTED_FIELDS_MODE }}
         api.has_param :rules, { list: 'string' }
         api.has_param :schedule, 'string'
+        api.has_param :selected_override_fields, { list: 'string' }
         api.has_param :update_schedule, 'string'
-        api.has_param :whitelisted_properties, { list: 'string' }
       end
     end
 
@@ -298,6 +343,7 @@ module FacebookAds
         api.has_param :filter, 'object'
         api.has_param :metadata, 'hash'
         api.has_param :name, 'string'
+        api.has_param :retailer_id, 'string'
       end
     end
 
@@ -314,8 +360,8 @@ module FacebookAds
         api.has_param :return_only_approved_products, 'bool'
       end
       edge.post 'ProductItem' do |api|
-        api.has_param :additional_image_files, { list: 'file' }
         api.has_param :additional_image_urls, { list: 'string' }
+        api.has_param :additional_uploaded_image_ids, { list: 'string' }
         api.has_param :additional_variant_attributes, 'hash'
         api.has_param :android_app_name, 'string'
         api.has_param :android_class, 'string'
@@ -324,6 +370,7 @@ module FacebookAds
         api.has_param :availability, { enum: -> { ProductItem::AVAILABILITY }}
         api.has_param :brand, 'string'
         api.has_param :category, 'string'
+        api.has_param :category_specific_fields, 'hash'
         api.has_param :checkout_url, 'string'
         api.has_param :color, 'string'
         api.has_param :commerce_tax_category, { enum: -> { ProductItem::COMMERCE_TAX_CATEGORY }}
@@ -337,6 +384,7 @@ module FacebookAds
         api.has_param :custom_label_4, 'string'
         api.has_param :description, 'string'
         api.has_param :expiration_date, 'string'
+        api.has_param :fb_product_category, 'string'
         api.has_param :gender, { enum: -> { ProductItem::GENDER }}
         api.has_param :gtin, 'string'
         api.has_param :image_url, 'string'