stripe 15.3.0.pre.beta.1 → 15.3.0

data/lib/stripe/services/privacy/redaction_job_service.rb

@@ -1,240 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Privacy
-    class RedactionJobService < StripeService
-      attr_reader :validation_errors
-
-      def initialize(requestor)
-        super
-        @validation_errors = Stripe::Privacy::RedactionJobValidationErrorService.new(@requestor)
-      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
-        # Attribute for param field status
-        attr_accessor :status
-
-        def initialize(
-          ending_before: nil,
-          expand: nil,
-          limit: nil,
-          starting_after: nil,
-          status: nil
-        )
-          @ending_before = ending_before
-          @expand = expand
-          @limit = limit
-          @starting_after = starting_after
-          @status = status
-        end
-      end
-
-      class CreateParams < Stripe::RequestParams
-        class Objects < Stripe::RequestParams
-          # Attribute for param field charges
-          attr_accessor :charges
-          # Attribute for param field checkout_sessions
-          attr_accessor :checkout_sessions
-          # Attribute for param field customers
-          attr_accessor :customers
-          # Attribute for param field identity_verification_sessions
-          attr_accessor :identity_verification_sessions
-          # Attribute for param field invoices
-          attr_accessor :invoices
-          # Attribute for param field issuing_cardholders
-          attr_accessor :issuing_cardholders
-          # Attribute for param field issuing_cards
-          attr_accessor :issuing_cards
-          # Attribute for param field payment_intents
-          attr_accessor :payment_intents
-          # Attribute for param field radar_value_list_items
-          attr_accessor :radar_value_list_items
-          # Attribute for param field setup_intents
-          attr_accessor :setup_intents
-
-          def initialize(
-            charges: nil,
-            checkout_sessions: nil,
-            customers: nil,
-            identity_verification_sessions: nil,
-            invoices: nil,
-            issuing_cardholders: nil,
-            issuing_cards: nil,
-            payment_intents: nil,
-            radar_value_list_items: nil,
-            setup_intents: nil
-          )
-            @charges = charges
-            @checkout_sessions = checkout_sessions
-            @customers = customers
-            @identity_verification_sessions = identity_verification_sessions
-            @invoices = invoices
-            @issuing_cardholders = issuing_cardholders
-            @issuing_cards = issuing_cards
-            @payment_intents = payment_intents
-            @radar_value_list_items = radar_value_list_items
-            @setup_intents = setup_intents
-          end
-        end
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-        # The objects to redact. These root objects and their related ones will be validated for redaction.
-        attr_accessor :objects
-        # Determines the validation behavior of the job. Default is `error`.
-        attr_accessor :validation_behavior
-
-        def initialize(expand: nil, objects: nil, validation_behavior: nil)
-          @expand = expand
-          @objects = objects
-          @validation_behavior = validation_behavior
-        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
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-        # Determines the validation behavior of the job. Default is `error`.
-        attr_accessor :validation_behavior
-
-        def initialize(expand: nil, validation_behavior: nil)
-          @expand = expand
-          @validation_behavior = validation_behavior
-        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
-
-      class RunParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-
-        def initialize(expand: nil)
-          @expand = expand
-        end
-      end
-
-      class ValidateParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-
-        def initialize(expand: nil)
-          @expand = expand
-        end
-      end
-
-      # You can cancel a redaction job when it's in one of these statuses: ready, failed.
-      #
-      # Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
-      def cancel(job, params = {}, opts = {})
-        request(
-          method: :post,
-          path: format("/v1/privacy/redaction_jobs/%<job>s/cancel", { job: CGI.escape(job) }),
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-
-      # Creates a redaction job. When a job is created, it will start to validate.
-      def create(params = {}, opts = {})
-        request(
-          method: :post,
-          path: "/v1/privacy/redaction_jobs",
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-
-      # Returns a list of redaction jobs.
-      def list(params = {}, opts = {})
-        request(
-          method: :get,
-          path: "/v1/privacy/redaction_jobs",
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-
-      # Retrieves the details of a previously created redaction job.
-      def retrieve(job, params = {}, opts = {})
-        request(
-          method: :get,
-          path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-
-      # Run a redaction job in a ready status.
-      #
-      # When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
-      #
-      # The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
-      def run(job, params = {}, opts = {})
-        request(
-          method: :post,
-          path: format("/v1/privacy/redaction_jobs/%<job>s/run", { job: CGI.escape(job) }),
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-
-      # Updates the properties of a redaction job without running or canceling the job.
-      #
-      # If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
-      def update(job, params = {}, opts = {})
-        request(
-          method: :post,
-          path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-
-      # Validate a redaction job when it is in a failed status.
-      #
-      # When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
-      #
-      # The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
-      def validate(job, params = {}, opts = {})
-        request(
-          method: :post,
-          path: format("/v1/privacy/redaction_jobs/%<job>s/validate", { job: CGI.escape(job) }),
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-    end
-  end
-end

data/lib/stripe/services/privacy_service.rb

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

data/lib/stripe/services/quote_preview_subscription_schedule_service.rb

@@ -1,35 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  class QuotePreviewSubscriptionScheduleService < 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
-
-    # Preview the schedules that would be generated by accepting the quote
-    def list(quote, params = {}, opts = {})
-      request(
-        method: :get,
-        path: format("/v1/quotes/%<quote>s/preview_subscription_schedules", { quote: CGI.escape(quote) }),
-        params: params,
-        opts: opts,
-        base_address: :api
-      )
-    end
-  end
-end

data/lib/stripe/services/tax/association_service.rb

@@ -1,31 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Tax
-    class AssociationService < StripeService
-      class FindParams < Stripe::RequestParams
-        # Specifies which fields in the response should be expanded.
-        attr_accessor :expand
-        # Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id
-        attr_accessor :payment_intent
-
-        def initialize(expand: nil, payment_intent: nil)
-          @expand = expand
-          @payment_intent = payment_intent
-        end
-      end
-
-      # Finds a tax association object by PaymentIntent id.
-      def find(params = {}, opts = {})
-        request(
-          method: :get,
-          path: "/v1/tax/associations/find",
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-    end
-  end
-end

data/lib/stripe/services/tax/form_service.rb

@@ -1,100 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Tax
-    class FormService < StripeService
-      class ListParams < Stripe::RequestParams
-        class Payee < Stripe::RequestParams
-          # The ID of the Stripe account whose forms will be retrieved.
-          attr_accessor :account
-          # The external reference to the payee whose forms will be retrieved.
-          attr_accessor :external_reference
-          # Specifies the payee type. Either `account` or `external_reference`.
-          attr_accessor :type
-
-          def initialize(account: nil, external_reference: nil, type: nil)
-            @account = account
-            @external_reference = external_reference
-            @type = type
-          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
-        # The payee whose volume is represented on the tax form.
-        attr_accessor :payee
-        # 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
-        # An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
-        attr_accessor :type
-
-        def initialize(
-          ending_before: nil,
-          expand: nil,
-          limit: nil,
-          payee: nil,
-          starting_after: nil,
-          type: nil
-        )
-          @ending_before = ending_before
-          @expand = expand
-          @limit = limit
-          @payee = payee
-          @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
-
-      class PdfParams < 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 tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
-      def list(params = {}, opts = {})
-        request(method: :get, path: "/v1/tax/forms", params: params, opts: opts, base_address: :api)
-      end
-
-      # Download the PDF for a tax form.
-      def pdf(id, params = {}, opts = {}, &read_body_chunk_block)
-        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
-        request_stream(
-          method: :get,
-          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
-          params: params,
-          opts: opts,
-          base_address: :files,
-          &read_body_chunk_block
-        )
-      end
-
-      # Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
-      def retrieve(id, params = {}, opts = {})
-        request(
-          method: :get,
-          path: format("/v1/tax/forms/%<id>s", { id: CGI.escape(id) }),
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-    end
-  end
-end

data/lib/stripe/services/terminal/reader_collected_data_service.rb

@@ -1,28 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Terminal
-    class ReaderCollectedDataService < 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
-
-      # Retrieve data collected using Reader hardware.
-      def retrieve(reader_collected_data, params = {}, opts = {})
-        request(
-          method: :get,
-          path: format("/v1/terminal/reader_collected_data/%<reader_collected_data>s", { reader_collected_data: CGI.escape(reader_collected_data) }),
-          params: params,
-          opts: opts,
-          base_address: :api
-        )
-      end
-    end
-  end
-end

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

@@ -1,76 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module V2
-    module Core
-      class AccountLinkService < StripeService
-        class CreateParams < Stripe::RequestParams
-          class UseCase < Stripe::RequestParams
-            class AccountOnboarding < Stripe::RequestParams
-              # Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
-              attr_accessor :configurations
-              # The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
-              attr_accessor :refresh_url
-              # The URL that the user will be redirected to upon completing the linked flow.
-              attr_accessor :return_url
-
-              def initialize(configurations: nil, refresh_url: nil, return_url: nil)
-                @configurations = configurations
-                @refresh_url = refresh_url
-                @return_url = return_url
-              end
-            end
-
-            class AccountUpdate < Stripe::RequestParams
-              # Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
-              attr_accessor :configurations
-              # The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
-              attr_accessor :refresh_url
-              # The URL that the user will be redirected to upon completing the linked flow.
-              attr_accessor :return_url
-
-              def initialize(configurations: nil, refresh_url: nil, return_url: nil)
-                @configurations = configurations
-                @refresh_url = refresh_url
-                @return_url = return_url
-              end
-            end
-            # Open Enum. The type of AccountLink the user is requesting.
-            attr_accessor :type
-            # Indicates that the AccountLink provided should onboard an account.
-            attr_accessor :account_onboarding
-            # Indicates that the AccountLink provided should update a previously onboarded account.
-            attr_accessor :account_update
-
-            def initialize(type: nil, account_onboarding: nil, account_update: nil)
-              @type = type
-              @account_onboarding = account_onboarding
-              @account_update = account_update
-            end
-          end
-          # The ID of the Account to create link for.
-          attr_accessor :account
-          # The use case of the AccountLink.
-          attr_accessor :use_case
-
-          def initialize(account: nil, use_case: nil)
-            @account = account
-            @use_case = use_case
-          end
-        end
-
-        # Creates an AccountLink object that includes a single-use Stripe URL that the merchant can redirect their user to in order to take them to a Stripe-hosted application such as Recipient Onboarding.
-        def create(params = {}, opts = {})
-          request(
-            method: :post,
-            path: "/v2/core/account_links",
-            params: params,
-            opts: opts,
-            base_address: :api
-          )
-        end
-      end
-    end
-  end
-end