recurly 3.15.0 → 3.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecaa5f1cc2110480aac4355c469c84d7a423badce1a4860cd494ab9e4966a118
-  data.tar.gz: b5c805224d670c22eed575410d51af2e801279f7f5dae0d274d84ecc60731363
+  metadata.gz: a7b4df1917c4b15c1d01a13889c926f0c262c2ca1d5ccea2d74dabd19f9a8744
+  data.tar.gz: 33dbffde9c280aa495676f348a103a18d40c2627b7e98f7876cdca1704e49d45
 SHA512:
-  metadata.gz: 322cf51b9d06fb661860d02603896a370b92b0292eae793a1ec911bd5528f8452180e76a80199f0f938b9ff4f7c8458001941a18f899c3bdfdd6b49aaf6e0963
-  data.tar.gz: 2cace6d2929076220ae9f029865a9bc6ca73e66edd0bafb66bce496e5e70985bb1da9a72fa0265c659c725a187a1fdc42730b696524bc1a66bdd84495ccc6958
+  metadata.gz: 549b263ed42946ab85c5efa475a66c11c35d4a0ea4098f814a8096ffb6cf4ad2bb413d1ee7ae5603fea4027cbe3fcc9c7d5bd4d358203f142fa47964a3a21b99
+  data.tar.gz: ec7d592254799f676bdc0ca6c95e4b173c35a3535200d5f76fbeb4609600ac6639d194b8705d942e6e184b6b68fce400ce697bc0398cbfbe40bfe2ea7b4a2b15

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,8 +1,25 @@
 # Changelog
 
-## [3.15.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
+## [3.16.0](https://github.com/recurly/recurly-client-ruby/tree/HEAD)
 
-[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.14.0...HEAD)
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.15.0...HEAD)
+
+**Implemented enhancements:**
+
+- Latest Changes for 2019-10-10 \(tax\_identifier / tax\_identifier\_type\) [\#654](https://github.com/recurly/recurly-client-ruby/pull/654) ([douglasmiller](https://github.com/douglasmiller))
+- Latest Changes for 2019-10-10 [\#651](https://github.com/recurly/recurly-client-ruby/pull/651) ([douglasmiller](https://github.com/douglasmiller))
+
+**Fixed bugs:**
+
+- Refund API V2 Error Details [\#652](https://github.com/recurly/recurly-client-ruby/issues/652)
+
+**Merged pull requests:**
+
+- Release 3.16.0 [\#656](https://github.com/recurly/recurly-client-ruby/pull/656) ([douglasmiller](https://github.com/douglasmiller))
+
+## [3.15.0](https://github.com/recurly/recurly-client-ruby/tree/3.15.0) (2020-11-06)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.14.0...3.15.0)
 
 **Implemented enhancements:**
 

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.15'
+gem 'recurly', '~> 3.16'
 ```
 
 > *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

@@ -568,6 +568,7 @@ module Recurly
     # @param 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.
     #
+    # @param state [String] Filter by state.
     # @param 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 [Pager<Resources::CouponRedemption>] A list of the the coupon redemptions on an account.
@@ -1470,6 +1471,17 @@ module Recurly
     # @param 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::Coupon] The restored coupon.
+    # @example
+    #   begin
+    #     coupon = @client.restore_coupon(coupon_id: coupon_id, body: {
+    #       name: "New Coupon Name"
+    #     })
+    #     puts "Restored coupon #{coupon}"
+    #   rescue Recurly::Errors::NotFoundError
+    #     # If the resource was not found, you may want to alert the user or
+    #     # just return nil
+    #     puts "Resource Not Found"
+    #   end
     #
     def restore_coupon(coupon_id:, body:, **options)
       path = interpolate_path("/coupons/{coupon_id}/restore", coupon_id: coupon_id)
@@ -3041,6 +3053,7 @@ module Recurly
     #
     #   You may also terminate a subscription with no refund and then manually refund specific invoices.
     #
+    # @param charge [Boolean] Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.
     # @param 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::Subscription] An expired subscription.

data/lib/recurly/requests/billing_info_create.rb

@@ -86,6 +86,14 @@ module Recurly
       #   @return [String] Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)
       define_attribute :sort_code, String
 
+      # @!attribute tax_identifier
+      #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF, CPF is a Brazilian tax identifier for all tax paying residents.
+      define_attribute :tax_identifier, String
+
+      # @!attribute tax_identifier_type
+      #   @return [String] this field and a value of 'cpf' are required if adding a billing info that is an elo or hipercard type in Brazil.
+      define_attribute :tax_identifier_type, String
+
       # @!attribute three_d_secure_action_result_token_id
       #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
       define_attribute :three_d_secure_action_result_token_id, String

data/lib/recurly/requests/plan_update.rb

@@ -10,10 +10,6 @@ module Recurly
       #   @return [String] Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.
       define_attribute :accounting_code, String
 
-      # @!attribute add_ons
-      #   @return [Array[AddOnCreate]] Add Ons
-      define_attribute :add_ons, Array, { :item_type => :AddOnCreate }
-
       # @!attribute allow_any_item_on_subscriptions
       #   @return [Boolean] Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
       define_attribute :allow_any_item_on_subscriptions, :Boolean

data/lib/recurly/resources/subscription.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :collection_method, String
 
       # @!attribute coupon_redemptions
-      #   @return [Array[CouponRedemptionMini]] Coupon redemptions
+      #   @return [Array[CouponRedemptionMini]] Returns subscription level coupon redemptions that are tied to this subscription.
       define_attribute :coupon_redemptions, Array, { :item_type => :CouponRedemptionMini }
 
       # @!attribute created_at

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.15.0"
+  VERSION = "3.16.0"
 end

data/openapi/api.yaml

@@ -1142,14 +1142,11 @@ paths:
             const account = await client.deactivateAccount(accountId)
             console.log('Deleted account: ', account.code)
           } catch (err) {
-            if (err && err.type === 'not-found') {
+            if (err instanceof recurly.errors.NotFoundError) {
               // If the request was not found, you may want to alert the user or
               // just return null
               console.log('Resource Not Found')
             }
-            // If we don't know what to do with the err, we should
-            // probably re-raise and let our web framework and logger handle it
-            throw err
           }
       - lang: Python
         source: |
@@ -1649,14 +1646,11 @@ paths:
             const account = await client.reactivateAccount(accountId)
             console.log('Reactivated account: ', account.code)
           } catch (err) {
-            if (err && err.type === 'not_found') {
+            if (err instanceof recurly.errors.NotFoundError) {
               // If the request was not found, you may want to alert the user or
               // just return null
               console.log('Resource Not Found')
             }
-            // If we don't know what to do with the err, we should
-            // probably re-raise and let our web framework and logger handle it
-            throw err
           }
       - lang: Python
         source: |
@@ -2481,6 +2475,7 @@ paths:
       - "$ref": "#/components/parameters/sort_dates"
       - "$ref": "#/components/parameters/filter_begin_time"
       - "$ref": "#/components/parameters/filter_end_time"
+      - "$ref": "#/components/parameters/filter_state"
       responses:
         '200':
           description: A list of the the coupon redemptions on an account.
@@ -5742,7 +5737,108 @@ paths:
             application/json:
               schema:
                 "$ref": "#/components/schemas/Error"
-      x-code-samples: []
+      x-code-samples:
+      - lang: Node.js
+        source: |
+          try {
+            const coupon = await client.restoreCoupon(couponId, {
+              name: "New Coupon Name"
+            })
+            console.log('Restored coupon: ', coupon.code)
+          } catch (err) {
+            if (err instanceof recurly.errors.NotFoundError) {
+              // If the request was not found, you may want to alert the user or
+              // just return null
+              console.log('Resource Not Found')
+            }
+
+          }
+      - lang: Python
+        source: |
+          try:
+              coupon = client.restore_coupon(coupon_id, {
+                  "name": "New Coupon Name"
+              })
+              print("Restored Coupon %s" % coupon)
+          except recurly.errors.NotFoundError:
+              # If the resource was not found, you may want to alert the user or
+              # just return nil
+              print("Resource Not Found")
+      - lang: ".NET"
+        source: |
+          try
+          {
+              var couponReq = new CouponUpdate() {
+                  Name = "New Coupon Name"
+              };
+              Coupon coupon = client.RestoreCoupon(couponId, couponReq);
+              Console.WriteLine($"Restored coupon {coupon.Code}");
+          }
+          catch (Recurly.Errors.Validation ex)
+          {
+              // If the request was not valid, you may want to tell your user
+              // why. You can find the invalid params and reasons in ex.Error.Params
+              Console.WriteLine($"Failed validation: {ex.Error.Message}");
+          }
+          catch (Recurly.Errors.ApiError ex)
+          {
+              // Use ApiError to catch a generic error from the API
+              Console.WriteLine($"Unexpected Recurly Error: {ex.Error.Message}");
+          }
+      - lang: Ruby
+        source: |
+          begin
+            coupon = @client.restore_coupon(coupon_id: coupon_id, body: {
+              name: "New Coupon Name"
+            })
+            puts "Restored coupon #{coupon}"
+          rescue Recurly::Errors::NotFoundError
+            # If the resource was not found, you may want to alert the user or
+            # just return nil
+            puts "Resource Not Found"
+          end
+      - lang: Java
+        source: |
+          try {
+              final CouponUpdate couponUpdate = new CouponUpdate();
+              couponUpdate.setName("New Coupon Name");
+
+              final Coupon coupon = client.restoreCoupon(couponId, couponUpdate);
+              System.out.println("Restored coupon: " + coupon.getCode());
+          } catch (ValidationException e) {
+              // If the request was not valid, you may want to tell your user
+              // why. You can find the invalid params and reasons in e.getError().getParams()
+              System.out.println("Failed validation: " + e.getError().getMessage());
+          } catch (ApiException e) {
+              // Use ApiException to catch a generic error from the API
+              System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
+          }
+      - lang: PHP
+        source: |
+          try {
+              $coupon_update = [
+                  "name" => "New Coupon Name"
+              ];
+              $coupon = $client->restoreCoupon($coupon_id, $coupon_update);
+
+              echo 'Restored Coupon:' . PHP_EOL;
+              var_dump($coupon);
+          } catch (\Recurly\Errors\NotFound $e) {
+              // Could not find the resource, you may want to inform the user
+              // or just return a NULL
+              echo 'Could not find resource.' . PHP_EOL;
+              var_dump($e);
+          } catch (\Recurly\RecurlyError $e) {
+              // Something bad happened... tell the user so that they can fix it?
+              echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
+          }
+      - lang: Go
+        source: "updateReq := &recurly.CouponUpdate{\n\tName: recurly.String(\"New
+          Coupon Name\"),\n}\ncoupon, err := client.RestoreCoupon(couponId, updateReq)\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(\"Restored Coupon:
+          %s\", coupon.Id)"
   "/sites/{site_id}/coupons/{coupon_id}/unique_coupon_codes":
     get:
       tags:
@@ -6741,14 +6837,11 @@ paths:
             const item = await client.deactivateItem(itemId)
             console.log('Deleted item: ', item.code)
           } catch (err) {
-            if (err && err.type === 'not-found') {
+            if (err instanceof recurly.errors.NotFoundError) {
               // If the request was not found, you may want to alert the user or
               // just return null
               console.log('Resource Not Found')
             }
-            // If we don't know what to do with the err, we should
-            // probably re-raise and let our web framework and logger handle it
-            throw err
           }
       - lang: Python
         source: |
@@ -6865,14 +6958,11 @@ paths:
             const item = await client.reactivateItem(itemId)
             console.log('Reactivated item: ', item.code)
           } catch (err) {
-            if (err && err.type === 'not_found') {
+            if (err instanceof recurly.errors.NotFoundError) {
               // If the request was not found, you may want to alert the user or
               // just return null
               console.log('Resource Not Found')
             }
-            // If we don't know what to do with the err, we should
-            // probably re-raise and let our web framework and logger handle it
-            throw err
           }
       - lang: Python
         source: |
@@ -11451,6 +11541,16 @@ paths:
           - partial
           - none
           default: none
+      - name: charge
+        in: query
+        description: Applicable only if the subscription has usage based add-ons and
+          unbilled usage logged for the current billing cycle. If true, current billing
+          cycle unbilled usage is billed on the final invoice. If false, Recurly will
+          create a negative usage record for current billing cycle usage that will
+          zero out the final invoice line items.
+        schema:
+          default: true
+          type: boolean
       responses:
         '200':
           description: An expired subscription.
@@ -16106,6 +16206,17 @@ components:
           - checking
           - savings
           description: The bank account type. (ACH only)
+        tax_identifier:
+          type: string
+          description: Tax identifier is required if adding a billing info that is
+            a consumer card in Brazil. This would be the customer's CPF, CPF is a
+            Brazilian tax identifier for all tax paying residents.
+        tax_identifier_type:
+          type: string
+          enum:
+          - cpf
+          description: this field and a value of 'cpf' are required if adding a billing
+            info that is an elo or hipercard type in Brazil.
         primary_payment_method:
           type: boolean
           title: Primary Payment Method
@@ -18620,13 +18731,13 @@ components:
             the setup fee will be charged at the time of signup. Setup fees do not
             increase with the quantity of a subscription plan.
           minimum: 0
-          maximum: 100000
+          maximum: 1000000
         unit_amount:
           type: number
           format: float
           title: Unit price
           minimum: 0
-          maximum: 100000
+          maximum: 1000000
     PlanUpdate:
       type: object
       properties:
@@ -18759,11 +18870,6 @@ components:
           type: object
           title: Hosted pages settings
           "$ref": "#/components/schemas/PlanHostedPages"
-        add_ons:
-          type: array
-          title: Add Ons
-          items:
-            "$ref": "#/components/schemas/AddOnCreate"
         allow_any_item_on_subscriptions:
           type: boolean
           title: Allow any item on subscriptions
@@ -18784,7 +18890,7 @@ components:
           format: float
           title: Unit price
           minimum: 0
-          maximum: 100000
+          maximum: 1000000
       required:
       - currency
       - unit_amount
@@ -18801,7 +18907,7 @@ components:
           format: float
           title: Unit price
           minimum: 0
-          maximum: 100000
+          maximum: 1000000
       required:
       - currency
       - unit_amount
@@ -19310,6 +19416,8 @@ components:
         coupon_redemptions:
           type: array
           title: Coupon redemptions
+          description: Returns subscription level coupon redemptions that are tied
+            to this subscription.
           items:
             "$ref": "#/components/schemas/CouponRedemptionMini"
         pending_change:
@@ -19598,6 +19706,7 @@ components:
             * Optionally, override the add-on's default unit amount.
             * If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` must be absent.
           minimum: 0
+          maximum: 1000000
         tiers:
           type: array
           title: Tiers
@@ -19671,6 +19780,7 @@ components:
           title: Unit amount
           description: Optionally, override the add-on's default unit amount.
           minimum: 0
+          maximum: 1000000
         tiers:
           type: array
           title: Tiers
@@ -19711,6 +19821,7 @@ components:
           format: float
           title: Unit amount
           minimum: 0
+          maximum: 1000000
     SubscriptionCancel:
       type: object
       properties:
@@ -19843,7 +19954,7 @@ components:
             the plan's default unit amount. The subscription's current currency will
             be used.
           minimum: 0
-          maximum: 100000
+          maximum: 1000000
         quantity:
           type: integer
           title: Quantity
@@ -19993,7 +20104,7 @@ components:
             this value. If not provided, the subscription will inherit the price from
             the subscription plan for the provided currency.
           minimum: 0
-          maximum: 100000
+          maximum: 1000000
         quantity:
           type: integer
           title: Quantity
@@ -20127,7 +20238,7 @@ components:
             this value in cents. If not provided, the subscription will inherit the
             price from the subscription plan for the provided currency.
           minimum: 0
-          maximum: 100000
+          maximum: 1000000
         quantity:
           type: integer
           title: Quantity

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.15.0
+  version: 3.16.0
 platform: ruby
 authors:
 - Recurly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -293,7 +293,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.15.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.16.0
 post_install_message:
 rdoc_options: []
 require_paths: