facebookads 0.2.11.0 → 0.999

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f5863fdb541ae250c21d0ab010b95253d656d79
-  data.tar.gz: 9b6914ef28784356a7945676e4c541c1faf6423d
+SHA256:
+  metadata.gz: 3e21d42c25e4c0892720fb7a9aa9c3eac2c8d6c042646696c514dfbc91097b42
+  data.tar.gz: b8d1fa1d55a2a349f7bdfb6aa0f39b17af6d315773210e5b38415caa565e1ace
 SHA512:
-  metadata.gz: 0373a0e8a6740ee63dd8e0bcc476ddf9e47769d47d415af74fcbf64c2b606d4d94698303727e5a24ece7d9887db43761bfd3bfbaa065f846973f04a600f9c9a1
-  data.tar.gz: 9aeeef48a88bd7d1bb7b75a9e3834edbe90cf1d9049756f79daec3c4e87ca446b9ef5723333e64b93281ac70173fa595f3f9c50a366b1f1aee03e301524211a3
+  metadata.gz: 9ae3dddbddb0c2af9b0dd8af00bf151481580dc1d8c627fc8b4ed0adbfceb12f600e9ee2501729543ce944a6dab00244788c02839a2037d4aec3daca79d5aa44
+  data.tar.gz: ee92f16e04307a8bd9857bc330cfe0c6f6933c4e83ea469b1f37c49863fbcf3b04d29250163205c15b563513c5f03e75cacb6e31db03d5a514302a47dc67c46e

metadata

@@ -1,384 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: facebookads
 version: !ruby/object:Gem::Version
-  version: 0.2.11.0
+  version: '0.999'
 platform: ruby
 authors:
 - Facebook
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-coolline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: |2
-    The official Facebook Ads API SDK for Ruby.
-    https://developers.facebook.com/docs/marketing-api/sdks'
+date: 2023-01-18 00:00:00.000000000 Z
+dependencies: []
+description: "[Deprecated] Please use facebookbusiness gem instead"
 email: ''
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
-- LICENSE.txt
-- README.md
-- lib/facebook_ads.rb
-- lib/facebook_ads/ad_object.rb
-- lib/facebook_ads/ad_objects/ad.rb
-- lib/facebook_ads/ad_objects/ad_account.rb
-- lib/facebook_ads/ad_objects/ad_account_ad_rules_history.rb
-- lib/facebook_ads/ad_objects/ad_account_delivery_estimate.rb
-- lib/facebook_ads/ad_objects/ad_account_roas.rb
-- lib/facebook_ads/ad_objects/ad_account_targeting_unified.rb
-- lib/facebook_ads/ad_objects/ad_account_user.rb
-- lib/facebook_ads/ad_objects/ad_activity.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_asset_label.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_body.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_caption.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_description.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_group_rule.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_image.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_link_url.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_target_rule.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_title.rb
-- lib/facebook_ads/ad_objects/ad_asset_feed_spec_video.rb
-- lib/facebook_ads/ad_objects/ad_async_request.rb
-- lib/facebook_ads/ad_objects/ad_async_request_set.rb
-- lib/facebook_ads/ad_objects/ad_async_request_set_notification_result.rb
-- lib/facebook_ads/ad_objects/ad_campaign_delivery_estimate.rb
-- lib/facebook_ads/ad_objects/ad_creative.rb
-- lib/facebook_ads/ad_objects/ad_creative_collection_thumbnail_info.rb
-- lib/facebook_ads/ad_objects/ad_creative_link_data.rb
-- lib/facebook_ads/ad_objects/ad_creative_link_data_app_link_spec.rb
-- lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action.rb
-- lib/facebook_ads/ad_objects/ad_creative_link_data_call_to_action_value.rb
-- lib/facebook_ads/ad_objects/ad_creative_link_data_child_attachment.rb
-- lib/facebook_ads/ad_objects/ad_creative_link_data_image_overlay_spec.rb
-- lib/facebook_ads/ad_objects/ad_creative_object_story_spec.rb
-- lib/facebook_ads/ad_objects/ad_creative_offer_data.rb
-- lib/facebook_ads/ad_objects/ad_creative_photo_data.rb
-- lib/facebook_ads/ad_objects/ad_creative_place_data.rb
-- lib/facebook_ads/ad_objects/ad_creative_post_click_configuration.rb
-- lib/facebook_ads/ad_objects/ad_creative_text_data.rb
-- lib/facebook_ads/ad_objects/ad_creative_video_data.rb
-- lib/facebook_ads/ad_objects/ad_image.rb
-- lib/facebook_ads/ad_objects/ad_keyword_stats.rb
-- lib/facebook_ads/ad_objects/ad_label.rb
-- lib/facebook_ads/ad_objects/ad_place_page_set.rb
-- lib/facebook_ads/ad_objects/ad_preview.rb
-- lib/facebook_ads/ad_objects/ad_promoted_object.rb
-- lib/facebook_ads/ad_objects/ad_recommendation.rb
-- lib/facebook_ads/ad_objects/ad_recommendation_data.rb
-- lib/facebook_ads/ad_objects/ad_report_run.rb
-- lib/facebook_ads/ad_objects/ad_rule.rb
-- lib/facebook_ads/ad_objects/ad_rule_evaluation_spec.rb
-- lib/facebook_ads/ad_objects/ad_rule_execution_options.rb
-- lib/facebook_ads/ad_objects/ad_rule_execution_spec.rb
-- lib/facebook_ads/ad_objects/ad_rule_filters.rb
-- lib/facebook_ads/ad_objects/ad_rule_history.rb
-- lib/facebook_ads/ad_objects/ad_rule_history_result.rb
-- lib/facebook_ads/ad_objects/ad_rule_history_result_action.rb
-- lib/facebook_ads/ad_objects/ad_rule_schedule.rb
-- lib/facebook_ads/ad_objects/ad_rule_schedule_spec.rb
-- lib/facebook_ads/ad_objects/ad_rule_trigger.rb
-- lib/facebook_ads/ad_objects/ad_set.rb
-- lib/facebook_ads/ad_objects/ad_study.rb
-- lib/facebook_ads/ad_objects/ad_study_cell.rb
-- lib/facebook_ads/ad_objects/ad_study_objective.rb
-- lib/facebook_ads/ad_objects/ad_video.rb
-- lib/facebook_ads/ad_objects/adgroup_placement_specific_review_feedback.rb
-- lib/facebook_ads/ad_objects/adgroup_relevance_score.rb
-- lib/facebook_ads/ad_objects/adgroup_review_feedback.rb
-- lib/facebook_ads/ad_objects/ads_action_stats.rb
-- lib/facebook_ads/ad_objects/ads_data_partner.rb
-- lib/facebook_ads/ad_objects/ads_image_crops.rb
-- lib/facebook_ads/ad_objects/ads_insights.rb
-- lib/facebook_ads/ad_objects/ads_pixel.rb
-- lib/facebook_ads/ad_objects/ads_pixel_stats.rb
-- lib/facebook_ads/ad_objects/ads_pixel_stats_result.rb
-- lib/facebook_ads/ad_objects/agency_client_declaration.rb
-- lib/facebook_ads/ad_objects/android_app_link.rb
-- lib/facebook_ads/ad_objects/app_links.rb
-- lib/facebook_ads/ad_objects/broad_targeting_categories.rb
-- lib/facebook_ads/ad_objects/business.rb
-- lib/facebook_ads/ad_objects/business_ad_account_request.rb
-- lib/facebook_ads/ad_objects/business_page_request.rb
-- lib/facebook_ads/ad_objects/campaign.rb
-- lib/facebook_ads/ad_objects/check_batch_request_status.rb
-- lib/facebook_ads/ad_objects/conversion_action_query.rb
-- lib/facebook_ads/ad_objects/custom_audience.rb
-- lib/facebook_ads/ad_objects/custom_audience_ad_account.rb
-- lib/facebook_ads/ad_objects/custom_audience_data_source.rb
-- lib/facebook_ads/ad_objects/custom_audience_permission.rb
-- lib/facebook_ads/ad_objects/custom_audience_prefill_state.rb
-- lib/facebook_ads/ad_objects/custom_audience_session.rb
-- lib/facebook_ads/ad_objects/custom_audience_status.rb
-- lib/facebook_ads/ad_objects/custom_audiences_tos.rb
-- lib/facebook_ads/ad_objects/custom_conversion.rb
-- lib/facebook_ads/ad_objects/custom_conversion_stats_result.rb
-- lib/facebook_ads/ad_objects/day_part.rb
-- lib/facebook_ads/ad_objects/delivery_check.rb
-- lib/facebook_ads/ad_objects/delivery_check_extra_info.rb
-- lib/facebook_ads/ad_objects/delivery_estimate.rb
-- lib/facebook_ads/ad_objects/domain.rb
-- lib/facebook_ads/ad_objects/event.rb
-- lib/facebook_ads/ad_objects/event_source_group.rb
-- lib/facebook_ads/ad_objects/external_event_source.rb
-- lib/facebook_ads/ad_objects/flexible_targeting.rb
-- lib/facebook_ads/ad_objects/funding_source_details.rb
-- lib/facebook_ads/ad_objects/funding_source_details_coupon.rb
-- lib/facebook_ads/ad_objects/helpers/custom_audience_helpers.rb
-- lib/facebook_ads/ad_objects/hotel.rb
-- lib/facebook_ads/ad_objects/hotel_room.rb
-- lib/facebook_ads/ad_objects/id_name.rb
-- lib/facebook_ads/ad_objects/ios_app_link.rb
-- lib/facebook_ads/ad_objects/lead.rb
-- lib/facebook_ads/ad_objects/lead_gen_qualifier.rb
-- lib/facebook_ads/ad_objects/lead_gen_question.rb
-- lib/facebook_ads/ad_objects/lead_gen_question_option.rb
-- lib/facebook_ads/ad_objects/leadgen_form.rb
-- lib/facebook_ads/ad_objects/legacy_business_ad_account_request.rb
-- lib/facebook_ads/ad_objects/lookalike_spec.rb
-- lib/facebook_ads/ad_objects/minimum_budget.rb
-- lib/facebook_ads/ad_objects/offline_conversion_data_set.rb
-- lib/facebook_ads/ad_objects/offsite_pixel.rb
-- lib/facebook_ads/ad_objects/outcome_prediction_point.rb
-- lib/facebook_ads/ad_objects/partner_category.rb
-- lib/facebook_ads/ad_objects/product_catalog.rb
-- lib/facebook_ads/ad_objects/product_catalog_hotel_rooms_batch.rb
-- lib/facebook_ads/ad_objects/product_catalog_image_settings.rb
-- lib/facebook_ads/ad_objects/product_catalog_image_settings_operation.rb
-- lib/facebook_ads/ad_objects/product_catalog_pricing_variables_batch.rb
-- lib/facebook_ads/ad_objects/product_feed.rb
-- lib/facebook_ads/ad_objects/product_feed_schedule.rb
-- lib/facebook_ads/ad_objects/product_feed_upload.rb
-- lib/facebook_ads/ad_objects/product_feed_upload_error.rb
-- lib/facebook_ads/ad_objects/product_feed_upload_error_sample.rb
-- lib/facebook_ads/ad_objects/product_group.rb
-- lib/facebook_ads/ad_objects/product_item.rb
-- lib/facebook_ads/ad_objects/product_item_commerce_insights.rb
-- lib/facebook_ads/ad_objects/product_set.rb
-- lib/facebook_ads/ad_objects/product_variant.rb
-- lib/facebook_ads/ad_objects/profile_picture_source.rb
-- lib/facebook_ads/ad_objects/rate_card.rb
-- lib/facebook_ads/ad_objects/reach_estimate.rb
-- lib/facebook_ads/ad_objects/reach_frequency_prediction.rb
-- lib/facebook_ads/ad_objects/reach_frequency_spec.rb
-- lib/facebook_ads/ad_objects/rev_share_policy.rb
-- lib/facebook_ads/ad_objects/roas_cohorts_data.rb
-- lib/facebook_ads/ad_objects/roas_cohorts_per_cohort_interval_unit.rb
-- lib/facebook_ads/ad_objects/targeting.rb
-- lib/facebook_ads/ad_objects/targeting_dynamic_rule.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_city.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_custom_location.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_electoral_district.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_market.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_place.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_political_district.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_region.rb
-- lib/facebook_ads/ad_objects/targeting_geo_location_zip.rb
-- lib/facebook_ads/ad_objects/targeting_product_audience_spec.rb
-- lib/facebook_ads/ad_objects/targeting_product_audience_sub_spec.rb
-- lib/facebook_ads/ad_objects/targeting_sentence_line.rb
-- lib/facebook_ads/ad_objects/transaction.rb
-- lib/facebook_ads/ad_objects/transaction_currency_amount.rb
-- lib/facebook_ads/ad_objects/user.rb
-- lib/facebook_ads/ad_objects/user_lead_gen_disclaimer_response.rb
-- lib/facebook_ads/ad_objects/user_lead_gen_field_data.rb
-- lib/facebook_ads/ad_objects/video_thumbnail.rb
-- lib/facebook_ads/ad_objects/web_app_link.rb
-- lib/facebook_ads/ad_objects/windows_app_link.rb
-- lib/facebook_ads/ad_objects/windows_phone_app_link.rb
-- lib/facebook_ads/api_request.rb
-- lib/facebook_ads/api_response.rb
-- lib/facebook_ads/batch_api/batch.rb
-- lib/facebook_ads/batch_api/batch_proxy.rb
-- lib/facebook_ads/config.rb
-- lib/facebook_ads/edge.rb
-- lib/facebook_ads/errors.rb
-- lib/facebook_ads/field_types.rb
-- lib/facebook_ads/field_types/ad_object.rb
-- lib/facebook_ads/field_types/base.rb
-- lib/facebook_ads/field_types/boolean.rb
-- lib/facebook_ads/field_types/datetime.rb
-- lib/facebook_ads/field_types/double.rb
-- lib/facebook_ads/field_types/enum.rb
-- lib/facebook_ads/field_types/integer.rb
-- lib/facebook_ads/field_types/list.rb
-- lib/facebook_ads/field_types/object.rb
-- lib/facebook_ads/field_types/string_type.rb
-- lib/facebook_ads/field_types/upload_file.rb
-- lib/facebook_ads/fields.rb
-- lib/facebook_ads/helpers/edge_helpers.rb
-- lib/facebook_ads/helpers/node_helpers.rb
-- lib/facebook_ads/helpers/shortcuts.rb
-- lib/facebook_ads/param_set.rb
-- lib/facebook_ads/ruby2patch.rb
-- lib/facebook_ads/session.rb
-- lib/facebook_ads/utils/utils.rb
-- lib/facebook_ads/version.rb
-- lib/facebook_ads/videos/video_io.rb
-- lib/facebook_ads/videos/video_request.rb
-- lib/facebookads.rb
-homepage: https://github.com/facebook/facebook-ruby-ads-sdk
+files: []
+homepage: https://github.com/facebook/facebook-ruby-business-sdk
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message: This gem has been deprecated in favor of the updated facebookbusiness
+  gem. Please migrate to the facebookbusiness gem and this gem will be removed from
+  rubygems.org by July 2023
 rdoc_options: []
 require_paths:
 - lib
@@ -393,9 +37,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
-summary: Facebook Ads API SDK for Ruby (Official)
+summary: "[Deprecated] Please use facebookbusiness gem instead"
 test_files: []

data/LICENSE.txt

@@ -1,17 +0,0 @@
-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.

data/README.md

@@ -1,222 +0,0 @@
-# Facebook Ads API SDK for Ruby
-
-## Pre-requisites
-### Ruby Version
-We developed this SDK using Ruby 2.0, and supports Ruby 2.0+, however, the SDK is not thread-safe at the moment.
-
-### App
-To get started with the SDK you must have a Facebook app registered on [developers.facebook.com](https://developers.facebook.com).
-
-**IMPORTANT**: Enable all migrations in the App's Settings->Migrations page.
-
-**IMPORTANT**: To have better security, we recommend you to turn on 'App Secret Proof for Server API calls' in your app's Settings->Advanced page.
-
-## Installation
-The SDK is available as a RubyGem. To use the gem, you can add the following to Gemfile
-
-```ruby
-gem 'facebookads'
-```
-
-or install it using command line
-
-```bash
-gem install facebookads
-```
-
-and then in your code
-
-```ruby
-require 'facebook_ads'
-```
-
-
-## Configuration
-### Access Token
-There are several ways to configure access token and app secret. If you only use one access token and app secret (example: an internal app managing only your own assets). You can set a global access token and app secret will will be used across all requests
-
-```ruby
-FacebookAds.configure do |config|
-  config.access_token = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-  config.app_secret = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-end
-```
-
-Another way is to configure using environment variables, which will be picked up by the SDK as the default
-
-```bash
-FB_ACCESS_TOKEN=asdsadasds
-FB_APP_SECRET=asdasdsa
-```
-
-Or you can create a session object for particular object
-
-```ruby
-# Create a Session object to be reused
-session = FacebookAds::Session.new(access_token: <ACCESS_TOKEN>, app_secret: <APP SECRET>)
-ad_account = FacebookAds::AdAccount.get('act_12334', 'name', session)
-
-# Or a using shortcut during object instantiation
-ad_account = FacebookAds::AdAccount.get('act_12334', 'name', {
-    access_token: <ACCESS_TOKEN>, app_secret: <APP SECRET>
-})
-```
-
-## Basic Operations
-
-### Reading a node
-The SDK contains ad object files auto generated from our API metadata, each node type has its own corresponding Ruby class under the `FacebookAds` module. For example, to fetch an AdAccount
-
-```ruby
-ad_account = FacebookAds::AdAccount.get('act_1234567', 'name')
-puts "Ad Account Name: #{ad_account.name}"
-```
-
-The `#get` method doesn't trigger the `GET` request immediately. The API request for `GET` is fired on-demand. In the example above, API request won't fire until `ad_account.name` is executed.
-
-### Updating a node
-To update a node, you can use the `#save` method of ad object classes.
-
-```ruby
-ad_account = FacebookAds::AdAccount.get('act_1234567', 'name')
-ad_account.name = "New Ad Account"
-ad_account.save
-
-# Fetch it again
-ad_account.reload!
-ad_account.name
-=> "New Ad Account"
-```
-
-### Deleting a node
-To delete a node, you can use the `#destroy` method.
-
-```ruby
-campaign = FacebookAds::Campaign.get('<CAMPAIGN_ID>')
-campaign.destroy
-```
-
-### Reference
-You can refer to our [Marketing API reference](https://developers.facebook.com/docs/marketing-api/reference/) or look inside `lib/facebook_ads/ad_objects` directory of the code base to see the complete list of available ad objects.
-
-## Interacting with Edges
-
-To interact with an edge, you first need to instantiate the parent node. Since, as mentioned above, `GET` request of a node is triggered on-demand, so you don't need to worry about consuming unnecessary API quota.
-
-### Fetching Edges (GET)
-
-Iterating edges is easy, instantiate the parent nodes and then simply iterate with `#each`. The edge is an  `Enumerable` so a bunch of handy methods such as `#map`, `#select`, `#find` etc. come for free!
-
-```ruby
-ad_account = FacebookAds::AdAccount.get('act_1234567', 'name')
-
-# Printing all campaign names
-ad_account.campaigns(fields: 'name').each do |campaign|
-  puts campaign.name
-end
-
-# Getting all campaign names
-ad_account.campaigns(fields: 'name').map(&:name)
-
-```
-
-### Creating new nodes (POST)
-To `POST` to a edge, you can use the `#create` method on the edge and supply parameter if needed
-
-```ruby
-campaign = ad_account.campaigns.create({
-  name: "My First campaign",
-  objective: "CONVERSIONS",
-})
-```
-
-### Removing from edge (DELETE)
-To `DELETE` an edge, you can use the `#destroy` method on the edge and supply parameter if needed
-
-```ruby
-# Deleting an AdImage by its hash
-ad_account.adimages.destroy({hash: 'abcd1234'})
-```
-
-## Images/Videos
-The SDK supports image/video uploads. Just supply a parameter of `File` type.
-
-Image upload example:
-
-```ruby
-# AdImage supports multiple images upload
-ad_account.adimages.create({
-  'logo1.png' => File.open('./assets/logo1.jpg'),
-  'logo2.png' => File.open('./assets/logo2.jpg'),
-})
-=> [#<FacebookAds::AdImage {:hash=>"..."}>, #<FacebookAds::AdImage {:hash=>"..."}>]
-```
-
-Video upload example:
-
-```ruby
-ad_account.advideos.create({
-  name: 'My first video',
-  source: File.open(File.expand_path("../video_ad_example.mp4", __FILE__))
-})
-```
-
-## Batch API
-
-[Batch API](https://developers.facebook.com/docs/marketing-api/asyncrequests) allows you to make API calls in a batch. You can collect a bunch of API requests and fire them all at once to reduce wait time. To create a batch, just wrap operations with a block to `FacebookAds::Batch#with_batch`
-
-```ruby
-ad_account = FacebookAds::AdAccount.get('act_<ACT_ID>')
-
-batch = FacebookAds::Batch.with_batch do
-  10.times.map do |n|
-    ad_account.campaigns.create({
-      name: 'My Test Campaign #' + n,
-      objective: 'CONVERSIONS',
-      status: 'PAUSED',
-    })
-  end
-end
-
-batch.execute
-```
-
-### Dependencies within a batch (Experimental)
-Dependencies between requests is supported, the SDK simplifies the use of JSONPath references between batched operations.
-
-```ruby
-ad_account = FacebookAds::AdAccount.get('act_12334')
-
-batch = FacebookAds::Batch.with_batch do
-  # This won't be sent out immediately!
-  campaign = ad_account.campaigns.create({
-    name: 'My Test Campaign',
-    objective: 'CONVERSIONS',
-    status: 'PAUSED',
-  })
-
-  # Even the request above is not being sent yet, reference to campaign.id still works
-  ad_accounts.adsets.create({
-    name: 'My AdSet',
-    campaign_id: campaign.id, # campaign.id here will return {result=create-campaign:$.id}
-    ...
-    ...
-    ...
-  })
-end
-```
-
-## Logging
-
-```ruby
-FacebookAds.configure do |config|
-  # Logger for debugger
-  config.logger = ::Logger.new(STDOUT).tap { |d| d.level = Logger::DEBUG }
-
-  # Log Http request & response to logger
-  config.log_api_bodies = true
-end
-```
-
-## Reporting Bugs/Feedback
-Please raise any issue on GitHub.