facebookbusiness 0.12.0.1 → 21.0.0

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.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
 
@@ -26,66 +14,55 @@ module FacebookAds
   # pull request for this class.
 
   class OfflineConversionDataSet < AdObject
-    PERMITTED_ROLES = [
-      "ADMIN",
-      "ADVERTISER",
-      "UPLOADER",
-    ]
-
-    RELATIONSHIP_TYPE = [
-      "AD_MANAGER",
-      "AGENCY",
-      "AGGREGATOR",
-      "AUDIENCE_MANAGER",
-      "OTHER",
-    ]
-
 
+    field :automatic_matching_fields, { list: 'string' }
     field :business, 'Business'
+    field :can_proxy, 'bool'
     field :config, 'string'
     field :creation_time, 'datetime'
+    field :creator, 'User'
+    field :data_use_setting, 'string'
     field :description, 'string'
     field :duplicate_entries, 'int'
     field :enable_auto_assign_to_accounts, 'bool'
+    field :enable_automatic_matching, 'bool'
     field :event_stats, 'string'
     field :event_time_max, 'int'
     field :event_time_min, 'int'
+    field :first_party_cookie_status, 'string'
     field :id, 'string'
+    field :is_consolidated_container, 'bool'
+    field :is_created_by_business, 'bool'
+    field :is_crm, 'bool'
     field :is_mta_use, 'bool'
     field :is_restricted_use, 'bool'
     field :is_unavailable, 'bool'
+    field :last_fired_time, 'datetime'
     field :last_upload_app, 'string'
     field :last_upload_app_changed_time, 'int'
     field :match_rate_approx, 'int'
     field :matched_entries, 'int'
     field :name, 'string'
-    field :usage, 'object'
+    field :owner_ad_account, 'AdAccount'
+    field :owner_business, 'Business'
+    field :usage, 'OfflineConversionDataSetUsage'
     field :valid_entries, 'int'
-    field :auto_assign_to_new_accounts_only, 'bool'
+    has_no_post
+    has_no_delete
 
     has_edge :adaccounts do |edge|
       edge.get 'AdAccount' do |api|
         api.has_param :business, 'string'
       end
-      edge.post 'OfflineConversionDataSet' do |api|
-        api.has_param :account_id, 'string'
-        api.has_param :auto_track_for_ads, 'bool'
-        api.has_param :business, 'string'
-      end
     end
 
     has_edge :agencies do |edge|
       edge.get 'Business'
-      edge.post 'OfflineConversionDataSet' do |api|
-        api.has_param :business, 'string'
-        api.has_param :other_relationship, 'string'
-        api.has_param :permitted_roles, { list: { enum: -> { OfflineConversionDataSet::PERMITTED_ROLES }} }
-        api.has_param :relationship_type, { list: { enum: -> { OfflineConversionDataSet::RELATIONSHIP_TYPE }} }
-      end
     end
 
     has_edge :audiences do |edge|
       edge.get 'CustomAudience' do |api|
+        api.has_param :action_source, { enum: -> { CustomAudience::ACTION_SOURCE }}
         api.has_param :ad_account, 'string'
       end
     end
@@ -96,14 +73,20 @@ module FacebookAds
       end
     end
 
-    has_edge :events do |edge|
-      edge.post do |api|
-        api.has_param :data, { list: 'string' }
-        api.has_param :namespace_id, 'string'
-        api.has_param :progress, 'object'
-        api.has_param :upload_id, 'string'
-        api.has_param :upload_source, 'string'
-        api.has_param :upload_tag, 'string'
+    has_edge :server_events_permitted_business do |edge|
+      edge.get 'Business'
+    end
+
+    has_edge :shared_accounts do |edge|
+      edge.get 'AdAccount' do |api|
+        api.has_param :action_source, { enum: -> { AdAccount::ACTION_SOURCE }}
+        api.has_param :business, 'string'
+      end
+    end
+
+    has_edge :shared_agencies do |edge|
+      edge.get 'Business' do |api|
+        api.has_param :action_source, { enum: -> { Business::ACTION_SOURCE }}
       end
     end
 
@@ -119,23 +102,13 @@ module FacebookAds
     end
 
     has_edge :uploads do |edge|
-      edge.get do |api|
+      edge.get 'OfflineConversionDataSetUpload' do |api|
         api.has_param :end_time, 'datetime'
-        api.has_param :order, { enum: %w{ASCENDING DESCENDING }}
-        api.has_param :sort_by, { enum: %w{API_CALLS CREATION_TIME EVENT_TIME_MAX EVENT_TIME_MIN FIRST_UPLOAD_TIME IS_EXCLUDED_FOR_LIFT LAST_UPLOAD_TIME }}
+        api.has_param :order, { enum: -> { OfflineConversionDataSetUpload::ORDER }}
+        api.has_param :sort_by, { enum: -> { OfflineConversionDataSetUpload::SORT_BY }}
         api.has_param :start_time, 'datetime'
         api.has_param :upload_tag, 'string'
       end
-      edge.post do |api|
-        api.has_param :upload_tag, 'string'
-      end
-    end
-
-    has_edge :validate do |edge|
-      edge.post 'OfflineConversionDataSet' do |api|
-        api.has_param :data, { list: 'string' }
-        api.has_param :namespace_id, 'string'
-      end
     end
 
   end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set_activities.rb

@@ -0,0 +1,33 @@
+# 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 OfflineConversionDataSetActivities < AdObject
+
+    field :actor_id, 'int'
+    field :actor_name, 'string'
+    field :adaccount_id, 'int'
+    field :adaccount_name, 'string'
+    field :event_time, 'datetime'
+    field :event_type, 'string'
+    field :extra_data, 'string'
+    field :object_id, 'int'
+    field :object_name, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set_optimization_status.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 OfflineConversionDataSetOptimizationStatus < AdObject
+
+    field :event, 'string'
+    field :last_changed_time, 'int'
+    field :last_detected_time, 'int'
+    field :status, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set_permissions.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 OfflineConversionDataSetPermissions < AdObject
+
+    field :can_edit, 'bool'
+    field :can_edit_or_upload, 'bool'
+    field :can_upload, 'bool'
+    field :should_block_vanilla_business_employee_access, 'bool'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set_upload.rb

@@ -0,0 +1,59 @@
+# 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 OfflineConversionDataSetUpload < AdObject
+    ORDER = [
+      "ASCENDING",
+      "DESCENDING",
+    ]
+
+    SORT_BY = [
+      "API_CALLS",
+      "CREATION_TIME",
+      "EVENT_TIME_MAX",
+      "EVENT_TIME_MIN",
+      "FIRST_UPLOAD_TIME",
+      "IS_EXCLUDED_FOR_LIFT",
+      "LAST_UPLOAD_TIME",
+    ]
+
+
+    field :api_calls, 'int'
+    field :creation_time, 'int'
+    field :duplicate_entries, 'int'
+    field :event_stats, 'string'
+    field :event_time_max, 'int'
+    field :event_time_min, 'int'
+    field :first_upload_time, 'int'
+    field :id, 'string'
+    field :is_excluded_for_lift, 'bool'
+    field :last_upload_time, 'int'
+    field :match_rate_approx, 'int'
+    field :matched_entries, 'int'
+    field :upload_tag, 'string'
+    field :valid_entries, 'int'
+    has_no_post
+    has_no_delete
+
+    has_edge :progress do |edge|
+      edge.get
+    end
+
+    has_edge :pull_sessions do |edge|
+      edge.get
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set_usage.rb

@@ -0,0 +1,25 @@
+# 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 OfflineConversionDataSetUsage < AdObject
+
+    field :num_lift_studies, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_product_item.rb

@@ -0,0 +1,63 @@
+# 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 OfflineProductItem < AdObject
+    IMAGE_FETCH_STATUS = [
+      "DIRECT_UPLOAD",
+      "FETCHED",
+      "FETCH_FAILED",
+      "NO_STATUS",
+      "OUTDATED",
+      "PARTIAL_FETCH",
+    ]
+
+    VISIBILITY = [
+      "PUBLISHED",
+      "STAGING",
+    ]
+
+
+    field :applinks, 'CatalogItemAppLinks'
+    field :brand, 'string'
+    field :category, 'string'
+    field :category_specific_fields, 'CatalogSubVerticalList'
+    field :currency, 'string'
+    field :description, 'string'
+    field :id, 'string'
+    field :image_fetch_status, { enum: -> { IMAGE_FETCH_STATUS }}
+    field :image_url, 'string'
+    field :images, { list: 'string' }
+    field :name, 'string'
+    field :offline_product_item_id, 'string'
+    field :price, 'string'
+    field :sanitized_images, { list: 'string' }
+    field :url, 'string'
+    field :visibility, { enum: -> { VISIBILITY }}
+    has_no_post
+    has_no_delete
+
+    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
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_terms_of_service.rb

@@ -0,0 +1,25 @@
+# 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 OfflineTermsOfService < AdObject
+
+    field :accept_time, 'int'
+    field :id, 'string'
+    field :signed_by_user, 'User'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/offsite_pixel.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/offsite_signal_container_business_object.rb

@@ -0,0 +1,37 @@
+# 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 OffsiteSignalContainerBusinessObject < AdObject
+
+    field :business, 'Business'
+    field :id, 'string'
+    field :is_eligible_for_sharing_to_ad_account, 'bool'
+    field :is_eligible_for_sharing_to_business, 'bool'
+    field :is_unavailable, 'bool'
+    field :name, 'string'
+    field :primary_container_id, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :linked_application do |edge|
+      edge.get 'AdsDataset'
+    end
+
+    has_edge :linked_page do |edge|
+      edge.get 'Page'
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/omega_customer_trx.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
 
@@ -38,9 +26,8 @@ module FacebookAds
     field :advertiser_name, 'string'
     field :amount, 'string'
     field :amount_due, 'CurrencyAmount'
-    field :billed_amount_details, 'BilledAmountDetails'
+    field :billed_amount_details, 'object'
     field :billing_period, 'string'
-    field :campaign, 'AtlasCampaign'
     field :cdn_download_uri, 'string'
     field :currency, 'string'
     field :download_uri, 'string'
@@ -58,7 +45,7 @@ module FacebookAds
     has_no_delete
 
     has_edge :campaigns do |edge|
-      edge.get 'InvoiceCampaign'
+      edge.get
     end
 
   end

data/lib/facebook_ads/ad_objects/open_bridge_configuration.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 OpenBridgeConfiguration < AdObject
+
+    field :active, 'bool'
+    field :endpoint, 'string'
+    field :fallback_domain, 'string'
+    field :fallback_domain_enabled, 'bool'
+    field :host_business_id, 'string'
+    field :host_external_id, 'string'
+    field :id, 'string'
+    field :instance_id, 'string'
+    field :pixel_id, 'string'
+
+  end
+end

data/lib/facebook_ads/ad_objects/open_graph_context.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/order_id_attributions.rb

@@ -0,0 +1,33 @@
+# 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 OrderIdAttributions < AdObject
+
+    field :app_id, 'string'
+    field :attribution_type, 'string'
+    field :attributions, { list: 'object' }
+    field :conversion_device, 'string'
+    field :dataset_id, 'string'
+    field :holdout_status, { list: 'object' }
+    field :order_id, 'string'
+    field :order_timestamp, 'datetime'
+    field :pixel_id, 'string'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/organization.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 Organization < AdObject
+
+    field :hq_country, 'string'
+    field :id, 'string'
+    field :legal_entity_name, 'string'
+    field :master_bm_id, 'string'
+    field :owner_business, 'Business'
+    has_no_post
+    has_no_delete
+
+  end
+end