facebookbusiness 0.12.0.1 → 21.0.0

data/lib/facebook_ads/ad_objects/mailing_address.rb

@@ -1,20 +1,8 @@
-# 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.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
 
 # FB:AUTOGEN
 

data/lib/facebook_ads/ad_objects/managed_partner_business.rb

@@ -1,20 +1,8 @@
-# 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.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
 
 # FB:AUTOGEN
 
@@ -29,7 +17,7 @@ module FacebookAds
 
     field :ad_account, 'AdAccount'
     field :catalog_segment, 'ProductCatalog'
-    field :extended_credit, 'ExtendedCredit'
+    field :extended_credit, 'ManagedPartnerExtendedCredit'
     field :page, 'Page'
     field :seller_business_info, 'object'
     field :seller_business_status, 'string'

data/lib/facebook_ads/ad_objects/managed_partner_extended_credit.rb

@@ -0,0 +1,26 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 ManagedPartnerExtendedCredit < AdObject
+
+    field :id, 'string'
+    field :max_balance, 'CurrencyAmount'
+    field :receiving_credit_allocation_config, 'ExtendedCreditAllocationConfig'
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/marketing_message_targeting.rb

@@ -0,0 +1,29 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 MarketingMessageTargeting < AdObject
+
+    field :automation_type, 'string'
+    field :delay_send_time_second, 'int'
+    field :delay_send_time_unit, 'string'
+    field :subscriber_lists, { list: 'RawCustomAudience' }
+    field :targeting_rules, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mc_experience_config_for_api.rb

@@ -0,0 +1,27 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 McExperienceConfigForApi < AdObject
+
+    field :is_campaign_enabled, 'bool'
+    field :is_terms_signed, 'bool'
+    field :merchant_type, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_bank_account.rb

@@ -0,0 +1,28 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 McomInvoiceBankAccount < AdObject
+
+    field :num_pending_verification_accounts, 'int'
+    field :num_verified_accounts, 'int'
+    field :pending_verification_accounts, { list: 'object' }
+    field :verified_accounts, { list: 'object' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_details.rb

@@ -0,0 +1,43 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 McomInvoiceDetails < AdObject
+
+    field :additional_amounts, { list: 'object' }
+    field :buyer_notes, 'string'
+    field :currency_amount, 'object'
+    field :external_invoice_id, 'string'
+    field :features, 'object'
+    field :invoice_created, 'int'
+    field :invoice_id, 'string'
+    field :invoice_instructions, 'string'
+    field :invoice_instructions_image_url, 'string'
+    field :invoice_updated, 'int'
+    field :outstanding_amount, 'object'
+    field :paid_amount, 'object'
+    field :payments, { list: 'object' }
+    field :platform_logo_url, 'string'
+    field :platform_name, 'string'
+    field :product_items, { list: 'object' }
+    field :shipping_address, 'object'
+    field :status, 'string'
+    field :tracking_info, 'object'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_lists.rb

@@ -0,0 +1,27 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 McomInvoiceLists < AdObject
+
+    field :invoice_details, { list: 'McomInvoiceDetails' }
+    field :invoice_ids, { list: 'string' }
+    field :page_id, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_invoice_status.rb

@@ -0,0 +1,36 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 McomInvoiceStatus < AdObject
+
+    field :bank_account_number, 'string'
+    field :bank_code, 'string'
+    field :invoice_id, 'string'
+    field :invoice_status, 'string'
+    field :page_id, 'string'
+    field :payment_method, 'string'
+    field :payment_type, 'string'
+    field :payout_amount, 'object'
+    field :slip_verification_error, 'string'
+    field :slip_verification_status, 'string'
+    field :transaction_fee, 'object'
+    field :transfer_slip, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_onboarding_status.rb

@@ -0,0 +1,26 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 McomOnboardingStatus < AdObject
+
+    field :onboarding_status, 'string'
+    field :page_id, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/mcom_payouts.rb

@@ -0,0 +1,31 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 McomPayouts < AdObject
+
+    field :number_of_orders, 'int'
+    field :order_ids, { list: 'string' }
+    field :payout_amount, 'object'
+    field :payout_provider_reference_id, 'string'
+    field :payout_status, 'string'
+    field :payout_time, 'int'
+    field :provider, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/measurement_report.rb

@@ -0,0 +1,27 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 MeasurementReport < AdObject
+
+    field :download_urls, { list: 'string' }
+    field :id, 'string'
+    field :metadata, 'hash'
+    field :report_type, 'string'
+    field :status, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/media_copyright_attribution.rb

@@ -0,0 +1,38 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 MediaCopyrightAttribution < AdObject
+
+    field :attribution_ig_target_id, 'string'
+    field :attribution_target_email_address, 'string'
+    field :attribution_target_id, 'string'
+    field :attribution_target_name, 'string'
+    field :attribution_type, 'string'
+    field :attribution_uri, 'string'
+    field :copyright_count, 'int'
+    field :creation_time, 'datetime'
+    field :creator, 'Profile'
+    field :id, 'string'
+    field :is_enabled, 'bool'
+    field :link_title, 'string'
+    field :match_count, 'int'
+    field :owner, 'Page'
+    field :status, 'string'
+    field :title, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/media_copyright_update_record.rb

@@ -0,0 +1,29 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 MediaCopyrightUpdateRecord < AdObject
+
+    field :action_types, { list: 'string' }
+    field :actor, 'User'
+    field :actor_type, 'string'
+    field :creation_time, 'datetime'
+    field :id, 'string'
+    field :ownership_countries, { list: 'object' }
+    field :whitelisted_accounts, { list: 'object' }
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/media_fingerprint.rb

@@ -1,20 +1,8 @@
-# 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.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
 
 # FB:AUTOGEN
 
@@ -42,6 +30,7 @@ module FacebookAds
     field :metadata, 'object'
     field :title, 'string'
     field :universal_content_id, 'string'
+    has_no_delete
 
   end
 end

data/lib/facebook_ads/ad_objects/media_title.rb

@@ -0,0 +1,76 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 MediaTitle < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
+    CONTENT_CATEGORY = [
+      "MOVIE",
+      "MUSIC",
+      "TV_SHOW",
+    ]
+
+
+    field :applinks, 'CatalogItemAppLinks'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :content_category, 'string'
+    field :currency, 'string'
+    field :description, 'string'
+    field :fb_page_alias, 'string'
+    field :fb_page_id, 'Page'
+    field :genres, { list: 'string' }
+    field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
+    field :images, { list: 'string' }
+    field :kg_fb_id, 'string'
+    field :media_title_id, 'string'
+    field :price, 'string'
+    field :sanitized_images, { list: 'string' }
+    field :title, 'string'
+    field :title_display_name, 'string'
+    field :unit_price, 'object'
+    field :url, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
+    field :wiki_data_item, 'string'
+
+    has_edge :channels_to_integrity_status do |edge|
+      edge.get 'CatalogItemChannelsToIntegrityStatus'
+    end
+
+    has_edge :override_details do |edge|
+      edge.get 'OverrideDetails' do |api|
+        api.has_param :keys, { list: 'string' }
+        api.has_param :type, { enum: -> { OverrideDetails::TYPE }}
+      end
+    end
+
+    has_edge :videos_metadata do |edge|
+      edge.get 'DynamicVideoMetadata'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/merchant_compliance.rb

@@ -0,0 +1,29 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 MerchantCompliance < AdObject
+
+    field :active_campaigns, 'int'
+    field :compliance_status, 'string'
+    field :count_down_start_time, 'int'
+    field :purchase, 'int'
+    field :purchase_conversion_value, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/merchant_report.rb

@@ -0,0 +1,39 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+# 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 MerchantReport < AdObject
+
+    field :add_to_cart, 'int'
+    field :brand, 'string'
+    field :catalog_segment_id, 'string'
+    field :catalog_segment_purchase_value, 'double'
+    field :category, 'string'
+    field :date, 'string'
+    field :latest_date, 'string'
+    field :link_clicks, 'int'
+    field :merchant_currency, 'string'
+    field :page_id, 'string'
+    field :product_id, 'string'
+    field :product_quantity, 'int'
+    field :product_total_value, 'double'
+    field :purchase, 'int'
+    field :purchase_value, 'double'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end