stripe 18.2.0 → 18.3.0.pre.alpha.1

data/lib/stripe/services/v2/billing/rate_cards/rate_service.rb

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class RateService < StripeService
+          # Set the Rate for a Metered Item on the latest version of a Rate Card object. This will create a new Rate Card version
+          # if the Metered Item already has a rate on the Rate Card.
+          def create(rate_card_id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates", { rate_card_id: CGI.escape(rate_card_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Remove an existing Rate from a Rate Card. This will create a new Rate Card Version without that Rate.
+          def delete(rate_card_id, id, params = {}, opts = {})
+            request(
+              method: :delete,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # List all Rates associated with a Rate Card for a specific version (defaults to latest). Rates remain active for all subsequent versions until a new rate is created for the same Metered Item.
+          def list(rate_card_id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates", { rate_card_id: CGI.escape(rate_card_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a Rate object.
+          def retrieve(rate_card_id, id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/rate_cards/version_service.rb

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class VersionService < StripeService
+          # List the versions of a Rate Card object. Results are sorted in reverse chronological order (most recent first).
+          def list(rate_card_id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/versions", { rate_card_id: CGI.escape(rate_card_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a specific version of a Rate Card object.
+          def retrieve(rate_card_id, id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/versions/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/service_action_service.rb

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class ServiceActionService < StripeService
+        # Create a Service Action object.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/service_actions",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a Service Action object.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/service_actions/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update a ServiceAction object.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/service_actions/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing_service.rb

@@ -4,14 +4,31 @@
 module Stripe
   module V2
     class BillingService < StripeService
-      attr_reader :meter_events, :meter_event_adjustments, :meter_event_session, :meter_event_stream
+      attr_reader :bill_settings, :cadences, :collection_settings, :custom_pricing_units, :intents, :license_fees, :license_fee_subscriptions, :licensed_items, :meter_events, :meter_event_adjustments, :meter_event_session, :meter_event_stream, :metered_items, :pricing_plans, :pricing_plan_subscriptions, :profiles, :rate_cards, :rate_card_subscriptions, :service_actions
 
       def initialize(requestor)
         super
+        @bill_settings = Stripe::V2::Billing::BillSettingService.new(@requestor)
+        @cadences = Stripe::V2::Billing::CadenceService.new(@requestor)
+        @collection_settings = Stripe::V2::Billing::CollectionSettingService.new(@requestor)
+        @custom_pricing_units = Stripe::V2::Billing::CustomPricingUnitService.new(@requestor)
+        @intents = Stripe::V2::Billing::IntentService.new(@requestor)
+        @license_fees = Stripe::V2::Billing::LicenseFeeService.new(@requestor)
+        @license_fee_subscriptions = Stripe::V2::Billing::LicenseFeeSubscriptionService
+                                     .new(@requestor)
+        @licensed_items = Stripe::V2::Billing::LicensedItemService.new(@requestor)
         @meter_events = Stripe::V2::Billing::MeterEventService.new(@requestor)
         @meter_event_adjustments = Stripe::V2::Billing::MeterEventAdjustmentService.new(@requestor)
         @meter_event_session = Stripe::V2::Billing::MeterEventSessionService.new(@requestor)
         @meter_event_stream = Stripe::V2::Billing::MeterEventStreamService.new(@requestor)
+        @metered_items = Stripe::V2::Billing::MeteredItemService.new(@requestor)
+        @pricing_plans = Stripe::V2::Billing::PricingPlanService.new(@requestor)
+        @pricing_plan_subscriptions = Stripe::V2::Billing::PricingPlanSubscriptionService
+                                      .new(@requestor)
+        @profiles = Stripe::V2::Billing::ProfileService.new(@requestor)
+        @rate_cards = Stripe::V2::Billing::RateCardService.new(@requestor)
+        @rate_card_subscriptions = Stripe::V2::Billing::RateCardSubscriptionService.new(@requestor)
+        @service_actions = Stripe::V2::Billing::ServiceActionService.new(@requestor)
       end
     end
   end

data/lib/stripe/services/v2/core/account_link_service.rb

@@ -6,6 +6,8 @@ module Stripe
     module Core
       class AccountLinkService < StripeService
         # Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.
+        #
+        # ** raises RateLimitError
         def create(params = {}, opts = {})
           request(
             method: :post,

data/lib/stripe/services/v2/core/account_service.rb

@@ -14,6 +14,8 @@ module Stripe
         end
 
         # Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.
+        #
+        # ** raises RateLimitError
         def close(id, params = {}, opts = {})
           request(
             method: :post,
@@ -25,6 +27,8 @@ module Stripe
         end
 
         # An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.
+        #
+        # ** raises RateLimitError
         def create(params = {}, opts = {})
           request(
             method: :post,
@@ -36,6 +40,8 @@ module Stripe
         end
 
         # Returns a list of Accounts.
+        #
+        # ** raises RateLimitError
         def list(params = {}, opts = {})
           request(
             method: :get,
@@ -47,6 +53,8 @@ module Stripe
         end
 
         # Retrieves the details of an Account.
+        #
+        # ** raises RateLimitError
         def retrieve(id, params = {}, opts = {})
           request(
             method: :get,
@@ -58,6 +66,8 @@ module Stripe
         end
 
         # Updates the details of an Account.
+        #
+        # ** raises RateLimitError
         def update(id, params = {}, opts = {})
           request(
             method: :post,

data/lib/stripe/services/v2/core/account_token_service.rb

@@ -6,6 +6,8 @@ module Stripe
     module Core
       class AccountTokenService < StripeService
         # Creates an Account Token.
+        #
+        # ** raises RateLimitError
         def create(params = {}, opts = {})
           request(
             method: :post,
@@ -17,6 +19,8 @@ module Stripe
         end
 
         # Retrieves an Account Token.
+        #
+        # ** raises RateLimitError
         def retrieve(id, params = {}, opts = {})
           request(
             method: :get,

data/lib/stripe/services/v2/core/accounts/person_service.rb

@@ -7,6 +7,8 @@ module Stripe
       module Accounts
         class PersonService < StripeService
           # Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation.
+          #
+          # ** raises RateLimitError
           def create(account_id, params = {}, opts = {})
             request(
               method: :post,
@@ -18,6 +20,8 @@ module Stripe
           end
 
           # Delete a Person associated with an Account.
+          #
+          # ** raises RateLimitError
           def delete(account_id, id, params = {}, opts = {})
             request(
               method: :delete,
@@ -29,6 +33,8 @@ module Stripe
           end
 
           # Returns a paginated list of Persons associated with an Account.
+          #
+          # ** raises RateLimitError
           def list(account_id, params = {}, opts = {})
             request(
               method: :get,
@@ -40,6 +46,8 @@ module Stripe
           end
 
           # Retrieves a Person associated with an Account.
+          #
+          # ** raises RateLimitError
           def retrieve(account_id, id, params = {}, opts = {})
             request(
               method: :get,
@@ -51,6 +59,8 @@ module Stripe
           end
 
           # Updates a Person associated with an Account.
+          #
+          # ** raises RateLimitError
           def update(account_id, id, params = {}, opts = {})
             request(
               method: :post,

data/lib/stripe/services/v2/core/accounts/person_token_service.rb

@@ -7,6 +7,8 @@ module Stripe
       module Accounts
         class PersonTokenService < StripeService
           # Creates a Person Token associated with an Account.
+          #
+          # ** raises RateLimitError
           def create(account_id, params = {}, opts = {})
             request(
               method: :post,
@@ -18,6 +20,8 @@ module Stripe
           end
 
           # Retrieves a Person Token associated with an Account.
+          #
+          # ** raises RateLimitError
           def retrieve(account_id, id, params = {}, opts = {})
             request(
               method: :get,

data/lib/stripe/services/v2/core/claimable_sandbox_service.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class ClaimableSandboxService < StripeService
+        # Create an anonymous, claimable sandbox. This sandbox can be prefilled with data. The response will include
+        # a claim URL that allow a user to claim the account.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/core/claimable_sandboxes",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves the details of a claimable sandbox that was previously been created.
+        # Supply the unique claimable sandbox ID that was returned from your creation request,
+        # and Stripe will return the corresponding sandbox information.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/core/claimable_sandboxes/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb

@@ -0,0 +1,85 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        class GbBankAccountService < StripeService
+          # Confirm that you have received the result of the Confirmation of Payee request, and that you are okay with
+          # proceeding to pay out to this bank account despite the account not matching, partially matching, or the service
+          # being unavailable. Once you confirm this, you will be able to send OutboundPayments, but this may lead to
+          # funds being sent to the wrong account, which we might not be able to recover.
+          def acknowledge_confirmation_of_payee(id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/core/vault/gb_bank_accounts/%<id>s/acknowledge_confirmation_of_payee", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Archive a GBBankAccount object. Archived GBBankAccount objects cannot be used as outbound destinations
+          # and will not appear in the outbound destination list.
+          def archive(id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/core/vault/gb_bank_accounts/%<id>s/archive", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Create a GB bank account.
+          def create(params = {}, opts = {})
+            request(
+              method: :post,
+              path: "/v2/core/vault/gb_bank_accounts",
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Initiate Confirmation of Payee (CoP) in order to verify that the owner of a UK bank account matches
+          # who you expect. This must be done on all UK bank accounts before sending domestic OutboundPayments. If
+          # the result is a partial match or a non match, explicit acknowledgement using AcknowledgeConfirmationOfPayee
+          # is required before sending funds.
+          def initiate_confirmation_of_payee(id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/core/vault/gb_bank_accounts/%<id>s/initiate_confirmation_of_payee", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # List objects that can be used as destinations for outbound money movement via OutboundPayment.
+          def list(params = {}, opts = {})
+            request(
+              method: :get,
+              path: "/v2/core/vault/gb_bank_accounts",
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a GB bank account.
+          def retrieve(id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/core/vault/gb_bank_accounts/%<id>s", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb

@@ -0,0 +1,101 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      module Vault
+        class UsBankAccountService < StripeService
+          # Archive a USBankAccount object. USBankAccount objects will not be automatically archived by Stripe.
+          # Archived USBankAccount objects cannot be used as outbound destinations
+          # and will not appear in the outbound destination list.
+          #
+          # ** raises ControlledByDashboardError
+          def archive(id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/core/vault/us_bank_accounts/%<id>s/archive", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Confirm microdeposits amounts or descriptor code that you have received from the Send Microdeposits request. Once you correctly confirm this, this US Bank Account will be verified and eligible to transfer funds with.
+          def confirm_microdeposits(id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/core/vault/us_bank_accounts/%<id>s/confirm_microdeposits", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Create a USBankAccount object.
+          #
+          # ** raises BlockedByStripeError
+          # ** raises InvalidPaymentMethodError
+          # ** raises QuotaExceededError
+          def create(params = {}, opts = {})
+            request(
+              method: :post,
+              path: "/v2/core/vault/us_bank_accounts",
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # List USBankAccount objects. Optionally filter by verification status.
+          def list(params = {}, opts = {})
+            request(
+              method: :get,
+              path: "/v2/core/vault/us_bank_accounts",
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a USBankAccount object.
+          def retrieve(id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/core/vault/us_bank_accounts/%<id>s", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Send microdeposits in order to verify your US Bank Account so it is eligible to transfer funds. This will start the verification process and you must Confirm Microdeposits to successfully verify your US Bank Account.
+          def send_microdeposits(id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/core/vault/us_bank_accounts/%<id>s/send_microdeposits", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Update a USBankAccount object. This is limited to supplying a previously empty routing_number field.
+          #
+          # ** raises BlockedByStripeError
+          # ** raises InvalidPaymentMethodError
+          # ** raises QuotaExceededError
+          def update(id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/core/vault/us_bank_accounts/%<id>s", { id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/core/vault_service.rb

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class VaultService < StripeService
+        attr_reader :gb_bank_accounts, :us_bank_accounts
+
+        def initialize(requestor)
+          super
+          @gb_bank_accounts = Stripe::V2::Core::Vault::GbBankAccountService.new(@requestor)
+          @us_bank_accounts = Stripe::V2::Core::Vault::UsBankAccountService.new(@requestor)
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/core_service.rb

@@ -4,15 +4,17 @@
 module Stripe
   module V2
     class CoreService < StripeService
-      attr_reader :accounts, :account_links, :account_tokens, :events, :event_destinations
+      attr_reader :accounts, :account_links, :account_tokens, :claimable_sandboxes, :events, :event_destinations, :vault
 
       def initialize(requestor)
         super
         @accounts = Stripe::V2::Core::AccountService.new(@requestor)
         @account_links = Stripe::V2::Core::AccountLinkService.new(@requestor)
         @account_tokens = Stripe::V2::Core::AccountTokenService.new(@requestor)
+        @claimable_sandboxes = Stripe::V2::Core::ClaimableSandboxService.new(@requestor)
         @events = Stripe::V2::Core::EventService.new(@requestor)
         @event_destinations = Stripe::V2::Core::EventDestinationService.new(@requestor)
+        @vault = Stripe::V2::Core::VaultService.new(@requestor)
       end
     end
   end

data/lib/stripe/services/v2/iam/api_key_service.rb

@@ -0,0 +1,76 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Iam
+      class ApiKeyService < StripeService
+        # Create an API key. To create a secret key in livemode, a public key for encryption must be provided.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/iam/api_keys",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Expire an API key. The specified key becomes invalid immediately.
+        def expire(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/iam/api_keys/%<id>s/expire", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List all API keys of an account.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/iam/api_keys",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve an API key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/iam/api_keys/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.
+        def rotate(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/iam/api_keys/%<id>s/rotate", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update an API key. Only parameters that are specified in the request will be updated.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/iam/api_keys/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/iam_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class IamService < StripeService
+      attr_reader :api_keys
+
+      def initialize(requestor)
+        super
+        @api_keys = Stripe::V2::Iam::ApiKeyService.new(@requestor)
+      end
+    end
+  end
+end