facebookbusiness 0.3.0.1

data/lib/facebook_ads/ad_objects/messenger_profile.rb

@@ -0,0 +1,55 @@
+# 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 MessengerProfile < AdObject
+    FIELDS = [
+      "GET_STARTED",
+      "PERSISTENT_MENU",
+      "TARGET_AUDIENCE",
+      "WHITELISTED_DOMAINS",
+      "GREETING",
+      "ACCOUNT_LINKING_URL",
+      "PAYMENT_SETTINGS",
+      "HOME_URL",
+    ]
+
+
+    field :account_linking_url, 'string'
+    field :get_started, 'object'
+    field :greeting, { list: 'object' }
+    field :home_url, 'object'
+    field :payment_settings, 'object'
+    field :persistent_menu, { list: 'object' }
+    field :target_audience, 'object'
+    field :whitelisted_domains, { list: 'string' }
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/minimum_budget.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 MinimumBudget < AdObject
+
+    field :currency, 'string'
+    field :min_daily_budget_high_freq, 'int'
+    field :min_daily_budget_imp, 'int'
+    field :min_daily_budget_low_freq, 'int'
+    field :min_daily_budget_video_views, 'int'
+    has_no_id
+    has_no_get
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/native_offer.rb

@@ -0,0 +1,113 @@
+# 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 NativeOffer < AdObject
+    UNIQUE_CODES_FILE_CODE_TYPE = [
+      "discount_codes",
+      "barcodes",
+      "online_discount_codes",
+      "instore_discount_codes",
+      "instore_barcodes",
+      "discount_and_barcodes",
+      "discount_and_discount",
+    ]
+
+    BARCODE_TYPE = [
+      "CODE128",
+      "CODE128B",
+      "CODE93",
+      "DATABAR",
+      "DATABAR_EXPANDED",
+      "DATABAR_EXPANDED_STACKED",
+      "DATABAR_LIMITED",
+      "DATAMATRIX",
+      "EAN",
+      "PDF417",
+      "QR",
+      "UPC_A",
+      "UPC_E",
+    ]
+
+    LOCATION_TYPE = [
+      "online",
+      "offline",
+      "both",
+    ]
+
+
+    field :barcode_photo, 'string'
+    field :barcode_photo_uri, 'string'
+    field :barcode_type, 'string'
+    field :barcode_value, 'string'
+    field :details, 'string'
+    field :disable_location, 'bool'
+    field :discounts, { list: 'object' }
+    field :expiration_time, 'datetime'
+    field :id, 'string'
+    field :instore_code, 'string'
+    field :location_type, 'string'
+    field :max_save_count, 'int'
+    field :online_code, 'string'
+    field :page, 'Page'
+    field :page_set_id, 'string'
+    field :redemption_link, 'string'
+    field :save_count, 'int'
+    field :terms, 'string'
+    field :title, 'string'
+    field :total_unique_codes, 'string'
+    field :unique_codes, 'string'
+    field :unique_codes_file_code_type, 'string'
+    field :unique_codes_file_name, 'string'
+    field :unique_codes_file_upload_status, 'string'
+    has_no_post
+    has_no_delete
+
+    has_edge :codes do |edge|
+      edge.post 'NativeOffer' do |api|
+        api.has_param :file, 'file'
+        api.has_param :unique_codes_file_code_type, { enum: -> { NativeOffer::UNIQUE_CODES_FILE_CODE_TYPE }}
+      end
+    end
+
+    has_edge :nativeofferviews do |edge|
+      edge.post 'NativeOffer' do |api|
+        api.has_param :ad_account, 'string'
+        api.has_param :ad_image_hashes, { list: 'string' }
+        api.has_param :carousel_captions, { list: 'string' }
+        api.has_param :carousel_links, { list: 'string' }
+        api.has_param :image_crops, { list: 'hash' }
+        api.has_param :message, 'string'
+        api.has_param :photos, { list: 'string' }
+        api.has_param :published, 'bool'
+        api.has_param :published_ads, 'bool'
+        api.has_param :urls, { list: 'string' }
+        api.has_param :videos, { list: 'string' }
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_conversion_data_set.rb

@@ -0,0 +1,137 @@
+# 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 OfflineConversionDataSet < AdObject
+
+    field :business, 'Business'
+    field :config, 'string'
+    field :creation_time, 'datetime'
+    field :description, 'string'
+    field :duplicate_entries, 'int'
+    field :enable_auto_assign_to_accounts, 'bool'
+    field :event_stats, 'string'
+    field :event_time_max, 'int'
+    field :event_time_min, 'int'
+    field :id, 'string'
+    field :is_restricted_use, 'bool'
+    field :last_upload_app, 'string'
+    field :matched_entries, 'int'
+    field :name, 'string'
+    field :usage, 'object'
+    field :valid_entries, 'int'
+    field :auto_assign_to_new_accounts_only, 'bool'
+
+    has_edge :activities do |edge|
+      edge.get do |api|
+        api.has_param :business_id, 'string'
+        api.has_param :end_time, 'datetime'
+        api.has_param :event_type, { enum: %w{dataset_assign_to_adacct dataset_autotrack_on_adacct dataset_disable_autotrack_on_adacct dataset_unassign_from_adacct add_dataset_to_business add_user_to_dataset remove_user_from_dataset update_user_role_on_dataset create_custom_conversion update_custom_conversion create_custom_audience share_custom_audience unshare_custom_audience }}
+        api.has_param :start_time, 'datetime'
+      end
+    end
+
+    has_edge :adaccounts do |edge|
+      edge.delete do |api|
+        api.has_param :account_id, 'string'
+        api.has_param :business, 'string'
+      end
+      edge.get 'AdAccount' do |api|
+        api.has_param :business, 'string'
+      end
+      edge.post 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.delete do |api|
+        api.has_param :business, 'string'
+      end
+      edge.post 'Business' do |api|
+        api.has_param :business, 'string'
+        api.has_param :permitted_roles, { list: { enum: -> { Business::PERMITTED_ROLES }} }
+      end
+    end
+
+    has_edge :events do |edge|
+      edge.post do |api|
+        api.has_param :data, { list: 'object' }
+        api.has_param :namespace_id, 'string'
+        api.has_param :progress, 'object'
+        api.has_param :upload_id, 'string'
+        api.has_param :upload_tag, 'string'
+      end
+    end
+
+    has_edge :stats do |edge|
+      edge.get do |api|
+        api.has_param :aggr_time, { enum: %w{upload_time event_time }}
+        api.has_param :end, 'int'
+        api.has_param :granularity, { enum: %w{daily hourly }}
+        api.has_param :skip_empty_values, 'bool'
+        api.has_param :start, 'int'
+        api.has_param :user_timezone_id, 'int'
+      end
+    end
+
+    has_edge :uploads do |edge|
+      edge.get do |api|
+        api.has_param :end_time, 'object'
+        api.has_param :order, { enum: %w{ASCENDING DESCENDING }}
+        api.has_param :sort_by, { enum: %w{CREATION_TIME FIRST_UPLOAD_TIME LAST_UPLOAD_TIME API_CALLS EVENT_TIME_MIN EVENT_TIME_MAX IS_EXCLUDED_FOR_LIFT }}
+        api.has_param :start_time, 'object'
+        api.has_param :upload_tag, 'string'
+      end
+      edge.post do |api|
+        api.has_param :upload_tag, 'string'
+      end
+    end
+
+    has_edge :userpermissions do |edge|
+      edge.delete do |api|
+        api.has_param :business, 'object'
+        api.has_param :email, 'string'
+        api.has_param :user, 'int'
+      end
+      edge.post do |api|
+        api.has_param :business, 'object'
+        api.has_param :role, { enum: %w{ADMIN UPLOADER ADVERTISER }}
+        api.has_param :user, 'int'
+      end
+    end
+
+    has_edge :validate do |edge|
+      edge.post 'OfflineConversionDataSet' do |api|
+        api.has_param :data, { list: 'object' }
+        api.has_param :namespace_id, 'string'
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/offline_terms_of_service.rb

@@ -0,0 +1,37 @@
+# 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 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

@@ -0,0 +1,57 @@
+# 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 OffsitePixel < AdObject
+    TAG = [
+      "CHECKOUT",
+      "REGISTRATION",
+      "LEAD",
+      "KEY_PAGE_VIEW",
+      "ADD_TO_CART",
+      "OTHER",
+    ]
+
+
+    field :creator, 'string'
+    field :id, 'string'
+    field :js_pixel, 'string'
+    field :last_firing_time, 'datetime'
+    field :name, 'string'
+    field :tag, 'string'
+
+    has_edge :adaccounts do |edge|
+      edge.delete do |api|
+        api.has_param :adaccounts, { list: 'string' }
+      end
+      edge.get 'AdAccount'
+      edge.post 'AdAccount' do |api|
+        api.has_param :adaccounts, { list: 'string' }
+      end
+    end
+
+  end
+end

data/lib/facebook_ads/ad_objects/open_graph_context.rb

@@ -0,0 +1,35 @@
+# 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 OpenGraphContext < AdObject
+
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end