mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-06 00:02:18 -04:00
81 lines
3.4 KiB
Ruby
81 lines
3.4 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
module Issuing
|
|
# A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
|
|
class PhysicalBundle < APIResource
|
|
extend Stripe::APIOperations::List
|
|
|
|
OBJECT_NAME = "issuing.physical_bundle"
|
|
def self.object_name
|
|
"issuing.physical_bundle"
|
|
end
|
|
|
|
class Features < Stripe::StripeObject
|
|
# The policy for how to use card logo images in a card design with this physical bundle.
|
|
attr_reader :card_logo
|
|
# The policy for how to use carrier letter text in a card design with this physical bundle.
|
|
attr_reader :carrier_text
|
|
# The policy for how to use a second line on a card with this physical bundle.
|
|
attr_reader :second_line
|
|
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
|
|
# Only return physical bundles with the given status.
|
|
attr_accessor :status
|
|
# Only return physical bundles with the given type.
|
|
attr_accessor :type
|
|
|
|
def initialize(
|
|
ending_before: nil,
|
|
expand: nil,
|
|
limit: nil,
|
|
starting_after: nil,
|
|
status: nil,
|
|
type: nil
|
|
)
|
|
@ending_before = ending_before
|
|
@expand = expand
|
|
@limit = limit
|
|
@starting_after = starting_after
|
|
@status = status
|
|
@type = type
|
|
end
|
|
end
|
|
# Attribute for field features
|
|
attr_reader :features
|
|
# Unique identifier for the object.
|
|
attr_reader :id
|
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
attr_reader :livemode
|
|
# Friendly display name.
|
|
attr_reader :name
|
|
# String representing the object's type. Objects of the same type share the same value.
|
|
attr_reader :object
|
|
# Whether this physical bundle can be used to create cards.
|
|
attr_reader :status
|
|
# Whether this physical bundle is a standard Stripe offering or custom-made for you.
|
|
attr_reader :type
|
|
|
|
# Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
|
|
def self.list(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :get,
|
|
path: "/v1/issuing/physical_bundles",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|