Generated Latest Changes for v2019-10-10

Author: Recurly Integrations

lib/recurly/client.php

@@ -295,6 +295,21 @@ public function verifyBillingInfo(string $account_id, array $body = []): \Recurl
         return $this->makeRequest('POST', $path, $body, null);
     }
 
+    /**
+     * Verify an account's credit card billing cvv
+     *
+     * @param string $account_id Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.
+     * @param array  $body       The body of the request.
+     *
+     * @return \Recurly\Resources\Transaction Transaction information from verify.
+     * @link   https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_info_cvv
+     */
+    public function verifyBillingInfoCvv(string $account_id, array $body): \Recurly\Resources\Transaction
+    {
+        $path = $this->interpolatePath("/accounts/{account_id}/billing_info/verify_cvv", ['account_id' => $account_id]);
+        return $this->makeRequest('POST', $path, $body, null);
+    }
+  
     /**
      * Get the list of billing information associated with an account
      *
@@ -392,6 +407,38 @@ public function removeABillingInfo(string $account_id, string $billing_info_id):
         return $this->makeRequest('DELETE', $path, null, null);
     }
 
+    /**
+     * Verify a billing information's credit card
+     *
+     * @param string $account_id      Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.
+     * @param string $billing_info_id Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
+     * @param array  $body            The body of the request.
+     *
+     * @return \Recurly\Resources\Transaction Transaction information from verify.
+     * @link   https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_infos
+     */
+    public function verifyBillingInfos(string $account_id, string $billing_info_id, array $body = []): \Recurly\Resources\Transaction
+    {
+        $path = $this->interpolatePath("/accounts/{account_id}/billing_infos/{billing_info_id}/verify", ['account_id' => $account_id, 'billing_info_id' => $billing_info_id]);
+        return $this->makeRequest('POST', $path, $body, null);
+    }
+  
+    /**
+     * Verify a billing information's credit card cvv
+     *
+     * @param string $account_id      Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.
+     * @param string $billing_info_id Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
+     * @param array  $body            The body of the request.
+     *
+     * @return \Recurly\Resources\Transaction Transaction information from verify.
+     * @link   https://developers.recurly.com/api/v2019-10-10#operation/verify_billing_infos_cvv
+     */
+    public function verifyBillingInfosCvv(string $account_id, string $billing_info_id, array $body): \Recurly\Resources\Transaction
+    {
+        $path = $this->interpolatePath("/accounts/{account_id}/billing_infos/{billing_info_id}/verify_cvv", ['account_id' => $account_id, 'billing_info_id' => $billing_info_id]);
+        return $this->makeRequest('POST', $path, $body, null);
+    }
+  
     /**
      * List the coupon redemptions for an account
      *
@@ -1423,7 +1470,7 @@ public function listInvoices(array $options = []): \Recurly\Pager
     /**
      * Fetch an invoice
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Resources\Invoice An invoice.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/get_invoice
@@ -1437,7 +1484,7 @@ public function getInvoice(string $invoice_id): \Recurly\Resources\Invoice
     /**
      * Update an invoice
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      * @param array  $body       The body of the request.
      *
      * @return \Recurly\Resources\Invoice An invoice.
@@ -1452,7 +1499,7 @@ public function putInvoice(string $invoice_id, array $body): \Recurly\Resources\
     /**
      * Fetch an invoice as a PDF
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Resources\BinaryFile An invoice as a PDF.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/get_invoice_pdf
@@ -1466,7 +1513,7 @@ public function getInvoicePdf(string $invoice_id): \Recurly\Resources\BinaryFile
     /**
      * Apply available credit to a pending or past due charge invoice
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Resources\Invoice The updated invoice.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/apply_credit_balance
@@ -1480,7 +1527,7 @@ public function applyCreditBalance(string $invoice_id): \Recurly\Resources\Invoi
     /**
      * Collect a pending or past due, automatic invoice
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      * @param array  $body       The body of the request.
      *
      * @return \Recurly\Resources\Invoice The updated invoice.
@@ -1495,7 +1542,7 @@ public function collectInvoice(string $invoice_id, array $body = []): \Recurly\R
     /**
      * Mark an open invoice as failed
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Resources\Invoice The updated invoice.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/fail_invoice
@@ -1509,7 +1556,7 @@ public function failInvoice(string $invoice_id): \Recurly\Resources\Invoice
     /**
      * Mark an open invoice as successful
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Resources\Invoice The updated invoice.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/mark_invoice_successful
@@ -1523,7 +1570,7 @@ public function markInvoiceSuccessful(string $invoice_id): \Recurly\Resources\In
     /**
      * Reopen a closed, manual invoice
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Resources\Invoice The updated invoice.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/reopen_invoice
@@ -1537,7 +1584,7 @@ public function reopenInvoice(string $invoice_id): \Recurly\Resources\Invoice
     /**
      * Void a credit invoice.
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Resources\Invoice The updated invoice.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/void_invoice
@@ -1551,7 +1598,7 @@ public function voidInvoice(string $invoice_id): \Recurly\Resources\Invoice
     /**
      * Record an external payment for a manual invoices.
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      * @param array  $body       The body of the request.
      *
      * @return \Recurly\Resources\Transaction The recorded transaction.
@@ -1566,7 +1613,7 @@ public function recordExternalTransaction(string $invoice_id, array $body): \Rec
     /**
      * List an invoice's line items
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      * @param array  $options    Associative array of optional parameters
      *
      * Supported optional query string parameters:
@@ -1607,7 +1654,7 @@ public function listInvoiceLineItems(string $invoice_id, array $options = []): \
     /**
      * List the coupon redemptions applied to an invoice
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      * @param array  $options    Associative array of optional parameters
      *
      * Supported optional query string parameters:
@@ -1643,7 +1690,7 @@ public function listInvoiceCouponRedemptions(string $invoice_id, array $options
     /**
      * List an invoice's related credit or charge invoices
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      *
      * @return \Recurly\Pager A list of the credit or charge invoices associated with the invoice.
      * @link   https://developers.recurly.com/api/v2019-10-10#operation/list_related_invoices
@@ -1657,7 +1704,7 @@ public function listRelatedInvoices(string $invoice_id): \Recurly\Pager
     /**
      * Refund an invoice
      *
-     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
+     * @param string $invoice_id Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`
      * @param array  $body       The body of the request.
      *
      * @return \Recurly\Resources\Invoice Returns the new credit invoice.

lib/recurly/resources/add_on.php

@@ -507,7 +507,7 @@ public function setState(string $state): void
 
     /**
     * Getter method for the tax_code attribute.
-    * Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+    * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
     *
     * @return ?string
     */

lib/recurly/resources/invoice.php

@@ -39,6 +39,7 @@ class Invoice extends RecurlyResource
     private $_state;
     private $_subscription_ids;
     private $_subtotal;
+    private $_subtotal_after_discount;
     private $_tax;
     private $_tax_info;
     private $_terms_and_conditions;
@@ -678,6 +679,29 @@ public function setSubtotal(float $subtotal): void
         $this->_subtotal = $subtotal;
     }
 
+    /**
+    * Getter method for the subtotal_after_discount attribute.
+    * The summation of charges and credits, after discounts applied.
+    *
+    * @return ?float
+    */
+    public function getSubtotalAfterDiscount(): ?float
+    {
+        return $this->_subtotal_after_discount;
+    }
+
+    /**
+    * Setter method for the subtotal_after_discount attribute.
+    *
+    * @param float $subtotal_after_discount
+    *
+    * @return void
+    */
+    public function setSubtotalAfterDiscount(float $subtotal_after_discount): void
+    {
+        $this->_subtotal_after_discount = $subtotal_after_discount;
+    }
+
     /**
     * Getter method for the tax attribute.
     * The total tax on this invoice.

lib/recurly/resources/item.php

@@ -384,7 +384,7 @@ public function setState(string $state): void
 
     /**
     * Getter method for the tax_code attribute.
-    * Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+    * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
     *
     * @return ?string
     */

lib/recurly/resources/line_item.php

@@ -164,7 +164,7 @@ public function setAddOnId(string $add_on_id): void
 
     /**
     * Getter method for the amount attribute.
-    * `(quantity * unit_amount) - (discount + tax)`
+    * `(quantity * unit_amount) - discount + tax`
     *
     * @return ?float
     */
@@ -1066,7 +1066,7 @@ public function setTax(float $tax): void
 
     /**
     * Getter method for the tax_code attribute.
-    * Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+    * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
     *
     * @return ?string
     */

lib/recurly/resources/plan.php

@@ -611,7 +611,7 @@ public function setState(string $state): void
 
     /**
     * Getter method for the tax_code attribute.
-    * Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+    * Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
     *
     * @return ?string
     */