recurly 3.24.0 → 3.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed0b8401ee5879270989110b1b826589fe628d1befb4209b2f995bc8c2d55124
-  data.tar.gz: 62d1aba9f1e248b0ba1c9eeb790cdfd2d935d49e743d2f9cfa8ccaf6d33cb5e7
+  metadata.gz: 9e70d1a1bb7c0d88be5d3a03dce9a78bf4a588124f396d8a28f5605a3f680cf8
+  data.tar.gz: d5f09642546b24a79fdb6514e6b6ce4309dd740dd1c1df69c17f9c141fb32326
 SHA512:
-  metadata.gz: 650e5852f33c74e4407668d517f0b2f8c429a358782ac8c7f804378528f88e4b903cd173020666f0a7aeb794143d1e01693e15ae1eaa838bf3d7febef4ccd28a
-  data.tar.gz: 545373440597d3477a1eaf2210ae5963ff7a8784524d3332a126550f059917f8d3516becf4a2793be90a048666edb1437f3038f40aca4d6093938f7b26a431c2
+  metadata.gz: 37d9669ada25d5a7ec8b74a45e0524f9fa7707b3081c9ab8dac05f3bf021e721ee61a06dfd8fd6dd6c153020fb49e76feaedb03daff9cccc5a1329224b335332
+  data.tar.gz: 694703dbf884a6ceb9f77864c2b29efef149722ec2d67baac25d82f76b2e14ec2250748a722a20dd5f4dd075e7250a9abc8c70275e71063d3c6d93f7b238f0f3

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [3.26.0](https://github.com/recurly/recurly-client-ruby/tree/3.26.0) (2023-04-26)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.25.0...3.26.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2019-10-10 (used_tax_service on Invoice) [#838](https://github.com/recurly/recurly-client-ruby/pull/838) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [3.25.0](https://github.com/recurly/recurly-client-ruby/tree/3.25.0) (2023-01-19)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.24.0...3.25.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2019-10-10 (Custom Fields on Line Items) [#822](https://github.com/recurly/recurly-client-ruby/pull/822) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [3.24.0](https://github.com/recurly/recurly-client-ruby/tree/3.24.0) (2023-01-11)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.23.0...3.24.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', '~> 3.24'
+gem 'recurly', '~> 3.26'
 ```
 
 > *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

@@ -127,6 +127,7 @@ module Recurly
     #       code: account_code,
     #       first_name: "Benjamin",
     #       last_name: "Du Monde",
+    #       preferred_time_zone: "America/Chicago",
     #       acquisition: {
     #         campaign: "podcast-marketing",
     #         channel: "social_media",

data/lib/recurly/requests/billing_info_create.rb

@@ -30,6 +30,10 @@ module Recurly
       #   @return [String] Company name
       define_attribute :company, String
 
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
       # @!attribute cvv
       #   @return [String] *STRONGLY RECOMMENDED*
       define_attribute :cvv, String

data/lib/recurly/requests/line_item_create.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.
       define_attribute :currency, String
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
       # @!attribute description
       #   @return [String] Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.
       define_attribute :description, String

data/lib/recurly/resources/custom_field_definition.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :updated_at, DateTime
 
       # @!attribute user_access
-      #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
+      #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
       define_attribute :user_access, String
     end
   end

data/lib/recurly/resources/invoice.rb

@@ -142,6 +142,10 @@ module Recurly
       #   @return [DateTime] Last updated at
       define_attribute :updated_at, DateTime
 
+      # @!attribute used_tax_service
+      #   @return [Boolean] Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.
+      define_attribute :used_tax_service, :Boolean
+
       # @!attribute vat_number
       #   @return [String] VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
       define_attribute :vat_number, String

data/lib/recurly/resources/line_item.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
       # @!attribute description
       #   @return [String] Description that appears on the invoice. For subscription related items this will be filled in automatically.
       define_attribute :description, String

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.24.0"
+  VERSION = "3.26.0"
 end

data/openapi/api.yaml

@@ -224,8 +224,8 @@ tags:
   x-displayName: Site
 - name: custom_field_definition
   x-displayName: Custom Field Definition
-  description: Describes the fields that can use used as custom fields on accounts
-    or subscriptions.
+  description: Describes the fields that can be used as custom fields on accounts,
+    items, line-items (one time charges), plans, or subscriptions.
 - name: item
   x-displayName: Item
   description: |-
@@ -686,6 +686,7 @@ paths:
               code: accountCode,
               firstName: 'Benjamin',
               lastName: 'Du Monde',
+              preferredTimeZone: 'America/Chicago',
               address: {
                 street1: '900 Camp St',
                 city: 'New Orleans',
@@ -714,6 +715,7 @@ paths:
                   "code": account_code,
                   "first_name": "Benjamin",
                   "last_name": "Du Monde",
+                  "preferred_time_zone": "America/Chicago",
                   "acquisition": {
                       "campaign": "podcast-marketing",
                       "channel": "social_media",
@@ -749,6 +751,7 @@ paths:
                   Code = accountCode,
                   FirstName = "Benjamin",
                   LastName = "Du Monde",
+                  PreferredTimeZone = "America/Chicago",
                   Address = new Address()
                   {
                       City = "New Orleans",
@@ -779,6 +782,7 @@ paths:
               code: account_code,
               first_name: "Benjamin",
               last_name: "Du Monde",
+              preferred_time_zone: "America/Chicago",
               acquisition: {
                 campaign: "podcast-marketing",
                 channel: "social_media",
@@ -817,6 +821,7 @@ paths:
               accountReq.setCode(accountCode);
               accountReq.setFirstName("Aaron");
               accountReq.setLastName("Du Monde");
+              accountReq.setPreferredTimeZone("America/Chicago");
 
               address.setStreet1("900 Camp St.");
               address.setCity("New Orleans");
@@ -843,6 +848,7 @@ paths:
                   "code" => $account_code,
                   "first_name" => "Douglas",
                   "last_name" => "DuMonde",
+                  "preferred_time_zone" => "America/Chicago",
                   "shipping_addresses" => [
                       [
                           "first_name" => "Douglas",
@@ -872,17 +878,17 @@ paths:
       - lang: Go
         source: "accountReq := &recurly.AccountCreate{\n\tCode:      &accountCode,\n\tFirstName:
           recurly.String(\"Isaac\"),\n\tLastName:  recurly.String(\"Du Monde\"),\n\tEmail:
-          \    recurly.String(\"isaac@example.com\"),\n\tBillingInfo: &recurly.BillingInfoCreate{\n\t\tFirstName:
-          recurly.String(\"Isaac\"),\n\t\tLastName:  recurly.String(\"Du Monde\"),\n\t\tAddress:
-          &recurly.AddressCreate{\n\t\t\tPhone:      recurly.String(\"415-555-5555\"),\n\t\t\tStreet1:
-          \   recurly.String(\"400 Alabama St.\"),\n\t\t\tCity:       recurly.String(\"San
-          Francisco\"),\n\t\t\tPostalCode: recurly.String(\"94110\"),\n\t\t\tCountry:
-          \   recurly.String(\"US\"),\n\t\t\tRegion:     recurly.String(\"CA\"),\n\t\t},\n\t\tNumber:
-          recurly.String(\"4111111111111111\"),\n\t\tMonth:  recurly.String(\"12\"),\n\t\tYear:
-          \  recurly.String(\"22\"),\n\t\tCvv:    recurly.String(\"123\"),\n\t},\n}\n\naccount,
-          err := client.CreateAccount(accountReq)\nif e, ok := err.(*recurly.Error);
-          ok {\n\tif e.Type == recurly.ErrorTypeValidation {\n\t\tfmt.Printf(\"Failed
-          validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
+          \    recurly.String(\"isaac@example.com\"),\n\tPreferredTimeZone: recurly.String(\"America/Los_Angeles\"),\n\tBillingInfo:
+          &recurly.BillingInfoCreate{\n\t\tFirstName: recurly.String(\"Isaac\"),\n\t\tLastName:
+          \ recurly.String(\"Du Monde\"),\n\t\tAddress: &recurly.AddressCreate{\n\t\t\tPhone:
+          \     recurly.String(\"415-555-5555\"),\n\t\t\tStreet1:    recurly.String(\"400
+          Alabama St.\"),\n\t\t\tCity:       recurly.String(\"San Francisco\"),\n\t\t\tPostalCode:
+          recurly.String(\"94110\"),\n\t\t\tCountry:    recurly.String(\"US\"),\n\t\t\tRegion:
+          \    recurly.String(\"CA\"),\n\t\t},\n\t\tNumber: recurly.String(\"4111111111111111\"),\n\t\tMonth:
+          \ recurly.String(\"12\"),\n\t\tYear:   recurly.String(\"22\"),\n\t\tCvv:
+          \   recurly.String(\"123\"),\n\t},\n}\n\naccount, err := client.CreateAccount(accountReq)\nif
+          e, ok := err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeValidation
+          {\n\t\tfmt.Printf(\"Failed validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
           Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Created Account:
           %s\", account.Id)"
   "/sites/{site_id}/accounts/{account_id}":
@@ -6175,6 +6181,7 @@ paths:
           - item
           - plan
           - subscription
+          - charge
       responses:
         '200':
           description: A list of the site's custom field definitions.
@@ -15554,7 +15561,9 @@ components:
           - es-MX
           - es-US
           - fi-FI
+          - fr-BE
           - fr-CA
+          - fr-CH
           - fr-FR
           - hi-IN
           - it-IT
@@ -15691,7 +15700,9 @@ components:
           - es-MX
           - es-US
           - fi-FI
+          - fr-BE
           - fr-CA
+          - fr-CH
           - fr-FR
           - hi-IN
           - it-IT
@@ -16612,6 +16623,9 @@ components:
           title: Security code or CVV
           description: "*STRONGLY RECOMMENDED*"
           maxLength: 4
+        currency:
+          type: string
+          description: 3-letter ISO 4217 currency code.
         vat_number:
           type: string
           title: VAT number
@@ -17444,6 +17458,7 @@ components:
           - item
           - plan
           - subscription
+          - charge
         name:
           type: string
           title: Name
@@ -17460,10 +17475,12 @@ components:
             - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but
               editing will only be available via the API.
             - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
+            - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.
           enum:
           - api_only
           - read_only
           - write
+          - set_only
         display_name:
           type: string
           title: Display name
@@ -17958,6 +17975,13 @@ components:
           description: The outstanding balance remaining on this invoice.
         tax_info:
           "$ref": "#/components/schemas/TaxInfo"
+        used_tax_service:
+          type: boolean
+          title: Used Tax Service?
+          description: Will be `true` when the invoice had a successful response from
+            the tax service and `false` when the invoice was not sent to tax service
+            due to a lack of address or enabled jurisdiction or was processed without
+            tax due to a non-blocking error returned from the tax service.
         vat_number:
           type: string
           title: VAT number
@@ -18696,6 +18720,8 @@ components:
           format: date-time
           title: End date
           description: If this date is provided, it indicates the end of a time range.
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         created_at:
           type: string
           format: date-time
@@ -18890,6 +18916,8 @@ components:
           format: date-time
           title: End date
           description: If this date is provided, it indicates the end of a time range.
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
       required:
       - currency
       - unit_amount

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.24.0
+  version: 3.26.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-11 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -306,7 +306,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/3.24.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.26.0
 post_install_message: 
 rdoc_options: []
 require_paths: