facebookbusiness 0.7.0.0 → 0.7.0.1

data/lib/facebook_ads/ad_objects/commerce_order.rb

@@ -0,0 +1,147 @@
+# 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 CommerceOrder < AdObject
+    REASON_CODE = [
+      "BUYERS_REMORSE",
+      "DAMAGED_GOODS",
+      "NOT_AS_DESCRIBED",
+      "QUALITY_ISSUE",
+      "REFUND_COMPROMISED",
+      "REFUND_FOR_RETURN",
+      "REFUND_REASON_OTHER",
+      "REFUND_SFI_FAKE",
+      "REFUND_SFI_REAL",
+      "WRONG_ITEM",
+    ]
+
+    FILTERS = [
+      "HAS_CANCELLATIONS",
+      "HAS_FULFILLMENTS",
+      "HAS_REFUNDS",
+      "NO_CANCELLATIONS",
+      "NO_REFUNDS",
+      "NO_SHIPMENTS",
+    ]
+
+    STATE = [
+      "COMPLETED",
+      "CREATED",
+      "FB_PROCESSING",
+      "IN_PROGRESS",
+    ]
+
+
+    field :buyer_details, 'object'
+    field :channel, 'string'
+    field :created, 'string'
+    field :estimated_payment_details, 'object'
+    field :id, 'string'
+    field :is_group_buy, 'bool'
+    field :last_updated, 'string'
+    field :merchant_order_id, 'string'
+    field :order_status, 'object'
+    field :selected_shipping_option, 'object'
+    field :ship_by_date, 'string'
+    field :shipping_address, 'object'
+    has_no_post
+    has_no_delete
+
+    has_edge :acknowledge_order do |edge|
+      edge.post 'CommerceOrder' do |api|
+        api.has_param :idempotency_key, 'string'
+        api.has_param :merchant_order_reference, 'string'
+      end
+    end
+
+    has_edge :cancellations do |edge|
+      edge.get
+      edge.post 'CommerceOrder' do |api|
+        api.has_param :cancel_reason, 'hash'
+        api.has_param :idempotency_key, 'string'
+        api.has_param :items, { list: 'hash' }
+        api.has_param :restock_items, 'bool'
+      end
+    end
+
+    has_edge :items do |edge|
+      edge.get
+    end
+
+    has_edge :payments do |edge|
+      edge.get
+    end
+
+    has_edge :promotions do |edge|
+      edge.get
+    end
+
+    has_edge :refunds do |edge|
+      edge.get
+      edge.post 'CommerceOrder' do |api|
+        api.has_param :deductions, { list: 'hash' }
+        api.has_param :idempotency_key, 'string'
+        api.has_param :items, { list: 'hash' }
+        api.has_param :reason_code, { enum: -> { CommerceOrder::REASON_CODE }}
+        api.has_param :reason_text, 'string'
+        api.has_param :return_id, 'string'
+        api.has_param :shipping, 'hash'
+      end
+    end
+
+    has_edge :returns do |edge|
+      edge.get do |api|
+        api.has_param :merchant_return_id, 'string'
+        api.has_param :statuses, { list: { enum: %w{APPROVED DISAPPROVED MERCHANT_MARKED_COMPLETED REFUNDED REQUESTED }} }
+      end
+    end
+
+    has_edge :shipments do |edge|
+      edge.get
+      edge.post 'CommerceOrder' do |api|
+        api.has_param :external_redemption_link, 'string'
+        api.has_param :external_shipment_id, 'string'
+        api.has_param :fulfillment, 'hash'
+        api.has_param :idempotency_key, 'string'
+        api.has_param :items, { list: 'hash' }
+        api.has_param :merchant_order_reference, 'string'
+        api.has_param :shipment_origin_postal_code, 'string'
+        api.has_param :shipping_tax_details, 'hash'
+        api.has_param :tracking_info, 'hash'
+      end
+    end
+
+    has_edge :update_shipment do |edge|
+      edge.post 'CommerceOrder' do |api|
+        api.has_param :fulfillment_id, 'string'
+        api.has_param :idempotency_key, 'string'
+        api.has_param :tracking_info, 'hash'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/commerce_order_transaction_detail.rb

@@ -0,0 +1,48 @@
+# 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 CommerceOrderTransactionDetail < AdObject
+
+    field :net_payment_amount, 'object'
+    field :order_details, 'CommerceOrder'
+    field :payout_reference_id, 'string'
+    field :processing_fee, 'object'
+    field :tax_rate, 'string'
+    field :transaction_date, 'string'
+    field :transaction_type, 'string'
+    field :transfer_id, 'string'
+    field :id, 'string'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+    has_edge :tax_details do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/{custom_audience_prefill_state.rb → commerce_payout.rb}

@@ -25,11 +25,13 @@ 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 CustomAudiencePrefillState < AdObject
+  class CommercePayout < AdObject
 
-    field :description, 'string'
-    field :num_added, 'int'
+    field :amount, 'object'
+    field :payout_date, 'string'
+    field :payout_reference_id, 'string'
     field :status, 'string'
+    field :transfer_id, 'string'
     has_no_id
     has_no_get
     has_no_post

data/lib/facebook_ads/ad_objects/cpas_parent_catalog_settings.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class CpasParentCatalogSettings < AdObject
     ATTRIBUTION_WINDOWS = [
+      "DDA",
       "DEFAULT",
       "X1D_CLICK",
       "X1D_VIEW",

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -44,6 +44,7 @@ module FacebookAds
       "FLIGHT",
       "HOME_LISTING",
       "HOTEL",
+      "LOCAL_SERVICE_BUSINESS",
       "LOCATION_BASED_ITEM",
       "MEDIA_TITLE",
       "OFFLINE_PRODUCT",
@@ -166,10 +167,6 @@ module FacebookAds
       end
     end
 
-    has_edge :prefills do |edge|
-      edge.get 'CustomAudiencePrefillState'
-    end
-
     has_edge :sessions do |edge|
       edge.get 'CustomAudienceSession' do |api|
         api.has_param :session_id, 'int'

data/lib/facebook_ads/ad_objects/custom_conversion.rb

@@ -35,6 +35,7 @@ module FacebookAds
       "CONTENT_VIEW",
       "CUSTOMIZE_PRODUCT",
       "DONATE",
+      "FACEBOOK_SELECTED",
       "FIND_LOCATION",
       "INITIATED_CHECKOUT",
       "LEAD",

data/lib/facebook_ads/ad_objects/ig_user.rb

@@ -33,6 +33,7 @@ module FacebookAds
     field :follows_count, 'int'
     field :id, 'string'
     field :ig_id, 'int'
+    field :is_ig_shopping_seller_policy_enabled, 'bool'
     field :media_count, 'int'
     field :mentioned_comment, 'IgComment'
     field :mentioned_media, 'IgMedia'

data/lib/facebook_ads/ad_objects/life_event.rb

@@ -55,9 +55,5 @@ module FacebookAds
       edge.get 'Photo'
     end
 
-    has_edge :sharedposts do |edge|
-      edge.get 'Post'
-    end
-
   end
 end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb

@@ -131,12 +131,6 @@ module FacebookAds
       end
     end
 
-    has_edge :users do |edge|
-      edge.post 'OfflineConversionDataSet' do |api|
-        api.has_param :data, { list: 'object' }
-      end
-    end
-
     has_edge :validate do |edge|
       edge.post 'OfflineConversionDataSet' do |api|
         api.has_param :data, { list: 'string' }

data/lib/facebook_ads/ad_objects/page.rb

@@ -292,6 +292,7 @@ module FacebookAds
       "messaging_appointments",
       "messaging_checkout_updates",
       "messaging_direct_sends",
+      "messaging_fblogin_account_linking",
       "messaging_game_plays",
       "messaging_handovers",
       "messaging_optins",
@@ -494,6 +495,13 @@ module FacebookAds
     field :written_by, 'string'
     has_no_delete
 
+    has_edge :acknowledge_orders do |edge|
+      edge.post 'Page' do |api|
+        api.has_param :idempotency_key, 'string'
+        api.has_param :orders, { list: 'hash' }
+      end
+    end
+
     has_edge :ads_posts do |edge|
       edge.get 'PagePost' do |api|
         api.has_param :exclude_dynamic_ads, 'bool'
@@ -596,6 +604,34 @@ module FacebookAds
       end
     end
 
+    has_edge :commerce_merchant_settings do |edge|
+      edge.get 'CommerceMerchantSettings'
+    end
+
+    has_edge :commerce_orders do |edge|
+      edge.get 'CommerceOrder' do |api|
+        api.has_param :filters, { list: { enum: -> { CommerceOrder::FILTERS }} }
+        api.has_param :state, { list: { enum: -> { CommerceOrder::STATE }} }
+        api.has_param :updated_after, 'datetime'
+        api.has_param :updated_before, 'datetime'
+      end
+    end
+
+    has_edge :commerce_payouts do |edge|
+      edge.get 'CommercePayout' do |api|
+        api.has_param :end_time, 'datetime'
+        api.has_param :start_time, 'datetime'
+      end
+    end
+
+    has_edge :commerce_transactions do |edge|
+      edge.get 'CommerceOrderTransactionDetail' do |api|
+        api.has_param :end_time, 'datetime'
+        api.has_param :payout_reference_id, 'string'
+        api.has_param :start_time, 'datetime'
+      end
+    end
+
     has_edge :conversations do |edge|
       edge.get 'UnifiedThread' do |api|
         api.has_param :folder, 'string'
@@ -909,6 +945,7 @@ module FacebookAds
       edge.get 'Page'
       edge.post 'Page' do |api|
         api.has_param :always_open, 'bool'
+        api.has_param :delivery_and_pickup_option_info, { list: 'string' }
         api.has_param :differently_open_offerings, 'hash'
         api.has_param :hours, 'hash'
         api.has_param :ignore_warnings, 'bool'
@@ -1181,18 +1218,6 @@ module FacebookAds
       edge.get 'ProductCatalog'
     end
 
-    has_edge :promotions do |edge|
-      edge.post do |api|
-        api.has_param :ad_account_id, 'string'
-        api.has_param :budget, 'int'
-        api.has_param :duration, 'string'
-        api.has_param :gender, 'int'
-        api.has_param :geo_level, 'string'
-        api.has_param :max_age, 'int'
-        api.has_param :min_age, 'int'
-      end
-    end
-
     has_edge :published_posts do |edge|
       edge.get 'PagePost' do |api|
         api.has_param :since, 'datetime'
@@ -1237,6 +1262,10 @@ module FacebookAds
       end
     end
 
+    has_edge :shop_setup_status do |edge|
+      edge.get 'CommerceMerchantSettingsSetupStatus'
+    end
+
     has_edge :subscribed_apps do |edge|
       edge.delete
       edge.get 'Application'
@@ -1322,10 +1351,6 @@ module FacebookAds
         api.has_param :selected_rule_id, 'string'
         api.has_param :source, { enum: -> { VideoCopyrightRule::SOURCE }}
       end
-      edge.post 'VideoCopyrightRule' do |api|
-        api.has_param :condition_groups, { list: 'object' }
-        api.has_param :name, 'string'
-      end
     end
 
     has_edge :video_copyrights do |edge|

data/lib/facebook_ads/ad_objects/page_call_to_action.rb

@@ -31,6 +31,7 @@ module FacebookAds
       "BECOME_A_VOLUNTEER",
       "EMAIL",
       "FACEBOOK_APP",
+      "FOLLOW",
       "MESSENGER",
       "MINI_SHOP",
       "NONE",
@@ -44,6 +45,7 @@ module FacebookAds
       "BECOME_A_VOLUNTEER",
       "EMAIL",
       "FACEBOOK_APP",
+      "FOLLOW",
       "MESSENGER",
       "MINI_SHOP",
       "NONE",
@@ -62,6 +64,7 @@ module FacebookAds
       "CONTACT_US",
       "DONATE_NOW",
       "EMAIL",
+      "FOLLOW_PAGE",
       "GET_DIRECTIONS",
       "GET_OFFER",
       "GET_OFFER_VIEW",
@@ -71,6 +74,7 @@ module FacebookAds
       "LOCAL_DEV_PLATFORM",
       "MESSAGE",
       "OPEN_APP",
+      "ORDER_FOOD",
       "PLAY_MUSIC",
       "PLAY_NOW",
       "PURCHASE_GIFT_CARDS",
@@ -89,6 +93,7 @@ module FacebookAds
       "BECOME_A_VOLUNTEER",
       "BECOME_SUPPORTER",
       "EMAIL",
+      "FOLLOW",
       "MESSENGER",
       "NONE",
       "SHOP_ON_FACEBOOK",

data/lib/facebook_ads/ad_objects/page_post.rb

@@ -62,15 +62,19 @@ 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'
@@ -81,6 +85,7 @@ 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'
@@ -93,6 +98,7 @@ 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'
@@ -102,10 +108,12 @@ 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