facebookbusiness 0.6.0.1 → 0.7.0.1

data/lib/facebook_ads/ad_objects/catalog_item_app_links.rb

@@ -0,0 +1,44 @@
+# 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 CatalogItemAppLinks < AdObject
+
+    field :android, { list: 'AndroidAppLink' }
+    field :ios, { list: 'IosAppLink' }
+    field :ipad, { list: 'IosAppLink' }
+    field :iphone, { list: 'IosAppLink' }
+    field :web, 'WebAppLink'
+    field :windows, { list: 'WindowsAppLink' }
+    field :windows_phone, { list: 'WindowsPhoneAppLink' }
+    field :windows_universal, { list: 'WindowsAppLink' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/catalog_item_appeal_status.rb

@@ -0,0 +1,40 @@
+# 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 CatalogItemAppealStatus < AdObject
+
+    field :handle, 'string'
+    field :item_id, 'int'
+    field :status, 'string'
+    field :use_cases, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/comment.rb

@@ -106,6 +106,7 @@ module FacebookAds
         api.has_param :nectar_module, 'string'
         api.has_param :tracking, 'string'
       end
+      edge.get 'Profile'
       edge.post 'Comment' do |api|
         api.has_param :feedback_source, 'string'
         api.has_param :nectar_module, 'string'

data/lib/facebook_ads/ad_objects/commerce_merchant_settings.rb

@@ -0,0 +1,99 @@
+# 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'
+    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
+
+  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/{video_game_show.rb → commerce_order_transaction_detail.rb}

@@ -25,27 +25,23 @@ 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 VideoGameShow < AdObject
-    ACTION = [
-      "END_GAME",
-      "START_GAME",
-    ]
-
-
-    field :end_time, 'datetime'
-    field :game_status, 'string'
-    field :game_type, 'string'
+  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'
-    field :start_time, 'datetime'
+    has_no_get
+    has_no_post
     has_no_delete
 
-    has_edge :questions do |edge|
+    has_edge :tax_details do |edge|
       edge.get
-      edge.post do |api|
-        api.has_param :correct_option, 'int'
-        api.has_param :options, { list: 'string' }
-        api.has_param :question, 'string'
-      end
     end
 
   end

data/lib/facebook_ads/ad_objects/commerce_payout.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 CommercePayout < AdObject
+
+    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
+    has_no_delete
+
+  end
+end