stripe 5.38.0 → 15.2.1

data/lib/stripe/services/checkout_service.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CheckoutService < StripeService
+    attr_reader :sessions
+
+    def initialize(requestor)
+      super
+      @sessions = Stripe::Checkout::SessionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/climate/order_service.rb

@@ -0,0 +1,170 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    class OrderService < StripeService
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class Beneficiary < Stripe::RequestParams
+          # Publicly displayable name for the end beneficiary of carbon removal.
+          attr_accessor :public_name
+
+          def initialize(public_name: nil)
+            @public_name = public_name
+          end
+        end
+        # Requested amount of carbon removal units. Either this or `metric_tons` must be specified.
+        attr_accessor :amount
+        # Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
+        attr_accessor :beneficiary
+        # Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.
+        attr_accessor :currency
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+        attr_accessor :metadata
+        # Requested number of tons for the order. Either this or `amount` must be specified.
+        attr_accessor :metric_tons
+        # Unique identifier of the Climate product.
+        attr_accessor :product
+
+        def initialize(
+          amount: nil,
+          beneficiary: nil,
+          currency: nil,
+          expand: nil,
+          metadata: nil,
+          metric_tons: nil,
+          product: nil
+        )
+          @amount = amount
+          @beneficiary = beneficiary
+          @currency = currency
+          @expand = expand
+          @metadata = metadata
+          @metric_tons = metric_tons
+          @product = product
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class UpdateParams < Stripe::RequestParams
+        class Beneficiary < Stripe::RequestParams
+          # Publicly displayable name for the end beneficiary of carbon removal.
+          attr_accessor :public_name
+
+          def initialize(public_name: nil)
+            @public_name = public_name
+          end
+        end
+        # Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
+        attr_accessor :beneficiary
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+        attr_accessor :metadata
+
+        def initialize(beneficiary: nil, expand: nil, metadata: nil)
+          @beneficiary = beneficiary
+          @expand = expand
+          @metadata = metadata
+        end
+      end
+
+      class CancelParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
+      # reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
+      # might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
+      # provides 90 days advance notice and refunds the amount_total.
+      def cancel(order, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/climate/orders/%<order>s/cancel", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a Climate order object for a given Climate product. The order will be processed immediately
+      # after creation and payment will be deducted your Stripe balance.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/climate/orders",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Lists all Climate order objects. The orders are returned sorted by creation date, with the
+      # most recently created orders appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/climate/orders",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Climate order object with the given ID.
+      def retrieve(order, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/climate/orders/%<order>s", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates the specified order by setting the values of the parameters passed.
+      def update(order, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/climate/orders/%<order>s", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/climate/product_service.rb

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    class ProductService < StripeService
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Lists all available Climate product objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/climate/products",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Climate product with the given ID.
+      def retrieve(product, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/climate/products/%<product>s", { product: CGI.escape(product) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/climate/supplier_service.rb

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    class SupplierService < StripeService
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Lists all available Climate supplier objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/climate/suppliers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a Climate supplier object.
+      def retrieve(supplier, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/climate/suppliers/%<supplier>s", { supplier: CGI.escape(supplier) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/climate_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ClimateService < StripeService
+    attr_reader :orders, :products, :suppliers
+
+    def initialize(requestor)
+      super
+      @orders = Stripe::Climate::OrderService.new(@requestor)
+      @products = Stripe::Climate::ProductService.new(@requestor)
+      @suppliers = Stripe::Climate::SupplierService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/confirmation_token_service.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ConfirmationTokenService < StripeService
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    # Retrieves an existing ConfirmationToken object
+    def retrieve(confirmation_token, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/confirmation_tokens/%<confirmation_token>s", { confirmation_token: CGI.escape(confirmation_token) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/country_spec_service.rb

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CountrySpecService < StripeService
+    class ListParams < Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    # Lists all Country Spec objects available in the API.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/country_specs",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a Country Spec for a given Country code.
+    def retrieve(country, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/country_specs/%<country>s", { country: CGI.escape(country) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/coupon_service.rb

@@ -0,0 +1,202 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CouponService < StripeService
+    class DeleteParams < Stripe::RequestParams; end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      class CurrencyOptions < Stripe::RequestParams
+        # A positive integer representing the amount to subtract from an invoice total.
+        attr_accessor :amount_off
+
+        def initialize(amount_off: nil)
+          @amount_off = amount_off
+        end
+      end
+      # Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+      attr_accessor :currency_options
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+      attr_accessor :name
+
+      def initialize(currency_options: nil, expand: nil, metadata: nil, name: nil)
+        @currency_options = currency_options
+        @expand = expand
+        @metadata = metadata
+        @name = name
+      end
+    end
+
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+      attr_accessor :created
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(created: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      class AppliesTo < Stripe::RequestParams
+        # An array of Product IDs that this Coupon will apply to.
+        attr_accessor :products
+
+        def initialize(products: nil)
+          @products = products
+        end
+      end
+
+      class CurrencyOptions < Stripe::RequestParams
+        # A positive integer representing the amount to subtract from an invoice total.
+        attr_accessor :amount_off
+
+        def initialize(amount_off: nil)
+          @amount_off = amount_off
+        end
+      end
+      # A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
+      attr_accessor :amount_off
+      # A hash containing directions for what this Coupon will apply discounts to.
+      attr_accessor :applies_to
+      # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
+      attr_accessor :currency
+      # Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+      attr_accessor :currency_options
+      # Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
+      attr_accessor :duration
+      # Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
+      attr_accessor :duration_in_months
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
+      attr_accessor :id
+      # A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
+      attr_accessor :max_redemptions
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+      attr_accessor :name
+      # A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
+      attr_accessor :percent_off
+      # Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
+      attr_accessor :redeem_by
+
+      def initialize(
+        amount_off: nil,
+        applies_to: nil,
+        currency: nil,
+        currency_options: nil,
+        duration: nil,
+        duration_in_months: nil,
+        expand: nil,
+        id: nil,
+        max_redemptions: nil,
+        metadata: nil,
+        name: nil,
+        percent_off: nil,
+        redeem_by: nil
+      )
+        @amount_off = amount_off
+        @applies_to = applies_to
+        @currency = currency
+        @currency_options = currency_options
+        @duration = duration
+        @duration_in_months = duration_in_months
+        @expand = expand
+        @id = id
+        @max_redemptions = max_redemptions
+        @metadata = metadata
+        @name = name
+        @percent_off = percent_off
+        @redeem_by = redeem_by
+      end
+    end
+
+    # You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
+    #
+    # A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/coupons", params: params, opts: opts, base_address: :api)
+    end
+
+    # You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+    def delete(coupon, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your coupons.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/coupons", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the coupon with the given ID.
+    def retrieve(coupon, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
+    def update(coupon, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/credit_note_line_item_service.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteLineItemService < StripeService
+    class ListParams < Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    # When retrieving a credit note, you'll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+    def list(credit_note, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/credit_notes/%<credit_note>s/lines", { credit_note: CGI.escape(credit_note) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end