Class: Google::Apis::ContentV2_1::OrdersUpdateShipmentRequest

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) ⇒ OrdersUpdateShipmentRequest

Returns a new instance of OrdersUpdateShipmentRequest.



7285
7286
7287
# File 'generated/google/apis/content_v2_1/classes.rb', line 7285

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

Instance Attribute Details

#carrierString

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)


7254
7255
7256
# File 'generated/google/apis/content_v2_1/classes.rb', line 7254

def carrier
  @carrier
end

#delivery_dateString

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)


7260
7261
7262
# File 'generated/google/apis/content_v2_1/classes.rb', line 7260

def delivery_date
  @delivery_date
end

#operation_idString

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

Returns:

  • (String)


7265
7266
7267
# File 'generated/google/apis/content_v2_1/classes.rb', line 7265

def operation_id
  @operation_id
end

#shipment_idString

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

Returns:

  • (String)


7270
7271
7272
# File 'generated/google/apis/content_v2_1/classes.rb', line 7270

def shipment_id
  @shipment_id
end

#statusString

New status for the shipment. Not updated if missing. Acceptable values are:

  • "delivered"
  • "undeliverable" Corresponds to the JSON property status

Returns:

  • (String)


7278
7279
7280
# File 'generated/google/apis/content_v2_1/classes.rb', line 7278

def status
  @status
end

#tracking_idString

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

Returns:

  • (String)


7283
7284
7285
# File 'generated/google/apis/content_v2_1/classes.rb', line 7283

def tracking_id
  @tracking_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7290
7291
7292
7293
7294
7295
7296
7297
# File 'generated/google/apis/content_v2_1/classes.rb', line 7290

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