Generated Latest Changes for v2021-02-25

Author: Recurly Integrations

lib/recurly/resources/address.php

@@ -73,7 +73,7 @@ public function setCountry(string $country): void
 
     /**
     * Getter method for the geo_code attribute.
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     *
     * @return ?string
     */

lib/recurly/resources/address_with_name.php

@@ -98,7 +98,7 @@ public function setFirstName(string $first_name): void
 
     /**
     * Getter method for the geo_code attribute.
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     *
     * @return ?string
     */

lib/recurly/resources/custom_field.php

@@ -13,6 +13,8 @@
 class CustomField extends RecurlyResource
 {
     private $_name;
+    private $_source_record_id;
+    private $_source_record_type;
     private $_value;
 
     protected static $array_hints = [
@@ -42,6 +44,52 @@ public function setName(string $name): void
         $this->_name = $name;
     }
 
+    /**
+    * Getter method for the source_record_id attribute.
+    * The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
+    *
+    * @return ?string
+    */
+    public function getSourceRecordId(): ?string
+    {
+        return $this->_source_record_id;
+    }
+
+    /**
+    * Setter method for the source_record_id attribute.
+    *
+    * @param string $source_record_id
+    *
+    * @return void
+    */
+    public function setSourceRecordId(string $source_record_id): void
+    {
+        $this->_source_record_id = $source_record_id;
+    }
+
+    /**
+    * Getter method for the source_record_type attribute.
+    * The type of record this custom field was automatically copied from. Only present when the field was copied from another record.
+    *
+    * @return ?string
+    */
+    public function getSourceRecordType(): ?string
+    {
+        return $this->_source_record_type;
+    }
+
+    /**
+    * Setter method for the source_record_type attribute.
+    *
+    * @param string $source_record_type
+    *
+    * @return void
+    */
+    public function setSourceRecordType(string $source_record_type): void
+    {
+        $this->_source_record_type = $source_record_type;
+    }
+
     /**
     * Getter method for the value attribute.
     * Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.

lib/recurly/resources/invoice.php

@@ -22,6 +22,7 @@ class Invoice extends RecurlyResource
     private $_created_at;
     private $_credit_payments;
     private $_currency;
+    private $_custom_fields;
     private $_customer_notes;
     private $_discount;
     private $_due_at;
@@ -60,6 +61,7 @@ class Invoice extends RecurlyResource
 
     protected static $array_hints = [
         'setCreditPayments' => '\Recurly\Resources\CreditPayment',
+        'setCustomFields' => '\Recurly\Resources\CustomField',
         'setLineItems' => '\Recurly\Resources\LineItem',
         'setSubscriptionIds' => 'string',
         'setTransactions' => '\Recurly\Resources\Transaction',
@@ -296,6 +298,29 @@ public function setCurrency(string $currency): void
         $this->_currency = $currency;
     }
 
+    /**
+    * Getter method for the custom_fields attribute.
+    * A list of custom fields that were on the account at the time of invoice creation and were marked to be displayed on invoices. Read-only; cannot be set directly on the invoice.
+    *
+    * @return array
+    */
+    public function getCustomFields(): array
+    {
+        return $this->_custom_fields ?? [] ;
+    }
+
+    /**
+    * Setter method for the custom_fields attribute.
+    *
+    * @param array $custom_fields
+    *
+    * @return void
+    */
+    public function setCustomFields(array $custom_fields): void
+    {
+        $this->_custom_fields = $custom_fields;
+    }
+
     /**
     * Getter method for the customer_notes attribute.
     * This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.

lib/recurly/resources/invoice_address.php

@@ -123,7 +123,7 @@ public function setFirstName(string $first_name): void
 
     /**
     * Getter method for the geo_code attribute.
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     *
     * @return ?string
     */

lib/recurly/resources/shipping_address.php

@@ -199,7 +199,7 @@ public function setFirstName(string $first_name): void
 
     /**
     * Getter method for the geo_code attribute.
-    * Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+    * Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
     *
     * @return ?string
     */

openapi/api.yaml

@@ -9245,7 +9245,6 @@ paths:
       description: Apply credit payment to the outstanding balance on an existing
         charge invoice from an account’s available balance from existing credit invoices.
       parameters:
-      - "$ref": "#/components/parameters/site_id"
       - "$ref": "#/components/parameters/invoice_id"
       responses:
         '200':
@@ -18621,7 +18620,7 @@ components:
           type: string
           maxLength: 20
           description: Code that represents a geographic entity (location or object).
-            Only returned for Sling Vertex Integration
+            Only returned when Vertex or Avalara for Communications is enabled.
     AddressWithName:
       allOf:
       - "$ref": "#/components/schemas/Address"
@@ -20195,6 +20194,19 @@ components:
           description: Any values that resemble a credit card number or security code
             (CVV/CVC) will be rejected.
           maxLength: 255
+        source_record_type:
+          type: string
+          title: Source record type
+          description: The type of record this custom field was automatically copied
+            from. Only present when the field was copied from another record.
+          readOnly: true
+          "$ref": "#/components/schemas/SourceRecordTypeEnum"
+        source_record_id:
+          type: string
+          title: Source record ID
+          description: The UUID of the record this custom field was automatically
+            copied from. Only present when the field was copied from another record.
+          readOnly: true
       required:
       - name
       - value
@@ -20206,6 +20218,15 @@ components:
         remove a field send the name with a null or empty value.
       items:
         "$ref": "#/components/schemas/CustomField"
+    InvoiceCustomFields:
+      type: array
+      title: Custom fields
+      description: A list of custom fields that were on the account at the time of
+        invoice creation and were marked to be displayed on invoices. Read-only; cannot
+        be set directly on the invoice.
+      readOnly: true
+      items:
+        "$ref": "#/components/schemas/CustomField"
     CustomFieldDefinition:
       type: object
       title: Custom field definition
@@ -21084,6 +21105,8 @@ components:
           title: Business Entity ID
           description: Unique ID to identify the business entity assigned to the invoice.
             Available when the `Multiple Business Entities` feature is enabled.
+        custom_fields:
+          "$ref": "#/components/schemas/InvoiceCustomFields"
     InvoiceCreate:
       type: object
       properties:
@@ -22735,7 +22758,7 @@ components:
           type: string
           maxLength: 20
           description: Code that represents a geographic entity (location or object).
-            Only returned for Sling Vertex Integration
+            Only returned when Vertex or Avalara for Communications is enabled.
         created_at:
           type: string
           title: Created at
@@ -22823,7 +22846,7 @@ components:
           type: string
           maxLength: 20
           description: Code that represents a geographic entity (location or object).
-            Only returned for Sling Vertex Integration
+            Only returned when Vertex or Avalara for Communications is enabled.
         country:
           type: string
           maxLength: 50
@@ -23154,7 +23177,7 @@ components:
           type: string
           maxLength: 20
           description: Code that represents a geographic entity (location or object).
-            Only returned for Sling Vertex Integration
+            Only returned when Vertex or Avalara for Communications is enabled.
     Site:
       type: object
       properties:
@@ -28104,3 +28127,11 @@ components:
       enum:
       - customer
       - merchant
+    SourceRecordTypeEnum:
+      type: string
+      description: The type of record a custom field was automatically copied from.
+      enum:
+      - account
+      - plan
+      - product
+      - subscription