From 215d2d7d3d5849d96b5793ec9145acfc756f3627 Mon Sep 17 00:00:00 2001 From: Recurly Integrations Date: Fri, 8 May 2026 18:29:09 +0000 Subject: [PATCH] Generated Latest Changes for v2021-02-25 --- lib/recurly/client/operations.rb | 1 - lib/recurly/requests/address.rb | 2 +- lib/recurly/requests/custom_field.rb | 8 ++++ lib/recurly/requests/invoice_address.rb | 2 +- .../requests/shipping_address_create.rb | 2 +- .../requests/shipping_address_update.rb | 2 +- lib/recurly/resources/address.rb | 2 +- lib/recurly/resources/address_with_name.rb | 2 +- lib/recurly/resources/custom_field.rb | 8 ++++ lib/recurly/resources/invoice.rb | 4 ++ lib/recurly/resources/invoice_address.rb | 2 +- lib/recurly/resources/shipping_address.rb | 2 +- openapi/api.yaml | 41 ++++++++++++++++--- 13 files changed, 64 insertions(+), 14 deletions(-) diff --git a/lib/recurly/client/operations.rb b/lib/recurly/client/operations.rb index 28a5d1af0..19b21fa65 100644 --- a/lib/recurly/client/operations.rb +++ b/lib/recurly/client/operations.rb @@ -2734,7 +2734,6 @@ def get_invoice_pdf(invoice_id:, **options) # # @param invoice_id [String] 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 params [Hash] Optional query string parameters: - # :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+. # # @return [Resources::Invoice] The updated invoice. # @example diff --git a/lib/recurly/requests/address.rb b/lib/recurly/requests/address.rb index d329e5ba8..1ca3d4394 100644 --- a/lib/recurly/requests/address.rb +++ b/lib/recurly/requests/address.rb @@ -15,7 +15,7 @@ class Address < Request define_attribute :country, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute phone diff --git a/lib/recurly/requests/custom_field.rb b/lib/recurly/requests/custom_field.rb index fbd989aa5..36a205e9f 100644 --- a/lib/recurly/requests/custom_field.rb +++ b/lib/recurly/requests/custom_field.rb @@ -10,6 +10,14 @@ class CustomField < Request # @return [String] Fields must be created in the UI before values can be assigned to them. define_attribute :name, String + # @!attribute source_record_id + # @return [String] The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record. + define_attribute :source_record_id, String + + # @!attribute source_record_type + # @return [String] The type of record this custom field was automatically copied from. Only present when the field was copied from another record. + define_attribute :source_record_type, String + # @!attribute value # @return [String] Any values that resemble a credit card number or security code (CVV/CVC) will be rejected. define_attribute :value, String diff --git a/lib/recurly/requests/invoice_address.rb b/lib/recurly/requests/invoice_address.rb index 1285004e7..426d39b06 100644 --- a/lib/recurly/requests/invoice_address.rb +++ b/lib/recurly/requests/invoice_address.rb @@ -23,7 +23,7 @@ class InvoiceAddress < Request define_attribute :first_name, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute last_name diff --git a/lib/recurly/requests/shipping_address_create.rb b/lib/recurly/requests/shipping_address_create.rb index 294bed073..d25a9f4db 100644 --- a/lib/recurly/requests/shipping_address_create.rb +++ b/lib/recurly/requests/shipping_address_create.rb @@ -27,7 +27,7 @@ class ShippingAddressCreate < Request define_attribute :first_name, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute last_name diff --git a/lib/recurly/requests/shipping_address_update.rb b/lib/recurly/requests/shipping_address_update.rb index e261de005..782cccf66 100644 --- a/lib/recurly/requests/shipping_address_update.rb +++ b/lib/recurly/requests/shipping_address_update.rb @@ -27,7 +27,7 @@ class ShippingAddressUpdate < Request define_attribute :first_name, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute id diff --git a/lib/recurly/resources/address.rb b/lib/recurly/resources/address.rb index ee92ff56f..d3a80381c 100644 --- a/lib/recurly/resources/address.rb +++ b/lib/recurly/resources/address.rb @@ -15,7 +15,7 @@ class Address < Resource define_attribute :country, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute phone diff --git a/lib/recurly/resources/address_with_name.rb b/lib/recurly/resources/address_with_name.rb index 1da328c91..4f63a376b 100644 --- a/lib/recurly/resources/address_with_name.rb +++ b/lib/recurly/resources/address_with_name.rb @@ -19,7 +19,7 @@ class AddressWithName < Resource define_attribute :first_name, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute last_name diff --git a/lib/recurly/resources/custom_field.rb b/lib/recurly/resources/custom_field.rb index 5ba94ac27..a62875c8e 100644 --- a/lib/recurly/resources/custom_field.rb +++ b/lib/recurly/resources/custom_field.rb @@ -10,6 +10,14 @@ class CustomField < Resource # @return [String] Fields must be created in the UI before values can be assigned to them. define_attribute :name, String + # @!attribute source_record_id + # @return [String] The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record. + define_attribute :source_record_id, String + + # @!attribute source_record_type + # @return [String] The type of record this custom field was automatically copied from. Only present when the field was copied from another record. + define_attribute :source_record_type, String + # @!attribute value # @return [String] Any values that resemble a credit card number or security code (CVV/CVC) will be rejected. define_attribute :value, String diff --git a/lib/recurly/resources/invoice.rb b/lib/recurly/resources/invoice.rb index 5922b635e..42c404e40 100644 --- a/lib/recurly/resources/invoice.rb +++ b/lib/recurly/resources/invoice.rb @@ -46,6 +46,10 @@ class Invoice < Resource # @return [String] 3-letter ISO 4217 currency code. define_attribute :currency, String + # @!attribute custom_fields + # @return [Array[CustomField]] 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. + define_attribute :custom_fields, Array, { :item_type => :CustomField } + # @!attribute customer_notes # @return [String] This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. define_attribute :customer_notes, String diff --git a/lib/recurly/resources/invoice_address.rb b/lib/recurly/resources/invoice_address.rb index 619158a87..654836e48 100644 --- a/lib/recurly/resources/invoice_address.rb +++ b/lib/recurly/resources/invoice_address.rb @@ -23,7 +23,7 @@ class InvoiceAddress < Resource define_attribute :first_name, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute last_name diff --git a/lib/recurly/resources/shipping_address.rb b/lib/recurly/resources/shipping_address.rb index 8a592b153..b850580ab 100644 --- a/lib/recurly/resources/shipping_address.rb +++ b/lib/recurly/resources/shipping_address.rb @@ -35,7 +35,7 @@ class ShippingAddress < Resource define_attribute :first_name, String # @!attribute geo_code - # @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration + # @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled. define_attribute :geo_code, String # @!attribute id diff --git a/openapi/api.yaml b/openapi/api.yaml index d03de7609..eb21fc3fd 100644 --- a/openapi/api.yaml +++ b/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