facebookbusiness 0.10.0.0 → 0.12.0.1

data/lib/facebook_ads/ad_objects/delivery_window.rb

@@ -0,0 +1,287 @@
+# 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 DeliveryWindow < AdObject
+
+    field :ad, 'int'
+    field :ae, 'int'
+    field :af, 'int'
+    field :ag, 'int'
+    field :ai, 'int'
+    field :al, 'int'
+    field :all, 'int'
+    field :am, 'int'
+    field :an, 'int'
+    field :ao, 'int'
+    field :aq, 'int'
+    field :ar, 'int'
+    field :as, 'int'
+    field :at, 'int'
+    field :au, 'int'
+    field :aw, 'int'
+    field :ax, 'int'
+    field :az, 'int'
+    field :ba, 'int'
+    field :bb, 'int'
+    field :bd, 'int'
+    field :be, 'int'
+    field :bf, 'int'
+    field :bg, 'int'
+    field :bh, 'int'
+    field :bi, 'int'
+    field :bj, 'int'
+    field :bl, 'int'
+    field :bm, 'int'
+    field :bn, 'int'
+    field :bo, 'int'
+    field :bq, 'int'
+    field :br, 'int'
+    field :bs, 'int'
+    field :bt, 'int'
+    field :bv, 'int'
+    field :bw, 'int'
+    field :by, 'int'
+    field :bz, 'int'
+    field :ca, 'int'
+    field :cc, 'int'
+    field :cd, 'int'
+    field :cf, 'int'
+    field :cg, 'int'
+    field :ch, 'int'
+    field :ci, 'int'
+    field :ck, 'int'
+    field :cl, 'int'
+    field :cm, 'int'
+    field :cn, 'int'
+    field :co, 'int'
+    field :cr, 'int'
+    field :cu, 'int'
+    field :cv, 'int'
+    field :cw, 'int'
+    field :cx, 'int'
+    field :cy, 'int'
+    field :cz, 'int'
+    field :de, 'int'
+    field :dj, 'int'
+    field :dk, 'int'
+    field :dm, 'int'
+    field :_do, 'int'
+    field :dz, 'int'
+    field :ec, 'int'
+    field :ee, 'int'
+    field :eg, 'int'
+    field :eh, 'int'
+    field :er, 'int'
+    field :es, 'int'
+    field :et, 'int'
+    field :fi, 'int'
+    field :fj, 'int'
+    field :fk, 'int'
+    field :fm, 'int'
+    field :fo, 'int'
+    field :fr, 'int'
+    field :ga, 'int'
+    field :gb, 'int'
+    field :gd, 'int'
+    field :ge, 'int'
+    field :gf, 'int'
+    field :gg, 'int'
+    field :gh, 'int'
+    field :gi, 'int'
+    field :gl, 'int'
+    field :gm, 'int'
+    field :gn, 'int'
+    field :gp, 'int'
+    field :gq, 'int'
+    field :gr, 'int'
+    field :gs, 'int'
+    field :gt, 'int'
+    field :gu, 'int'
+    field :gw, 'int'
+    field :gy, 'int'
+    field :hk, 'int'
+    field :hm, 'int'
+    field :hn, 'int'
+    field :hr, 'int'
+    field :ht, 'int'
+    field :hu, 'int'
+    field :id, 'int'
+    field :ie, 'int'
+    field :il, 'int'
+    field :im, 'int'
+    field :in, 'int'
+    field :io, 'int'
+    field :iq, 'int'
+    field :ir, 'int'
+    field :is, 'int'
+    field :it, 'int'
+    field :je, 'int'
+    field :jm, 'int'
+    field :jo, 'int'
+    field :jp, 'int'
+    field :ke, 'int'
+    field :kg, 'int'
+    field :kh, 'int'
+    field :ki, 'int'
+    field :km, 'int'
+    field :kn, 'int'
+    field :kp, 'int'
+    field :kr, 'int'
+    field :kw, 'int'
+    field :ky, 'int'
+    field :kz, 'int'
+    field :la, 'int'
+    field :lb, 'int'
+    field :lc, 'int'
+    field :li, 'int'
+    field :lk, 'int'
+    field :lr, 'int'
+    field :ls, 'int'
+    field :lt, 'int'
+    field :lu, 'int'
+    field :lv, 'int'
+    field :ly, 'int'
+    field :ma, 'int'
+    field :mc, 'int'
+    field :md, 'int'
+    field :me, 'int'
+    field :mf, 'int'
+    field :mg, 'int'
+    field :mh, 'int'
+    field :mk, 'int'
+    field :ml, 'int'
+    field :mm, 'int'
+    field :mn, 'int'
+    field :mo, 'int'
+    field :mp, 'int'
+    field :mq, 'int'
+    field :mr, 'int'
+    field :ms, 'int'
+    field :mt, 'int'
+    field :mu, 'int'
+    field :mv, 'int'
+    field :mw, 'int'
+    field :mx, 'int'
+    field :my, 'int'
+    field :mz, 'int'
+    field :na, 'int'
+    field :nc, 'int'
+    field :ne, 'int'
+    field :nf, 'int'
+    field :ng, 'int'
+    field :ni, 'int'
+    field :nl, 'int'
+    field :no, 'int'
+    field :np, 'int'
+    field :nr, 'int'
+    field :nu, 'int'
+    field :nz, 'int'
+    field :om, 'int'
+    field :pa, 'int'
+    field :pe, 'int'
+    field :pf, 'int'
+    field :pg, 'int'
+    field :ph, 'int'
+    field :pk, 'int'
+    field :pl, 'int'
+    field :pm, 'int'
+    field :pn, 'int'
+    field :pr, 'int'
+    field :ps, 'int'
+    field :pt, 'int'
+    field :pw, 'int'
+    field :py, 'int'
+    field :qa, 'int'
+    field :re, 'int'
+    field :ro, 'int'
+    field :rs, 'int'
+    field :ru, 'int'
+    field :rw, 'int'
+    field :sa, 'int'
+    field :sb, 'int'
+    field :sc, 'int'
+    field :sd, 'int'
+    field :se, 'int'
+    field :sg, 'int'
+    field :sh, 'int'
+    field :si, 'int'
+    field :sj, 'int'
+    field :sk, 'int'
+    field :sl, 'int'
+    field :sm, 'int'
+    field :sn, 'int'
+    field :so, 'int'
+    field :sr, 'int'
+    field :ss, 'int'
+    field :st, 'int'
+    field :sv, 'int'
+    field :sx, 'int'
+    field :sy, 'int'
+    field :sz, 'int'
+    field :tc, 'int'
+    field :td, 'int'
+    field :tf, 'int'
+    field :tg, 'int'
+    field :th, 'int'
+    field :tj, 'int'
+    field :tk, 'int'
+    field :tl, 'int'
+    field :tm, 'int'
+    field :tn, 'int'
+    field :to, 'int'
+    field :tr, 'int'
+    field :tt, 'int'
+    field :tv, 'int'
+    field :tw, 'int'
+    field :tz, 'int'
+    field :ua, 'int'
+    field :ug, 'int'
+    field :um, 'int'
+    field :us, 'int'
+    field :uy, 'int'
+    field :uz, 'int'
+    field :va, 'int'
+    field :vc, 'int'
+    field :ve, 'int'
+    field :vg, 'int'
+    field :vi, 'int'
+    field :vn, 'int'
+    field :vu, 'int'
+    field :wf, 'int'
+    field :ws, 'int'
+    field :xk, 'int'
+    field :ye, 'int'
+    field :yt, 'int'
+    field :za, 'int'
+    field :zm, 'int'
+    field :zw, 'int'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/destination.rb

@@ -26,6 +26,15 @@ module FacebookAds
   # pull request for this class.
 
   class Destination < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
 
     field :address, 'string'
     field :applinks, 'CatalogItemAppLinks'
@@ -34,15 +43,29 @@ module FacebookAds
     field :description, 'string'
     field :destination_id, 'string'
     field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
     field :images, { list: 'string' }
     field :name, 'string'
     field :price, 'string'
     field :price_change, 'string'
     field :sanitized_images, { list: 'string' }
     field :types, { list: 'string' }
+    field :unit_price, 'object'
     field :url, 'string'
     has_no_post
     has_no_delete
 
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/event.rb

@@ -68,6 +68,7 @@ module FacebookAds
       "group",
       "private",
       "public",
+      "work_company",
     ]
 
     EVENT_STATE_FILTER = [
@@ -87,6 +88,7 @@ module FacebookAds
     field :can_guests_invite, 'bool'
     field :category, { enum: -> { CATEGORY }}
     field :cover, 'CoverPhoto'
+    field :created_time, 'datetime'
     field :declined_count, 'int'
     field :description, 'string'
     field :discount_code_enabled, 'bool'
@@ -109,6 +111,7 @@ module FacebookAds
     field :place, 'Place'
     field :scheduled_publish_time, 'string'
     field :start_time, 'string'
+    field :ticket_setting, 'object'
     field :ticket_uri, 'string'
     field :ticket_uri_start_sales_time, 'string'
     field :ticketing_privacy_uri, 'string'
@@ -129,7 +132,10 @@ module FacebookAds
 
     has_edge :live_videos do |edge|
       edge.get 'NullNode'
-      edge.post 'LiveVideo' do |api|
+    end
+
+    has_edge :livevideos do |edge|
+      edge.post do |api|
         api.has_param :content_tags, { list: 'string' }
         api.has_param :description, 'string'
         api.has_param :enable_backup_ingest, 'bool'
@@ -140,16 +146,15 @@ module FacebookAds
         api.has_param :is_spherical, 'bool'
         api.has_param :live_encoders, { list: 'string' }
         api.has_param :original_fov, 'int'
-        api.has_param :planned_start_time, 'int'
         api.has_param :privacy, 'string'
-        api.has_param :projection, { enum: -> { LiveVideo::PROJECTION }}
+        api.has_param :projection, { enum: %w{CUBEMAP EQUIRECTANGULAR HALF_EQUIRECTANGULAR }}
         api.has_param :published, 'bool'
         api.has_param :schedule_custom_profile_image, 'file'
-        api.has_param :spatial_audio_format, { enum: -> { LiveVideo::SPATIAL_AUDIO_FORMAT }}
-        api.has_param :status, { enum: -> { LiveVideo::STATUS }}
-        api.has_param :stereoscopic_mode, { enum: -> { LiveVideo::STEREOSCOPIC_MODE }}
+        api.has_param :spatial_audio_format, { enum: %w{ambiX_4 }}
+        api.has_param :status, { enum: %w{LIVE_NOW SCHEDULED_CANCELED SCHEDULED_LIVE SCHEDULED_UNPUBLISHED UNPUBLISHED }}
+        api.has_param :stereoscopic_mode, { enum: %w{LEFT_RIGHT MONO TOP_BOTTOM }}
         api.has_param :stop_on_delete_stream, 'bool'
-        api.has_param :stream_type, { enum: -> { LiveVideo::STREAM_TYPE }}
+        api.has_param :stream_type, { enum: %w{AMBIENT REGULAR }}
         api.has_param :title, 'string'
       end
     end
@@ -170,6 +175,10 @@ module FacebookAds
       edge.get 'Profile'
     end
 
+    has_edge :ticket_tiers do |edge|
+      edge.get
+    end
+
     has_edge :videos do |edge|
       edge.get 'NullNode'
     end

data/lib/facebook_ads/ad_objects/flight.rb

@@ -26,6 +26,15 @@ module FacebookAds
   # pull request for this class.
 
   class Flight < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
 
     field :applinks, 'CatalogItemAppLinks'
     field :category_specific_fields, 'CatalogSubVerticalList'
@@ -35,6 +44,7 @@ module FacebookAds
     field :destination_city, 'string'
     field :flight_id, 'string'
     field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
     field :images, { list: 'string' }
     field :oneway_currency, 'string'
     field :oneway_price, 'string'
@@ -42,8 +52,21 @@ module FacebookAds
     field :origin_city, 'string'
     field :price, 'string'
     field :sanitized_images, { list: 'string' }
+    field :unit_price, 'object'
     field :url, 'string'
     has_no_delete
 
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/group.rb

@@ -49,6 +49,7 @@ module FacebookAds
       "EPHEMERAL",
       "EVENT_PLANNING",
       "FAMILY",
+      "FANTASY_LEAGUE",
       "FITNESS",
       "FOR_SALE",
       "FOR_WORK",
@@ -105,6 +106,7 @@ module FacebookAds
       "EPHEMERAL",
       "EVENT_PLANNING",
       "FAMILY",
+      "FANTASY_LEAGUE",
       "FITNESS",
       "FOR_SALE",
       "FOR_WORK",
@@ -367,7 +369,6 @@ module FacebookAds
         api.has_param :is_spherical, 'bool'
         api.has_param :live_encoders, { list: 'string' }
         api.has_param :original_fov, 'int'
-        api.has_param :planned_start_time, 'int'
         api.has_param :privacy, 'string'
         api.has_param :projection, { enum: -> { LiveVideo::PROJECTION }}
         api.has_param :published, 'bool'
@@ -466,6 +467,13 @@ module FacebookAds
       end
     end
 
+    has_edge :shift_settings do |edge|
+      edge.post do |api|
+        api.has_param :external_id, 'string'
+        api.has_param :shift_feature_setting, { enum: %w{ALL_FEATURES_OFF ALL_FEATURES_ON SHIFT_COVER_ONLY_ON SHIFT_VIEWER_ONLY_ON }}
+      end
+    end
+
     has_edge :videos do |edge|
       edge.get 'AdVideo' do |api|
         api.has_param :type, { enum: -> { AdVideo::TYPE }}
@@ -520,6 +528,7 @@ module FacebookAds
         api.has_param :original_fov, 'int'
         api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
         api.has_param :publish_event_id, 'int'
+        api.has_param :published, 'bool'
         api.has_param :react_mode_metadata, 'string'
         api.has_param :referenced_sticker_id, 'string'
         api.has_param :replace_video_id, 'string'

data/lib/facebook_ads/ad_objects/home_listing.rb

@@ -26,6 +26,15 @@ module FacebookAds
   # pull request for this class.
 
   class HomeListing < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
 
     field :ac_type, 'string'
     field :additional_fees_description, 'string'
@@ -50,6 +59,7 @@ module FacebookAds
     field :heating_type, 'string'
     field :home_listing_id, 'string'
     field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
     field :images, { list: 'string' }
     field :laundry_type, 'string'
     field :listing_type, 'string'
@@ -68,8 +78,21 @@ module FacebookAds
     field :price, 'string'
     field :property_type, 'string'
     field :sanitized_images, { list: 'string' }
+    field :unit_price, 'object'
     field :url, 'string'
     field :year_built, 'int'
 
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/hotel.rb

@@ -26,6 +26,15 @@ module FacebookAds
   # pull request for this class.
 
   class Hotel < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
 
     field :address, 'string'
     field :applinks, 'CatalogItemAppLinks'
@@ -37,6 +46,7 @@ module FacebookAds
     field :guest_ratings, 'string'
     field :hotel_id, 'string'
     field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
     field :images, { list: 'string' }
     field :lowest_base_price, 'string'
     field :loyalty_program, 'string'
@@ -46,12 +56,25 @@ module FacebookAds
     field :sale_price, 'string'
     field :sanitized_images, { list: 'string' }
     field :star_rating, 'double'
+    field :unit_price, 'object'
     field :url, 'string'
     field :base_price, 'int'
 
+    has_edge :augmented_realities_metadata do |edge|
+      edge.get
+    end
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
     has_edge :hotel_rooms do |edge|
       edge.get 'HotelRoom'
     end
 
+    has_edge :videos_metadata do |edge|
+      edge.get
+    end
+
   end
 end

data/lib/facebook_ads/ad_objects/ig_comment.rb

@@ -27,10 +27,12 @@ module FacebookAds
 
   class IgComment < AdObject
 
+    field :from, 'object'
     field :hidden, 'bool'
     field :id, 'string'
     field :like_count, 'int'
     field :media, 'IgMedia'
+    field :parent_id, 'string'
     field :text, 'string'
     field :timestamp, 'datetime'
     field :user, 'IgUser'

data/lib/facebook_ads/ad_objects/ig_media.rb

@@ -33,6 +33,7 @@ module FacebookAds
     field :ig_id, 'string'
     field :is_comment_enabled, 'bool'
     field :like_count, 'int'
+    field :media_product_type, 'string'
     field :media_type, 'string'
     field :media_url, 'string'
     field :owner, 'IgUser'
@@ -41,6 +42,7 @@ module FacebookAds
     field :thumbnail_url, 'string'
     field :timestamp, 'datetime'
     field :username, 'string'
+    field :video_title, 'string'
     has_no_delete
 
     has_edge :children do |edge|

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -60,7 +60,10 @@ module FacebookAds
     end
 
     has_edge :media do |edge|
-      edge.get 'IgMedia'
+      edge.get 'IgMedia' do |api|
+        api.has_param :since, 'datetime'
+        api.has_param :until, 'datetime'
+      end
       edge.post 'IgMedia' do |api|
         api.has_param :caption, 'string'
         api.has_param :image_url, 'string'

data/lib/facebook_ads/ad_objects/invoice_campaign.rb

@@ -33,6 +33,7 @@ module FacebookAds
     field :campaign_name, 'string'
     field :clicks, 'int'
     field :conversions, 'int'
+    field :description, 'string'
     field :impressions, 'int'
     field :tags, { list: 'string' }
     has_no_id