Class: Google::Apis::ContentV2_1::ReturnShipment

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2_1/classes.rb,
generated/google/apis/content_v2_1/representations.rb,
generated/google/apis/content_v2_1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReturnShipment

Returns a new instance of ReturnShipment.



10135
10136
10137
# File 'generated/google/apis/content_v2_1/classes.rb', line 10135

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_dateString

The date of creation of the shipment, in ISO 8601 format. Corresponds to the JSON property creationDate

Returns:

  • (String)


10093
10094
10095
# File 'generated/google/apis/content_v2_1/classes.rb', line 10093

def creation_date
  @creation_date
end

#delivery_dateString

The date of delivery of the shipment, in ISO 8601 format. Corresponds to the JSON property deliveryDate

Returns:

  • (String)


10098
10099
10100
# File 'generated/google/apis/content_v2_1/classes.rb', line 10098

def delivery_date
  @delivery_date
end

#return_method_typeString

Type of the return method. Acceptable values are:

  • "byMail"
  • "contactCustomerSupport"
  • "returnless" Corresponds to the JSON property returnMethodType

Returns:

  • (String)


10107
10108
10109
# File 'generated/google/apis/content_v2_1/classes.rb', line 10107

def return_method_type
  @return_method_type
end

#shipment_idString

Shipment ID generated by Google. Corresponds to the JSON property shipmentId

Returns:

  • (String)


10112
10113
10114
# File 'generated/google/apis/content_v2_1/classes.rb', line 10112

def shipment_id
  @shipment_id
end

#shipment_tracking_infosArray<Google::Apis::ContentV2_1::ShipmentTrackingInfo>

Tracking information of the shipment. One return shipment might be handled by several shipping carriers sequentially. Corresponds to the JSON property shipmentTrackingInfos



10118
10119
10120
# File 'generated/google/apis/content_v2_1/classes.rb', line 10118

def shipment_tracking_infos
  @shipment_tracking_infos
end

#shipping_dateString

The date of shipping of the shipment, in ISO 8601 format. Corresponds to the JSON property shippingDate

Returns:

  • (String)


10123
10124
10125
# File 'generated/google/apis/content_v2_1/classes.rb', line 10123

def shipping_date
  @shipping_date
end

#stateString

State of the shipment. Acceptable values are:

  • "completed"
  • "new"
  • "shipped"
  • "undeliverable" Corresponds to the JSON property state

Returns:

  • (String)


10133
10134
10135
# File 'generated/google/apis/content_v2_1/classes.rb', line 10133

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10140
10141
10142
10143
10144
10145
10146
10147
10148
# File 'generated/google/apis/content_v2_1/classes.rb', line 10140

def update!(**args)
  @creation_date = args[:creation_date] if args.key?(:creation_date)
  @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
  @return_method_type = args[:return_method_type] if args.key?(:return_method_type)
  @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
  @shipment_tracking_infos = args[:shipment_tracking_infos] if args.key?(:shipment_tracking_infos)
  @shipping_date = args[:shipping_date] if args.key?(:shipping_date)
  @state = args[:state] if args.key?(:state)
end