stripe 15.5.0 → 15.6.0.pre.alpha.2

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

@@ -0,0 +1,142 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanService < StripeService
+        attr_reader :components, :versions
+
+        def initialize(requestor)
+          super
+          @components = Stripe::V2::Billing::PricingPlans::ComponentService.new(@requestor)
+          @versions = Stripe::V2::Billing::PricingPlans::VersionService.new(@requestor)
+        end
+
+        class ListParams < Stripe::RequestParams
+          # Filter for active/inactive PricingPlans. Mutually exclusive with `lookup_keys`.
+          attr_accessor :active
+          # Optionally set the maximum number of results per page. Defaults to 20.
+          attr_accessor :limit
+          # Filter by lookup keys. Mutually exclusive with `active`.
+          # You can specify up to 10 lookup keys.
+          attr_accessor :lookup_keys
+
+          def initialize(active: nil, limit: nil, lookup_keys: nil)
+            @active = active
+            @limit = limit
+            @lookup_keys = lookup_keys
+          end
+        end
+
+        class CreateParams < Stripe::RequestParams
+          # The currency of the PricingPlan.
+          attr_accessor :currency
+          # Description of pricing plan subscription.
+          attr_accessor :description
+          # Display name of the PricingPlan. Maximum 250 characters.
+          attr_accessor :display_name
+          # An internal key you can use to search for a particular PricingPlan. Maximum length of 200 characters.
+          attr_accessor :lookup_key
+          # Set of [key-value pairs](/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.
+          attr_accessor :metadata
+          # The Stripe Tax tax behavior - whether the PricingPlan is inclusive or exclusive of tax.
+          attr_accessor :tax_behavior
+
+          def initialize(
+            currency: nil,
+            description: nil,
+            display_name: nil,
+            lookup_key: nil,
+            metadata: nil,
+            tax_behavior: nil
+          )
+            @currency = currency
+            @description = description
+            @display_name = display_name
+            @lookup_key = lookup_key
+            @metadata = metadata
+            @tax_behavior = tax_behavior
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams; end
+
+        class UpdateParams < Stripe::RequestParams
+          # Whether the PricingPlan is active.
+          attr_accessor :active
+          # Description of pricing plan subscription.
+          attr_accessor :description
+          # Display name of the PricingPlan. Maximum 250 characters.
+          attr_accessor :display_name
+          # The ID of the live version of the PricingPlan.
+          attr_accessor :live_version
+          # An internal key you can use to search for a particular PricingPlan. Maximum length of 200 characters.
+          attr_accessor :lookup_key
+          # Set of key-value pairs that you can attach to an object.
+          attr_accessor :metadata
+
+          def initialize(
+            active: nil,
+            description: nil,
+            display_name: nil,
+            live_version: nil,
+            lookup_key: nil,
+            metadata: nil
+          )
+            @active = active
+            @description = description
+            @display_name = display_name
+            @live_version = live_version
+            @lookup_key = lookup_key
+            @metadata = metadata
+          end
+        end
+
+        # Create a Pricing Plan object.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/pricing_plans",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List all Pricing Plan objects.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/billing/pricing_plans",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a Pricing Plan object.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/pricing_plans/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update a Pricing Plan object.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/pricing_plans/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionService < StripeService
+        class ListParams < Stripe::RequestParams
+          class Payer < Stripe::RequestParams
+            # The ID of the Customer object. If provided, only Pricing Plan Subscriptions that are subscribed on the cadences with the specified payer will be returned.
+            attr_accessor :customer
+            # A string identifying the type of the payer. Currently the only supported value is `customer`.
+            attr_accessor :type
+
+            def initialize(customer: nil, type: nil)
+              @customer = customer
+              @type = type
+            end
+          end
+          # Filter by Billing Cadence ID. Mutually exclusive with `payer`, `pricing_plan`, and `pricing_plan_version`.
+          attr_accessor :billing_cadence
+          # Optionally set the maximum number of results per page. Defaults to 20.
+          attr_accessor :limit
+          # Filter by payer. Mutually exclusive with `billing_cadence`, `pricing_plan`, and `pricing_plan_version`.
+          attr_accessor :payer
+          # Filter by PricingPlan ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan_version`.
+          attr_accessor :pricing_plan
+          # Filter by Pricing Plan Version ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan`.
+          attr_accessor :pricing_plan_version
+          # Filter by servicing status.
+          attr_accessor :servicing_status
+
+          def initialize(
+            billing_cadence: nil,
+            limit: nil,
+            payer: nil,
+            pricing_plan: nil,
+            pricing_plan_version: nil,
+            servicing_status: nil
+          )
+            @billing_cadence = billing_cadence
+            @limit = limit
+            @payer = payer
+            @pricing_plan = pricing_plan
+            @pricing_plan_version = pricing_plan_version
+            @servicing_status = servicing_status
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams; end
+
+        # List all Pricing Plan Subscription objects.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/billing/pricing_plan_subscriptions",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a Pricing Plan Subscription object.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/pricing_plan_subscriptions/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/pricing_plans/component_service.rb

@@ -0,0 +1,162 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class ComponentService < StripeService
+          class ListParams < Stripe::RequestParams
+            # Optionally set the maximum number of results per page. Defaults to 20.
+            attr_accessor :limit
+            # Filter by lookup keys. Mutually exclusive with `pricing_plan_version`.
+            # You can specify up to 10 lookup keys.
+            attr_accessor :lookup_keys
+            # The ID of the Pricing Plan Version to list components for. Will use the latest version if not provided.
+            # Mutually exclusive with `lookup_keys`.
+            attr_accessor :pricing_plan_version
+
+            def initialize(limit: nil, lookup_keys: nil, pricing_plan_version: nil)
+              @limit = limit
+              @lookup_keys = lookup_keys
+              @pricing_plan_version = pricing_plan_version
+            end
+          end
+
+          class CreateParams < Stripe::RequestParams
+            class LicenseFee < Stripe::RequestParams
+              # The ID of the License Fee.
+              attr_accessor :id
+              # The version of the LicenseFee. Defaults to 'latest', if not specified.
+              attr_accessor :version
+
+              def initialize(id: nil, version: nil)
+                @id = id
+                @version = version
+              end
+            end
+
+            class RateCard < Stripe::RequestParams
+              # The ID of the Rate Card.
+              attr_accessor :id
+              # The version of the RateCard. Defaults to 'latest', if not specified.
+              attr_accessor :version
+
+              def initialize(id: nil, version: nil)
+                @id = id
+                @version = version
+              end
+            end
+
+            class ServiceAction < Stripe::RequestParams
+              # The ID of the service action.
+              attr_accessor :id
+
+              def initialize(id: nil)
+                @id = id
+              end
+            end
+            # An identifier that can be used to find this component.
+            attr_accessor :lookup_key
+            # Set of [key-value pairs](/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.
+            attr_accessor :metadata
+            # The type of the PricingPlanComponent.
+            attr_accessor :type
+            # Details if this component is a License Fee.
+            attr_accessor :license_fee
+            # Details if this component is a Rate Card.
+            attr_accessor :rate_card
+            # Details if this component is a Service Action.
+            attr_accessor :service_action
+
+            def initialize(
+              lookup_key: nil,
+              metadata: nil,
+              type: nil,
+              license_fee: nil,
+              rate_card: nil,
+              service_action: nil
+            )
+              @lookup_key = lookup_key
+              @metadata = metadata
+              @type = type
+              @license_fee = license_fee
+              @rate_card = rate_card
+              @service_action = service_action
+            end
+          end
+
+          class DeleteParams < Stripe::RequestParams; end
+          class RetrieveParams < Stripe::RequestParams; end
+
+          class UpdateParams < Stripe::RequestParams
+            # An identifier that can be used to find this component. Maximum length of 200 characters.
+            attr_accessor :lookup_key
+            # Set of key-value pairs that you can attach to an object.
+            attr_accessor :metadata
+
+            def initialize(lookup_key: nil, metadata: nil)
+              @lookup_key = lookup_key
+              @metadata = metadata
+            end
+          end
+
+          # Create a Pricing Plan Component object.
+          def create(pricing_plan_id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/billing/pricing_plans/%<pricing_plan_id>s/components", { pricing_plan_id: CGI.escape(pricing_plan_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Remove a Pricing Plan Component from the latest version of a Pricing Plan.
+          def delete(pricing_plan_id, id, params = {}, opts = {})
+            request(
+              method: :delete,
+              path: format("/v2/billing/pricing_plans/%<pricing_plan_id>s/components/%<id>s", { pricing_plan_id: CGI.escape(pricing_plan_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # List all Pricing Plan Component objects for a Pricing Plan.
+          def list(pricing_plan_id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/pricing_plans/%<pricing_plan_id>s/components", { pricing_plan_id: CGI.escape(pricing_plan_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a Pricing Plan Component object.
+          def retrieve(pricing_plan_id, id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/pricing_plans/%<pricing_plan_id>s/components/%<id>s", { pricing_plan_id: CGI.escape(pricing_plan_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Update a Pricing Plan Component object.
+          def update(pricing_plan_id, id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/billing/pricing_plans/%<pricing_plan_id>s/components/%<id>s", { pricing_plan_id: CGI.escape(pricing_plan_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module PricingPlans
+        class VersionService < StripeService
+          class ListParams < Stripe::RequestParams
+            # Optionally set the maximum number of results per page. Defaults to 20.
+            attr_accessor :limit
+
+            def initialize(limit: nil)
+              @limit = limit
+            end
+          end
+
+          class RetrieveParams < Stripe::RequestParams; end
+
+          # List all Pricing Plan Versions of a Pricing Plan.
+          def list(pricing_plan_id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/pricing_plans/%<pricing_plan_id>s/versions", { pricing_plan_id: CGI.escape(pricing_plan_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a specific Pricing Plan Version of a Pricing Plan.
+          def retrieve(pricing_plan_id, id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/pricing_plans/%<pricing_plan_id>s/versions/%<id>s", { pricing_plan_id: CGI.escape(pricing_plan_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class ProfileService < StripeService
+        class ListParams < Stripe::RequestParams
+          # Filter billing profiles by a customer. Mutually exclusive
+          # with `lookup_keys` and `default_payment_method`.
+          attr_accessor :customer
+          # Filter billing profiles by a default payment method. Mutually exclusive
+          # with `customer` and `lookup_keys`.
+          attr_accessor :default_payment_method
+          # Optionally set the maximum number of results per page. Defaults to 10.
+          attr_accessor :limit
+          # Filter billing profiles by lookup keys. Mutually exclusive
+          # with `customer` and `default_payment_method`.
+          # You can specify up to 10 lookup_keys.
+          attr_accessor :lookup_keys
+          # Filter billing profiles by status. Can be combined
+          # with all other filters. If not provided, all billing profiles will be returned.
+          attr_accessor :status
+
+          def initialize(
+            customer: nil,
+            default_payment_method: nil,
+            limit: nil,
+            lookup_keys: nil,
+            status: nil
+          )
+            @customer = customer
+            @default_payment_method = default_payment_method
+            @limit = limit
+            @lookup_keys = lookup_keys
+            @status = status
+          end
+        end
+
+        class CreateParams < Stripe::RequestParams
+          # The ID of the customer object.
+          attr_accessor :customer
+          # The ID of the payment method object.
+          attr_accessor :default_payment_method
+          # A customer-facing name for the billing profile.
+          # Maximum length of 250 characters.
+          attr_accessor :display_name
+          # An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
+          # Maximum length of 200 characters.
+          attr_accessor :lookup_key
+          # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+          attr_accessor :metadata
+
+          def initialize(
+            customer: nil,
+            default_payment_method: nil,
+            display_name: nil,
+            lookup_key: nil,
+            metadata: nil
+          )
+            @customer = customer
+            @default_payment_method = default_payment_method
+            @display_name = display_name
+            @lookup_key = lookup_key
+            @metadata = metadata
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams; end
+
+        class UpdateParams < Stripe::RequestParams
+          # The ID of the payment method object.
+          attr_accessor :default_payment_method
+          # A customer-facing name for the billing profile.
+          # Maximum length of 250 characters.
+          # To remove the display_name from the object, set it to null in the request.
+          attr_accessor :display_name
+          # An internal key you can use to search for a particular billing profile. It must be unique among billing profiles for a given customer.
+          # Maximum length of 200 characters.
+          # To remove the lookup_key from the object, set it to null in the request.
+          attr_accessor :lookup_key
+          # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+          attr_accessor :metadata
+
+          def initialize(
+            default_payment_method: nil,
+            display_name: nil,
+            lookup_key: nil,
+            metadata: nil
+          )
+            @default_payment_method = default_payment_method
+            @display_name = display_name
+            @lookup_key = lookup_key
+            @metadata = metadata
+          end
+        end
+
+        # Create a BillingProfile object.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/profiles",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List Billing Profiles.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/billing/profiles",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a BillingProfile object.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/profiles/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update a BillingProfile object.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/profiles/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end