Class: Google::Apis::ContentV2::OrdersUpdateShipmentRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrdersUpdateShipmentRequest

Returns a new instance of OrdersUpdateShipmentRequest.



7932
7933
7934
 
# File 'lib/google/apis/content_v2/classes.rb', line 7932

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

Instance Attribute Details

#carrier ⇒ String

The carrier handling the shipment. Not updated if missing. See shipments[]. carrier in the Orders resource representation for a list of acceptable values. Corresponds to the JSON property carrier

Returns:

  • (String) 


7903
7904
7905
 
# File 'lib/google/apis/content_v2/classes.rb', line 7903

def carrier
  @carrier
end

#delivery_date ⇒ String

Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. Corresponds to the JSON property deliveryDate

Returns:

  • (String) 


7909
7910
7911
 
# File 'lib/google/apis/content_v2/classes.rb', line 7909

def delivery_date
  @delivery_date
end

#operation_id ⇒ String

The ID of the operation. Unique across all operations for a given order. Corresponds to the JSON property operationId

Returns:

  • (String) 


7914
7915
7916
 
# File 'lib/google/apis/content_v2/classes.rb', line 7914

def operation_id
  @operation_id
end

#shipment_id ⇒ String

The ID of the shipment. Corresponds to the JSON property shipmentId

Returns:

  • (String) 


7919
7920
7921
 
# File 'lib/google/apis/content_v2/classes.rb', line 7919

def shipment_id
  @shipment_id
end

#status ⇒ String

New status for the shipment. Not updated if missing. Acceptable values are: - " delivered" - "undeliverable" - "readyForPickup" Corresponds to the JSON property status

Returns:

  • (String) 


7925
7926
7927
 
# File 'lib/google/apis/content_v2/classes.rb', line 7925

def status
  @status
end

#tracking_id ⇒ String

The tracking ID for the shipment. Not updated if missing. Corresponds to the JSON property trackingId

Returns:

  • (String) 


7930
7931
7932
 
# File 'lib/google/apis/content_v2/classes.rb', line 7930

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7937
7938
7939
7940
7941
7942
7943
7944
 
# File 'lib/google/apis/content_v2/classes.rb', line 7937

def update!(**args)
  @carrier = args[:carrier] if args.key?(:carrier)
  @delivery_date = args[:delivery_date] if args.key?(:delivery_date)
  @operation_id = args[:operation_id] if args.key?(:operation_id)
  @shipment_id = args[:shipment_id] if args.key?(:shipment_id)
  @status = args[:status] if args.key?(:status)
  @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
end