FM / Api

/home/techb158/ileadtechnology.com/SSM/vendor/paypal/rest-api-sdk-php/lib/PayPal/Api/

/home/techb158/ileadtechnology.com/SSM/vendor/paypal/rest-api-sdk-php/lib/PayPal/Api

Name	Size	Mode	Actions
Address.php	1085	0644	edit dl rm
Agreement.php	20513	0644	edit dl rm
AgreementDetails.php	4787	0644	edit dl rm
AgreementStateDescriptor.php	1149	0644	edit dl rm
AgreementTransaction.php	4893	0644	edit dl rm
AgreementTransactions.php	1935	0644	edit dl rm
AlternatePayment.php	2230	0644	edit dl rm
Amount.php	2298	0644	edit dl rm
Authorization.php	15801	0644	edit dl rm
BankAccount.php	14348	0644	edit dl rm
BankAccountsList.php	2632	0644	edit dl rm
BankToken.php	2036	0644	edit dl rm
BaseAddress.php	4219	0644	edit dl rm
Billing.php	794	0644	edit dl rm
BillingAgreementToken.php	310	0644	edit dl rm
BillingInfo.php	5376	0644	edit dl rm
CancelNotification.php	3680	0644	edit dl rm
Capture.php	9086	0644	edit dl rm
CarrierAccount.php	3042	0644	edit dl rm
CarrierAccountToken.php	1432	0644	edit dl rm
CartBase.php	9380	0644	edit dl rm
ChargeModel.php	1570	0644	edit dl rm
Cost.php	1417	0644	edit dl rm
CountryCode.php	942	0644	edit dl rm
CreateProfileResponse.php	603	0644	edit dl rm
Credit.php	1089	0644	edit dl rm
CreditCard.php	15414	0644	edit dl rm
CreditCardHistory.php	1849	0644	edit dl rm
CreditCardList.php	2629	0644	edit dl rm
CreditCardToken.php	4032	0644	edit dl rm
CreditFinancingOffered.php	3989	0644	edit dl rm
Currency.php	1475	0644	edit dl rm
CurrencyConversion.php	5533	0644	edit dl rm
CustomAmount.php	1251	0644	edit dl rm
DetailedRefund.php	4550	0644	edit dl rm
Details.php	5818	0644	edit dl rm
Error.php	6985	0644	edit dl rm
ErrorDetails.php	2092	0644	edit dl rm
ExtendedBankAccount.php	978	0644	edit dl rm
ExternalFunding.php	3320	0644	edit dl rm
FileAttachment.php	1138	0644	edit dl rm
FlowConfig.php	3122	0644	edit dl rm
FmfDetails.php	2405	0644	edit dl rm
FundingDetail.php	2380	0644	edit dl rm
FundingInstrument.php	7737	0644	edit dl rm
FundingOption.php	4998	0644	edit dl rm
FundingSource.php	6362	0644	edit dl rm
FuturePayment.php	1560	0644	edit dl rm
HyperSchema.php	3380	0644	edit dl rm
Image.php	1011	0644	edit dl rm
Incentive.php	4431	0644	edit dl rm
InputFields.php	3104	0644	edit dl rm
InstallmentInfo.php	3106	0644	edit dl rm
InstallmentOption.php	2189	0644	edit dl rm
Invoice.php	37040	0644	edit dl rm
InvoiceAddress.php	667	0644	edit dl rm
InvoiceItem.php	5117	0644	edit dl rm
InvoiceNumber.php	585	0644	edit dl rm
InvoiceSearchResponse.php	1821	0644	edit dl rm
Item.php	9845	0644	edit dl rm
ItemList.php	3502	0644	edit dl rm
Links.php	2517	0644	edit dl rm
Measurement.php	1076	0644	edit dl rm
MerchantInfo.php	5638	0644	edit dl rm
MerchantPreferences.php	6075	0644	edit dl rm
Metadata.php	5450	0644	edit dl rm
NameValuePair.php	1185	0644	edit dl rm
Notification.php	3125	0644	edit dl rm
OpenIdAddress.php	2451	0644	edit dl rm
OpenIdError.php	1852	0644	edit dl rm
OpenIdSession.php	3783	0644	edit dl rm
OpenIdTokeninfo.php	8268	0644	edit dl rm
OpenIdUserinfo.php	11161	0644	edit dl rm
Order.php	13574	0644	edit dl rm
OverrideChargeModel.php	1192	0644	edit dl rm
Participant.php	4153	0644	edit dl rm
Patch.php	2233	0644	edit dl rm
PatchRequest.php	1847	0644	edit dl rm
Payee.php	3531	0644	edit dl rm
Payer.php	7830	0644	edit dl rm
PayerInfo.php	9231	0644	edit dl rm
Payment.php	19738	0644	edit dl rm
PaymentCard.php	10053	0644	edit dl rm
PaymentCardToken.php	3394	0644	edit dl rm
PaymentDefinition.php	5022	0644	edit dl rm
PaymentDetail.php	4557	0644	edit dl rm
PaymentExecution.php	2817	0644	edit dl rm
PaymentHistory.php	2526	0644	edit dl rm
PaymentInstruction.php	4662	0644	edit dl rm
PaymentOptions.php	2259	0644	edit dl rm
PaymentSummary.php	1142	0644	edit dl rm
PaymentTerm.php	1649	0644	edit dl rm
Payout.php	4977	0644	edit dl rm
PayoutBatch.php	2433	0644	edit dl rm
PayoutBatchHeader.php	5464	0644	edit dl rm
PayoutItem.php	6453	0644	edit dl rm
PayoutItemDetails.php	5946	0644	edit dl rm
PayoutSenderBatchHeader.php	5251	0644	edit dl rm
Phone.php	1575	0644	edit dl rm
Plan.php	12099	0644	edit dl rm
PlanList.php	3249	0644	edit dl rm
PotentialPayerInfo.php	2442	0644	edit dl rm
Presentation.php	4582	0644	edit dl rm
PrivateLabelCard.php	3118	0644	edit dl rm
ProcessorResponse.php	3776	0644	edit dl rm
RecipientBankingInstruction.php	3230	0644	edit dl rm
RedirectUrls.php	1667	0644	edit dl rm
Refund.php	7148	0644	edit dl rm
RefundDetail.php	3245	0644	edit dl rm
RefundRequest.php	3720	0644	edit dl rm
RelatedResources.php	2467	0644	edit dl rm
Sale.php	18640	0644	edit dl rm
Search.php	12541	0644	edit dl rm
ShippingAddress.php	2216	0644	edit dl rm
ShippingCost.php	1179	0644	edit dl rm
ShippingInfo.php	3008	0644	edit dl rm
Tax.php	2174	0644	edit dl rm
Template.php	7860	0644	edit dl rm
TemplateData.php	15162	0644	edit dl rm
Templates.php	6947	0644	edit dl rm
TemplateSettings.php	1410	0644	edit dl rm
TemplateSettingsMetadata.php	705	0644	edit dl rm
Terms.php	3138	0644	edit dl rm
Transaction.php	1402	0644	edit dl rm
TransactionBase.php	943	0644	edit dl rm
Transactions.php	612	0644	edit dl rm
VerifyWebhookSignature.php	7306	0644	edit dl rm
VerifyWebhookSignatureResponse.php	890	0644	edit dl rm
Webhook.php	8182	0644	edit dl rm
WebhookEvent.php	9305	0644	edit dl rm
WebhookEventList.php	3053	0644	edit dl rm
WebhookEventType.php	3350	0644	edit dl rm
WebhookEventTypeList.php	1530	0644	edit dl rm
WebhookList.php	1344	0644	edit dl rm
WebProfile.php	8675	0644	edit dl rm

Edit: /home/techb158/ileadtechnology.com/SSM/vendor/paypal/rest-api-sdk-php/lib/PayPal/Api/Sale.php (18640B)

<?php

namespace PayPal\Api;

use PayPal\Common\PayPalResourceModel;
use PayPal\Validation\ArgumentValidator;
use PayPal\Rest\ApiContext;

/**
 * Class Sale
 *
 * A sale transaction. This is the resource that is returned as a part related resources in Payment
 *
 * @package PayPal\Api
 *
 * @property string id
 * @property string purchase_unit_reference_id
 * @property \PayPal\Api\Amount amount
 * @property string payment_mode
 * @property string state
 * @property string reason_code
 * @property string protection_eligibility
 * @property string protection_eligibility_type
 * @property string clearing_time
 * @property string payment_hold_status
 * @property string[] payment_hold_reasons
 * @property \PayPal\Api\Currency transaction_fee
 * @property \PayPal\Api\Currency receivable_amount
 * @property string exchange_rate
 * @property \PayPal\Api\FmfDetails fmf_details
 * @property string receipt_id
 * @property string parent_payment
 * @property \PayPal\Api\ProcessorResponse processor_response
 * @property string billing_agreement_id
 * @property string create_time
 * @property string update_time
 * @property \PayPal\Api\Links[] links
 */
class Sale extends PayPalResourceModel
{
    /**
     * Identifier of the sale transaction.
     *
     * @param string $id
     * 
     * @return $this
     */
    public function setId($id)
    {
        $this->id = $id;
        return $this;
    }

/**
     * Identifier of the sale transaction.
     *
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

/**
     * Identifier to the purchase or transaction unit corresponding to this sale transaction.
     *
     * @param string $purchase_unit_reference_id
     * 
     * @return $this
     */
    public function setPurchaseUnitReferenceId($purchase_unit_reference_id)
    {
        $this->purchase_unit_reference_id = $purchase_unit_reference_id;
        return $this;
    }

/**
     * Identifier to the purchase or transaction unit corresponding to this sale transaction.
     *
     * @return string
     */
    public function getPurchaseUnitReferenceId()
    {
        return $this->purchase_unit_reference_id;
    }

/**
     * Amount being collected.
     *
     * @param \PayPal\Api\Amount $amount
     * 
     * @return $this
     */
    public function setAmount($amount)
    {
        $this->amount = $amount;
        return $this;
    }

/**
     * Amount being collected.
     *
     * @return \PayPal\Api\Amount
     */
    public function getAmount()
    {
        return $this->amount;
    }

/**
     * Specifies payment mode of the transaction. Only supported when the `payment_method` is set to `paypal`.
     * Valid Values: ["INSTANT_TRANSFER", "MANUAL_BANK_TRANSFER", "DELAYED_TRANSFER", "ECHECK"]
     *
     * @param string $payment_mode
     * 
     * @return $this
     */
    public function setPaymentMode($payment_mode)
    {
        $this->payment_mode = $payment_mode;
        return $this;
    }

/**
     * Specifies payment mode of the transaction. Only supported when the `payment_method` is set to `paypal`.
     *
     * @return string
     */
    public function getPaymentMode()
    {
        return $this->payment_mode;
    }

/**
     * State of the sale transaction.
     * Valid Values: ["completed", "partially_refunded", "pending", "refunded", "denied"]
     *
     * @param string $state
     * 
     * @return $this
     */
    public function setState($state)
    {
        $this->state = $state;
        return $this;
    }

/**
     * State of the sale transaction.
     *
     * @return string
     */
    public function getState()
    {
        return $this->state;
    }

/**
     * Reason code for the transaction state being Pending or Reversed. Only supported when the `payment_method` is set to `paypal`.
     * Valid Values: ["CHARGEBACK", "GUARANTEE", "BUYER_COMPLAINT", "REFUND", "UNCONFIRMED_SHIPPING_ADDRESS", "ECHECK", "INTERNATIONAL_WITHDRAWAL", "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION", "PAYMENT_REVIEW", "REGULATORY_REVIEW", "UNILATERAL", "VERIFICATION_REQUIRED", "TRANSACTION_APPROVED_AWAITING_FUNDING"]
     *
     * @param string $reason_code
     * 
     * @return $this
     */
    public function setReasonCode($reason_code)
    {
        $this->reason_code = $reason_code;
        return $this;
    }

/**
     * Reason code for the transaction state being Pending or Reversed. Only supported when the `payment_method` is set to `paypal`.
     *
     * @return string
     */
    public function getReasonCode()
    {
        return $this->reason_code;
    }

/**
     * The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`. 
     * Valid Values: ["ELIGIBLE", "PARTIALLY_ELIGIBLE", "INELIGIBLE"]
     *
     * @param string $protection_eligibility
     * 
     * @return $this
     */
    public function setProtectionEligibility($protection_eligibility)
    {
        $this->protection_eligibility = $protection_eligibility;
        return $this;
    }

/**
     * The level of seller protection in force for the transaction. Only supported when the `payment_method` is set to `paypal`. 
     *
     * @return string
     */
    public function getProtectionEligibility()
    {
        return $this->protection_eligibility;
    }

/**
     * The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the `payment_method` is set to `paypal`.
     * Valid Values: ["ITEM_NOT_RECEIVED_ELIGIBLE", "UNAUTHORIZED_PAYMENT_ELIGIBLE", "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"]
     *
     * @param string $protection_eligibility_type
     * 
     * @return $this
     */
    public function setProtectionEligibilityType($protection_eligibility_type)
    {
        $this->protection_eligibility_type = $protection_eligibility_type;
        return $this;
    }

/**
     * The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the `payment_method` is set to `paypal`.
     *
     * @return string
     */
    public function getProtectionEligibilityType()
    {
        return $this->protection_eligibility_type;
    }

/**
     * Expected clearing time for eCheck Transactions. Returned when payment is made with eCheck. Only supported when the `payment_method` is set to `paypal`.
     *
     * @param string $clearing_time
     * 
     * @return $this
     */
    public function setClearingTime($clearing_time)
    {
        $this->clearing_time = $clearing_time;
        return $this;
    }

/**
     * Expected clearing time for eCheck Transactions. Returned when payment is made with eCheck. Only supported when the `payment_method` is set to `paypal`.
     *
     * @return string
     */
    public function getClearingTime()
    {
        return $this->clearing_time;
    }

/**
     * Status of the Recipient Fund. For now, it will be returned only when fund status is held
     * Valid Values: ["HELD"]
     *
     * @param string $payment_hold_status
     * 
     * @return $this
     */
    public function setPaymentHoldStatus($payment_hold_status)
    {
        $this->payment_hold_status = $payment_hold_status;
        return $this;
    }

/**
     * Status of the Recipient Fund. For now, it will be returned only when fund status is held
     *
     * @return string
     */
    public function getPaymentHoldStatus()
    {
        return $this->payment_hold_status;
    }

/**
     * Reasons for PayPal holding recipient fund. It is set only if payment hold status is held
     *
     * @param string[] $payment_hold_reasons
     * 
     * @return $this
     */
    public function setPaymentHoldReasons($payment_hold_reasons)
    {
        $this->payment_hold_reasons = $payment_hold_reasons;
        return $this;
    }

/**
     * Reasons for PayPal holding recipient fund. It is set only if payment hold status is held
     *
     * @return string[]
     */
    public function getPaymentHoldReasons()
    {
        return $this->payment_hold_reasons;
    }

/**
     * Append PaymentHoldReasons to the list.
     *
     * @param string $string
     * @return $this
     */
    public function addPaymentHoldReason($string)
    {
        if (!$this->getPaymentHoldReasons()) {
            return $this->setPaymentHoldReasons(array($string));
        } else {
            return $this->setPaymentHoldReasons(
                array_merge($this->getPaymentHoldReasons(), array($string))
            );
        }
    }

/**
     * Remove PaymentHoldReasons from the list.
     *
     * @param string $string
     * @return $this
     */
    public function removePaymentHoldReason($string)
    {
        return $this->setPaymentHoldReasons(
            array_diff($this->getPaymentHoldReasons(), array($string))
        );
    }

/**
     * Transaction fee applicable for this payment.
     *
     * @param \PayPal\Api\Currency $transaction_fee
     * 
     * @return $this
     */
    public function setTransactionFee($transaction_fee)
    {
        $this->transaction_fee = $transaction_fee;
        return $this;
    }

/**
     * Transaction fee applicable for this payment.
     *
     * @return \PayPal\Api\Currency
     */
    public function getTransactionFee()
    {
        return $this->transaction_fee;
    }

/**
     * Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
     *
     * @param \PayPal\Api\Currency $receivable_amount
     * 
     * @return $this
     */
    public function setReceivableAmount($receivable_amount)
    {
        $this->receivable_amount = $receivable_amount;
        return $this;
    }

/**
     * Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
     *
     * @return \PayPal\Api\Currency
     */
    public function getReceivableAmount()
    {
        return $this->receivable_amount;
    }

/**
     * Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
     *
     * @param string $exchange_rate
     * 
     * @return $this
     */
    public function setExchangeRate($exchange_rate)
    {
        $this->exchange_rate = $exchange_rate;
        return $this;
    }

/**
     * Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer.
     *
     * @return string
     */
    public function getExchangeRate()
    {
        return $this->exchange_rate;
    }

/**
     * Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](/docs/classic/fmf/integration-guide/FMFSummary/) for more information.
     *
     * @param \PayPal\Api\FmfDetails $fmf_details
     * 
     * @return $this
     */
    public function setFmfDetails($fmf_details)
    {
        $this->fmf_details = $fmf_details;
        return $this;
    }

/**
     * Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See [Fraud Management Filters Summary](/docs/classic/fmf/integration-guide/FMFSummary/) for more information.
     *
     * @return \PayPal\Api\FmfDetails
     */
    public function getFmfDetails()
    {
        return $this->fmf_details;
    }

/**
     * Receipt id is a payment identification number returned for guest users to identify the payment.
     *
     * @param string $receipt_id
     * 
     * @return $this
     */
    public function setReceiptId($receipt_id)
    {
        $this->receipt_id = $receipt_id;
        return $this;
    }

/**
     * Receipt id is a payment identification number returned for guest users to identify the payment.
     *
     * @return string
     */
    public function getReceiptId()
    {
        return $this->receipt_id;
    }

/**
     * ID of the payment resource on which this transaction is based.
     *
     * @param string $parent_payment
     * 
     * @return $this
     */
    public function setParentPayment($parent_payment)
    {
        $this->parent_payment = $parent_payment;
        return $this;
    }

/**
     * ID of the payment resource on which this transaction is based.
     *
     * @return string
     */
    public function getParentPayment()
    {
        return $this->parent_payment;
    }

/**
     * Response codes returned by the processor concerning the submitted payment. Only supported when the `payment_method` is set to `credit_card`.
     *
     * @param \PayPal\Api\ProcessorResponse $processor_response
     * 
     * @return $this
     */
    public function setProcessorResponse($processor_response)
    {
        $this->processor_response = $processor_response;
        return $this;
    }

/**
     * Response codes returned by the processor concerning the submitted payment. Only supported when the `payment_method` is set to `credit_card`.
     *
     * @return \PayPal\Api\ProcessorResponse
     */
    public function getProcessorResponse()
    {
        return $this->processor_response;
    }

/**
     * ID of the billing agreement used as reference to execute this transaction.
     *
     * @param string $billing_agreement_id
     * 
     * @return $this
     */
    public function setBillingAgreementId($billing_agreement_id)
    {
        $this->billing_agreement_id = $billing_agreement_id;
        return $this;
    }

/**
     * ID of the billing agreement used as reference to execute this transaction.
     *
     * @return string
     */
    public function getBillingAgreementId()
    {
        return $this->billing_agreement_id;
    }

/**
     * Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
     *
     * @param string $create_time
     * 
     * @return $this
     */
    public function setCreateTime($create_time)
    {
        $this->create_time = $create_time;
        return $this;
    }

/**
     * Time of sale as defined in [RFC 3339 Section 5.6](http://tools.ietf.org/html/rfc3339#section-5.6)
     *
     * @return string
     */
    public function getCreateTime()
    {
        return $this->create_time;
    }

/**
     * Time the resource was last updated in UTC ISO8601 format.
     *
     * @param string $update_time
     * 
     * @return $this
     */
    public function setUpdateTime($update_time)
    {
        $this->update_time = $update_time;
        return $this;
    }

/**
     * Time the resource was last updated in UTC ISO8601 format.
     *
     * @return string
     */
    public function getUpdateTime()
    {
        return $this->update_time;
    }

/**
     * Shows details for a sale, by ID. Returns only sales that were created through the REST API.
     *
     * @param string $saleId
     * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
     * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
     * @return Sale
     */
    public static function get($saleId, $apiContext = null, $restCall = null)
    {
        ArgumentValidator::validate($saleId, 'saleId');
        $payLoad = "";
        $json = self::executeCall(
            "/v1/payments/sale/$saleId",
            "GET",
            $payLoad,
            null,
            $apiContext,
            $restCall
        );
        $ret = new Sale();
        $ret->fromJson($json);
        return $ret;
    }

/**
     * Refund a completed payment by passing the sale_id in the request URI. In addition, include an empty JSON payload in the request body for a full refund. For a partial refund, include an amount object in the request body.
     *
     * @deprecated Please use #refundSale instead.
     * @param Refund         $refund
     * @param ApiContext     $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
     * @param PayPalRestCall $restCall   is the Rest Call Service that is used to make rest calls
     * @return Refund
     */
    public function refund($refund, $apiContext = null, $restCall = null)
    {
        ArgumentValidator::validate($this->getId(), "Id");
        ArgumentValidator::validate($refund, 'refund');
        $payLoad = $refund->toJSON();
        $json = self::executeCall(
            "/v1/payments/sale/{$this->getId()}/refund",
            "POST",
            $payLoad,
            null,
            $apiContext,
            $restCall
        );
        $ret = new Refund();
        $ret->fromJson($json);
        return $ret;
    }

/**
     * Refunds a sale, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an `amount` object in the JSON request body.
     *
     * @param RefundRequest $refundRequest
     * @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
     * @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
     * @return DetailedRefund
     */
    public function refundSale($refundRequest, $apiContext = null, $restCall = null)
    {
        ArgumentValidator::validate($this->getId(), "Id");
        ArgumentValidator::validate($refundRequest, 'refundRequest');
        $payLoad = $refundRequest->toJSON();
        $json = self::executeCall(
            "/v1/payments/sale/{$this->getId()}/refund",
            "POST",
            $payLoad,
            null,
            $apiContext,
            $restCall
        );
        $ret = new DetailedRefund();
        $ret->fromJson($json);
        return $ret;
    }
}

cmd: