Files
2026-04-28 15:13:50 +02:00

550 lines
15 KiB
PHP

<?php
/*
* 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.
*/
namespace FacebookPixelPlugin\FacebookAds\Object;
use FacebookPixelPlugin\FacebookAds\ApiRequest;
use FacebookPixelPlugin\FacebookAds\Cursor;
use FacebookPixelPlugin\FacebookAds\Http\RequestInterface;
use FacebookPixelPlugin\FacebookAds\TypeChecker;
use FacebookPixelPlugin\FacebookAds\Object\Fields\ProductFeedFields;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedDelimiterValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedEncodingValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedFeedTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedIngestionSourceTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedItemSubTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedOverrideTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedQuotedFieldsModeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductFeedRuleRuleTypeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductItemErrorPriorityValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\ProductItemErrorTypeValues;
/**
* 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 ProductFeed extends AbstractCrudObject {
/**
* @deprecated getEndpoint function is deprecated
*/
protected function getEndpoint() {
return 'product_feeds';
}
/**
* @return ProductFeedFields
*/
public static function getFieldsEnum() {
return ProductFeedFields::getInstance();
}
protected static function getReferencedEnums() {
$ref_enums = array();
$ref_enums['Delimiter'] = ProductFeedDelimiterValues::getInstance()->getValues();
$ref_enums['IngestionSourceType'] = ProductFeedIngestionSourceTypeValues::getInstance()->getValues();
$ref_enums['QuotedFieldsMode'] = ProductFeedQuotedFieldsModeValues::getInstance()->getValues();
$ref_enums['Encoding'] = ProductFeedEncodingValues::getInstance()->getValues();
$ref_enums['FeedType'] = ProductFeedFeedTypeValues::getInstance()->getValues();
$ref_enums['ItemSubType'] = ProductFeedItemSubTypeValues::getInstance()->getValues();
$ref_enums['OverrideType'] = ProductFeedOverrideTypeValues::getInstance()->getValues();
return $ref_enums;
}
public function getAutomotiveModels(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/automotive_models',
new AutomotiveModel(),
'EDGE',
AutomotiveModel::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getDestinations(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/destinations',
new Destination(),
'EDGE',
Destination::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getFlights(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/flights',
new Flight(),
'EDGE',
Flight::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getHomeListings(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/home_listings',
new HomeListing(),
'EDGE',
HomeListing::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getHotels(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/hotels',
new Hotel(),
'EDGE',
Hotel::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getMediaTitles(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/media_titles',
new MediaTitle(),
'EDGE',
MediaTitle::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getProducts(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'error_priority' => 'error_priority_enum',
'error_type' => 'error_type_enum',
'filter' => 'Object',
);
$enums = array(
'error_priority_enum' => ProductItemErrorPriorityValues::getInstance()->getValues(),
'error_type_enum' => ProductItemErrorTypeValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/products',
new ProductItem(),
'EDGE',
ProductItem::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getRules(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/rules',
new ProductFeedRule(),
'EDGE',
ProductFeedRule::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createRule(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'attribute' => 'string',
'params' => 'map',
'rule_type' => 'rule_type_enum',
);
$enums = array(
'rule_type_enum' => ProductFeedRuleRuleTypeValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/rules',
new ProductFeedRule(),
'EDGE',
ProductFeedRule::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createSupplementaryFeedAssoc(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'assoc_data' => 'list<map>',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/supplementary_feed_assocs',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getUploadSchedules(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/upload_schedules',
new ProductFeedSchedule(),
'EDGE',
ProductFeedSchedule::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createUploadSchedule(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'upload_schedule' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/upload_schedules',
new ProductFeed(),
'EDGE',
ProductFeed::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getUploads(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/uploads',
new ProductFeedUpload(),
'EDGE',
ProductFeedUpload::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createUpload(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'fbe_external_business_id' => 'string',
'file' => 'file',
'password' => 'string',
'update_only' => 'bool',
'url' => 'string',
'username' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/uploads',
new ProductFeedUpload(),
'EDGE',
ProductFeedUpload::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getVehicleOffers(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/vehicle_offers',
new VehicleOffer(),
'EDGE',
VehicleOffer::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getVehicles(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'bulk_pagination' => 'bool',
'filter' => 'Object',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/vehicles',
new Vehicle(),
'EDGE',
Vehicle::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function deleteSelf(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_DELETE,
'/',
new AbstractCrudObject(),
'NODE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getSelf(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/',
new ProductFeed(),
'NODE',
ProductFeed::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function updateSelf(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'default_currency' => 'string',
'deletion_enabled' => 'bool',
'delimiter' => 'delimiter_enum',
'encoding' => 'encoding_enum',
'migrated_from_feed_id' => 'string',
'name' => 'string',
'quoted_fields_mode' => 'quoted_fields_mode_enum',
'schedule' => 'string',
'update_schedule' => 'string',
);
$enums = array(
'delimiter_enum' => ProductFeedDelimiterValues::getInstance()->getValues(),
'encoding_enum' => ProductFeedEncodingValues::getInstance()->getValues(),
'quoted_fields_mode_enum' => ProductFeedQuotedFieldsModeValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/',
new ProductFeed(),
'NODE',
ProductFeed::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
}