<?php

namespace Srmklive\PayPal\Traits\PayPalAPI;

trait InvoicesTemplates
{
    /**
     * Get list of invoice templates.
     *
     * @param string $fields
     *
     * @throws \Throwable
     *
     * @return array|\Psr\Http\Message\StreamInterface|string
     *
     * @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_list
     */
    public function listInvoiceTemplates(string $fields = 'all')
    {
        $this->apiEndPoint = "v2/invoicing/templates?page={$this->current_page}&page_size={$this->page_size}&fields={$fields}";

        $this->verb = 'get';

        return $this->doPayPalRequest();
    }

    /**
     * Create a new invoice template.
     *
     * @param array $data
     *
     * @throws \Throwable
     *
     * @return array|\Psr\Http\Message\StreamInterface|string
     *
     * @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_create
     */
    public function createInvoiceTemplate(array $data)
    {
        $this->apiEndPoint = 'v2/invoicing/templates';

        $this->options['json'] = $data;

        $this->verb = 'post';

        return $this->doPayPalRequest();
    }

    /**
     * Show details for an existing invoice.
     *
     * @param string $template_id
     *
     * @throws \Throwable
     *
     * @return array|\Psr\Http\Message\StreamInterface|string
     *
     * @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_get
     */
    public function showInvoiceTemplateDetails(string $template_id)
    {
        $this->apiEndPoint = "v2/invoicing/templates/{$template_id}";

        $this->verb = 'get';

        return $this->doPayPalRequest();
    }

    /**
     * Update an existing invoice template.
     *
     * @param string $template_id
     * @param array  $data
     *
     * @throws \Throwable
     *
     * @return array|\Psr\Http\Message\StreamInterface|string
     *
     * @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_update
     */
    public function updateInvoiceTemplate(string $template_id, array $data)
    {
        $this->apiEndPoint = "v2/invoicing/templates/{$template_id}";

        $this->options['json'] = $data;

        $this->verb = 'put';

        return $this->doPayPalRequest();
    }

    /**
     * Delete an invoice template.
     *
     * @param string $template_id
     *
     * @throws \Throwable
     *
     * @return array|\Psr\Http\Message\StreamInterface|string
     *
     * @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_delete
     */
    public function deleteInvoiceTemplate(string $template_id)
    {
        $this->apiEndPoint = "v2/invoicing/templates/{$template_id}";

        $this->verb = 'delete';

        return $this->doPayPalRequest(false);
    }
}

• [D] BillingPlans
• [D] InvoiceSearch
• [D] Orders
• [D] PaymentMethodsTokens
• [D] Subscriptions
• [F] BillingPlans.php
  Delete
• [F] CatalogProducts.php
  Delete
• [F] Disputes.php
  Delete
• [F] DisputesActions.php
  Delete
• [F] Identity.php
  Delete
• [F] Invoices.php
  Delete
• [F] InvoicesSearch.php
  Delete
• [F] InvoicesTemplates.php
  Delete
• [F] Orders.php
  Delete
• [F] PartnerReferrals.php
  Delete
• [F] PaymentAuthorizations.php
  Delete
• [F] PaymentCaptures.php
  Delete
• [F] PaymentExperienceWebProfiles.php
  Delete
• [F] PaymentMethodsTokens.php
  Delete
• [F] PaymentRefunds.php
  Delete
• [F] Payouts.php
  Delete
• [F] ReferencedPayouts.php
  Delete
• [F] Reporting.php
  Delete
• [F] Subscriptions.php
  Delete
• [F] Trackers.php
  Delete
• [F] WebHooks.php
  Delete
• [F] WebHooksEvents.php
  Delete
• [F] WebHooksVerification.php
  Delete

Developer

• Support

Back to Home page