recurly 4.11.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d45224bbd99e205cb61df3b688a47b73527e19b0cb12bc1dd64c01fabf035ec6
-  data.tar.gz: c921de862702509c3b4929c610e4565dc4ad868ba72daa8668781b2162a06362
+  metadata.gz: '0876e485b804ec79b1a15203f09ffe4ee5d209775aa21b2c720d6fbf23b0aeb3'
+  data.tar.gz: 7cc1dc915610febad9e7fffe2617efdaa6ab27ed01cbac429765d1bbcf32df7a
 SHA512:
-  metadata.gz: c3598292853a0f0a551fd653c46ab53cfe223276acf9155eb20dd1a0df1bf6e60d09a7f184838efaff53ecb6b910f33d5c26fe0d4f83efadb8ceadccb37c5708
-  data.tar.gz: 2c5faf56692a870a199c94baff93aa4017564b32cce82104654b377a04bed36dd7623a90ce7c65a5020d57f4f3361732ddf9d43f1c3860d4d5544eaa4b61237b
+  metadata.gz: 4b513a3e05b7b7d01588900fe8ffeef0c01d6b10e95fa8dd3c0738e9786705cdcbffe4c1e8604983de8b4fc5e17fd884e24e5b12dc2cdf407ceacd6119f165fa
+  data.tar.gz: 5c0e860427fa02b6fbb4f31afe6d7ddee1bc842af631a380e85cde67a7d0dfa4ba3bc9a983b310d6060d32198f530d8a8bc706240ea33bda7ae11f9144bdcc44

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [4.12.0](https://github.com/recurly/recurly-client-ruby/tree/4.12.0) (2022-01-28)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.11.0...4.12.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Invoice Customization) [#746](https://github.com/recurly/recurly-client-ruby/pull/746) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2021-02-25 [#743](https://github.com/recurly/recurly-client-ruby/pull/743) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.11.0](https://github.com/recurly/recurly-client-ruby/tree/4.11.0) (2021-12-29)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.10.0...4.11.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.11'
+gem 'recurly', '~> 4.12'
 ```
 
 > *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

@@ -1712,6 +1712,49 @@ module Recurly
       get(path, **options)
     end
 
+    # List an invoice template's associated accounts
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_template_accounts list_invoice_template_accounts api documenation}
+    #
+    # @param invoice_template_id [String] Invoice template ID.
+    # @param params [Hash] Optional query string parameters:
+    #        :ids [String] Filter results by their IDs. Up to 200 IDs can be passed at once using
+    #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
+    #
+    #   *Important notes:*
+    #
+    #   * The +ids+ parameter cannot be used with any other ordering or filtering
+    #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
+    #   * Invalid or unknown IDs will be ignored, so you should check that the
+    #     results correspond to your request.
+    #   * Records are returned in an arbitrary order. Since results are all
+    #     returned at once you can sort the records yourself.
+    #
+    #        :limit [Integer] Limit number of records 1-200.
+    #        :order [String] Sort order.
+    #        :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.
+    #
+    #        :begin_time [DateTime] Inclusively filter by begin_time when +sort=created_at+ or +sort=updated_at+.
+    #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+    #
+    #        :end_time [DateTime] Inclusively filter by end_time when +sort=created_at+ or +sort=updated_at+.
+    #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
+    #
+    #        :email [String] Filter for accounts with this exact email address. A blank value will return accounts with both +null+ and +""+ email addresses. Note that multiple accounts can share one email address.
+    #        :subscriber [Boolean] Filter for accounts with or without a subscription in the +active+,
+    #   +canceled+, or +future+ state.
+    #
+    #        :past_due [String] Filter for accounts with an invoice in the +past_due+ state.
+    #
+    # @return [Pager<Resources::Account>] A list of an invoice template's associated accounts.
+    #
+    def list_invoice_template_accounts(invoice_template_id:, **options)
+      path = interpolate_path("/invoice_templates/{invoice_template_id}/accounts", invoice_template_id: invoice_template_id)
+      pager(path, **options)
+    end
+
     # List a site's items
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_items list_items api documenation}

data/lib/recurly/requests/account_create.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  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
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/account_purchase.rb

@@ -58,6 +58,10 @@ module Recurly
       #   @return [String] Optional, but if present allows an existing account to be used and updated as part of the purchase.
       define_attribute :id, String
 
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  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
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/account_update.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  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
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/add_on_create.rb

@@ -39,11 +39,11 @@ module Recurly
       define_attribute :display_quantity, :Boolean
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Available when the `Credit Invoices` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] Unique code to identify an item. Available when the `Credit Invoices` feature are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the `Credit Invoices` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] System-generated unique identifier for an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_id, String
 
       # @!attribute measured_unit_id

data/lib/recurly/requests/billing_info_create.rb

@@ -111,7 +111,7 @@ module Recurly
       define_attribute :transaction_type, String
 
       # @!attribute type
-      #   @return [String] The payment method type for a non-credit card based billing info. The value of `bacs` is the only accepted value (Bacs only)
+      #   @return [String] The payment method type for a non-credit card based billing info. `bacs` and `becs` are the only accepted values.
       define_attribute :type, String
 
       # @!attribute vat_number

data/lib/recurly/requests/line_item_create.rb

@@ -35,11 +35,11 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] Unique code to identify an item. Available when the Credit Invoices feature is enabled.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
       define_attribute :item_id, String
 
       # @!attribute origin

data/lib/recurly/resources/account.rb

@@ -90,6 +90,10 @@ module Recurly
       #   @return [String]
       define_attribute :id, String
 
+      # @!attribute invoice_template
+      #   @return [AccountInvoiceTemplate] Invoice template associated to the account. Available when invoice customization flag is enabled.
+      define_attribute :invoice_template, :AccountInvoiceTemplate
+
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/resources/account_invoice_template.rb

@@ -0,0 +1,18 @@
+# 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 AccountInvoiceTemplate < Resource
+
+      # @!attribute id
+      #   @return [String] Unique ID to identify the invoice template.
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Template name
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/resources/line_item.rb

@@ -67,7 +67,7 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!attribute external_sku
-      #   @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.
       define_attribute :external_sku, String
 
       # @!attribute id
@@ -83,11 +83,11 @@ module Recurly
       define_attribute :invoice_number, String
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] Unique code to identify an item. Available when the Credit Invoices feature is enabled.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
       define_attribute :item_id, String
 
       # @!attribute legacy_category

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.11.0"
+  VERSION = "4.12.0"
 end

data/openapi/api.yaml

@@ -232,7 +232,7 @@ tags:
   description: |-
     For merchants who sell the same things to many customers, documenting those offerings in a catalog allows for faster charge creation, easier management of offerings, and analytics about your offerings across all sales channels. Because your offerings can be physical, digital, or service-oriented, Recurly collectively calls these offerings "Items".
 
-    Recurly's item catalog requires the Credit Invoices and Subscription Billing Terms features to be enabled.
+    Recurly's item catalog requires the Credit Invoices features to be enabled.
 - name: plan
   x-displayName: Plan
   description: A plan tells Recurly how often and how much to charge your customers.
@@ -6337,6 +6337,51 @@ paths:
           {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
           Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Custom
           Field Definition: %s\", definition.Id)"
+  "/invoice_templates/{invoice_template_id}/accounts":
+    get:
+      tags:
+      - account
+      operationId: list_invoice_template_accounts
+      summary: List an invoice template's associated accounts
+      description: See the [Pagination Guide](/guides/pagination.html) to learn how
+        to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/invoice_template_id"
+      - "$ref": "#/components/parameters/ids"
+      - "$ref": "#/components/parameters/limit"
+      - "$ref": "#/components/parameters/order"
+      - "$ref": "#/components/parameters/sort_dates"
+      - "$ref": "#/components/parameters/filter_begin_time"
+      - "$ref": "#/components/parameters/filter_end_time"
+      - "$ref": "#/components/parameters/filter_account_email"
+      - "$ref": "#/components/parameters/filter_account_subscriber"
+      - "$ref": "#/components/parameters/filter_account_past_due"
+      responses:
+        '200':
+          description: A list of an invoice template's associated accounts.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/AccountList"
+        '400':
+          description: Invalid or unpermitted parameter.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site or invoice template ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/items":
     get:
       tags:
@@ -14614,6 +14659,13 @@ components:
       required: true
       schema:
         type: string
+    invoice_template_id:
+      name: invoice_template_id
+      in: path
+      description: Invoice template ID.
+      required: true
+      schema:
+        type: string
     item_id:
       name: item_id
       in: path
@@ -15456,6 +15508,12 @@ components:
             dunning campaign should be assigned to this account. For sites without
             multiple dunning campaigns enabled, the default dunning campaign will
             always be used.
+        invoice_template_id:
+          type: string
+          title: Invoice Template ID
+          description: Unique ID to identify an invoice template.  Available when
+            the Invoice Customization feature is enabled.  Used to specify which invoice
+            template, if any, should be used to generate invoices for the account.
         address:
           "$ref": "#/components/schemas/Address"
         billing_info:
@@ -15540,6 +15598,8 @@ components:
           "$ref": "#/components/schemas/BillingInfo"
         custom_fields:
           "$ref": "#/components/schemas/CustomFields"
+        invoice_template:
+          "$ref": "#/components/schemas/AccountInvoiceTemplate"
     AccountNote:
       type: object
       required:
@@ -15636,6 +15696,20 @@ components:
           format: float
           title: Amount
           description: Total amount the account is past due.
+    AccountInvoiceTemplate:
+      type: object
+      title: Invoice Template
+      description: Invoice template associated to the account. Available when invoice
+        customization flag is enabled.
+      properties:
+        id:
+          type: string
+          title: ID
+          description: Unique ID to identify the invoice template.
+        name:
+          type: string
+          title: Name
+          description: Template name
     InvoiceAddress:
       allOf:
       - "$ref": "#/components/schemas/Address"
@@ -15900,16 +15974,16 @@ components:
           type: string
           title: Item Code
           description: Unique code to identify an item. Available when the `Credit
-            Invoices` and `Subscription Billing Terms` features are enabled. If `item_id`
-            and `item_code` are both present, `item_id` will be used.
+            Invoices` feature are enabled. If `item_id` and `item_code` are both present,
+            `item_id` will be used.
           pattern: "/^[a-z0-9_+-]+$/"
           maxLength: 50
         item_id:
           type: string
           title: Item ID
           description: System-generated unique identifier for an item. Available when
-            the `Credit Invoices` and `Subscription Billing Terms` features are enabled.
-            If `item_id` and `item_code` are both present, `item_id` will be used.
+            the `Credit Invoices` feature is enabled. If `item_id` and `item_code`
+            are both present, `item_id` will be used.
           maxLength: 13
         code:
           type: string
@@ -17888,20 +17962,20 @@ components:
           type: string
           title: Item Code
           description: Unique code to identify an item. Available when the Credit
-            Invoices and Subscription Billing Terms features are enabled.
+            Invoices feature is enabled.
           pattern: "/^[a-z0-9_+-]+$/"
           maxLength: 50
         item_id:
           type: string
           title: Item ID
           description: System-generated unique identifier for an item. Available when
-            the Credit Invoices and Subscription Billing Terms features are enabled.
+            the Credit Invoices feature is enabled.
           maxLength: 13
         external_sku:
           type: string
           title: External SKU
           description: Optional Stock Keeping Unit assigned to an item. Available
-            when the Credit Invoices and Subscription Billing Terms features are enabled.
+            when the Credit Invoices feature is enabled.
           maxLength: 50
         revenue_schedule_type:
           title: Revenue schedule type
@@ -18204,14 +18278,14 @@ components:
           type: string
           title: Item Code
           description: Unique code to identify an item. Available when the Credit
-            Invoices and Subscription Billing Terms features are enabled.
+            Invoices feature is enabled.
           pattern: "/^[a-z0-9_+-]+$/"
           maxLength: 50
         item_id:
           type: string
           title: Item ID
           description: System-generated unique identifier for an item. Available when
-            the Credit Invoices and Subscription Billing Terms features are enabled.
+            the Credit Invoices feature is enabled.
           maxLength: 13
         revenue_schedule_type:
           title: Revenue schedule type
@@ -22160,9 +22234,10 @@ components:
     AchTypeEnum:
       type: string
       description: The payment method type for a non-credit card based billing info.
-        The value of `bacs` is the only accepted value (Bacs only)
+        `bacs` and `becs` are the only accepted values.
       enum:
       - bacs
+      - becs
     AchAccountTypeEnum:
       type: string
       description: The bank account type. (ACH only)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.11.0
+  version: 4.12.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,6 +212,7 @@ files:
 - lib/recurly/resources/account_acquisition_cost.rb
 - lib/recurly/resources/account_balance.rb
 - lib/recurly/resources/account_balance_amount.rb
+- lib/recurly/resources/account_invoice_template.rb
 - lib/recurly/resources/account_mini.rb
 - lib/recurly/resources/account_note.rb
 - lib/recurly/resources/add_on.rb
@@ -302,7 +303,7 @@ 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.11.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.12.0
 post_install_message: 
 rdoc_options: []
 require_paths: