stripe-ruby/lib/stripe/services/product_feature_service.rb
2024-12-20 19:41:09 +00:00

93 lines
3.4 KiB
Ruby

# File generated from our OpenAPI spec
# frozen_string_literal: true
module Stripe
class ProductFeatureService < 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 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
# The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product.
attr_accessor :entitlement_feature
# Specifies which fields in the response should be expanded.
attr_accessor :expand
def initialize(entitlement_feature: nil, expand: nil)
@entitlement_feature = entitlement_feature
@expand = expand
end
end
# Creates a product_feature, which represents a feature attachment to a product
def create(product, params = {}, opts = {})
request(
method: :post,
path: format("/v1/products/%<product>s/features", { product: CGI.escape(product) }),
params: params,
opts: opts,
base_address: :api
)
end
# Deletes the feature attachment to a product
def delete(product, id, params = {}, opts = {})
request(
method: :delete,
path: format("/v1/products/%<product>s/features/%<id>s", { product: CGI.escape(product), id: CGI.escape(id) }),
params: params,
opts: opts,
base_address: :api
)
end
# Retrieve a list of features for a product
def list(product, params = {}, opts = {})
request(
method: :get,
path: format("/v1/products/%<product>s/features", { product: CGI.escape(product) }),
params: params,
opts: opts,
base_address: :api
)
end
# Retrieves a product_feature, which represents a feature attachment to a product
def retrieve(product, id, params = {}, opts = {})
request(
method: :get,
path: format("/v1/products/%<product>s/features/%<id>s", { product: CGI.escape(product), id: CGI.escape(id) }),
params: params,
opts: opts,
base_address: :api
)
end
end
end