stripe 12.5.0 → 15.0.0

data/lib/stripe/services/application_fee_refund_service.rb

@@ -0,0 +1,114 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeRefundService < 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
+
+    class UpdateParams < Stripe::RequestParams
+      # 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(expand: nil, metadata: nil)
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+
+    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
+      # A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.
+      attr_accessor :amount
+      # 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(amount: nil, expand: nil, metadata: nil)
+        @amount = amount
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+
+    # Refunds an application fee that has previously been collected but not yet refunded.
+    # Funds will be refunded to the Stripe account from which the fee was originally collected.
+    #
+    # You can optionally refund only part of an application fee.
+    # You can do so multiple times, until the entire fee has been refunded.
+    #
+    # Once entirely refunded, an application fee can't be refunded again.
+    # This method will raise an error when called on an already-refunded application fee,
+    # or when trying to refund more money than is left on an application fee.
+    def create(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
+    def list(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
+    def retrieve(fee, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    #
+    # This request only accepts metadata as an argument.
+    def update(fee, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/application_fee_service.rb

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeService < StripeService
+    attr_reader :refunds
+
+    def initialize(requestor)
+      super(requestor)
+      @refunds = Stripe::ApplicationFeeRefundService.new(@requestor)
+    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
+      # Only return application fees for the charge specified by this charge ID.
+      attr_accessor :charge
+      # Only return applications fees that were created during the given date interval.
+      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(
+        charge: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil
+      )
+        @charge = charge
+        @created = created
+        @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
+
+    # Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/application_fees",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/apps/secret_service.rb

@@ -0,0 +1,168 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Apps
+    class SecretService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          attr_accessor :user
+
+          def initialize(type: nil, user: nil)
+            @type = type
+            @user = user
+          end
+        end
+        # 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
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        attr_accessor :scope
+        # 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, scope: nil, starting_after: nil)
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @scope = scope
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          attr_accessor :user
+
+          def initialize(type: nil, user: nil)
+            @type = type
+            @user = user
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The Unix timestamp for the expiry time of the secret, after which the secret deletes.
+        attr_accessor :expires_at
+        # A name for the secret that's unique within the scope.
+        attr_accessor :name
+        # The plaintext secret value to be stored.
+        attr_accessor :payload
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        attr_accessor :scope
+
+        def initialize(expand: nil, expires_at: nil, name: nil, payload: nil, scope: nil)
+          @expand = expand
+          @expires_at = expires_at
+          @name = name
+          @payload = payload
+          @scope = scope
+        end
+      end
+
+      class FindParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          attr_accessor :user
+
+          def initialize(type: nil, user: nil)
+            @type = type
+            @user = user
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A name for the secret that's unique within the scope.
+        attr_accessor :name
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        attr_accessor :scope
+
+        def initialize(expand: nil, name: nil, scope: nil)
+          @expand = expand
+          @name = name
+          @scope = scope
+        end
+      end
+
+      class DeleteWhereParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          attr_accessor :user
+
+          def initialize(type: nil, user: nil)
+            @type = type
+            @user = user
+          end
+        end
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A name for the secret that's unique within the scope.
+        attr_accessor :name
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        attr_accessor :scope
+
+        def initialize(expand: nil, name: nil, scope: nil)
+          @expand = expand
+          @name = name
+          @scope = scope
+        end
+      end
+
+      # Create or replace a secret in the secret store.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/apps/secrets",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deletes a secret from the secret store by name and scope.
+      def delete_where(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Finds a secret in the secret store by name and scope.
+      def find(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List all secrets stored on the given scope.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/apps/secrets",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/apps_service.rb

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

data/lib/stripe/services/balance_service.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BalanceService < 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 the current account balance, based on the authentication that was used to make the request.
+    #  For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
+    def retrieve(params = {}, opts = {})
+      request(method: :get, path: "/v1/balance", params: params, opts: opts, base_address: :api)
+    end
+  end
+end

data/lib/stripe/services/balance_transaction_service.rb

@@ -0,0 +1,101 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BalanceTransactionService < StripeService
+    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
+      # Only return transactions that were created during the given date interval.
+      attr_accessor :created
+      # Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_accessor :currency
+      # 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
+      # For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
+      attr_accessor :payout
+      # Only returns the original transaction.
+      attr_accessor :source
+      # 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
+      # Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
+      attr_accessor :type
+
+      def initialize(
+        created: nil,
+        currency: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        payout: nil,
+        source: nil,
+        starting_after: nil,
+        type: nil
+      )
+        @created = created
+        @currency = currency
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @payout = payout
+        @source = source
+        @starting_after = starting_after
+        @type = type
+      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
+
+    # Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
+    #
+    # Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/balance_transactions",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the balance transaction with the given ID.
+    #
+    # Note that this endpoint previously used the path /v1/balance/history/:id.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/balance_transactions/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end