class

Stripe::IssuingCardShipping

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [bulk, individual]."
ERROR_MESSAGE_FOR_CARRIER = "invalid value for \"carrier\", must be one of [dhl, fedex, royal_mail, usps]."
ERROR_MESSAGE_FOR_SERVICE = "invalid value for \"service\", must be one of [express, priority, standard]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, delivered, failure, pending, returned, shipped]."
MAX_LENGTH_FOR_NAME = 5000
MAX_LENGTH_FOR_PHONE_NUMBER = 5000
MAX_LENGTH_FOR_TRACKING_NUMBER = 5000
MAX_LENGTH_FOR_TRACKING_URL = 5000
VALID_VALUES_FOR__TYPE = String.static_array("bulk", "individual")
VALID_VALUES_FOR_CARRIER = String.static_array("dhl", "fedex", "royal_mail", "usps")
VALID_VALUES_FOR_SERVICE = String.static_array("express", "priority", "standard")
VALID_VALUES_FOR_STATUS = String.static_array("canceled", "delivered", "failure", "pending", "returned", "shipped")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, address : Stripe::Address | Nil = nil, address_validation : Stripe::IssuingCardShippingAddressValidation1 | Nil = nil, carrier : String | Nil = nil, customs : Stripe::IssuingCardShippingCustoms1 | Nil = nil, eta : Int64 | Nil = nil, name : String | Nil = nil, phone_number : String | Nil = nil, require_signature : Bool | Nil = nil, service : String | Nil = nil, status : String | Nil = nil, tracking_number : String | Nil = nil, tracking_url : String | Nil = nil, _type : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type

Packaging options.

Source
_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

Source
address
Source
address=(new_value : Stripe::Address | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] address Object to be assigned

Source
address_validation
Source
address_validation=(new_value : Stripe::IssuingCardShippingAddressValidation1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] address_validation Object to be assigned

Source
carrier

The delivery company that shipped a card.

Source
carrier=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] carrier Object to be assigned

Source
customs
Source
customs=(new_value : Stripe::IssuingCardShippingCustoms1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] customs Object to be assigned

Source
eta

A unix timestamp representing a best estimate of when the card will be delivered.

Source
eta=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] eta Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
name

Recipient name.

Source
name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned

Source
phone_number

The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.

Source
phone_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] phone_number Object to be assigned

Source
require_signature

Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.

Source
require_signature=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] require_signature Object to be assigned

Source
service

Shipment service, such as standard or express.

Source
service=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] service Object to be assigned

Source
status

The delivery status of the card.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
tracking_number

A tracking number for a card shipment.

Source
tracking_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tracking_number Object to be assigned

Source
tracking_url

A link to the shipping carrier's site where you can view detailed information about a card shipment.

Source
tracking_url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tracking_url Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source