stripe 10.13.0 → 10.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97c811b2b459b17181407a3623e59762e40d4673adc0fd73b5be8ebc6b6dc6e0
-  data.tar.gz: a548789eb483613398223cfb9edf9113f8c30fc11bb8e75b16111ea7c6844ced
+  metadata.gz: 4e005b6f71d3104349ec84fd1828b46bd94131b49a746233231654a682da91a1
+  data.tar.gz: c04f1e21e02e4a615a6477cddd1dc11130998ffcc90d2afc66ad73131e435cfa
 SHA512:
-  metadata.gz: 03d491204d0bc879e91771025e8755fdc65b927b3f6d49bdd88831d994d2ae5db7865d8d1b79b64969369cf473fb46df87920d97fe60a239a9e5c2e660d660c6
-  data.tar.gz: 32638e41755069eacce29e7a4a2e2e4847d7b9c890f868eb15eb1ad254c33d4b802724769010df046c50f239b30ff8a72bfe34824c3ee13dfe940b223e3571a3
+  metadata.gz: 8f56042df34d499b9fb85a4e8fba37a9a048cc9830caad148442fd629d34c943c5c5ea425e066007625a6bb8124de7cd53223a511d09fd495bba068038b2375d
+  data.tar.gz: 175595f2208cfdb6c952d4b163e2e86121e0bd0fe1afc0164368f5cbf72e471a46a0ff721274c1e1fd8de329c71f91029790573a99a4b94a782b22be16fa585e

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+## 10.14.0 - 2024-03-28
+* [#1369](https://github.com/stripe/stripe-ruby/pull/1369) Update generated code
+  * Add support for new resources `Billing.MeterEventAdjustment`, `Billing.MeterEvent`, and `Billing.Meter`
+  * Add support for `create`, `deactivate`, `list`, `reactivate`, `retrieve`, and `update` methods on resource `Meter`
+  * Add support for `create` method on resources `MeterEventAdjustment` and `MeterEvent`
+
 ## 10.13.0 - 2024-03-21
 * [#1367](https://github.com/stripe/stripe-ruby/pull/1367) Update generated code
   * Add support for new resources `ConfirmationToken` and `Forwarding.Request`

data/OPENAPI_VERSION

@@ -1 +1 @@
-v889
+v908

data/VERSION

@@ -1 +1 @@
-10.13.0
+10.14.0

data/lib/stripe/object_types.rb

@@ -23,6 +23,10 @@ module Stripe
         Balance.object_name => Balance,
         BalanceTransaction.object_name => BalanceTransaction,
         BankAccount.object_name => BankAccount,
+        Billing::Meter.object_name => Billing::Meter,
+        Billing::MeterEvent.object_name => Billing::MeterEvent,
+        Billing::MeterEventAdjustment.object_name => Billing::MeterEventAdjustment,
+        Billing::MeterEventSummary.object_name => Billing::MeterEventSummary,
         BillingPortal::Configuration.object_name => BillingPortal::Configuration,
         BillingPortal::Session.object_name => BillingPortal::Session,
         Capability.object_name => Capability,

data/lib/stripe/resources/billing/meter.rb

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then use the billing meter to charge the user for the number of API calls they make.
+    class Meter < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing.meter"
+      def self.object_name
+        "billing.meter"
+      end
+
+      nested_resource_class_methods :event_summary,
+                                    operations: %i[list],
+                                    resource_plural: "event_summaries"
+
+      # Creates a billing meter
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/billing/meters", params: params, opts: opts)
+      end
+
+      # Deactivates a billing meter
+      def deactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deactivates a billing meter
+      def self.deactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of billing meters.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/billing/meters", params: filters, opts: opts)
+      end
+
+      # Reactivates a billing meter
+      def reactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Reactivates a billing meter
+      def self.reactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a billing meter
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter_event.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.
+    # Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.
+    class MeterEvent < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing.meter_event"
+      def self.object_name
+        "billing.meter_event"
+      end
+
+      # Creates a billing meter event
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/meter_events",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter_event_adjustment.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event adjustment represents the status of a meter event adjustment.
+    class MeterEventAdjustment < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing.meter_event_adjustment"
+      def self.object_name
+        "billing.meter_event_adjustment"
+      end
+
+      # Creates a billing meter event adjustment
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/meter_event_adjustments",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter_event_summary.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much
+    # usage was accrued by a customer for that period.
+    class MeterEventSummary < APIResource
+      OBJECT_NAME = "billing.meter_event_summary"
+      def self.object_name
+        "billing.meter_event_summary"
+      end
+    end
+  end
+end

data/lib/stripe/resources/confirmation_token.rb

@@ -6,7 +6,9 @@ module Stripe
   # to your server for confirming a PaymentIntent or SetupIntent. If the confirmation
   # is successful, values present on the ConfirmationToken are written onto the Intent.
   #
-  # To learn more or request access, visit the related guided: [Finalize payments on the server using Confirmation Tokens](https://stripe.com/docs/payments/finalize-payments-on-the-server-confirmation-tokens).
+  # To learn more about how to use ConfirmationToken, visit the related guides:
+  # - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)
+  # - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).
   class ConfirmationToken < APIResource
     OBJECT_NAME = "confirmation_token"
     def self.object_name

data/lib/stripe/resources/forwarding/request.rb

@@ -17,6 +17,8 @@ module Stripe
     #
     # Forwarding Requests are synchronous requests that return a response or time out according to
     # Stripe's limits.
+    #
+    # Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).
     class Request < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/invoice.rb

@@ -203,6 +203,8 @@ module Stripe
     end
 
     # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
+    #
+    # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
     def void_invoice(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -213,6 +215,8 @@ module Stripe
     end
 
     # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
+    #
+    # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
     def self.void_invoice(invoice, params = {}, opts = {})
       request_stripe_object(
         method: :post,

data/lib/stripe/resources/quote.rb

@@ -124,7 +124,7 @@ module Stripe
       )
     end
 
-    # Download the PDF for a finalized quote
+    # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.corp.stripe.com/quotes/overview#quote_pdf)
     def pdf(params = {}, opts = {}, &read_body_chunk_block)
       config = opts[:client]&.config || Stripe.config
       opts = { api_base: config.uploads_base }.merge(opts)
@@ -137,7 +137,7 @@ module Stripe
       )
     end
 
-    # Download the PDF for a finalized quote
+    # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.corp.stripe.com/quotes/overview#quote_pdf)
     def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
       config = opts[:client]&.config || Stripe.config
       opts = { api_base: config.uploads_base }.merge(opts)

data/lib/stripe/resources.rb

@@ -11,6 +11,10 @@ require "stripe/resources/apps/secret"
 require "stripe/resources/balance"
 require "stripe/resources/balance_transaction"
 require "stripe/resources/bank_account"
+require "stripe/resources/billing/meter"
+require "stripe/resources/billing/meter_event"
+require "stripe/resources/billing/meter_event_adjustment"
+require "stripe/resources/billing/meter_event_summary"
 require "stripe/resources/billing_portal/configuration"
 require "stripe/resources/billing_portal/session"
 require "stripe/resources/capability"

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "10.13.0"
+  VERSION = "10.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 10.13.0
+  version: 10.14.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
@@ -63,6 +63,10 @@ files:
 - lib/stripe/resources/balance.rb
 - lib/stripe/resources/balance_transaction.rb
 - lib/stripe/resources/bank_account.rb
+- lib/stripe/resources/billing/meter.rb
+- lib/stripe/resources/billing/meter_event.rb
+- lib/stripe/resources/billing/meter_event_adjustment.rb
+- lib/stripe/resources/billing/meter_event_summary.rb
 - lib/stripe/resources/billing_portal/configuration.rb
 - lib/stripe/resources/billing_portal/session.rb
 - lib/stripe/resources/capability.rb