recurly 4.21.1 → 4.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219f3d280dd061539e7087e972e0954371e691300aa1bfdad4c6e4a4b22cf946
-  data.tar.gz: b5e700f336e8e25f9381aa1d302724880a55d7d69003c6a05d1fef1b8e31a0bf
+  metadata.gz: f3425e11a326e6886fe09606f3cd02f155ded5fb774f639d20f47f2a4def65f3
+  data.tar.gz: 39d0917188e796d37e7179a86e78427dab022cf94ea3d6c13b734153d54f2b0c
 SHA512:
-  metadata.gz: 96c0570bdd87a04d9364415e8e984417ca4bb98c580f587b96f637e3bd78bbe7829a6a232f0dfc5f594b2cf917126bf609db5718f1179b64fef065ce4cabfab1
-  data.tar.gz: 410770536d971b7e0eb3db98027507b4ce174d185af412c883e3348873ccecc5a1aa84405dcf157c8c84ca7dc05f528edd7f3c4ead88c6a7843d1e06d2eed8a8
+  metadata.gz: c06705fdd51268f7f1a298dc6b92ab65c4a972106d32d2e7909ac6852d780ab0024170da9c0f028d43695fe17706371684f93366217bbf3577fd9e1200068854
+  data.tar.gz: 63565f407525519ff2594677070a394675c7500d03565d704c0bd07e4ef7afa94ffb2d9839efd07f527bc65fc9979090d4ab4cf1166d988d7879fcbb757576e9

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.23.0](https://github.com/recurly/recurly-client-ruby/tree/4.23.0) (2022-10-27)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.22.0...4.23.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Entitlements feature) [#804](https://github.com/recurly/recurly-client-ruby/pull/804) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.22.0](https://github.com/recurly/recurly-client-ruby/tree/4.22.0) (2022-10-21)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.21.1...4.22.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25(Decimal Usage and Quantities and DunningEvent new fields) [#801](https://github.com/recurly/recurly-client-ruby/pull/801) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.21.1](https://github.com/recurly/recurly-client-ruby/tree/4.21.1) (2022-09-08)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.21.0...4.21.1)

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

@@ -4091,5 +4091,24 @@ module Recurly
       path = interpolate_path("/invoice_templates/{invoice_template_id}", invoice_template_id: invoice_template_id)
       get(path, **options)
     end
+
+    # Show all entitlements granted to an account
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param params [Hash] Optional query string parameters:
+    #        :state [String] Filter the entitlements based on the state of the applicable subscription.
+    #
+    #   - When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
+    #   - When no state is provided, subscriptions with active or canceled states will be returned.
+    #
+    #
+    # @return [Pager<Resources::Entitlements>] A list of the entitlements granted to an account.
+    #
+    def list_entitlements(account_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/entitlements", account_id: account_id)
+      pager(path, **options)
+    end
   end
 end

data/lib/recurly/requests/billing_info_create.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :cvv, String
 
       # @!attribute external_hpp_type
-      #   @return [String] Use for Adyen HPP billing info.
+      #   @return [String] Use for Adyen HPP billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
       define_attribute :external_hpp_type, String
 
       # @!attribute first_name
@@ -83,7 +83,7 @@ module Recurly
       define_attribute :number, String
 
       # @!attribute online_banking_payment_type
-      #   @return [String] Use for Online Banking billing info.
+      #   @return [String] Use for Online Banking billing info. This should only be used as part of a pending purchase request, when the billing info is nested inside an account object.
       define_attribute :online_banking_payment_type, String
 
       # @!attribute paypal_billing_agreement_id

data/lib/recurly/requests/line_item_refund.rb

@@ -17,6 +17,10 @@ module Recurly
       # @!attribute quantity
       #   @return [Integer] Line item quantity to be refunded.
       define_attribute :quantity, Integer
+
+      # @!attribute quantity_decimal
+      #   @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+      define_attribute :quantity_decimal, String
     end
   end
 end

data/lib/recurly/requests/usage_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class UsageCreate < Request
 
       # @!attribute amount
-      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places.  Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
       define_attribute :amount, Float
 
       # @!attribute merchant_tag

data/lib/recurly/resources/customer_permission.rb

@@ -0,0 +1,30 @@
+# 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 CustomerPermission < Resource
+
+      # @!attribute code
+      #   @return [String] Customer permission code.
+      define_attribute :code, String
+
+      # @!attribute description
+      #   @return [String] Description of customer permission.
+      define_attribute :description, String
+
+      # @!attribute id
+      #   @return [String] Customer permission ID.
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Customer permission name.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] It will always be "customer_permission".
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/entitlement.rb

@@ -0,0 +1,30 @@
+# 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 Entitlement < Resource
+
+      # @!attribute created_at
+      #   @return [DateTime] Time object was created.
+      define_attribute :created_at, DateTime
+
+      # @!attribute customer_permission
+      #   @return [CustomerPermission]
+      define_attribute :customer_permission, :CustomerPermission
+
+      # @!attribute granted_by
+      #   @return [Array[GrantedBy]] Subscription or item that granted the customer permission.
+      define_attribute :granted_by, Array, { :item_type => :GrantedBy }
+
+      # @!attribute object
+      #   @return [String] Entitlement
+      define_attribute :object, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Time the object was last updated
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/entitlements.rb

@@ -0,0 +1,26 @@
+# 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 Entitlements < Resource
+
+      # @!attribute data
+      #   @return [Array[Entitlement]]
+      define_attribute :data, Array, { :item_type => :Entitlement }
+
+      # @!attribute has_more
+      #   @return [Boolean] Indicates there are more results on subsequent pages.
+      define_attribute :has_more, :Boolean
+
+      # @!attribute next
+      #   @return [String] Path to subsequent page of results.
+      define_attribute :next, String
+
+      # @!attribute object
+      #   @return [String] Object Type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/granted_by.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 GrantedBy < Resource
+
+      # @!attribute id
+      #   @return [String] The ID of the subscription or external subscription that grants the permission to the account.
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object Type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/invoice.rb

@@ -58,6 +58,14 @@ module Recurly
       #   @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
       define_attribute :dunning_campaign_id, String
 
+      # @!attribute dunning_events_sent
+      #   @return [Integer] Number of times the event was sent.
+      define_attribute :dunning_events_sent, Integer
+
+      # @!attribute final_dunning_event
+      #   @return [Boolean] Last communication attempt.
+      define_attribute :final_dunning_event, :Boolean
+
       # @!attribute has_more_line_items
       #   @return [Boolean] Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
       define_attribute :has_more_line_items, :Boolean

data/lib/recurly/resources/line_item.rb

@@ -130,6 +130,10 @@ module Recurly
       #   @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
       define_attribute :quantity, Integer
 
+      # @!attribute quantity_decimal
+      #   @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+      define_attribute :quantity_decimal, String
+
       # @!attribute refund
       #   @return [Boolean] Refund?
       define_attribute :refund, :Boolean
@@ -138,6 +142,10 @@ module Recurly
       #   @return [Integer] For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
       define_attribute :refunded_quantity, Integer
 
+      # @!attribute refunded_quantity_decimal
+      #   @return [String] A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
+      define_attribute :refunded_quantity_decimal, String
+
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String

data/lib/recurly/resources/usage.rb

@@ -7,7 +7,7 @@ module Recurly
     class Usage < Resource
 
       # @!attribute amount
-      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places.  Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
       define_attribute :amount, Float
 
       # @!attribute billed_at

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.21.1"
+  VERSION = "4.23.0"
 end

data/openapi/api.yaml

@@ -305,6 +305,8 @@ tags:
   description: A purchase is a checkout containing at least one or more subscriptions
     or one-time charges (line items) and supports both coupon and gift card redemptions.
     All items purchased will be on one invoice and paid for with one transaction.
+    The purchases endpoint can also be used to immediately create a credit invoice
+    on an account, when Credit Invoices is enabled on your site.
 - name: usage
   x-displayName: Usage
   description: Send Recurly your customer usage and we will automatically bill them
@@ -3773,6 +3775,8 @@ paths:
       - line_item
       operationId: create_line_item
       summary: Create a new line item for the account
+      description: When using the Credit Invoices feature, utilize the purchases endpoint
+        in order to immediately post credit to a credit invoice.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       requestBody:
@@ -15065,6 +15069,35 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/accounts/{account_id}/entitlements":
+    parameters:
+    - "$ref": "#/components/parameters/account_id"
+    - "$ref": "#/components/parameters/filter_limited_subscription_state"
+    get:
+      tags:
+      - account
+      operationId: list_entitlements
+      summary: Show all entitlements granted to an account
+      responses:
+        '200':
+          description: A list of the entitlements granted to an account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Entitlements"
+        '404':
+          description: Incorrect site or account ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
 servers:
 - url: https://v3.recurly.com
 - url: https://v3.eu.recurly.com
@@ -15306,6 +15339,16 @@ components:
         - When `state=live`, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
       schema:
         "$ref": "#/components/schemas/FilterSubscriptionStateEnum"
+    filter_limited_subscription_state:
+      name: state
+      in: query
+      description: |
+        Filter the entitlements based on the state of the applicable subscription.
+
+        - When `state=active`, `state=canceled`, `state=expired`, or `state=future`, subscriptions with states that match the query and only those subscriptions will be returned.
+        - When no state is provided, subscriptions with active or canceled states will be returned.
+      schema:
+        "$ref": "#/components/schemas/FilterLimitedSubscriptionStateEnum"
     filter_begin_time:
       name: begin_time
       in: query
@@ -18141,6 +18184,14 @@ components:
           description: Unique ID to identify the dunning campaign used when dunning
             the invoice. For sites without multiple dunning campaigns enabled, this
             will always be the default dunning campaign.
+        dunning_events_sent:
+          type: integer
+          title: Dunning Event Sent
+          description: Number of times the event was sent.
+        final_dunning_event:
+          type: boolean
+          title: Final Dunning Event
+          description: Last communication attempt.
     InvoiceCreate:
       type: object
       properties:
@@ -18622,6 +18673,14 @@ components:
           description: This number will be multiplied by the unit amount to compute
             the subtotal before any discounts or taxes.
           default: 1
+        quantity_decimal:
+          type: string
+          title: Quantity Decimal
+          description: A floating-point alternative to Quantity. If this value is
+            present, it will be used in place of Quantity for calculations, and Quantity
+            will be the rounded integer value of this number. This field supports
+            up to 9 decimal places. The Decimal Quantity feature must be enabled to
+            utilize this field.
         unit_amount:
           type: number
           format: float
@@ -18706,6 +18765,13 @@ components:
           title: Refunded Quantity
           description: For refund charges, the quantity being refunded. For non-refund
             charges, the total quantity refunded (possibly over multiple refunds).
+        refunded_quantity_decimal:
+          type: string
+          title: Refunded Quantity Decimal
+          description: A floating-point alternative to Refunded Quantity. For refund
+            charges, the quantity being refunded. For non-refund charges, the total
+            quantity refunded (possibly over multiple refunds). The Decimal Quantity
+            feature must be enabled to utilize this field.
         credit_applied:
           type: number
           format: float
@@ -18747,6 +18813,14 @@ components:
           type: integer
           title: Quantity
           description: Line item quantity to be refunded.
+        quantity_decimal:
+          type: string
+          title: Quantity Decimal
+          description: A floating-point alternative to Quantity. If this value is
+            present, it will be used in place of Quantity for calculations, and Quantity
+            will be the rounded integer value of this number. This field supports
+            up to 9 decimal places. The Decimal Quantity feature must be enabled to
+            utilize this field.
         prorate:
           type: boolean
           title: Prorate
@@ -21667,10 +21741,11 @@ components:
         amount:
           type: number
           format: float
-          description: The amount of usage. Can be positive, negative, or 0. No decimals
-            allowed, we will strip them. If the usage-based add-on is billed with
-            a percentage, your usage will be a monetary amount you will want to format
-            in cents. (e.g., $5.00 is "500").
+          description: The amount of usage. Can be positive, negative, or 0. If the
+            Decimal Quantity feature is enabled, this value will be rounded to nine
+            decimal places.  Otherwise, all digits after the decimal will be stripped.
+            If the usage-based add-on is billed with a percentage, your usage should
+            be a monetary amount formatted in cents (e.g., $5.00 is "500").
         usage_type:
           "$ref": "#/components/schemas/UsageTypeEnum"
         tier_type:
@@ -21741,10 +21816,11 @@ components:
         amount:
           type: number
           format: float
-          description: The amount of usage. Can be positive, negative, or 0. No decimals
-            allowed, we will strip them. If the usage-based add-on is billed with
-            a percentage, your usage will be a monetary amount you will want to format
-            in cents. (e.g., $5.00 is "500").
+          description: The amount of usage. Can be positive, negative, or 0. If the
+            Decimal Quantity feature is enabled, this value will be rounded to nine
+            decimal places.  Otherwise, all digits after the decimal will be stripped.
+            If the usage-based add-on is billed with a percentage, your usage should
+            be a monetary amount formatted in cents (e.g., $5.00 is "500").
         recording_timestamp:
           type: string
           format: date-time
@@ -22060,6 +22136,75 @@ components:
           maxItems: 200
           items:
             "$ref": "#/components/schemas/Plan"
+    Entitlements:
+      type: object
+      description: A list of privileges granted to a customer through the purchase
+        of a plan or item.
+      properties:
+        object:
+          type: string
+          title: Object Type
+        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/Entitlement"
+    Entitlement:
+      type: object
+      properties:
+        object:
+          type: string
+          description: Entitlement
+        customer_permission:
+          "$ref": "#/components/schemas/CustomerPermission"
+        granted_by:
+          type: array
+          description: Subscription or item that granted the customer permission.
+          items:
+            "$ref": "#/components/schemas/GrantedBy"
+        created_at:
+          type: string
+          format: date-time
+          description: Time object was created.
+        updated_at:
+          type: string
+          format: date-time
+          description: Time the object was last updated
+    CustomerPermission:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Customer permission ID.
+        code:
+          type: string
+          description: Customer permission code.
+        name:
+          type: string
+          description: Customer permission name.
+        description:
+          type: string
+          description: Description of customer permission.
+        object:
+          type: string
+          description: It will always be "customer_permission".
+    GrantedBy:
+      type: object
+      description: The subscription or external subscription that grants customer
+        permissions.
+      properties:
+        object:
+          type: string
+          title: Object Type
+        id:
+          type: string
+          description: The ID of the subscription or external subscription that grants
+            the permission to the account.
     InvoiceTemplateList:
       type: object
       properties:
@@ -22273,6 +22418,13 @@ components:
       - future
       - in_trial
       - live
+    FilterLimitedSubscriptionStateEnum:
+      type: string
+      enum:
+      - active
+      - canceled
+      - expired
+      - future
     TrueEnum:
       type: string
       enum:
@@ -23058,12 +23210,16 @@ components:
       - savings
     ExternalHppTypeEnum:
       type: string
-      description: Use for Adyen HPP billing info.
+      description: Use for Adyen HPP billing info. This should only be used as part
+        of a pending purchase request, when the billing info is nested inside an account
+        object.
       enum:
       - adyen
     OnlineBankingPaymentTypeEnum:
       type: string
-      description: Use for Online Banking billing info.
+      description: Use for Online Banking billing info. This should only be used as
+        part of a pending purchase request, when the billing info is nested inside
+        an account object.
       enum:
       - ideal
       - sofort

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.21.1
+  version: 4.23.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -239,16 +239,20 @@ files:
 - lib/recurly/resources/credit_payment.rb
 - lib/recurly/resources/custom_field.rb
 - lib/recurly/resources/custom_field_definition.rb
+- lib/recurly/resources/customer_permission.rb
 - lib/recurly/resources/dunning_campaign.rb
 - lib/recurly/resources/dunning_campaigns_bulk_update_response.rb
 - lib/recurly/resources/dunning_cycle.rb
 - lib/recurly/resources/dunning_interval.rb
+- lib/recurly/resources/entitlement.rb
+- lib/recurly/resources/entitlements.rb
 - lib/recurly/resources/error.rb
 - lib/recurly/resources/error_may_have_transaction.rb
 - lib/recurly/resources/export_dates.rb
 - lib/recurly/resources/export_file.rb
 - lib/recurly/resources/export_files.rb
 - lib/recurly/resources/fraud_info.rb
+- lib/recurly/resources/granted_by.rb
 - lib/recurly/resources/invoice.rb
 - lib/recurly/resources/invoice_address.rb
 - lib/recurly/resources/invoice_collection.rb
@@ -316,7 +320,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.21.1
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.23.0
 post_install_message: 
 rdoc_options: []
 require_paths: