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

462 lines
12 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\CommerceOrderFields;
use FacebookPixelPlugin\FacebookAds\Object\Values\CommerceOrderFiltersValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\CommerceOrderReasonCodeValues;
use FacebookPixelPlugin\FacebookAds\Object\Values\CommerceOrderStateValues;
/**
* 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 CommerceOrder extends AbstractCrudObject {
/**
* @return CommerceOrderFields
*/
public static function getFieldsEnum() {
return CommerceOrderFields::getInstance();
}
protected static function getReferencedEnums() {
$ref_enums = array();
$ref_enums['Filters'] = CommerceOrderFiltersValues::getInstance()->getValues();
$ref_enums['State'] = CommerceOrderStateValues::getInstance()->getValues();
$ref_enums['ReasonCode'] = CommerceOrderReasonCodeValues::getInstance()->getValues();
return $ref_enums;
}
public function createAcknowledgeOrder(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'idempotency_key' => 'string',
'merchant_order_reference' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/acknowledge_order',
new CommerceOrder(),
'EDGE',
CommerceOrder::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getCancellations(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,
'/cancellations',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createCancellation(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'cancel_reason' => 'map',
'idempotency_key' => 'string',
'items' => 'list<map>',
'restock_items' => 'bool',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/cancellations',
new CommerceOrder(),
'EDGE',
CommerceOrder::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createItemUpdate(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'items' => 'list<map>',
'merchant_order_reference' => 'string',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/item_updates',
new CommerceOrder(),
'EDGE',
CommerceOrder::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getItems(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,
'/items',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getPayments(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,
'/payments',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getPromotionDetails(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,
'/promotion_details',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getPromoTIOns(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,
'/promotions',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getRefunds(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,
'/refunds',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createRefund(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'adjustment_amount' => 'map',
'deductions' => 'list<map>',
'idempotency_key' => 'string',
'items' => 'list<map>',
'reason_code' => 'reason_code_enum',
'reason_text' => 'string',
'return_id' => 'string',
'shipping' => 'map',
);
$enums = array(
'reason_code_enum' => CommerceOrderReasonCodeValues::getInstance()->getValues(),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/refunds',
new CommerceOrder(),
'EDGE',
CommerceOrder::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getReturns(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'merchant_return_id' => 'string',
'statuses' => 'list<statuses_enum>',
);
$enums = array(
'statuses_enum' => array(
'APPROVED',
'DISAPPROVED',
'MERCHANT_MARKED_COMPLETED',
'REFUNDED',
'REQUESTED',
),
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_GET,
'/returns',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createReturn(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'items' => 'list<map>',
'merchant_return_id' => 'string',
'return_message' => 'string',
'update' => 'map',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/returns',
new CommerceOrder(),
'EDGE',
CommerceOrder::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function getShipments(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,
'/shipments',
new AbstractCrudObject(),
'EDGE',
array(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createShipment(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'external_redemption_link' => 'string',
'external_shipment_id' => 'string',
'fulfillment' => 'map',
'idempotency_key' => 'string',
'items' => 'list<map>',
'merchant_order_reference' => 'string',
'shipment_origin_postal_code' => 'string',
'shipping_tax_details' => 'map',
'should_use_default_fulfillment_location' => 'bool',
'tracking_info' => 'map',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/shipments',
new CommerceOrder(),
'EDGE',
CommerceOrder::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
public function createUpdateShipment(array $fields = array(), array $params = array(), $pending = false) {
$this->assureId();
$param_types = array(
'external_shipment_id' => 'string',
'fulfillment_id' => 'string',
'idempotency_key' => 'string',
'shipment_id' => 'string',
'tracking_info' => 'map',
);
$enums = array(
);
$request = new ApiRequest(
$this->api,
$this->data['id'],
RequestInterface::METHOD_POST,
'/update_shipment',
new CommerceOrder(),
'EDGE',
CommerceOrder::getFieldsEnum()->getValues(),
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 CommerceOrder(),
'NODE',
CommerceOrder::getFieldsEnum()->getValues(),
new TypeChecker($param_types, $enums)
);
$request->addParams($params);
$request->addFields($fields);
return $pending ? $request : $request->execute();
}
}