facebookbusiness 0.3.1.1 → 0.3.1.5

data/lib/facebook_ads/ad_objects/crm_address.rb

@@ -0,0 +1,48 @@
+# 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 CrmAddress < AdObject
+
+    field :city, 'string'
+    field :cnpj_tax_id, 'string'
+    field :country, 'string'
+    field :id, 'string'
+    field :postal_code, 'string'
+    field :registration_label, 'string'
+    field :registration_number, 'string'
+    field :state, 'string'
+    field :street1, 'string'
+    field :street2, 'string'
+    field :street3, 'string'
+    field :street4, 'string'
+    field :validation_status, 'string'
+    field :vat_tax_id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/currency.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 Currency < AdObject
+
+    field :currency_exchange, 'double'
+    field :currency_exchange_inverse, 'double'
+    field :currency_offset, 'int'
+    field :usd_exchange, 'double'
+    field :usd_exchange_inverse, 'double'
+    field :user_currency, 'string'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/currency_amount.rb

@@ -0,0 +1,39 @@
+# 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 CurrencyAmount < AdObject
+
+    field :amount, 'string'
+    field :amount_in_hundredths, 'string'
+    field :currency, 'string'
+    field :offsetted_amount, 'string'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience.rb

@@ -28,11 +28,12 @@ module FacebookAds
   class CustomAudience < AdObject
     include CustomAudienceHelpers
     CLAIM_OBJECTIVE = [
-      "AUTO_OFFER",
+      "AUTOMOTIVE_MODEL",
       "HOME_LISTING",
       "PRODUCT",
       "TRAVEL",
       "VEHICLE",
+      "VEHICLE_OFFER",
     ]
 
     CONTENT_TYPE = [
@@ -70,83 +71,72 @@ module FacebookAds
       "FOX",
     ]
 
-    FIELDS = [
-      "account_id",
-      "customer_file_source",
-      "data_source",
-      "delivery_status",
-      "description",
-      "external_event_source",
-      "id",
-      "approximate_count",
-      "is_value_based",
-      "lookalike_audience_ids",
-      "lookalike_spec",
-      "name",
-      "operation_status",
-      "opt_out_link",
-      "permission_for_actions",
-      "pixel_id",
-      "retention_days",
-      "rule",
-      "rule_aggregation",
-      "sharing_status",
-      "subtype",
-      "time_content_updated",
-      "time_created",
-      "time_updated",
-    ]
-
 
     field :account_id, 'string'
     field :approximate_count, 'int'
     field :customer_file_source, 'string'
     field :data_source, 'CustomAudienceDataSource'
+    field :data_source_types, 'string'
     field :delivery_status, 'CustomAudienceStatus'
     field :description, 'string'
+    field :excluded_custom_audiences, { list: 'CustomAudience' }
+    field :expiry_time, 'int'
     field :external_event_source, 'AdsPixel'
+    field :household_audience, 'int'
     field :id, 'string'
+    field :included_custom_audiences, { list: 'CustomAudience' }
+    field :is_household, 'bool'
+    field :is_snapshot, 'bool'
     field :is_value_based, 'bool'
+    field :list_of_accounts, { list: 'string' }
     field :lookalike_audience_ids, { list: 'string' }
     field :lookalike_spec, 'LookalikeSpec'
     field :name, 'string'
     field :operation_status, 'CustomAudienceStatus'
     field :opt_out_link, 'string'
-    field :permission_for_actions, 'object'
+    field :permission_for_actions, 'AudiencePermissionForActions'
     field :pixel_id, 'string'
     field :retention_days, 'int'
+    field :rev_share_policy_id, 'int'
     field :rule, 'string'
     field :rule_aggregation, 'string'
+    field :rule_v2, 'string'
+    field :seed_audience, 'int'
     field :sharing_status, 'CustomAudienceSharingStatus'
+    field :study_spec, 'AudienceInsightsStudySpec'
     field :subtype, 'string'
     field :time_content_updated, 'int'
     field :time_created, 'int'
     field :time_updated, 'int'
+    field :creation_params, 'hash'
+    field :parent_audience_id, 'int'
+    field :tags, { list: 'string' }
+    field :associated_audience_id, 'int'
+    field :is_household_exclusion, 'bool'
     field :allowed_domains, { list: 'string' }
+    field :partner_reference_key, 'string'
+    field :prefill, 'bool'
+    field :inclusions, { list: 'object' }
+    field :exclusions, { list: 'object' }
+    field :countries, 'string'
+    field :origin_audience_id, 'string'
+    field :details, 'string'
+    field :source, 'string'
+    field :isprivate, 'bool'
+    field :additionalmetadata, 'string'
+    field :minage, 'int'
+    field :maxage, 'int'
+    field :expectedsize, 'int'
+    field :gender, 'string'
+    field :partnerid, 'string'
+    field :accountid, 'string'
     field :claim_objective, { enum: -> { CLAIM_OBJECTIVE }}
     field :content_type, { enum: -> { CONTENT_TYPE }}
-    field :dataset_id, 'string'
     field :event_source_group, 'string'
-    field :event_sources, { list: 'hash' }
-    field :list_of_accounts, { list: 'int' }
-    field :origin_audience_id, 'string'
-    field :prefill, 'bool'
     field :product_set_id, 'string'
-    field :associated_audience_id, 'int'
-    field :creation_params, 'hash'
-    field :exclusions, { list: 'object' }
-    field :inclusions, { list: 'object' }
-    field :parent_audience_id, 'int'
-    field :tags, { list: 'string' }
-
-    has_edge :ad_accounts do |edge|
-      edge.post 'AdAccount' do |api|
-        api.has_param :adaccounts, { list: 'string' }
-        api.has_param :permissions, 'string'
-        api.has_param :relationship_type, { list: 'string' }
-        api.has_param :replace, 'bool'
-      end
-    end
+    field :event_sources, { list: 'hash' }
+    field :video_group_ids, { list: 'string' }
+    field :dataset_id, 'string'
 
     has_edge :adaccounts do |edge|
       edge.delete do |api|
@@ -155,6 +145,12 @@ module FacebookAds
       edge.get 'AdAccount' do |api|
         api.has_param :permissions, 'string'
       end
+      edge.post 'CustomAudience' do |api|
+        api.has_param :adaccounts, { list: 'string' }
+        api.has_param :permissions, 'string'
+        api.has_param :replace, 'bool'
+        api.has_param :relationship_type, { list: 'string' }
+      end
     end
 
     has_edge :ads do |edge|
@@ -164,6 +160,28 @@ module FacebookAds
       end
     end
 
+    has_edge :capabilities do |edge|
+      edge.delete do |api|
+        api.has_param :adaccounts, { list: 'string' }
+      end
+      edge.post do |api|
+        api.has_param :accounts_capabilities, 'string'
+        api.has_param :relationship_type, { list: 'string' }
+      end
+    end
+
+    has_edge :data do |edge|
+      edge.post do |api|
+        api.has_param :action_type, { enum: %w{add remove match optout }}
+        api.has_param :encoding, { enum: %w{md5 sha256 plain }}
+        api.has_param :entry_type, { enum: %w{0 1 2 3 4 5 6 }}
+        api.has_param :entries, { list: 'string' }
+        api.has_param :session_id, 'int'
+        api.has_param :batch_seq, 'int'
+        api.has_param :last_batch_flag, 'bool'
+      end
+    end
+
     has_edge :prefills do |edge|
       edge.get 'CustomAudiencePrefillState'
     end
@@ -174,16 +192,33 @@ module FacebookAds
       end
     end
 
-    has_edge :users do |edge|
+    has_edge :shared_account_info do |edge|
+      edge.get 'CustomAudiencesharedAccountInfo'
+    end
+
+    has_edge :upload do |edge|
       edge.delete do |api|
-        api.has_param :namespace, 'string'
-        api.has_param :payload, 'object'
         api.has_param :session, 'object'
+        api.has_param :payload, 'object'
+        api.has_param :namespace, 'string'
       end
-      edge.post 'User' do |api|
+      edge.post 'CustomAudience' do |api|
+        api.has_param :session, 'object'
+        api.has_param :payload, 'object'
         api.has_param :namespace, 'string'
+      end
+    end
+
+    has_edge :users do |edge|
+      edge.delete do |api|
+        api.has_param :session, 'object'
         api.has_param :payload, 'object'
+        api.has_param :namespace, 'string'
+      end
+      edge.post 'CustomAudience' do |api|
         api.has_param :session, 'object'
+        api.has_param :payload, 'object'
+        api.has_param :namespace, 'string'
       end
     end
 

data/lib/facebook_ads/ad_objects/custom_audience_ad_account.rb

@@ -28,7 +28,6 @@ module FacebookAds
   class CustomAudienceAdAccount < AdObject
 
     field :id, 'string'
-    has_no_get
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/custom_audience_capabilities.rb

@@ -0,0 +1,36 @@
+# 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 CustomAudienceCapabilities < AdObject
+
+    field :capabilities, 'hash'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end

data/lib/facebook_ads/ad_objects/custom_audience_data_source.rb

@@ -73,6 +73,7 @@ module FacebookAds
       "PLATFORM_USERS",
       "MULTI_EVENT_SOURCE",
       "SMART_AUDIENCE",
+      "LOOKALIKE_PLATFORM",
       "MAIL_CHIMP_EMAIL_HASHES",
       "CONSTANT_CONTACTS_EMAIL_HASHES",
       "COPY_PASTE_EMAIL_HASHES",
@@ -95,8 +96,7 @@ module FacebookAds
     field :creation_params, 'string'
     field :sub_type, { enum: -> { SUB_TYPE }}
     field :type, { enum: -> { TYPE }}
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/custom_audience_prefill_state.rb

@@ -30,8 +30,7 @@ module FacebookAds
     field :description, 'string'
     field :num_added, 'int'
     field :status, 'string'
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/custom_audience_session.rb

@@ -35,8 +35,7 @@ module FacebookAds
     field :session_id, 'string'
     field :stage, 'string'
     field :start_time, 'string'
-    has_no_id
-    has_no_get
+    field :id, 'string'
     has_no_post
     has_no_delete
 

data/lib/facebook_ads/ad_objects/custom_audience_shared_account_campaign_info.rb

@@ -0,0 +1,43 @@
+# 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 CustomAudienceSharedAccountCampaignInfo < AdObject
+
+    field :account_id, 'string'
+    field :account_name, 'string'
+    field :adset_excluding_count, 'int'
+    field :adset_including_count, 'int'
+    field :campaign_delivery_status, 'string'
+    field :campaign_objective, 'string'
+    field :campaign_pages, { list: 'object' }
+    field :campaign_schedule, 'string'
+    field :id, 'string'
+    has_no_post
+    has_no_delete
+
+  end
+end