facebookbusiness 0.3.2.12 → 0.3.2.13

data/lib/facebook_ads/ad_objects/product_catalog.rb

@@ -41,8 +41,13 @@ module FacebookAds
     ]
 
     PERMITTED_TASKS = [
-      "ADMIN",
-      "ADVERTISER",
+      "ADVERTISE",
+      "MANAGE",
+    ]
+
+    TASKS = [
+      "ADVERTISE",
+      "MANAGE",
     ]
 
     STANDARD = [
@@ -81,6 +86,21 @@ module FacebookAds
       end
     end
 
+    has_edge :assigned_users do |edge|
+      edge.delete do |api|
+        api.has_param :business, 'string'
+        api.has_param :user, 'int'
+      end
+      edge.get 'AssignedUser' do |api|
+        api.has_param :business, 'string'
+      end
+      edge.post 'ProductCatalog' do |api|
+        api.has_param :business, 'string'
+        api.has_param :tasks, { list: { enum: -> { ProductCatalog::TASKS }} }
+        api.has_param :user, 'int'
+      end
+    end
+
     has_edge :automotive_models do |edge|
       edge.get 'AutomotiveModel' do |api|
         api.has_param :bulk_pagination, 'bool'
@@ -90,8 +110,8 @@ module FacebookAds
 
     has_edge :batch do |edge|
       edge.post 'ProductCatalog' do |api|
-        api.has_param :requests, { list: 'hash' }
         api.has_param :allow_upsert, 'bool'
+        api.has_param :requests, { list: 'hash' }
       end
     end
 
@@ -134,9 +154,9 @@ module FacebookAds
 
     has_edge :da_event_samples do |edge|
       edge.get 'ProductDaEventSamplesBatch' do |api|
-        api.has_param :source_id, 'string'
-        api.has_param :event, { enum: -> { ProductDaEventSamplesBatch::EVENT }}
         api.has_param :aggregation_type, { enum: -> { ProductDaEventSamplesBatch::AGGREGATION_TYPE }}
+        api.has_param :event, { enum: -> { ProductDaEventSamplesBatch::EVENT }}
+        api.has_param :source_id, 'string'
       end
     end
 
@@ -146,15 +166,15 @@ module FacebookAds
         api.has_param :filter, 'object'
       end
       edge.post 'Destination' do |api|
+        api.has_param :address, 'object'
+        api.has_param :currency, 'string'
+        api.has_param :description, 'string'
         api.has_param :destination_id, 'string'
         api.has_param :images, { list: 'object' }
-        api.has_param :types, 'string'
-        api.has_param :url, 'string'
         api.has_param :name, 'string'
-        api.has_param :address, 'object'
-        api.has_param :currency, 'string'
         api.has_param :price, 'int'
-        api.has_param :description, 'string'
+        api.has_param :types, 'string'
+        api.has_param :url, 'string'
       end
     end
 
@@ -180,13 +200,13 @@ module FacebookAds
         api.has_param :filter, 'object'
       end
       edge.post 'Flight' do |api|
+        api.has_param :currency, 'string'
+        api.has_param :description, 'string'
+        api.has_param :destination_airport, 'string'
         api.has_param :images, { list: 'object' }
         api.has_param :origin_airport, 'string'
-        api.has_param :destination_airport, 'string'
-        api.has_param :description, 'string'
-        api.has_param :url, 'string'
-        api.has_param :currency, 'string'
         api.has_param :price, 'int'
+        api.has_param :url, 'string'
       end
     end
 
@@ -196,21 +216,21 @@ module FacebookAds
         api.has_param :filter, 'object'
       end
       edge.post 'HomeListing' do |api|
-        api.has_param :home_listing_id, 'string'
         api.has_param :address, 'object'
         api.has_param :availability, 'string'
-        api.has_param :images, { list: 'object' }
-        api.has_param :name, 'string'
         api.has_param :currency, 'string'
-        api.has_param :price, 'double'
-        api.has_param :url, 'string'
-        api.has_param :year_built, 'int'
         api.has_param :description, 'string'
+        api.has_param :home_listing_id, 'string'
+        api.has_param :images, { list: 'object' }
         api.has_param :listing_type, 'string'
+        api.has_param :name, 'string'
         api.has_param :num_baths, 'double'
         api.has_param :num_beds, 'double'
         api.has_param :num_units, 'double'
+        api.has_param :price, 'double'
         api.has_param :property_type, 'string'
+        api.has_param :url, 'string'
+        api.has_param :year_built, 'int'
       end
     end
 
@@ -222,9 +242,9 @@ module FacebookAds
         api.has_param :file, 'file'
         api.has_param :password, 'string'
         api.has_param :standard, { enum: -> { ProductCatalog::STANDARD }}
+        api.has_param :update_only, 'bool'
         api.has_param :url, 'string'
         api.has_param :username, 'string'
-        api.has_param :update_only, 'bool'
       end
     end
 
@@ -234,27 +254,27 @@ module FacebookAds
         api.has_param :filter, 'object'
       end
       edge.post 'Hotel' do |api|
-        api.has_param :hotel_id, 'string'
         api.has_param :address, 'object'
+        api.has_param :applinks, 'object'
+        api.has_param :base_price, 'int'
         api.has_param :brand, 'string'
+        api.has_param :currency, 'string'
         api.has_param :description, 'string'
-        api.has_param :name, 'string'
-        api.has_param :url, 'string'
+        api.has_param :guest_ratings, { list: 'object' }
+        api.has_param :hotel_id, 'string'
         api.has_param :images, { list: 'object' }
-        api.has_param :currency, 'string'
-        api.has_param :base_price, 'int'
-        api.has_param :applinks, 'object'
+        api.has_param :name, 'string'
         api.has_param :phone, 'string'
         api.has_param :star_rating, 'double'
-        api.has_param :guest_ratings, { list: 'object' }
+        api.has_param :url, 'string'
       end
     end
 
     has_edge :items_batch do |edge|
       edge.post 'ProductCatalog' do |api|
-        api.has_param :requests, 'hash'
-        api.has_param :item_type, 'string'
         api.has_param :allow_upsert, 'bool'
+        api.has_param :item_type, 'string'
+        api.has_param :requests, 'hash'
       end
     end
 
@@ -266,27 +286,27 @@ module FacebookAds
         api.has_param :file, 'file'
         api.has_param :password, 'string'
         api.has_param :standard, { enum: -> { ProductCatalog::STANDARD }}
+        api.has_param :update_only, 'bool'
         api.has_param :url, 'string'
         api.has_param :username, 'string'
-        api.has_param :update_only, 'bool'
       end
     end
 
     has_edge :product_feeds do |edge|
       edge.get 'ProductFeed'
       edge.post 'ProductFeed' do |api|
+        api.has_param :country, 'string'
         api.has_param :default_currency, 'string'
+        api.has_param :deletion_enabled, 'bool'
         api.has_param :delimiter, { enum: -> { ProductFeed::DELIMITER }}
         api.has_param :encoding, { enum: -> { ProductFeed::ENCODING }}
+        api.has_param :feed_type, { enum: -> { ProductFeed::FEED_TYPE }}
+        api.has_param :file_name, 'string'
         api.has_param :name, 'string'
         api.has_param :quoted_fields_mode, { enum: -> { ProductFeed::QUOTED_FIELDS_MODE }}
+        api.has_param :rules, { list: 'string' }
         api.has_param :schedule, 'string'
         api.has_param :update_schedule, 'string'
-        api.has_param :country, 'string'
-        api.has_param :deletion_enabled, 'bool'
-        api.has_param :feed_type, { enum: -> { ProductFeed::FEED_TYPE }}
-        api.has_param :file_name, 'string'
-        api.has_param :rules, { list: 'string' }
       end
     end
 
@@ -300,9 +320,9 @@ module FacebookAds
 
     has_edge :product_sets do |edge|
       edge.get 'ProductSet' do |api|
-        api.has_param :parent_id, 'string'
         api.has_param :ancestor_id, 'string'
         api.has_param :has_children, 'bool'
+        api.has_param :parent_id, 'string'
         api.has_param :retailer_id, 'string'
       end
       edge.post 'ProductSet' do |api|
@@ -319,95 +339,95 @@ module FacebookAds
         api.has_param :file, 'file'
         api.has_param :password, 'string'
         api.has_param :standard, { enum: -> { ProductCatalog::STANDARD }}
+        api.has_param :update_only, 'bool'
         api.has_param :url, 'string'
         api.has_param :username, 'string'
-        api.has_param :update_only, 'bool'
       end
     end
 
     has_edge :products do |edge|
       edge.get 'ProductItem' do |api|
         api.has_param :bulk_pagination, 'bool'
-        api.has_param :return_only_approved_products, 'bool'
         api.has_param :filter, 'object'
+        api.has_param :return_only_approved_products, 'bool'
       end
       edge.post 'ProductItem' do |api|
-        api.has_param :retailer_id, 'string'
-        api.has_param :retailer_product_group_id, 'string'
-        api.has_param :availability, { enum: -> { ProductItem::AVAILABILITY }}
-        api.has_param :currency, 'string'
-        api.has_param :condition, { enum: -> { ProductItem::CONDITION }}
-        api.has_param :description, 'string'
-        api.has_param :image_url, 'string'
-        api.has_param :name, 'string'
-        api.has_param :price, 'int'
-        api.has_param :product_type, 'string'
-        api.has_param :url, 'string'
-        api.has_param :visibility, { enum: -> { ProductItem::VISIBILITY }}
         api.has_param :additional_image_urls, { list: 'string' }
         api.has_param :additional_variant_attributes, 'hash'
+        api.has_param :android_app_name, 'string'
+        api.has_param :android_class, 'string'
+        api.has_param :android_package, 'string'
+        api.has_param :android_url, 'string'
+        api.has_param :availability, { enum: -> { ProductItem::AVAILABILITY }}
         api.has_param :brand, 'string'
         api.has_param :category, 'string'
         api.has_param :checkout_url, 'string'
         api.has_param :color, 'string'
+        api.has_param :condition, { enum: -> { ProductItem::CONDITION }}
+        api.has_param :currency, 'string'
         api.has_param :custom_data, 'hash'
         api.has_param :custom_label_0, 'string'
         api.has_param :custom_label_1, 'string'
         api.has_param :custom_label_2, 'string'
         api.has_param :custom_label_3, 'string'
         api.has_param :custom_label_4, 'string'
+        api.has_param :description, 'string'
         api.has_param :expiration_date, 'string'
         api.has_param :gender, { enum: -> { ProductItem::GENDER }}
         api.has_param :gtin, 'string'
+        api.has_param :image_url, 'string'
         api.has_param :inventory, 'int'
+        api.has_param :ios_app_name, 'string'
+        api.has_param :ios_app_store_id, 'int'
+        api.has_param :ios_url, 'string'
+        api.has_param :ipad_app_name, 'string'
+        api.has_param :ipad_app_store_id, 'int'
+        api.has_param :ipad_url, 'string'
+        api.has_param :iphone_app_name, 'string'
+        api.has_param :iphone_app_store_id, 'int'
+        api.has_param :iphone_url, 'string'
         api.has_param :manufacturer_part_number, 'string'
-        api.has_param :mobile_link, 'string'
         api.has_param :material, 'string'
+        api.has_param :mobile_link, 'string'
+        api.has_param :name, 'string'
         api.has_param :offer_price_amount, 'int'
         api.has_param :offer_price_end_date, 'datetime'
         api.has_param :offer_price_start_date, 'datetime'
         api.has_param :ordering_index, 'int'
         api.has_param :pattern, 'string'
+        api.has_param :price, 'int'
+        api.has_param :product_type, 'string'
+        api.has_param :retailer_id, 'string'
+        api.has_param :retailer_product_group_id, 'string'
         api.has_param :sale_price, 'int'
         api.has_param :sale_price_end_date, 'datetime'
         api.has_param :sale_price_start_date, 'datetime'
         api.has_param :short_description, 'string'
         api.has_param :size, 'string'
         api.has_param :start_date, 'string'
-        api.has_param :ios_url, 'string'
-        api.has_param :ios_app_store_id, 'int'
-        api.has_param :ios_app_name, 'string'
-        api.has_param :iphone_url, 'string'
-        api.has_param :iphone_app_store_id, 'int'
-        api.has_param :iphone_app_name, 'string'
-        api.has_param :ipad_url, 'string'
-        api.has_param :ipad_app_store_id, 'int'
-        api.has_param :ipad_app_name, 'string'
-        api.has_param :android_url, 'string'
-        api.has_param :android_package, 'string'
-        api.has_param :android_class, 'string'
-        api.has_param :android_app_name, 'string'
-        api.has_param :windows_phone_url, 'string'
+        api.has_param :url, 'string'
+        api.has_param :visibility, { enum: -> { ProductItem::VISIBILITY }}
         api.has_param :windows_phone_app_id, 'string'
         api.has_param :windows_phone_app_name, 'string'
+        api.has_param :windows_phone_url, 'string'
       end
     end
 
     has_edge :userpermissions do |edge|
       edge.delete do |api|
-        api.has_param :user, 'int'
-        api.has_param :email, 'string'
         api.has_param :business, 'string'
+        api.has_param :email, 'string'
+        api.has_param :user, 'int'
       end
       edge.get 'ProductCatalogUserPermissions' do |api|
         api.has_param :business, 'string'
         api.has_param :user, 'int'
       end
       edge.post 'ProductCatalog' do |api|
-        api.has_param :user, 'int'
+        api.has_param :business, 'string'
         api.has_param :email, 'string'
         api.has_param :role, { enum: -> { ProductCatalog::ROLE }}
-        api.has_param :business, 'string'
+        api.has_param :user, 'int'
       end
     end
 
@@ -417,111 +437,111 @@ module FacebookAds
         api.has_param :filter, 'object'
       end
       edge.post 'Vehicle' do |api|
-        api.has_param :vehicle_id, 'string'
+        api.has_param :address, 'hash'
+        api.has_param :applinks, 'object'
+        api.has_param :availability, { enum: -> { Vehicle::AVAILABILITY }}
         api.has_param :body_style, { enum: -> { Vehicle::BODY_STYLE }}
+        api.has_param :condition, { enum: -> { Vehicle::CONDITION }}
+        api.has_param :currency, 'string'
+        api.has_param :date_first_on_lot, 'string'
+        api.has_param :dealer_id, 'string'
+        api.has_param :dealer_name, 'string'
+        api.has_param :dealer_phone, 'string'
         api.has_param :description, 'string'
+        api.has_param :drivetrain, { enum: -> { Vehicle::DRIVETRAIN }}
         api.has_param :exterior_color, 'string'
+        api.has_param :fuel_type, { enum: -> { Vehicle::FUEL_TYPE }}
+        api.has_param :images, { list: 'object' }
+        api.has_param :interior_color, 'string'
         api.has_param :make, 'string'
         api.has_param :mileage, 'hash'
         api.has_param :model, 'string'
-        api.has_param :state_of_vehicle, { enum: -> { Vehicle::STATE_OF_VEHICLE }}
-        api.has_param :vin, 'string'
-        api.has_param :url, 'string'
-        api.has_param :year, 'int'
-        api.has_param :images, { list: 'object' }
-        api.has_param :address, 'hash'
-        api.has_param :currency, 'string'
         api.has_param :price, 'int'
+        api.has_param :state_of_vehicle, { enum: -> { Vehicle::STATE_OF_VEHICLE }}
         api.has_param :title, 'string'
-        api.has_param :applinks, 'object'
         api.has_param :transmission, { enum: -> { Vehicle::TRANSMISSION }}
-        api.has_param :drivetrain, { enum: -> { Vehicle::DRIVETRAIN }}
-        api.has_param :fuel_type, { enum: -> { Vehicle::FUEL_TYPE }}
         api.has_param :trim, 'string'
-        api.has_param :interior_color, 'string'
-        api.has_param :condition, { enum: -> { Vehicle::CONDITION }}
-        api.has_param :date_first_on_lot, 'string'
-        api.has_param :availability, { enum: -> { Vehicle::AVAILABILITY }}
-        api.has_param :dealer_id, 'string'
-        api.has_param :dealer_name, 'string'
-        api.has_param :dealer_phone, 'string'
+        api.has_param :url, 'string'
+        api.has_param :vehicle_id, 'string'
         api.has_param :vehicle_type, { enum: -> { Vehicle::VEHICLE_TYPE }}
+        api.has_param :vin, 'string'
+        api.has_param :year, 'int'
       end
     end
 
     has_edge :videos do |edge|
       edge.post 'AdVideo' do |api|
-        api.has_param :title, 'string'
-        api.has_param :source, 'string'
-        api.has_param :unpublished_content_type, { enum: -> { AdVideo::UNPUBLISHED_CONTENT_TYPE }}
-        api.has_param :time_since_original_post, 'int'
-        api.has_param :file_url, 'string'
-        api.has_param :composer_session_id, 'string'
-        api.has_param :waterfall_id, 'string'
-        api.has_param :og_action_type_id, 'string'
-        api.has_param :og_object_id, 'string'
-        api.has_param :og_phrase, 'string'
-        api.has_param :og_icon_id, 'string'
-        api.has_param :og_suggestion_mechanism, 'string'
-        api.has_param :thumb, 'file'
-        api.has_param :spherical, 'bool'
-        api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
-        api.has_param :initial_heading, 'int'
-        api.has_param :initial_pitch, 'int'
-        api.has_param :fov, 'int'
-        api.has_param :original_fov, 'int'
-        api.has_param :fisheye_video_cropped, 'bool'
-        api.has_param :front_z_rotation, 'double'
-        api.has_param :guide_enabled, 'bool'
-        api.has_param :guide, { list: { list: 'int' } }
-        api.has_param :audio_story_wave_animation_handle, 'string'
-        api.has_param :manual_privacy, 'bool'
-        api.has_param :is_explicit_share, 'bool'
         api.has_param :adaptive_type, 'string'
         api.has_param :animated_effect_id, 'int'
+        api.has_param :application_id, 'string'
         api.has_param :asked_fun_fact_prompt_id, 'int'
+        api.has_param :attribution_app_id, 'string'
+        api.has_param :audio_story_wave_animation_handle, 'string'
         api.has_param :composer_entry_picker, 'string'
         api.has_param :composer_entry_point, 'string'
         api.has_param :composer_entry_time, 'int'
         api.has_param :composer_session_events_log, 'string'
+        api.has_param :composer_session_id, 'string'
         api.has_param :composer_source_surface, 'string'
         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 :description, 'string'
+        api.has_param :embeddable, 'bool'
+        api.has_param :end_offset, 'int'
+        api.has_param :fbuploader_video_file_chunk, 'string'
+        api.has_param :file_size, 'int'
+        api.has_param :file_url, 'string'
+        api.has_param :fisheye_video_cropped, 'bool'
         api.has_param :formatting, { enum: -> { AdVideo::FORMATTING }}
+        api.has_param :fov, 'int'
+        api.has_param :front_z_rotation, 'double'
         api.has_param :fun_fact_prompt_id, 'int'
         api.has_param :fun_fact_toastee_id, 'int'
-        api.has_param :is_group_linking_post, 'bool'
+        api.has_param :guide, { list: { list: 'int' } }
+        api.has_param :guide_enabled, 'bool'
         api.has_param :has_nickname, 'bool'
         api.has_param :holiday_card, 'string'
+        api.has_param :initial_heading, 'int'
+        api.has_param :initial_pitch, 'int'
         api.has_param :instant_game_entry_point_data, 'string'
         api.has_param :is_boost_intended, 'bool'
+        api.has_param :is_explicit_share, 'bool'
+        api.has_param :is_group_linking_post, 'bool'
+        api.has_param :is_voice_clip, 'bool'
         api.has_param :location_source_id, 'string'
-        api.has_param :description, 'string'
+        api.has_param :manual_privacy, 'bool'
         api.has_param :offer_like_post_id, 'int'
+        api.has_param :og_action_type_id, 'string'
+        api.has_param :og_icon_id, 'string'
+        api.has_param :og_object_id, 'string'
+        api.has_param :og_phrase, 'string'
+        api.has_param :og_suggestion_mechanism, 'string'
+        api.has_param :original_fov, 'int'
+        api.has_param :original_projection_type, { enum: -> { AdVideo::ORIGINAL_PROJECTION_TYPE }}
         api.has_param :publish_event_id, 'int'
         api.has_param :react_mode_metadata, 'string'
+        api.has_param :referenced_sticker_id, 'string'
+        api.has_param :replace_video_id, 'string'
         api.has_param :sales_promo_id, 'int'
+        api.has_param :slideshow_spec, 'hash'
+        api.has_param :source, 'string'
+        api.has_param :spherical, 'bool'
+        api.has_param :start_offset, 'int'
+        api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
         api.has_param :text_format_metadata, 'string'
         api.has_param :throwback_camera_roll_media, 'string'
-        api.has_param :video_start_time_ms, 'int'
-        api.has_param :application_id, 'string'
+        api.has_param :thumb, 'file'
+        api.has_param :time_since_original_post, 'int'
+        api.has_param :title, 'string'
+        api.has_param :transcode_setting_properties, 'string'
+        api.has_param :unpublished_content_type, { enum: -> { AdVideo::UNPUBLISHED_CONTENT_TYPE }}
         api.has_param :upload_phase, { enum: -> { AdVideo::UPLOAD_PHASE }}
-        api.has_param :file_size, 'int'
-        api.has_param :start_offset, 'int'
-        api.has_param :end_offset, 'int'
-        api.has_param :video_file_chunk, 'string'
-        api.has_param :fbuploader_video_file_chunk, 'string'
         api.has_param :upload_session_id, 'string'
-        api.has_param :is_voice_clip, 'bool'
-        api.has_param :attribution_app_id, 'string'
-        api.has_param :content_category, { enum: -> { AdVideo::CONTENT_CATEGORY }}
-        api.has_param :embeddable, 'bool'
-        api.has_param :slideshow_spec, 'hash'
         api.has_param :upload_setting_properties, 'string'
-        api.has_param :transcode_setting_properties, 'string'
-        api.has_param :container_type, { enum: -> { AdVideo::CONTAINER_TYPE }}
-        api.has_param :referenced_sticker_id, 'string'
-        api.has_param :replace_video_id, 'string'
-        api.has_param :swap_mode, { enum: -> { AdVideo::SWAP_MODE }}
+        api.has_param :video_file_chunk, 'string'
+        api.has_param :video_start_time_ms, 'int'
+        api.has_param :waterfall_id, 'string'
       end
     end