recurly 4.42.0 → 4.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7802ac249c077300036dea6ac4488f55df9c12d1483c6a9f56183cb85b49af66
-  data.tar.gz: 69689a9e956ca294bbadc961b9980f075a84ca1fd0d96afffbc6dfde773a8e70
+  metadata.gz: a6f7b9520933bcb659ed347252df909d49e49ea5b44c05f62e4e63abe5b344ee
+  data.tar.gz: 83d581c701db2790bc9522357594f713f54a0616f94df81e16d8fc97dacbc49d
 SHA512:
-  metadata.gz: 94c751bb78e2d1a3f67eabfcee1b9b61ec0d27465d7f05e1ba7e720e9991545867087fa6f18318e4f4dc96db1b0906644de4e9034ed752369f541672c4e983a6
-  data.tar.gz: 91fad41e3162d3e16770ca2d46aea058e51c115e606be885e1905160207379b9b5058246895a88dd457aeee04763790254339116cd43b805570a2fb646373dcc
+  metadata.gz: dc77ed0330c88e1b883dd90052709f03e8bbf8445e5dae3465098a4e69ae48c2c3fdc7eca3ca6a1e48466815d1f635510983bf6b342e8284f4d441a76ab74837
+  data.tar.gz: 5408f63bce4954ec15b459d9d05fabfa6e4f50d4dcb419eddaee3dc0553f97f8399c23d27b2de20582505fff54220a94468475f7e7559e0bd6a3d0f04a38942c

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.42.0
+current_version = 4.44.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/.github/codeql/codeql-config.yml

@@ -0,0 +1,13 @@
+#  Recurly Security and Quality checks
+#  
+#  Customize this file for your project.
+#  Contact the application security team in slack/security channel for assistance.
+#  https://coda.io/d/Information-Security_dDTWpZde3Uu/GitHub-Advanced-Security_suXj4#_lu8Xf
+#  https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan
+name: "Recurly Security Tests"
+query-filters:
+#  - exclude:
+#      id: js/redundant-query
+paths-ignore:
+  - '**/node_modules'
+  - '**/*test*'

data/.github/workflows/codeql.yml

@@ -0,0 +1,68 @@
+# Managed by Security
+# Documentation: https://coda.io/d/Information-Security_dDTWpZde3Uu/GitHub-Advanced-Security_suXj4#_lu8Xf
+# Contact us in the security slack channel for concerns
+name: "Security check - CodeQL"
+
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    branches:
+      - staging
+      - main
+      - master
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby', 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        config-file: ./.github/codeql/codeql-config.yml
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        queries: + security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      continue-on-error: true
+      with:
+        category: "/language:${{matrix.language}}"

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.44.0](https://github.com/recurly/recurly-client-ruby/tree/4.44.0) (2023-12-06)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.43.0...4.44.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (External Payment Phases) [#869](https://github.com/recurly/recurly-client-ruby/pull/869) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.43.0](https://github.com/recurly/recurly-client-ruby/tree/4.43.0) (2023-11-07)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.42.0...4.43.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#867](https://github.com/recurly/recurly-client-ruby/pull/867) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.42.0](https://github.com/recurly/recurly-client-ruby/tree/4.42.0) (2023-08-29)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.41.0...4.42.0)

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 4.42'
+gem 'recurly', '~> 4.44'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client/operations.rb

@@ -4433,6 +4433,41 @@ module Recurly
       get(path, **options)
     end
 
+    # List the external payment phases on an external subscription
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscription_external_payment_phases list_external_subscription_external_payment_phases api documentation}
+    #
+    # @param external_subscription_id [String] External subscription id
+    # @param params [Hash] Optional query string parameters:
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    #   order. In descending order updated records will move behind the cursor and could
+    #   prevent some records from being returned.
+    #
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #
+    # @return [Pager<Resources::ExternalPaymentPhase>] A list of the the external_payment_phases on a site.
+    #
+    def list_external_subscription_external_payment_phases(external_subscription_id:, **options)
+      path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_payment_phases", external_subscription_id: external_subscription_id)
+      pager(path, **options)
+    end
+
+    # Fetch an external payment_phase
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription_external_payment_phase get_external_subscription_external_payment_phase api documentation}
+    #
+    # @param external_subscription_id [String] External subscription id
+    # @param external_payment_phase_id [String] External payment phase ID, e.g. +a34ypb2ef9w1+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalPaymentPhase] Details for an external payment_phase.
+    #
+    def get_external_subscription_external_payment_phase(external_subscription_id:, external_payment_phase_id:, **options)
+      path = interpolate_path("/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}", external_subscription_id: external_subscription_id, external_payment_phase_id: external_payment_phase_id)
+      get(path, **options)
+    end
+
     # List entitlements granted to an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}

data/lib/recurly/requests/account_create.rb

@@ -59,7 +59,7 @@ module Recurly
       define_attribute :first_name, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Enterprise plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Elite plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
       define_attribute :invoice_template_id, String
 
       # @!attribute last_name

data/lib/recurly/requests/account_purchase.rb

@@ -59,7 +59,7 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Enterprise plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Elite plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
       define_attribute :invoice_template_id, String
 
       # @!attribute last_name

data/lib/recurly/requests/account_update.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :first_name, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Enterprise plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      #   @return [String] Unique ID to identify an invoice template.  Available when the site is on a Pro or Elite plan.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
       define_attribute :invoice_template_id, String
 
       # @!attribute last_name

data/lib/recurly/requests/address.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute phone
       #   @return [String] Phone number
       define_attribute :phone, String

data/lib/recurly/requests/billing_info_create.rb

@@ -102,6 +102,10 @@ module Recurly
       #   @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
       define_attribute :primary_payment_method, :Boolean
 
+      # @!attribute roku_billing_agreement_id
+      #   @return [String] Roku's CIB if billing through Roku
+      define_attribute :roku_billing_agreement_id, String
+
       # @!attribute routing_number
       #   @return [String] The bank's rounting number. (ACH only)
       define_attribute :routing_number, String

data/lib/recurly/requests/invoice_address.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] First name
       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
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/requests/shipping_address_create.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String]
       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
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/shipping_address_update.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String]
       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
+      define_attribute :geo_code, String
+
       # @!attribute id
       #   @return [String] Shipping Address ID
       define_attribute :id, String

data/lib/recurly/requests/subscription_create.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
       define_attribute :customer_notes, String
 
+      # @!attribute gateway_code
+      #   @return [String] If present, this subscription's transactions will use the payment gateway with this code.
+      define_attribute :gateway_code, String
+
       # @!attribute gift_card_redemption_code
       #   @return [String] A gift card redemption code to be redeemed on the purchase invoice.
       define_attribute :gift_card_redemption_code, String

data/lib/recurly/resources/account.rb

@@ -95,7 +95,7 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute invoice_template_id
-      #   @return [String] Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
+      #   @return [String] Unique ID to identify an invoice template. Available when the site is on a Pro or Elite plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
       define_attribute :invoice_template_id, String
 
       # @!attribute last_name

data/lib/recurly/resources/address.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned for Sling Vertex Integration
+      define_attribute :geo_code, String
+
       # @!attribute phone
       #   @return [String] Phone number
       define_attribute :phone, String

data/lib/recurly/resources/address_with_name.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] First name
       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
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/resources/external_payment_phase.rb

@@ -0,0 +1,70 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class ExternalPaymentPhase < Resource
+
+      # @!attribute amount
+      #   @return [String] Allows up to 9 decimal places
+      define_attribute :amount, String
+
+      # @!attribute created_at
+      #   @return [DateTime] When the external subscription was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute ending_billing_period_index
+      #   @return [Integer] Ending Billing Period Index
+      define_attribute :ending_billing_period_index, Integer
+
+      # @!attribute ends_at
+      #   @return [DateTime] Ends At
+      define_attribute :ends_at, DateTime
+
+      # @!attribute external_subscription
+      #   @return [ExternalSubscription] Subscription from an external resource such as Apple App Store or Google Play Store.
+      define_attribute :external_subscription, :ExternalSubscription
+
+      # @!attribute id
+      #   @return [String] System-generated unique identifier for an external payment phase ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute offer_name
+      #   @return [String] Name of the discount offer given, e.g. "introductory"
+      define_attribute :offer_name, String
+
+      # @!attribute offer_type
+      #   @return [String] Type of discount offer given, e.g. "FREE_TRIAL"
+      define_attribute :offer_type, String
+
+      # @!attribute period_count
+      #   @return [Integer] Number of billing periods
+      define_attribute :period_count, Integer
+
+      # @!attribute period_length
+      #   @return [String] Billing cycle length
+      define_attribute :period_length, String
+
+      # @!attribute started_at
+      #   @return [DateTime] Started At
+      define_attribute :started_at, DateTime
+
+      # @!attribute starting_billing_period_index
+      #   @return [Integer] Starting Billing Period Index
+      define_attribute :starting_billing_period_index, Integer
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the external subscription was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/invoice.rb

@@ -139,7 +139,7 @@ module Recurly
       define_attribute :tax, Float
 
       # @!attribute tax_info
-      #   @return [TaxInfo] Tax info
+      #   @return [TaxInfo] Only for merchants using Recurly's In-The-Box taxes.
       define_attribute :tax_info, :TaxInfo
 
       # @!attribute terms_and_conditions

data/lib/recurly/resources/invoice_address.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] First name
       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
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/resources/line_item.rb

@@ -191,7 +191,7 @@ module Recurly
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute tax_info
-      #   @return [TaxInfo] Tax info
+      #   @return [TaxInfo] Only for merchants using Recurly's In-The-Box taxes.
       define_attribute :tax_info, :TaxInfo
 
       # @!attribute taxable

data/lib/recurly/resources/shipping_address.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String]
       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
+      define_attribute :geo_code, String
+
       # @!attribute id
       #   @return [String] Shipping Address ID
       define_attribute :id, String

data/lib/recurly/resources/subscription.rb

@@ -175,7 +175,7 @@ module Recurly
       define_attribute :subtotal, Float
 
       # @!attribute tax
-      #   @return [Float] Estimated tax
+      #   @return [Float] Only for merchants using Recurly's In-The-Box taxes.
       define_attribute :tax, Float
 
       # @!attribute tax_inclusive
@@ -183,7 +183,7 @@ module Recurly
       define_attribute :tax_inclusive, :Boolean
 
       # @!attribute tax_info
-      #   @return [TaxInfo] Tax info
+      #   @return [TaxInfo] Only for merchants using Recurly's In-The-Box taxes.
       define_attribute :tax_info, :TaxInfo
 
       # @!attribute terms_and_conditions

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.42.0"
+  VERSION = "4.44.0"
 end

data/openapi/api.yaml

@@ -207,6 +207,7 @@ x-tagGroups:
   - external_products
   - external_accounts
   - external_product_references
+  - external_payment_phases
 - name: Products and Promotions
   tags:
   - item
@@ -366,6 +367,11 @@ tags:
   x-displayName: External Product Reference
   description: Associates an external product to a corresponding resource on an external
     platform like the Apple App Store or Google Play Store.
+- name: external_payment_phases
+  x-displayName: External Payment Phase
+  description: Details of payments in the lifecycle of a subscription from an external
+    resource that is not managed by the Recurly platform, e.g. App Store or Google
+    Play Store.
 - name: gift_cards
   x-displayName: Gift Cards
   description: Add gift card purchases to your checkout and allow gift card recipients
@@ -15918,6 +15924,69 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/external_subscriptions/{external_subscription_id}/external_payment_phases":
+    parameters:
+    - "$ref": "#/components/parameters/external_subscription_id"
+    get:
+      tags:
+      - external_subscriptions
+      operationId: list_external_subscription_external_payment_phases
+      summary: List the external payment phases on an external subscription
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/sort_dates"
+      - "$ref": "#/components/parameters/limit"
+      - "$ref": "#/components/parameters/order"
+      responses:
+        '200':
+          description: A list of the the external_payment_phases on a site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalPaymentPhaseList"
+        '404':
+          description: Incorrect site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id}":
+    parameters:
+    - "$ref": "#/components/parameters/external_subscription_id"
+    - "$ref": "#/components/parameters/external_payment_phase_id"
+    get:
+      tags:
+      - external_payment_phases
+      operationId: get_external_subscription_external_payment_phase
+      summary: Fetch an external payment_phase
+      responses:
+        '200':
+          description: Details for an external payment_phase.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalPaymentPhase"
+        '404':
+          description: Incorrect site or external subscription ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/accounts/{account_id}/entitlements":
     parameters:
     - "$ref": "#/components/parameters/account_id"
@@ -16355,6 +16424,13 @@ components:
       required: true
       schema:
         type: string
+    external_payment_phase_id:
+      name: external_payment_phase_id
+      in: path
+      description: External payment phase ID, e.g. `a34ypb2ef9w1`.
+      required: true
+      schema:
+        type: string
     invoice_template_id:
       name: invoice_template_id
       in: path
@@ -17256,8 +17332,8 @@ components:
           type: string
           title: Invoice Template ID
           description: Unique ID to identify an invoice template.  Available when
-            the site is on a Pro or Enterprise plan.  Used to specify which invoice
-            template, if any, should be used to generate invoices for the account.
+            the site is on a Pro or Elite plan.  Used to specify which invoice template,
+            if any, should be used to generate invoices for the account.
         address:
           "$ref": "#/components/schemas/Address"
         billing_info:
@@ -17355,10 +17431,10 @@ components:
           type: string
           title: Invoice Template ID
           description: Unique ID to identify an invoice template. Available when the
-            site is on a Pro or Enterprise plan. Used to specify if a non-default
-            invoice template will be used to generate invoices for the account. For
-            sites without multiple invoice templates enabled, the default template
-            will always be used.
+            site is on a Pro or Elite plan. Used to specify if a non-default invoice
+            template will be used to generate invoices for the account. For sites
+            without multiple invoice templates enabled, the default template will
+            always be used.
         address:
           "$ref": "#/components/schemas/Address"
         billing_info:
@@ -17511,6 +17587,11 @@ components:
           type: string
           title: Country
           description: Country, 2-letter ISO 3166-1 alpha-2 code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
     AddressWithName:
       allOf:
       - "$ref": "#/components/schemas/Address"
@@ -18215,6 +18296,9 @@ components:
         paypal_billing_agreement_id:
           type: string
           title: PayPal billing agreement ID
+        roku_billing_agreement_id:
+          type: string
+          title: Roku's CIB if billing through Roku
         fraud_session_id:
           type: string
           title: Fraud Session ID
@@ -21107,6 +21191,11 @@ components:
           type: string
           maxLength: 50
           description: Country, 2-letter ISO 3166-1 alpha-2 code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
         created_at:
           type: string
           title: Created at
@@ -21158,6 +21247,11 @@ components:
           type: string
           maxLength: 20
           description: Zip or postal code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
         country:
           type: string
           maxLength: 50
@@ -21412,6 +21506,11 @@ components:
           type: string
           maxLength: 50
           description: Country, 2-letter ISO 3166-1 alpha-2 code.
+        geo_code:
+          type: string
+          maxLength: 20
+          description: Code that represents a geographic entity (location or object).
+            Only returned for Sling Vertex Integration
     Site:
       type: object
       properties:
@@ -21610,6 +21709,7 @@ components:
           type: number
           format: float
           title: Estimated tax
+          description: Only for merchants using Recurly's In-The-Box taxes.
         tax_info:
           "$ref": "#/components/schemas/TaxInfo"
         total:
@@ -22441,6 +22541,12 @@ components:
           default: 0
         net_terms_type:
           "$ref": "#/components/schemas/NetTermsTypeEnum"
+        gateway_code:
+          type: string
+          title: Gateway Code
+          description: If present, this subscription's transactions will use the payment
+            gateway with this code.
+          maxLength: 13
         transaction_type:
           description: An optional type designation for the payment gateway transaction
             created by this request. Supports 'moto' value, which is the acronym for
@@ -22782,6 +22888,7 @@ components:
     TaxInfo:
       type: object
       title: Tax info
+      description: Only for merchants using Recurly's In-The-Box taxes.
       properties:
         type:
           type: string
@@ -23623,6 +23730,90 @@ components:
           type: string
           format: date-time
           description: Time the object was last updated
+    ExternalPaymentPhase:
+      type: object
+      description: Details of payments in the lifecycle of a subscription from an
+        external resource that is not managed by the Recurly platform, e.g. App Store
+        or Google Play Store.
+      properties:
+        id:
+          type: string
+          title: External payment phase ID
+          description: System-generated unique identifier for an external payment
+            phase ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        external_subscription:
+          "$ref": "#/components/schemas/ExternalSubscription"
+        started_at:
+          type: string
+          format: date-time
+          title: Started At
+        ends_at:
+          type: string
+          format: date-time
+          title: Ends At
+        starting_billing_period_index:
+          type: integer
+          title: Starting Billing Period Index
+        ending_billing_period_index:
+          type: integer
+          title: Ending Billing Period Index
+        offer_type:
+          type: string
+          title: Offer Type
+          description: Type of discount offer given, e.g. "FREE_TRIAL"
+        offer_name:
+          type: string
+          title: Offer Name
+          description: Name of the discount offer given, e.g. "introductory"
+        period_count:
+          type: integer
+          title: Period Count
+          description: Number of billing periods
+        period_length:
+          type: string
+          title: Period Length
+          description: Billing cycle length
+        amount:
+          type: string
+          format: decimal
+          title: Amount
+          minimum: 0
+          description: Allows up to 9 decimal places
+        currency:
+          type: string
+          title: Currency
+          description: 3-letter ISO 4217 currency code.
+          maxLength: 3
+        created_at:
+          type: string
+          format: date-time
+          title: Created at
+          description: When the external subscription was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          title: Updated at
+          description: When the external subscription was updated in Recurly.
+    ExternalPaymentPhaseList:
+      type: object
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be List.
+        has_more:
+          type: boolean
+          description: Indicates there are more results on subsequent pages.
+        next:
+          type: string
+          description: Path to subsequent page of results.
+        data:
+          type: array
+          items:
+            "$ref": "#/components/schemas/ExternalPaymentPhase"
     ExternalProduct:
       type: object
       description: Product from an external resource such as Apple App Store or Google
@@ -24979,6 +25170,7 @@ components:
       - check
       - credit_card
       - eft
+      - google_pay
       - money_order
       - other
       - paypal
@@ -25172,6 +25364,7 @@ components:
       - credit_card
       - eft
       - gateway_token
+      - google_pay
       - iban_bank_account
       - money_order
       - other

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.42.0
+  version: 4.44.0
 platform: ruby
 authors:
 - Recurly
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,7 +119,9 @@ files:
 - ".changelog_config.yaml"
 - ".github/ISSUE_TEMPLATE/bug-report.md"
 - ".github/ISSUE_TEMPLATE/question-or-other.md"
+- ".github/codeql/codeql-config.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/codeql.yml"
 - ".github/workflows/docs.yml"
 - ".github/workflows/pr-review.yml"
 - ".gitignore"
@@ -268,6 +270,7 @@ files:
 - lib/recurly/resources/external_account.rb
 - lib/recurly/resources/external_charge.rb
 - lib/recurly/resources/external_invoice.rb
+- lib/recurly/resources/external_payment_phase.rb
 - lib/recurly/resources/external_product.rb
 - lib/recurly/resources/external_product_reference_collection.rb
 - lib/recurly/resources/external_product_reference_mini.rb
@@ -345,8 +348,8 @@ metadata:
   changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
   documentation_uri: https://recurly.github.io/recurly-client-ruby/
   homepage_uri: https://github.com/recurly/recurly-client-ruby
-  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.42.0
-post_install_message: 
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.44.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -361,8 +364,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: The ruby client for Recurly's V3 API
 test_files: []