facebookbusiness 0.6.0.3 → 0.7.0.3

data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb

@@ -0,0 +1,107 @@
+# 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 CommerceMerchantSettings < AdObject
+    MERCHANT_STATUS = [
+      "ENABLED",
+      "EXTERNALLY_DISABLED",
+    ]
+
+
+    field :braintree_merchant_id, 'string'
+    field :checkout_message, 'string'
+    field :contact_email, 'string'
+    field :disable_checkout_urls, 'bool'
+    field :display_name, 'string'
+    field :facebook_channel, 'object'
+    field :has_discount_code, 'bool'
+    field :id, 'string'
+    field :instagram_channel, 'object'
+    field :merchant_alert_email, 'string'
+    field :merchant_page, 'Profile'
+    field :merchant_status, 'string'
+    field :onsite_commerce_merchant, 'object'
+    field :payment_provider, 'string'
+    field :privacy_url_by_locale, 'hash'
+    field :review_rejection_messages, { list: 'string' }
+    field :review_rejection_reasons, { list: 'string' }
+    field :review_status, 'string'
+    field :supported_card_types, { list: 'string' }
+    field :terms, 'string'
+    field :terms_url_by_locale, 'hash'
+    field :whatsapp_channel, 'object'
+    has_no_delete
+
+    has_edge :facebook_channel do |edge|
+      edge.post 'CommerceMerchantSettings' do |api|
+        api.has_param :pages, { list: 'string' }
+      end
+    end
+
+    has_edge :instagram_channel do |edge|
+      edge.delete
+      edge.post 'CommerceMerchantSettings' do |api|
+        api.has_param :instagram_business_accounts, { list: 'string' }
+        api.has_param :instagram_users, { list: 'string' }
+      end
+    end
+
+    has_edge :order_management_apps do |edge|
+      edge.get 'Application'
+      edge.post 'CommerceMerchantSettings'
+    end
+
+    has_edge :product_catalogs do |edge|
+      edge.get 'ProductCatalog'
+    end
+
+    has_edge :returns do |edge|
+      edge.get do |api|
+        api.has_param :end_time_created, 'datetime'
+        api.has_param :merchant_return_id, 'string'
+        api.has_param :start_time_created, 'datetime'
+        api.has_param :statuses, { list: { enum: %w{APPROVED DISAPPROVED MERCHANT_MARKED_COMPLETED REFUNDED REQUESTED }} }
+      end
+    end
+
+    has_edge :setup_status do |edge|
+      edge.get 'CommerceMerchantSettingsSetupStatus'
+    end
+
+    has_edge :tax_settings do |edge|
+      edge.get
+    end
+
+    has_edge :whatsapp_channel do |edge|
+      edge.post do |api|
+        api.has_param :op, { enum: %w{ADD REMOVE }}
+        api.has_param :whatsapp_business_accounts, { list: 'string' }
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/commerce_merchant_settings_setup_status.rb

@@ -0,0 +1,41 @@
+# 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 CommerceMerchantSettingsSetupStatus < AdObject
+
+    field :deals_setup, 'string'
+    field :marketplace_approval_status, 'string'
+    field :marketplace_approval_status_details, 'object'
+    field :payment_setup, 'string'
+    field :shop_setup, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

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/{business_creative.rb → commerce_order_transaction_detail.rb}

@@ -25,24 +25,22 @@ 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 BusinessCreative < AdObject
+  class CommerceOrderTransactionDetail < AdObject
 
-    field :creation_time, 'datetime'
-    field :duration, 'int'
-    field :hash, 'string'
-    field :height, 'int'
+    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'
-    field :name, 'string'
-    field :thumbnail, 'string'
-    field :type, 'string'
-    field :url, 'string'
-    field :video_id, 'string'
-    field :width, 'int'
     has_no_get
     has_no_post
     has_no_delete
 
-    has_edge :ad_placement_validation_results do |edge|
+    has_edge :tax_details do |edge|
       edge.get
     end
 

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

@@ -25,12 +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 ClientTransparencyStatus < AdObject
+  class CommercePayout < AdObject
 
-    field :grace_period_expiration_date, 'datetime'
-    field :has_owning_business, 'bool'
-    field :is_satisfied, 'bool'
-    field :owning_business_requirements, 'object'
+    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/destination.rb

@@ -28,6 +28,7 @@ module FacebookAds
   class Destination < AdObject
 
     field :address, 'string'
+    field :applinks, 'CatalogItemAppLinks'
     field :currency, 'string'
     field :description, 'string'
     field :destination_id, 'string'

data/lib/facebook_ads/ad_objects/event.rb

@@ -54,8 +54,17 @@ module FacebookAds
       "WORKSHOP",
     ]
 
+    ONLINE_EVENT_FORMAT = [
+      "fb_live",
+      "messenger_room",
+      "none",
+      "other",
+      "third_party",
+    ]
+
     TYPE = [
       "community",
+      "friends",
       "group",
       "private",
       "public",
@@ -93,6 +102,8 @@ module FacebookAds
     field :maybe_count, 'int'
     field :name, 'string'
     field :noreply_count, 'int'
+    field :online_event_format, { enum: -> { ONLINE_EVENT_FORMAT }}
+    field :online_event_third_party_url, 'string'
     field :owner, 'object'
     field :parent_group, 'Group'
     field :place, 'Place'

data/lib/facebook_ads/ad_objects/external_event_source.rb

@@ -30,6 +30,7 @@ module FacebookAds
     field :id, 'string'
     field :name, 'string'
     field :source_type, 'string'
+    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/flight.rb

@@ -27,6 +27,7 @@ module FacebookAds
 
   class Flight < AdObject
 
+    field :applinks, 'CatalogItemAppLinks'
     field :currency, 'string'
     field :description, 'string'
     field :destination_airport, 'string'

data/lib/facebook_ads/ad_objects/group.rb

@@ -84,9 +84,11 @@ module FacebookAds
       "WORK_MENTORSHIP",
       "WORK_MULTI_COMPANY",
       "WORK_RECRUITING",
+      "WORK_RESUME_REVIEW",
       "WORK_SOCIAL",
       "WORK_TEAM",
       "WORK_TEAMWORK",
+      "WORK_VC_CALL",
     ]
 
     GROUP_TYPE = [
@@ -135,9 +137,11 @@ module FacebookAds
       "WORK_MENTORSHIP",
       "WORK_MULTI_COMPANY",
       "WORK_RECRUITING",
+      "WORK_RESUME_REVIEW",
       "WORK_SOCIAL",
       "WORK_TEAM",
       "WORK_TEAMWORK",
+      "WORK_VC_CALL",
     ]
 
     SUGGESTION_CATEGORY = [
@@ -385,42 +389,6 @@ module FacebookAds
       end
     end
 
-    has_edge :open_graph_action_feed do |edge|
-      edge.post do |api|
-        api.has_param :added, 'string'
-        api.has_param :alias, 'string'
-        api.has_param :android_key_hash, 'string'
-        api.has_param :client_secret, 'string'
-        api.has_param :created_time, 'datetime'
-        api.has_param :end_time, 'datetime'
-        api.has_param :expires_in, 'int'
-        api.has_param :fb_channel, 'string'
-        api.has_param :fb_explicitly_shared, 'bool'
-        api.has_param :image_height, 'int'
-        api.has_param :image_secure_url, 'string'
-        api.has_param :image_type, 'string'
-        api.has_param :image_url, 'string'
-        api.has_param :image_user_generated, 'bool'
-        api.has_param :image_width, 'int'
-        api.has_param :ios_bundle_id, 'string'
-        api.has_param :message, 'string'
-        api.has_param :no_action_link, 'bool'
-        api.has_param :no_feed_story, 'bool'
-        api.has_param :notify, 'bool'
-        api.has_param :place, 'string'
-        api.has_param :preview, 'bool'
-        api.has_param :privacy, 'string'
-        api.has_param :proxied_app_id, 'string'
-        api.has_param :ref, 'string'
-        api.has_param :scrape, 'bool'
-        api.has_param :start_time, 'datetime'
-        api.has_param :tags, { list: 'int' }
-        api.has_param :to, 'string'
-        api.has_param :user_selected_place, 'bool'
-        api.has_param :user_selected_tags, 'bool'
-      end
-    end
-
     has_edge :opted_in_members do |edge|
       edge.get 'User'
     end
@@ -484,6 +452,7 @@ module FacebookAds
 
     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 }}
@@ -511,6 +480,7 @@ module FacebookAds
         api.has_param :composer_type, 'string'
         api.has_param :container_type, { enum: -> { AdVideo::CONTAINER_TYPE }}
         api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
+        api.has_param :creative_tools, 'string'
         api.has_param :description, 'string'
         api.has_param :embeddable, 'bool'
         api.has_param :end_offset, 'int'
@@ -566,6 +536,7 @@ module FacebookAds
         api.has_param :upload_session_id, 'string'
         api.has_param :upload_setting_properties, 'string'
         api.has_param :video_file_chunk, 'string'
+        api.has_param :video_id_original, 'string'
         api.has_param :video_start_time_ms, 'int'
         api.has_param :waterfall_id, 'string'
       end